Skip to main content

carrier_gateway

Gets or updates an individual carrier_gateway resource, use carrier_gateways to retrieve a list of resources or to create or delete a resource.

Overview

Namecarrier_gateway
TypeResource
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Idaws.ec2.carrier_gateway

Fields

NameDatatypeDescription
carrier_gateway_idstringThe ID of the carrier gateway.
statestringThe state of the carrier gateway.
vpc_idstringThe ID of the VPC.
owner_idstringThe ID of the owner.
tagsarrayThe tags for the carrier gateway.
regionstringAWS region.

Methods

NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
get_resourceSELECTdata__Identifier, region

SELECT Example

SELECT
region,
carrier_gateway_id,
state,
vpc_id,
owner_id,
tags
FROM aws.ec2.carrier_gateway
WHERE region = 'us-east-1' AND data__Identifier = '<CarrierGatewayId>';

Permissions

To operate on the carrier_gateway resource, the following permissions are required:

Read

ec2:DescribeCarrierGateways

Update

ec2:DescribeCarrierGateways,
ec2:CreateTags,
ec2:DeleteTags