carrier_gateways

Creates, updates, deletes or gets a carrier_gateway resource or lists carrier_gateways in a region

Overview

Name	carrier_gateways
Type	Resource
Description	Resource Type definition for Carrier Gateway which describes the Carrier Gateway resource
Id	awscc.ec2.carrier_gateways

Fields

get (all properties)

Name	Datatype	Description
carrier_gateway_id	string	The ID of the carrier gateway.
state	string	The state of the carrier gateway.
vpc_id	string	The ID of the VPC.
owner_id	string	The ID of the owner.
▶tags	array	The tags for the carrier gateway.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
carrier_gateway_id	string	The ID of the carrier gateway.
region	string	AWS region.

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

Methods

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

SELECT examples

get (all properties)

Gets all properties from an individual carrier_gateway.

SELECT
  region,
  carrier_gateway_id,
  state,
  vpc_id,
  owner_id,
  tags
FROM awscc.ec2.carrier_gateways
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ carrier_gateway_id }}';

list (identifiers only)

Lists all carrier_gateways in a region.

SELECT
  region,
  carrier_gateway_id
FROM awscc.ec2.carrier_gateways_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

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

All Properties

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

UPDATE example

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

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

DELETE example

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

Create

ec2:CreateCarrierGateway,
ec2:DescribeCarrierGateways,
ec2:CreateTags

Read

ec2:DescribeCarrierGateways,
ec2:DescribeTags

Update

ec2:DescribeCarrierGateways,
ec2:CreateTags,
ec2:DeleteTags,
ec2:DescribeTags

Delete

ec2:DeleteCarrierGateway,
ec2:DescribeCarrierGateways,
ec2:DeleteTags

List

ec2:DescribeCarrierGateways