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
Name | carrier_gateway |
Type | Resource |
Description | An example resource schema demonstrating some basic constructs and validation rules. |
Id | aws.ec2.carrier_gateway |
Fields
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. |
Methods
Name | Accessible by | Required Params |
---|---|---|
update_resource | UPDATE | data__Identifier, data__PatchDocument, region |
get_resource | SELECT | data__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