links

Creates, updates, deletes or gets a link resource or lists links in a region

Overview

Name	links
Type	Resource
Description	The AWS::NetworkManager::Link type describes a link.
Id	awscc.networkmanager.links

Fields

get (all properties)

Name	Datatype	Description
link_arn	string	The Amazon Resource Name (ARN) of the link.
link_id	string	The ID of the link.
global_network_id	string	The ID of the global network.
site_id	string	The ID of the site
▶bandwidth	object	The Bandwidth for the link.
provider	string	The provider of the link.
description	string	The description of the link.
▶tags	array	The tags for the link.
type	string	The type of the link.
created_at	string	The date and time that the device was created.
state	string	The state of the link.
region	string	AWS region.

list (identifiers only)

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

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	links	INSERT	GlobalNetworkId, SiteId, Bandwidth, region
delete_resource	links	DELETE	Identifier, region
update_resource	links	UPDATE	Identifier, PatchDocument, region
list_resources	links_list_only	SELECT	region
get_resource	links	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual link.

SELECT
  region,
  link_arn,
  link_id,
  global_network_id,
  site_id,
  bandwidth,
  provider,
  description,
  tags,
  type,
  created_at,
  state
FROM awscc.networkmanager.links
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ global_network_id }}|{{ link_id }}';

list (identifiers only)

Lists all links in a region.

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

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.networkmanager.links (
  GlobalNetworkId,
  SiteId,
  Bandwidth,
  region
)
SELECT
  '{{ global_network_id }}',
  '{{ site_id }}',
  '{{ bandwidth }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.networkmanager.links (
  GlobalNetworkId,
  SiteId,
  Bandwidth,
  Provider,
  Description,
  Tags,
  Type,
  region
)
SELECT
  '{{ global_network_id }}',
  '{{ site_id }}',
  '{{ bandwidth }}',
  '{{ provider }}',
  '{{ description }}',
  '{{ tags }}',
  '{{ type }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: link
    props:
      - name: global_network_id
        value: '{{ global_network_id }}'
      - name: site_id
        value: '{{ site_id }}'
      - name: bandwidth
        value:
          download_speed: '{{ download_speed }}'
          upload_speed: '{{ upload_speed }}'
      - name: provider
        value: '{{ provider }}'
      - name: description
        value: '{{ description }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'
      - name: type
        value: '{{ type }}'

UPDATE example

Use the following StackQL query and manifest file to update a link resource, using stack-deploy.

/*+ update */
UPDATE awscc.networkmanager.links
SET PatchDocument = string('{{ {
    "Bandwidth": bandwidth,
    "Provider": provider,
    "Description": description,
    "Tags": tags,
    "Type": type
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ global_network_id }}|{{ link_id }}';

DELETE example

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

Permissions

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

Create

networkmanager:CreateLink,
networkmanager:GetLinks,
networkmanager:TagResource

Read

networkmanager:GetLinks

Update

networkmanager:ListTagsForResource,
networkmanager:TagResource,
networkmanager:GetLinks,
networkmanager:UntagResource,
networkmanager:UpdateLink

Delete

networkmanager:GetLinks,
networkmanager:DeleteLink

List

networkmanager:GetLinks