transit_gateway_connect_peer_associations

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

Overview

Name	transit_gateway_connect_peer_associations
Type	Resource
Id	aws.networkmanager.transit_gateway_connect_peer_associations

Fields

The following fields are returned by SELECT queries:

get_transit_gateway_connect_peer_associations

Name	Datatype	Description
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 state of the association. (PENDING, AVAILABLE, DELETING, DELETED)
transit_gateway_connect_peer_arn	string	The Amazon Resource Name (ARN) of the transit gateway Connect peer. (pattern: <code>[\s\S]*</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_transit_gateway_connect_peer_associations	select	global_network_id, region	transitGatewayConnectPeerArns, maxResults, nextToken	Gets information about one or more of your transit gateway Connect peer associations in a 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)
maxResults	integer	The maximum number of results to return.
nextToken	string	The token for the next page of results.
transitGatewayConnectPeerArns	array	One or more transit gateway Connect peer Amazon Resource Names (ARNs).

SELECT examples

get_transit_gateway_connect_peer_associations

Gets information about one or more of your transit gateway Connect peer associations in a global network.

SELECT
device_id,
global_network_id,
link_id,
state,
transit_gateway_connect_peer_arn
FROM aws.networkmanager.transit_gateway_connect_peer_associations
WHERE global_network_id = '{{ global_network_id }}' -- required
AND region = '{{ region }}' -- required
AND transitGatewayConnectPeerArns = '{{ transitGatewayConnectPeerArns }}'
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;