cross_account_attachments

Creates, updates, deletes or gets a cross_account_attachment resource or lists cross_account_attachments in a region

Overview

Name	cross_account_attachments
Type	Resource
Description	Resource Type definition for AWS::GlobalAccelerator::CrossAccountAttachment
Id	aws.globalaccelerator.cross_account_attachments

Fields

Name	Datatype	Description
name	string	The Friendly identifier of the attachment.
attachment_arn	string	The Amazon Resource Name (ARN) of the attachment.
principals	array	Principals to share the resources with.
resources	array	Resources shared using the attachment.
tags	array
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 cross_account_attachments in a region.

SELECT
region,
name,
attachment_arn,
principals,
resources,
tags
FROM aws.globalaccelerator.cross_account_attachments
;

Gets all properties from an individual cross_account_attachment.

SELECT
region,
name,
attachment_arn,
principals,
resources,
tags
FROM aws.globalaccelerator.cross_account_attachments
WHERE data__Identifier = '<AttachmentArn>';

INSERT example

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

Required Properties

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

All Properties

/*+ create */
INSERT INTO aws.globalaccelerator.cross_account_attachments (
 Name,
 Principals,
 Resources,
 Tags,
 region
)
SELECT 
 '{{ Name }}',
 '{{ Principals }}',
 '{{ Resources }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: cross_account_attachment
    props:
      - name: Name
        value: '{{ Name }}'
      - name: Principals
        value:
          - '{{ Principals[0] }}'
      - name: Resources
        value:
          - EndpointId: '{{ EndpointId }}'
            Region: '{{ Region }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.globalaccelerator.cross_account_attachments
WHERE data__Identifier = '<AttachmentArn>'
AND region = 'us-east-1';

Permissions

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

Create

globalaccelerator:DescribeCrossAccountAttachment,
globalaccelerator:CreateCrossAccountAttachment,
globalaccelerator:TagResource

Read

globalaccelerator:DescribeCrossAccountAttachment

Update

globalaccelerator:UpdateCrossAccountAttachment,
globalaccelerator:DescribeCrossAccountAttachment,
globalaccelerator:TagResource,
globalaccelerator:UntagResource

Delete

globalaccelerator:DescribeCrossAccountAttachment,
globalaccelerator:DeleteCrossAccountAttachment

List

globalaccelerator:ListCrossAccountAttachments