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	awscc.ec2.vpc_gateway_attachments

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
attachment_type	string	Used to identify if this resource is an Internet Gateway or Vpn Gateway Attachment
vpc_id	string	The ID of the VPC.
region	string	AWS region.

For more information, see AWS::EC2::VPCGatewayAttachment.

Methods

Name	Resource	Accessible by	Required Params
create_resource	vpc_gateway_attachments	INSERT	VpcId, region
delete_resource	vpc_gateway_attachments	DELETE	Identifier, region
update_resource	vpc_gateway_attachments	UPDATE	Identifier, PatchDocument, region
list_resources	vpc_gateway_attachments_list_only	SELECT	region
get_resource	vpc_gateway_attachments	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual vpc_gateway_attachment.

SELECT
  region,
  attachment_type,
  internet_gateway_id,
  vpc_id,
  vpn_gateway_id
FROM awscc.ec2.vpc_gateway_attachments
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ attachment_type }}|{{ vpc_id }}';

list (identifiers only)

Lists all vpc_gateway_attachments in a region.

SELECT
  region,
  attachment_type,
  vpc_id
FROM awscc.ec2.vpc_gateway_attachments_list_only
WHERE
  region = '{{ region }}';

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 awscc.ec2.vpc_gateway_attachments (
  VpcId,
  region
)
SELECT
  '{{ vpc_id }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.ec2.vpc_gateway_attachments (
  InternetGatewayId,
  VpcId,
  VpnGatewayId,
  region
)
SELECT
  '{{ internet_gateway_id }}',
  '{{ vpc_id }}',
  '{{ vpn_gateway_id }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

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: internet_gateway_id
      value: '{{ internet_gateway_id }}'
    - name: vpc_id
      value: '{{ vpc_id }}'
    - name: vpn_gateway_id
      value: '{{ vpn_gateway_id }}'

UPDATE example

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

/*+ update */
UPDATE awscc.ec2.vpc_gateway_attachments
SET PatchDocument = string('{{ {
    "InternetGatewayId": internet_gateway_id,
    "VpnGatewayId": vpn_gateway_id
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ attachment_type }}|{{ vpc_id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.ec2.vpc_gateway_attachments
WHERE
  Identifier = '{{ attachment_type }}|{{ vpc_id }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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