site_to_site_vpn_attachments

Creates, updates, deletes or gets a site_to_site_vpn_attachment resource or lists site_to_site_vpn_attachments in a region

Overview

Name	site_to_site_vpn_attachments
Type	Resource
Description	AWS::NetworkManager::SiteToSiteVpnAttachment Resource Type definition.
Id	aws.networkmanager.site_to_site_vpn_attachments

Fields

Name	Datatype	Description
core_network_id	string	The ID of a core network where you're creating a site-to-site VPN attachment.
core_network_arn	string	The ARN of a core network for the VPC attachment.
attachment_id	string	The ID of the attachment.
owner_account_id	string	Owner account of the attachment.
attachment_type	string	The type of attachment.
state	string	The state of the attachment.
edge_location	string	The Region where the edge is located.
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 that attachment is in.
proposed_segment_change	object	The attachment to move from one segment 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.
vpn_connection_arn	string	The ARN of the site-to-site VPN attachment.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	CoreNetworkId, VpnConnectionArn, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all site_to_site_vpn_attachments in a region.

SELECT
region,
core_network_id,
core_network_arn,
attachment_id,
owner_account_id,
attachment_type,
state,
edge_location,
resource_arn,
attachment_policy_rule_number,
segment_name,
proposed_segment_change,
tags,
created_at,
updated_at,
vpn_connection_arn
FROM aws.networkmanager.site_to_site_vpn_attachments
WHERE region = 'us-east-1';

Gets all properties from an individual site_to_site_vpn_attachment.

SELECT
region,
core_network_id,
core_network_arn,
attachment_id,
owner_account_id,
attachment_type,
state,
edge_location,
resource_arn,
attachment_policy_rule_number,
segment_name,
proposed_segment_change,
tags,
created_at,
updated_at,
vpn_connection_arn
FROM aws.networkmanager.site_to_site_vpn_attachments
WHERE region = 'us-east-1' AND data__Identifier = '<AttachmentId>';

INSERT example

Use the following StackQL query and manifest file to create a new site_to_site_vpn_attachment resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.networkmanager.site_to_site_vpn_attachments (
 CoreNetworkId,
 VpnConnectionArn,
 region
)
SELECT 
'{{ CoreNetworkId }}',
 '{{ VpnConnectionArn }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.networkmanager.site_to_site_vpn_attachments (
 CoreNetworkId,
 ProposedSegmentChange,
 Tags,
 VpnConnectionArn,
 region
)
SELECT 
 '{{ CoreNetworkId }}',
 '{{ ProposedSegmentChange }}',
 '{{ Tags }}',
 '{{ VpnConnectionArn }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: site_to_site_vpn_attachment
    props:
      - name: CoreNetworkId
        value: '{{ CoreNetworkId }}'
      - name: ProposedSegmentChange
        value:
          Tags:
            - Key: '{{ Key }}'
              Value: '{{ Value }}'
          AttachmentPolicyRuleNumber: '{{ AttachmentPolicyRuleNumber }}'
          SegmentName: '{{ SegmentName }}'
      - name: Tags
        value:
          - null
      - name: VpnConnectionArn
        value: '{{ VpnConnectionArn }}'

DELETE example

/*+ delete */
DELETE FROM aws.networkmanager.site_to_site_vpn_attachments
WHERE data__Identifier = '<AttachmentId>'
AND region = 'us-east-1';

Permissions

To operate on the site_to_site_vpn_attachments resource, the following permissions are required:

Create

networkmanager:GetSiteToSiteVpnAttachment,
networkmanager:CreateSiteToSiteVpnAttachment,
ec2:DescribeRegions,
networkmanager:TagResource

Read

networkmanager:GetSiteToSiteVpnAttachment

Update

networkmanager:GetSiteToSiteVpnAttachment,
networkmanager:ListTagsForResource,
networkmanager:TagResource,
networkmanager:UntagResource,
ec2:DescribeRegions

Delete

networkmanager:GetSiteToSiteVpnAttachment,
networkmanager:DeleteAttachment,
ec2:DescribeRegions

List

networkmanager:ListAttachments