direct_connect_gateway_attachments

Creates, updates, deletes or gets a direct_connect_gateway_attachment resource or lists direct_connect_gateway_attachments in a region

Overview

Name	direct_connect_gateway_attachments
Type	Resource
Description	AWS::NetworkManager::DirectConnectGatewayAttachment Resource Type
Id	aws.networkmanager.direct_connect_gateway_attachments

Fields

Name	Datatype	Description
core_network_id	string	The ID of a core network for the Direct Connect Gateway attachment.
core_network_arn	string	The ARN of a core network for the Direct Connect Gateway attachment.
attachment_id	string	Id of the attachment.
owner_account_id	string	Owner account of the attachment.
attachment_type	string	Attachment type.
state	string	State of the attachment.
edge_locations	array	The Regions where the edges are located.
direct_connect_gateway_arn	string	The ARN of the Direct Connect Gateway.
resource_arn	string	The ARN of the Resource.
attachment_policy_rule_number	integer	The policy rule number associated with the attachment.
segment_name	string	The name of the segment attachment..
proposed_segment_change	object	The attachment to move from one segment to another.
network_function_group_name	string	The name of the network function group attachment.
proposed_network_function_group_change	object	The attachment to move from one network function group to another.
tags	array	Tags for the attachment.
created_at	string	Creation time of the attachment.
updated_at	string	Last update time of the attachment.
region	string	AWS region.

For more information, see AWS::NetworkManager::DirectConnectGatewayAttachment.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	CoreNetworkId, DirectConnectGatewayArn, EdgeLocations, 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 direct_connect_gateway_attachments in a region.

SELECT
region,
core_network_id,
core_network_arn,
attachment_id,
owner_account_id,
attachment_type,
state,
edge_locations,
direct_connect_gateway_arn,
resource_arn,
attachment_policy_rule_number,
segment_name,
proposed_segment_change,
network_function_group_name,
proposed_network_function_group_change,
tags,
created_at,
updated_at
FROM aws.networkmanager.direct_connect_gateway_attachments
WHERE region = 'us-east-1';

Gets all properties from an individual direct_connect_gateway_attachment.

SELECT
region,
core_network_id,
core_network_arn,
attachment_id,
owner_account_id,
attachment_type,
state,
edge_locations,
direct_connect_gateway_arn,
resource_arn,
attachment_policy_rule_number,
segment_name,
proposed_segment_change,
network_function_group_name,
proposed_network_function_group_change,
tags,
created_at,
updated_at
FROM aws.networkmanager.direct_connect_gateway_attachments
WHERE region = 'us-east-1' AND data__Identifier = '<AttachmentId>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.networkmanager.direct_connect_gateway_attachments (
 CoreNetworkId,
 EdgeLocations,
 DirectConnectGatewayArn,
 region
)
SELECT 
'{{ CoreNetworkId }}',
 '{{ EdgeLocations }}',
 '{{ DirectConnectGatewayArn }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.networkmanager.direct_connect_gateway_attachments (
 CoreNetworkId,
 EdgeLocations,
 DirectConnectGatewayArn,
 ProposedSegmentChange,
 ProposedNetworkFunctionGroupChange,
 Tags,
 region
)
SELECT 
 '{{ CoreNetworkId }}',
 '{{ EdgeLocations }}',
 '{{ DirectConnectGatewayArn }}',
 '{{ ProposedSegmentChange }}',
 '{{ ProposedNetworkFunctionGroupChange }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: direct_connect_gateway_attachment
    props:
      - name: CoreNetworkId
        value: '{{ CoreNetworkId }}'
      - name: EdgeLocations
        value:
          - '{{ EdgeLocations[0] }}'
      - name: DirectConnectGatewayArn
        value: '{{ DirectConnectGatewayArn }}'
      - name: ProposedSegmentChange
        value:
          Tags:
            - Key: '{{ Key }}'
              Value: '{{ Value }}'
          AttachmentPolicyRuleNumber: '{{ AttachmentPolicyRuleNumber }}'
          SegmentName: '{{ SegmentName }}'
      - name: ProposedNetworkFunctionGroupChange
        value:
          Tags:
            - null
          AttachmentPolicyRuleNumber: '{{ AttachmentPolicyRuleNumber }}'
          NetworkFunctionGroupName: '{{ NetworkFunctionGroupName }}'
      - name: Tags
        value:
          - null

DELETE example

/*+ delete */
DELETE FROM aws.networkmanager.direct_connect_gateway_attachments
WHERE data__Identifier = '<AttachmentId>'
AND region = 'us-east-1';

Permissions

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

Create

networkmanager:CreateDirectConnectGatewayAttachment,
networkmanager:GetDirectConnectGatewayAttachment,
networkmanager:TagResource,
ec2:DescribeRegions,
iam:CreateServiceLinkedRole

Read

networkmanager:GetDirectConnectGatewayAttachment

Update

networkmanager:UpdateDirectConnectGatewayAttachment,
networkmanager:GetDirectConnectGatewayAttachment,
networkmanager:ListTagsForResource,
networkmanager:TagResource,
networkmanager:UntagResource,
ec2:DescribeRegions

Delete

networkmanager:DeleteAttachment,
networkmanager:GetDirectConnectGatewayAttachment,
networkmanager:UntagResource,
ec2:DescribeRegions

List

networkmanager:ListAttachments