carrier_gateways

Creates, updates, deletes, gets or lists a carrier_gateways resource.

Overview

Name	carrier_gateways
Type	Resource
Id	aws.ec2.carrier_gateways

Fields

The following fields are returned by SELECT queries:

describe_carrier_gateways

Name	Datatype	Description
carrier_gateway_id	string	The ID of the carrier gateway.
owner_id	string	The Amazon Web Services account ID of the owner of the carrier gateway.
state	string	The state of the carrier gateway.
tags	string	The tags assigned to the carrier gateway.
vpc_id	string	The ID of the VPC associated with the carrier gateway.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_carrier_gateways	select	region	CarrierGatewayId, Filter, MaxResults, NextToken, DryRun	Describes one or more of your carrier gateways.
create_carrier_gateway	insert	VpcId, region	TagSpecification, DryRun, ClientToken	Creates a carrier gateway. For more information about carrier gateways, see Carrier gateways in the Amazon Web Services Wavelength Developer Guide.
delete_carrier_gateway	delete	CarrierGatewayId, region	DryRun	Deletes a carrier gateway. If you do not delete the route that contains the carrier gateway as the Target, the route is a blackhole route. For information about how to delete a route, see DeleteRoute.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
CarrierGatewayId	string	The ID of the carrier gateway.
VpcId	string	The ID of the VPC to associate with the carrier gateway.
region	string	AWS region (default: us-east-1)
CarrierGatewayId	array	One or more carrier gateway IDs.
ClientToken	string	Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
DryRun	boolean	Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Filter	array	One or more filters. carrier-gateway-id - The ID of the carrier gateway. state - The state of the carrier gateway (pending | failed | available | deleting | deleted). owner-id - The Amazon Web Services account ID of the owner of the carrier gateway. tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. vpc-id - The ID of the VPC associated with the carrier gateway.
MaxResults	integer	The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
NextToken	string	The token for the next page of results.
TagSpecification	array	The tags to associate with the carrier gateway.

SELECT examples

describe_carrier_gateways

Describes one or more of your carrier gateways.

SELECT
carrier_gateway_id,
owner_id,
state,
tags,
vpc_id
FROM aws.ec2.carrier_gateways
WHERE region = '{{ region }}' -- required
AND CarrierGatewayId = '{{ CarrierGatewayId }}'
AND Filter = '{{ Filter }}'
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
AND DryRun = '{{ DryRun }}'
;

INSERT examples

create_carrier_gateway

Creates a carrier gateway. For more information about carrier gateways, see Carrier gateways in the Amazon Web Services Wavelength Developer Guide.

INSERT INTO aws.ec2.carrier_gateways (
VpcId,
region,
TagSpecification,
DryRun,
ClientToken
)
SELECT 
'{{ VpcId }}',
'{{ region }}',
'{{ TagSpecification }}',
'{{ DryRun }}',
'{{ ClientToken }}'
RETURNING
carrier_gateway_id,
owner_id,
state,
tags,
vpc_id
;

Manifest

# Description fields are for documentation purposes
- name: carrier_gateways
props:
  - name: VpcId
    value: "{{ VpcId }}"
    description: Required parameter for the carrier_gateways resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the carrier_gateways resource.
  - name: TagSpecification
    value: "{{ TagSpecification }}"
    description: The tags to associate with the carrier gateway.
    description: The tags to associate with the carrier gateway.
  - name: DryRun
    value: {{ DryRun }}
    description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
    description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
  - name: ClientToken
    value: "{{ ClientToken }}"
    description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
    description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

DELETE examples

delete_carrier_gateway

Deletes a carrier gateway. If you do not delete the route that contains the carrier gateway as the Target, the route is a blackhole route. For information about how to delete a route, see DeleteRoute.

DELETE FROM aws.ec2.carrier_gateways
WHERE CarrierGatewayId = '{{ CarrierGatewayId }}' --required
AND region = '{{ region }}' --required
AND DryRun = '{{ DryRun }}'
;