customer_gateway_associations

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

Overview

Name	customer_gateway_associations
Type	Resource
Id	aws.networkmanager.customer_gateway_associations

Fields

The following fields are returned by SELECT queries:

get_customer_gateway_associations

Name	Datatype	Description
customer_gateway_arn	string	The Amazon Resource Name (ARN) of the customer gateway. (pattern: <code>[\s\S]*</code>)
device_id	string	The ID of the device. (pattern: <code>[\s\S]*</code>)
global_network_id	string	The ID of the global network. (pattern: <code>[\s\S]*</code>)
link_id	string	The ID of the link. (pattern: <code>[\s\S]*</code>)
state	string	The association state. (PENDING, AVAILABLE, DELETING, DELETED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_customer_gateway_associations	select	global_network_id, region	customerGatewayArns, maxResults, nextToken	Gets the association information for customer gateways that are associated with devices and links in your global network.

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
global_network_id	string	The ID of the global network.
region	string	AWS region (default: us-east-1)
customerGatewayArns	array	One or more customer gateway Amazon Resource Names (ARNs). The maximum is 10.
maxResults	integer	The maximum number of results to return.
nextToken	string	The token for the next page of results.

SELECT examples

get_customer_gateway_associations

Gets the association information for customer gateways that are associated with devices and links in your global network.

SELECT
customer_gateway_arn,
device_id,
global_network_id,
link_id,
state
FROM aws.networkmanager.customer_gateway_associations
WHERE global_network_id = '{{ global_network_id }}' -- required
AND region = '{{ region }}' -- required
AND customerGatewayArns = '{{ customerGatewayArns }}'
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;