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	aws.networkmanager.links

Fields

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.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	GlobalNetworkId, SiteId, Bandwidth, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all links in a region.

SELECT
region,
link_arn,
link_id,
global_network_id,
site_id,
bandwidth,
provider,
description,
tags,
type,
created_at,
state
FROM aws.networkmanager.links
WHERE region = 'us-east-1';

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 aws.networkmanager.links
WHERE region = 'us-east-1' AND data__Identifier = '<GlobalNetworkId>|<LinkId>';

INSERT example

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

Required Properties

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

All Properties

/*+ create */
INSERT INTO aws.networkmanager.links (
 GlobalNetworkId,
 SiteId,
 Bandwidth,
 Provider,
 Description,
 Tags,
 Type,
 region
)
SELECT 
 '{{ GlobalNetworkId }}',
 '{{ SiteId }}',
 '{{ 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: GlobalNetworkId
        value: '{{ GlobalNetworkId }}'
      - name: SiteId
        value: '{{ SiteId }}'
      - name: Bandwidth
        value:
          DownloadSpeed: '{{ DownloadSpeed }}'
          UploadSpeed: '{{ UploadSpeed }}'
      - name: Provider
        value: '{{ Provider }}'
      - name: Description
        value: '{{ Description }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'
      - name: Type
        value: '{{ Type }}'

DELETE example

/*+ delete */
DELETE FROM aws.networkmanager.links
WHERE data__Identifier = '<GlobalNetworkId|LinkId>'
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