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	awscc.globalaccelerator.cross_account_attachments

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
attachment_arn	string	The Amazon Resource Name (ARN) of the attachment.
region	string	AWS region.

For more information, see AWS::GlobalAccelerator::CrossAccountAttachment.

Methods

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

SELECT examples

get (all properties)

Gets all properties from an individual cross_account_attachment.

SELECT
  region,
  name,
  attachment_arn,
  principals,
  resources,
  tags
FROM awscc.globalaccelerator.cross_account_attachments
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ attachment_arn }}';

list (identifiers only)

Lists all cross_account_attachments in a region.

SELECT
  region,
  attachment_arn
FROM awscc.globalaccelerator.cross_account_attachments_list_only
WHERE
  region = 'us-east-1';

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 awscc.globalaccelerator.cross_account_attachments (
  Name,
  region
)
SELECT
  '{{ name }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.globalaccelerator.cross_account_attachments (
  Name,
  Principals,
  Resources,
  Tags,
  region
)
SELECT
  '{{ name }}',
  '{{ principals }}',
  '{{ resources }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

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:
        - endpoint_id: '{{ endpoint_id }}'
          cidr: '{{ cidr }}'
          region: '{{ region }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.globalaccelerator.cross_account_attachments
SET PatchDocument = string('{{ {
    "Name": name,
    "Principals": principals,
    "Resources": resources,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ attachment_arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.globalaccelerator.cross_account_attachments
WHERE
  Identifier = '{{ attachment_arn }}' AND
  region = 'us-east-1'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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