global_networks

Creates, updates, deletes or gets a global_network resource or lists global_networks in a region

Overview

Name	global_networks
Type	Resource
Description	The AWS::NetworkManager::GlobalNetwork type specifies a global network of the user's account
Id	aws.networkmanager.global_networks

Fields

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the global network.
id	string	The ID of the global network.
description	string	The description of the global network.
tags	array	The tags for the global network.
created_at	string	The date and time that the global network was created.
state	string	The state of the global network.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	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 global_networks in a region.

SELECT
region,
arn,
id,
description,
tags,
created_at,
state
FROM aws.networkmanager.global_networks
WHERE region = 'us-east-1';

Gets all properties from an individual global_network.

SELECT
region,
arn,
id,
description,
tags,
created_at,
state
FROM aws.networkmanager.global_networks
WHERE region = 'us-east-1' AND data__Identifier = '<Id>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.networkmanager.global_networks (
 Description,
 Tags,
 CreatedAt,
 State,
 region
)
SELECT 
'{{ Description }}',
 '{{ Tags }}',
 '{{ CreatedAt }}',
 '{{ State }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.networkmanager.global_networks (
 Description,
 Tags,
 CreatedAt,
 State,
 region
)
SELECT 
 '{{ Description }}',
 '{{ Tags }}',
 '{{ CreatedAt }}',
 '{{ State }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: global_network
    props:
      - name: Description
        value: '{{ Description }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'
      - name: CreatedAt
        value: '{{ CreatedAt }}'
      - name: State
        value: '{{ State }}'

DELETE example

/*+ delete */
DELETE FROM aws.networkmanager.global_networks
WHERE data__Identifier = '<Id>'
AND region = 'us-east-1';

Permissions

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

Create

networkmanager:CreateGlobalNetwork,
networkmanager:DescribeGlobalNetworks,
networkmanager:TagResource,
iam:CreateServiceLinkedRole

Read

networkmanager:DescribeGlobalNetworks

Update

networkmanager:UpdateGlobalNetwork,
networkmanager:DescribeGlobalNetworks,
networkmanager:TagResource,
networkmanager:UntagResource,
networkmanager:ListTagsForResource

Delete

networkmanager:DeleteGlobalNetwork,
networkmanager:DescribeGlobalNetworks

List

networkmanager:DescribeGlobalNetworks