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	awscc.networkmanager.direct_connect_gateway_attachments

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
attachment_id	string	Id of the attachment.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	direct_connect_gateway_attachments	INSERT	CoreNetworkId, DirectConnectGatewayArn, EdgeLocations, region
delete_resource	direct_connect_gateway_attachments	DELETE	Identifier, region
update_resource	direct_connect_gateway_attachments	UPDATE	Identifier, PatchDocument, region
list_resources	direct_connect_gateway_attachments_list_only	SELECT	region
get_resource	direct_connect_gateway_attachments	SELECT	Identifier, region

SELECT examples

get (all properties)

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 awscc.networkmanager.direct_connect_gateway_attachments
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ attachment_id }}';

list (identifiers only)

Lists all direct_connect_gateway_attachments in a region.

SELECT
  region,
  attachment_id
FROM awscc.networkmanager.direct_connect_gateway_attachments_list_only
WHERE
  region = 'us-east-1';

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 awscc.networkmanager.direct_connect_gateway_attachments (
  CoreNetworkId,
  EdgeLocations,
  DirectConnectGatewayArn,
  region
)
SELECT
  '{{ core_network_id }}',
  '{{ edge_locations }}',
  '{{ direct_connect_gateway_arn }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.networkmanager.direct_connect_gateway_attachments (
  CoreNetworkId,
  EdgeLocations,
  DirectConnectGatewayArn,
  ProposedSegmentChange,
  ProposedNetworkFunctionGroupChange,
  Tags,
  region
)
SELECT
  '{{ core_network_id }}',
  '{{ edge_locations }}',
  '{{ direct_connect_gateway_arn }}',
  '{{ proposed_segment_change }}',
  '{{ proposed_network_function_group_change }}',
  '{{ 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: core_network_id
        value: '{{ core_network_id }}'
      - name: edge_locations
        value:
          - '{{ edge_locations[0] }}'
      - name: direct_connect_gateway_arn
        value: '{{ direct_connect_gateway_arn }}'
      - name: proposed_segment_change
        value:
          tags:
            - key: '{{ key }}'
              value: '{{ value }}'
          attachment_policy_rule_number: '{{ attachment_policy_rule_number }}'
          segment_name: '{{ segment_name }}'
      - name: proposed_network_function_group_change
        value:
          tags:
            - null
          attachment_policy_rule_number: '{{ attachment_policy_rule_number }}'
          network_function_group_name: '{{ network_function_group_name }}'
      - name: tags
        value:
          - null

UPDATE example

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

/*+ update */
UPDATE awscc.networkmanager.direct_connect_gateway_attachments
SET PatchDocument = string('{{ {
    "EdgeLocations": edge_locations,
    "ProposedSegmentChange": proposed_segment_change,
    "ProposedNetworkFunctionGroupChange": proposed_network_function_group_change,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ attachment_id }}';

DELETE example

/*+ delete */
DELETE FROM awscc.networkmanager.direct_connect_gateway_attachments
WHERE
  Identifier = '{{ attachment_id }}' 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