connect_peer_associations

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

Overview

Name	connect_peer_associations
Type	Resource
Id	aws.networkmanager.connect_peer_associations

Fields

The following fields are returned by SELECT queries:

get_connect_peer_associations

Name	Datatype	Description
connect_peer_id	string	The ID of the Connect peer. (pattern: <code>^connect-peer-([0-9a-f]{8,17})$</code>)
device_id	string	The ID of the device to connect to. (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 Connect peer association. (PENDING, AVAILABLE, DELETING, DELETED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_connect_peer_associations	select	global_network_id, region	connectPeerIds, maxResults, nextToken	Returns information about a core network Connect peer associations.

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)
connectPeerIds	array	The IDs of the Connect peers.
maxResults	integer	The maximum number of results to return.
nextToken	string	The token for the next page of results.

SELECT examples

get_connect_peer_associations

Returns information about a core network Connect peer associations.

SELECT
connect_peer_id,
device_id,
global_network_id,
link_id,
state
FROM aws.networkmanager.connect_peer_associations
WHERE global_network_id = '{{ global_network_id }}' -- required
AND region = '{{ region }}' -- required
AND connectPeerIds = '{{ connectPeerIds }}'
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;