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	awscc.oam.sinks

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
arn	string	The Amazon resource name (ARN) of the ObservabilityAccessManager Sink
region	string	AWS region.

For more information, see AWS::Oam::Sink.

Methods

Name	Resource	Accessible by	Required Params
create_resource	sinks	INSERT	Name, region
delete_resource	sinks	DELETE	Identifier, region
update_resource	sinks	UPDATE	Identifier, PatchDocument, region
list_resources	sinks_list_only	SELECT	region
get_resource	sinks	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual sink.

SELECT
  region,
  arn,
  name,
  policy,
  tags
FROM awscc.oam.sinks
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ arn }}';

list (identifiers only)

Lists all sinks in a region.

SELECT
  region,
  arn
FROM awscc.oam.sinks_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

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

All Properties

/*+ create */
INSERT INTO awscc.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: {}

UPDATE example

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

/*+ update */
UPDATE awscc.oam.sinks
SET PatchDocument = string('{{ {
    "Policy": policy,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}';

DELETE example

/*+ delete */
DELETE FROM awscc.oam.sinks
WHERE
  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,
oam:TagResource,
oam:ListTagsForResource

Delete

oam:DeleteSink,
oam:GetSinkPolicy,
oam:GetSink

List

oam:ListSinks

Read

oam:GetSinkPolicy,
oam:GetSink,
oam:ListTagsForResource

Update

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