Skip to main content

customer_gateway

Gets an individual customer_gateway resource

Overview

Namecustomer_gateway
TypeResource
Descriptioncustomer_gateway
Idawscc.ec2.customer_gateway

Fields

NameDatatypeDescription
customer_gateway_idstringCustomerGateway ID generated after customer gateway is created. Each customer gateway has a unique ID.
bgp_asnintegerFor devices that support BGP, the customer gateway's BGP ASN.
ip_addressstringThe internet-routable IP address for the customer gateway's outside interface. The address must be static.
tagsarrayOne or more tags for the customer gateway.
typestringThe type of VPN connection that this customer gateway supports.
device_namestringA name for the customer gateway device.
regionstringAWS region.

Methods

Currently only SELECT is supported for this resource resource.

Example

SELECT
region,
customer_gateway_id,
bgp_asn,
ip_address,
tags,
type,
device_name
FROM awscc.ec2.customer_gateway
WHERE data__Identifier = '<CustomerGatewayId>';

Permissions

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

Read

ec2:DescribeCustomerGateways

Update

ec2:CreateTags,
ec2:DeleteTags

Delete

ec2:DeleteCustomerGateway,
ec2:DescribeCustomerGateways