customer_gateway

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

Overview

Name	customer_gateway
Type	Resource
Description	Specifies a customer gateway.
Id	aws.ec2.customer_gateway

Fields

Name	Datatype	Description
certificate_arn	string
customer_gateway_id	string
bgp_asn	integer	For devices that support BGP, the customer gateway's BGP ASN.<br/> Default: 65000
ip_address	string	IPv4 address for the customer gateway device's outside interface. The address must be static.
tags	array	One or more tags for the customer gateway.
type	string	The type of VPN connection that this customer gateway supports (ipsec.1).
device_name	string	The name of customer gateway device.
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,
certificate_arn,
customer_gateway_id,
bgp_asn,
ip_address,
tags,
type,
device_name
FROM aws.ec2.customer_gateway
WHERE region = 'us-east-1' AND data__Identifier = '<CustomerGatewayId>';

Permissions

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

Read

ec2:DescribeCustomerGateways

Update

ec2:CreateTags,
ec2:DeleteTags,
ec2:DescribeCustomerGateways