link_associations

Creates, updates, deletes or gets a link_association resource or lists link_associations in a region

Overview

Name	link_associations
Type	Resource
Description	The AWS::NetworkManager::LinkAssociation type associates a link to a device. The device and link must be in the same global network and the same site.
Id	awscc.networkmanager.link_associations

Fields

get (all properties)

Name	Datatype	Description
global_network_id	string	The ID of the global network.
device_id	string	The ID of the device
link_id	string	The ID of the link
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
global_network_id	string	The ID of the global network.
device_id	string	The ID of the device
link_id	string	The ID of the link
region	string	AWS region.

For more information, see AWS::NetworkManager::LinkAssociation.

Methods

Name	Resource	Accessible by	Required Params
create_resource	link_associations	INSERT	GlobalNetworkId, DeviceId, LinkId, region
delete_resource	link_associations	DELETE	Identifier, region
list_resources	link_associations_list_only	SELECT	region
get_resource	link_associations	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual link_association.

SELECT
  region,
  global_network_id,
  device_id,
  link_id
FROM awscc.networkmanager.link_associations
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ global_network_id }}|{{ device_id }}|{{ link_id }}';

list (identifiers only)

Lists all link_associations in a region.

SELECT
  region,
  global_network_id,
  device_id,
  link_id
FROM awscc.networkmanager.link_associations_list_only
WHERE
  region = 'us-east-1';

INSERT example

Use the following StackQL query and manifest file to create a new link_association resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.networkmanager.link_associations (
  GlobalNetworkId,
  DeviceId,
  LinkId,
  region
)
SELECT
  '{{ global_network_id }}',
  '{{ device_id }}',
  '{{ link_id }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.networkmanager.link_associations (
  GlobalNetworkId,
  DeviceId,
  LinkId,
  region
)
SELECT
  '{{ global_network_id }}',
  '{{ device_id }}',
  '{{ link_id }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: link_association
    props:
      - name: global_network_id
        value: '{{ global_network_id }}'
      - name: device_id
        value: '{{ device_id }}'
      - name: link_id
        value: '{{ link_id }}'

DELETE example

/*+ delete */
DELETE FROM awscc.networkmanager.link_associations
WHERE
  Identifier = '{{ global_network_id }}|{{ device_id }}|{{ link_id }}' AND
  region = 'us-east-1';

Permissions

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

Create

networkmanager:GetLinkAssociations,
networkmanager:AssociateLink

Read

networkmanager:GetLinkAssociations

List

networkmanager:GetLinkAssociations

Delete

networkmanager:DisassociateLink