vpc_attachments

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

Overview

Name	vpc_attachments
Type	Resource
Id	aws.networkmanager.vpc_attachments

Fields

The following fields are returned by SELECT queries:

get_vpc_attachment

Name	Datatype	Description
attachment	object	Describes a core network attachment.
options	object	Describes the VPC options.
subnet_arns	array	The subnet ARNs.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_vpc_attachment	select	attachment_id, region		Returns information about a VPC attachment.
create_vpc_attachment	insert	region, CoreNetworkId, VpcArn, SubnetArns		Creates a VPC attachment on an edge location of a core network.
update_vpc_attachment	update	attachment_id, region		Updates a VPC 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 attachment.
region	string	AWS region (default: us-east-1)

SELECT examples

get_vpc_attachment

Returns information about a VPC attachment.

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

INSERT examples

create_vpc_attachment

Creates a VPC attachment on an edge location of a core network.

INSERT INTO aws.networkmanager.vpc_attachments (
CoreNetworkId,
VpcArn,
SubnetArns,
Options,
RoutingPolicyLabel,
Tags,
ClientToken,
region
)
SELECT 
'{{ CoreNetworkId }}' /* required */,
'{{ VpcArn }}' /* required */,
'{{ SubnetArns }}' /* required */,
'{{ Options }}',
'{{ RoutingPolicyLabel }}',
'{{ Tags }}',
'{{ ClientToken }}',
'{{ region }}'
RETURNING
vpc_attachment
;

Manifest

# Description fields are for documentation purposes
- name: vpc_attachments
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the vpc_attachments resource.
  - name: CoreNetworkId
    value: "{{ CoreNetworkId }}"
  - name: VpcArn
    value: "{{ VpcArn }}"
  - name: SubnetArns
    value:
      - "{{ SubnetArns }}"
  - name: Options
    description: |
      Describes the VPC options.
    value:
      Ipv6Support: {{ Ipv6Support }}
      ApplianceModeSupport: {{ ApplianceModeSupport }}
      DnsSupport: {{ DnsSupport }}
      SecurityGroupReferencingSupport: {{ SecurityGroupReferencingSupport }}
  - name: RoutingPolicyLabel
    value: "{{ RoutingPolicyLabel }}"
  - name: Tags
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
  - name: ClientToken
    value: "{{ ClientToken }}"

UPDATE examples

update_vpc_attachment

Updates a VPC attachment.

UPDATE aws.networkmanager.vpc_attachments
SET 
AddSubnetArns = '{{ AddSubnetArns }}',
RemoveSubnetArns = '{{ RemoveSubnetArns }}',
Options = '{{ Options }}'
WHERE 
attachment_id = '{{ attachment_id }}' --required
AND region = '{{ region }}' --required
RETURNING
vpc_attachment;