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 = 'us-east-1' 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 = 'us-east-1';

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 }}';

All Properties

/*+ create */
INSERT INTO awscc.ec2.carrier_gateways (
  VpcId,
  Tags,
  region
)
SELECT
  '{{ vpc_id }}',
  '{{ tags }}',
  '{{ region }}';

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 }}';

DELETE example

/*+ delete */
DELETE FROM awscc.ec2.carrier_gateways
WHERE
  Identifier = '{{ carrier_gateway_id }}' AND
  region = 'us-east-1';

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