connect_attachments

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

Overview

Name	connect_attachments
Type	Resource
Id	aws.networkmanager.connect_attachments

Fields

The following fields are returned by SELECT queries:

get_connect_attachment

Name	Datatype	Description
attachment	object	The attachment details.
options	object	Describes a core network Connect attachment options.
transport_attachment_id	string	The ID of the transport attachment. (pattern: <code>^attachment-([0-9a-f]{8,17})$</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_connect_attachment	select	attachment_id, region		Returns information about a core network Connect attachment.
create_connect_attachment	insert	region, CoreNetworkId, EdgeLocation, TransportAttachmentId, Options		Creates a core network Connect attachment from a specified core network attachment. A core network Connect attachment is a GRE-based tunnel attachment that you can use to establish a connection between a core network and an appliance. A core network Connect attachment uses an existing VPC attachment as the underlying transport mechanism.

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 attachment.
region	string	AWS region (default: us-east-1)

SELECT examples

get_connect_attachment

Returns information about a core network Connect attachment.

SELECT
attachment,
options,
transport_attachment_id
FROM aws.networkmanager.connect_attachments
WHERE attachment_id = '{{ attachment_id }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples

create_connect_attachment

Creates a core network Connect attachment from a specified core network attachment. A core network Connect attachment is a GRE-based tunnel attachment that you can use to establish a connection between a core network and an appliance. A core network Connect attachment uses an existing VPC attachment as the underlying transport mechanism.

INSERT INTO aws.networkmanager.connect_attachments (
CoreNetworkId,
EdgeLocation,
TransportAttachmentId,
RoutingPolicyLabel,
Options,
Tags,
ClientToken,
region
)
SELECT 
'{{ CoreNetworkId }}' /* required */,
'{{ EdgeLocation }}' /* required */,
'{{ TransportAttachmentId }}' /* required */,
'{{ RoutingPolicyLabel }}',
'{{ Options }}' /* required */,
'{{ Tags }}',
'{{ ClientToken }}',
'{{ region }}'
RETURNING
connect_attachment
;

Manifest

# Description fields are for documentation purposes
- name: connect_attachments
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the connect_attachments resource.
  - name: CoreNetworkId
    value: "{{ CoreNetworkId }}"
  - name: EdgeLocation
    value: "{{ EdgeLocation }}"
  - name: TransportAttachmentId
    value: "{{ TransportAttachmentId }}"
  - name: RoutingPolicyLabel
    value: "{{ RoutingPolicyLabel }}"
  - name: Options
    description: |
      Describes a core network Connect attachment options.
    value:
      Protocol: "{{ Protocol }}"
  - name: Tags
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
  - name: ClientToken
    value: "{{ ClientToken }}"