internet_gateways

Creates, updates, deletes or gets an internet_gateway resource or lists internet_gateways in a region

Overview

Name	internet_gateways
Type	Resource
Description	Allocates an internet gateway for use with a VPC. After creating the Internet gateway, you then attach it to a VPC.
Id	awscc.ec2.internet_gateways

Fields

get (all properties)

Name	Datatype	Description
internet_gateway_id	string
▶tags	array	Any tags to assign to the internet gateway.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
internet_gateway_id	string
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	internet_gateways	INSERT	region
delete_resource	internet_gateways	DELETE	Identifier, region
update_resource	internet_gateways	UPDATE	Identifier, PatchDocument, region
list_resources	internet_gateways_list_only	SELECT	region
get_resource	internet_gateways	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual internet_gateway.

SELECT
  region,
  internet_gateway_id,
  tags
FROM awscc.ec2.internet_gateways
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ internet_gateway_id }}';

list (identifiers only)

Lists all internet_gateways in a region.

SELECT
  region,
  internet_gateway_id
FROM awscc.ec2.internet_gateways_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.ec2.internet_gateways (
  Tags,
  region
)
SELECT
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.ec2.internet_gateways (
  Tags,
  region
)
SELECT
  '{{ tags }}',
  '{{ 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: internet_gateway
  props:
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

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

DELETE example

/*+ delete */
DELETE FROM awscc.ec2.internet_gateways
WHERE
  Identifier = '{{ internet_gateway_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 internet_gateways resource, the following permissions are required:

Create

ec2:CreateInternetGateway,
ec2:CreateTags,
ec2:DescribeInternetGateways

Read

ec2:DescribeInternetGateways

Delete

ec2:DeleteInternetGateway,
ec2:DescribeInternetGateways

Update

ec2:DeleteTags,
ec2:CreateTags,
ec2:DescribeInternetGateways

List

ec2:DescribeInternetGateways