site_to_site_vpn_attachments

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

Overview

Name	site_to_site_vpn_attachments
Type	Resource
Id	aws.networkmanager.site_to_site_vpn_attachments

Fields

The following fields are returned by SELECT queries:

get_site_to_site_vpn_attachment

Name	Datatype	Description
attachment	object	Describes a core network attachment.
vpn_connection_arn	string	The ARN of the site-to-site VPN attachment. (pattern: <code>^arn:[^:]{1,63}:ec2:[^:]{0,63}:[^:]{0,63}:vpn-connection/vpn-[0-9a-f]{8,17}$</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_site_to_site_vpn_attachment	select	attachment_id, region		Returns information about a site-to-site VPN attachment.
create_site_to_site_vpn_attachment	insert	region, CoreNetworkId, VpnConnectionArn		Creates an Amazon Web Services site-to-site VPN attachment on an edge location of a core network.

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_site_to_site_vpn_attachment

Returns information about a site-to-site VPN attachment.

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

INSERT examples

create_site_to_site_vpn_attachment

Creates an Amazon Web Services site-to-site VPN attachment on an edge location of a core network.

INSERT INTO aws.networkmanager.site_to_site_vpn_attachments (
CoreNetworkId,
VpnConnectionArn,
RoutingPolicyLabel,
Tags,
ClientToken,
region
)
SELECT 
'{{ CoreNetworkId }}' /* required */,
'{{ VpnConnectionArn }}' /* required */,
'{{ RoutingPolicyLabel }}',
'{{ Tags }}',
'{{ ClientToken }}',
'{{ region }}'
RETURNING
site_to_site_vpn_attachment
;

Manifest

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