link_associations

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

Overview

Name	link_associations
Type	Resource
Id	aws.networkmanager.link_associations

Fields

The following fields are returned by SELECT queries:

get_link_associations

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

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_link_associations	select	global_network_id, region	deviceId, linkId, maxResults, nextToken	Gets the link associations for a device or a link. Either the device ID or the link ID must be specified.

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)
deviceId	string	The ID of the device.
linkId	string	The ID of the link.
maxResults	integer	The maximum number of results to return.
nextToken	string	The token for the next page of results.

SELECT examples

get_link_associations

Gets the link associations for a device or a link. Either the device ID or the link ID must be specified.

SELECT
device_id,
global_network_id,
link_association_state,
link_id
FROM aws.networkmanager.link_associations
WHERE global_network_id = '{{ global_network_id }}' -- required
AND region = '{{ region }}' -- required
AND deviceId = '{{ deviceId }}'
AND linkId = '{{ linkId }}'
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;