links

Creates, updates, deletes or gets a link resource or lists links in a region

Overview

Name	links
Type	Resource
Description	Definition of AWS::Oam::Link Resource Type
Id	aws.oam.links

Fields

Name	Datatype	Description
arn	string
label	string
label_template	string
resource_types	array
sink_identifier	string
link_configuration	object
tags	object	Tags to apply to the link
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	ResourceTypes, SinkIdentifier, 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 links in a region.

SELECT
region,
arn,
label,
label_template,
resource_types,
sink_identifier,
link_configuration,
tags
FROM aws.oam.links
WHERE region = 'us-east-1';

Gets all properties from an individual link.

SELECT
region,
arn,
label,
label_template,
resource_types,
sink_identifier,
link_configuration,
tags
FROM aws.oam.links
WHERE region = 'us-east-1' AND data__Identifier = '<Arn>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.oam.links (
 ResourceTypes,
 SinkIdentifier,
 region
)
SELECT 
'{{ ResourceTypes }}',
 '{{ SinkIdentifier }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.oam.links (
 LabelTemplate,
 ResourceTypes,
 SinkIdentifier,
 LinkConfiguration,
 Tags,
 region
)
SELECT 
 '{{ LabelTemplate }}',
 '{{ ResourceTypes }}',
 '{{ SinkIdentifier }}',
 '{{ LinkConfiguration }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: link
    props:
      - name: LabelTemplate
        value: '{{ LabelTemplate }}'
      - name: ResourceTypes
        value:
          - '{{ ResourceTypes[0] }}'
      - name: SinkIdentifier
        value: '{{ SinkIdentifier }}'
      - name: LinkConfiguration
        value:
          MetricConfiguration:
            Filter: '{{ Filter }}'
          LogGroupConfiguration: null
      - name: Tags
        value: {}

DELETE example

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

Permissions

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

Create

oam:CreateLink,
oam:GetLink,
cloudwatch:Link,
logs:Link,
xray:Link,
applicationinsights:Link,
internetmonitor:Link

Read

oam:GetLink

Update

oam:GetLink,
oam:UpdateLink,
cloudwatch:Link,
logs:Link,
xray:Link,
applicationinsights:Link,
internetmonitor:Link,
oam:TagResource,
oam:UntagResource

Delete

oam:DeleteLink,
oam:GetLink

List

oam:ListLinks