vpc_gateway_attachments

Creates, updates, deletes or gets a vpc_gateway_attachment resource or lists vpc_gateway_attachments in a region

Overview

Name	vpc_gateway_attachments
Type	Resource
Description	Resource Type definition for AWS::EC2::VPCGatewayAttachment
Id	aws.ec2.vpc_gateway_attachments

Fields

Name	Datatype	Description
attachment_type	string	Used to identify if this resource is an Internet Gateway or Vpn Gateway Attachment
internet_gateway_id	string	The ID of the internet gateway. You must specify either InternetGatewayId or VpnGatewayId, but not both.
vpc_id	string	The ID of the VPC.
vpn_gateway_id	string	The ID of the virtual private gateway. You must specify either InternetGatewayId or VpnGatewayId, but not both.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	VpcId, 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 vpc_gateway_attachments in a region.

SELECT
region,
attachment_type,
internet_gateway_id,
vpc_id,
vpn_gateway_id
FROM aws.ec2.vpc_gateway_attachments
WHERE region = 'us-east-1';

Gets all properties from an individual vpc_gateway_attachment.

SELECT
region,
attachment_type,
internet_gateway_id,
vpc_id,
vpn_gateway_id
FROM aws.ec2.vpc_gateway_attachments
WHERE region = 'us-east-1' AND data__Identifier = '<AttachmentType>|<VpcId>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.ec2.vpc_gateway_attachments (
 VpcId,
 region
)
SELECT 
'{{ VpcId }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.ec2.vpc_gateway_attachments (
 InternetGatewayId,
 VpcId,
 VpnGatewayId,
 region
)
SELECT 
 '{{ InternetGatewayId }}',
 '{{ VpcId }}',
 '{{ VpnGatewayId }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: vpc_gateway_attachment
    props:
      - name: InternetGatewayId
        value: '{{ InternetGatewayId }}'
      - name: VpcId
        value: '{{ VpcId }}'
      - name: VpnGatewayId
        value: '{{ VpnGatewayId }}'

DELETE example

/*+ delete */
DELETE FROM aws.ec2.vpc_gateway_attachments
WHERE data__Identifier = '<AttachmentType|VpcId>'
AND region = 'us-east-1';

Permissions

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

Create

ec2:AttachInternetGateway,
ec2:AttachVpnGateway,
ec2:DescribeInternetGateways,
ec2:DescribeVpnGateways

Read

ec2:DescribeInternetGateways,
ec2:DescribeVpnGateways

Update

ec2:AttachInternetGateway,
ec2:AttachVpnGateway,
ec2:DetachInternetGateway,
ec2:DetachVpnGateway,
ec2:DescribeInternetGateways,
ec2:DescribeVpnGateways

Delete

ec2:DetachInternetGateway,
ec2:DetachVpnGateway,
ec2:DescribeInternetGateways,
ec2:DescribeVpnGateways

List

ec2:DescribeInternetGateways,
ec2:DescribeVpnGateways