direct_connect_gateway_attachments

Creates, updates, deletes, gets or lists a direct_connect_gateway_attachments resource.

Overview

Name	direct_connect_gateway_attachments
Type	Resource
Id	aws.networkmanager.direct_connect_gateway_attachments

Fields

The following fields are returned by SELECT queries:

get_direct_connect_gateway_attachment

Name	Datatype	Description
attachment	object	Describes a core network attachment.
direct_connect_gateway_arn	string	The Direct Connect gateway attachment ARN. (pattern: <code>^arn:[^:]{1,63}:directconnect::[^:]{0,63}:dx-gateway/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_direct_connect_gateway_attachment	select	attachment_id, region		Returns information about a specific Amazon Web Services Direct Connect gateway attachment.
create_direct_connect_gateway_attachment	insert	region, CoreNetworkId, DirectConnectGatewayArn, EdgeLocations		Creates an Amazon Web Services Direct Connect gateway attachment
update_direct_connect_gateway_attachment	update	attachment_id, region		Updates the edge locations associated with an Amazon Web Services Direct Connect gateway attachment.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
attachment_id	string	The ID of the Direct Connect gateway attachment for the updated edge locations.
region	string	AWS region (default: us-east-1)

SELECT examples

get_direct_connect_gateway_attachment

Returns information about a specific Amazon Web Services Direct Connect gateway attachment.

SELECT
attachment,
direct_connect_gateway_arn
FROM aws.networkmanager.direct_connect_gateway_attachments
WHERE attachment_id = '{{ attachment_id }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples

create_direct_connect_gateway_attachment

Creates an Amazon Web Services Direct Connect gateway attachment

INSERT INTO aws.networkmanager.direct_connect_gateway_attachments (
CoreNetworkId,
DirectConnectGatewayArn,
RoutingPolicyLabel,
EdgeLocations,
Tags,
ClientToken,
region
)
SELECT 
'{{ CoreNetworkId }}' /* required */,
'{{ DirectConnectGatewayArn }}' /* required */,
'{{ RoutingPolicyLabel }}',
'{{ EdgeLocations }}' /* required */,
'{{ Tags }}',
'{{ ClientToken }}',
'{{ region }}'
RETURNING
direct_connect_gateway_attachment
;

Manifest

# Description fields are for documentation purposes
- name: direct_connect_gateway_attachments
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the direct_connect_gateway_attachments resource.
  - name: CoreNetworkId
    value: "{{ CoreNetworkId }}"
  - name: DirectConnectGatewayArn
    value: "{{ DirectConnectGatewayArn }}"
  - name: RoutingPolicyLabel
    value: "{{ RoutingPolicyLabel }}"
  - name: EdgeLocations
    value:
      - "{{ EdgeLocations }}"
  - name: Tags
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
  - name: ClientToken
    value: "{{ ClientToken }}"

UPDATE examples

update_direct_connect_gateway_attachment

Updates the edge locations associated with an Amazon Web Services Direct Connect gateway attachment.

UPDATE aws.networkmanager.direct_connect_gateway_attachments
SET 
EdgeLocations = '{{ EdgeLocations }}'
WHERE 
attachment_id = '{{ attachment_id }}' --required
AND region = '{{ region }}' --required
RETURNING
direct_connect_gateway_attachment;