sinks

Creates, updates, deletes or gets a sink resource or lists sinks in a region

Overview

Name	sinks
Type	Resource
Description	Resource Type definition for AWS::Oam::Sink
Id	aws.oam.sinks

Fields

Name	Datatype	Description
arn	string	The Amazon resource name (ARN) of the ObservabilityAccessManager Sink
name	string	The name of the ObservabilityAccessManager Sink.
policy	object	The policy of this ObservabilityAccessManager Sink.
tags	object	Tags to apply to the sink
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Name, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all sinks in a region.

SELECT
region,
arn,
name,
policy,
tags
FROM aws.oam.sinks
WHERE region = 'us-east-1';

Gets all properties from an individual sink.

SELECT
region,
arn,
name,
policy,
tags
FROM aws.oam.sinks
WHERE region = 'us-east-1' AND data__Identifier = '<Arn>';

INSERT example

Use the following StackQL query and manifest file to create a new sink resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.oam.sinks (
 Name,
 region
)
SELECT 
'{{ Name }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.oam.sinks (
 Name,
 Policy,
 Tags,
 region
)
SELECT 
 '{{ Name }}',
 '{{ Policy }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: sink
    props:
      - name: Name
        value: '{{ Name }}'
      - name: Policy
        value: {}
      - name: Tags
        value: {}

DELETE example

/*+ delete */
DELETE FROM aws.oam.sinks
WHERE data__Identifier = '<Arn>'
AND region = 'us-east-1';

Permissions

To operate on the sinks resource, the following permissions are required:

Create

oam:CreateSink,
oam:PutSinkPolicy,
oam:GetSinkPolicy,
oam:GetSink

Delete

oam:DeleteSink,
oam:GetSinkPolicy,
oam:GetSink

List

oam:ListSinks

Read

oam:GetSinkPolicy,
oam:GetSink

Update

oam:PutSinkPolicy,
oam:GetSinkPolicy,
oam:GetSink,
oam:TagResource,
oam:UntagResource