global_networks

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

Overview

Name	global_networks
Type	Resource
Id	aws.networkmanager.global_networks

Fields

The following fields are returned by SELECT queries:

describe_global_networks

Name	Datatype	Description
created_at	string (date-time)	The date and time that the global network was created.
description	string	The description of the global network. (pattern: <code>[\s\S]*</code>)
global_network_arn	string	The Amazon Resource Name (ARN) of the global network. (pattern: <code>[\s\S]*</code>)
global_network_id	string	The ID of the global network. (pattern: <code>[\s\S]*</code>)
state	string	The state of the global network. (PENDING, AVAILABLE, DELETING, UPDATING)
tags	array	The tags for the global network.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_global_networks	select	region	globalNetworkIds, maxResults, nextToken	Describes one or more global networks. By default, all global networks are described. To describe the objects in your global network, you must use the appropriate Get* action. For example, to list the transit gateways in your global network, use GetTransitGatewayRegistrations.
register_transit_gateway	insert	global_network_id, region, TransitGatewayArn		Registers a transit gateway in your global network. Not all Regions support transit gateways for global networks. For a list of the supported Regions, see Region Availability in the Amazon Web Services Transit Gateways for Global Networks User Guide. The transit gateway can be in any of the supported Amazon Web Services Regions, but it must be owned by the same Amazon Web Services account that owns the global network. You cannot register a transit gateway in more than one global network.
create_global_network	insert	region		Creates a new, empty global network.
associate_customer_gateway	update	global_network_id, region, CustomerGatewayArn, DeviceId		Associates a customer gateway with a device and optionally, with a link. If you specify a link, it must be associated with the specified device. You can only associate customer gateways that are connected to a VPN attachment on a transit gateway or core network registered in your global network. When you register a transit gateway or core network, customer gateways that are connected to the transit gateway are automatically included in the global network. To list customer gateways that are connected to a transit gateway, use the DescribeVpnConnections EC2 API and filter by transit-gateway-id. You cannot associate a customer gateway with more than one device and link.
disassociate_customer_gateway	update	global_network_id, customer_gateway_arn, region		Disassociates a customer gateway from a device and a link.
update_global_network	update	global_network_id, region		Updates an existing global network. To remove information for any of the parameters, specify an empty string.
deregister_transit_gateway	delete	global_network_id, transit_gateway_arn, region		Deregisters a transit gateway from your global network. This action does not delete your transit gateway, or modify any of its attachments. This action removes any customer gateway associations.
delete_global_network	delete	global_network_id, region		Deletes an existing global network. You must first delete all global network objects (devices, links, and sites), deregister all transit gateways, and delete any core networks.

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
customer_gateway_arn	string	The Amazon Resource Name (ARN) of the customer gateway.
global_network_id	string	The ID of the global network.
region	string	AWS region (default: us-east-1)
transit_gateway_arn	string	The Amazon Resource Name (ARN) of the transit gateway.
globalNetworkIds	array	The IDs of one or more global networks. The maximum is 10.
maxResults	integer	The maximum number of results to return.
nextToken	string	The token for the next page of results.

SELECT examples

describe_global_networks

Describes one or more global networks. By default, all global networks are described. To describe the objects in your global network, you must use the appropriate Get* action. For example, to list the transit gateways in your global network, use GetTransitGatewayRegistrations.

SELECT
created_at,
description,
global_network_arn,
global_network_id,
state,
tags
FROM aws.networkmanager.global_networks
WHERE region = '{{ region }}' -- required
AND globalNetworkIds = '{{ globalNetworkIds }}'
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

register_transit_gateway

Registers a transit gateway in your global network. Not all Regions support transit gateways for global networks. For a list of the supported Regions, see Region Availability in the Amazon Web Services Transit Gateways for Global Networks User Guide. The transit gateway can be in any of the supported Amazon Web Services Regions, but it must be owned by the same Amazon Web Services account that owns the global network. You cannot register a transit gateway in more than one global network.

INSERT INTO aws.networkmanager.global_networks (
TransitGatewayArn,
global_network_id,
region
)
SELECT 
'{{ TransitGatewayArn }}' /* required */,
'{{ global_network_id }}',
'{{ region }}'
RETURNING
transit_gateway_registration
;

create_global_network

Creates a new, empty global network.

INSERT INTO aws.networkmanager.global_networks (
Description,
Tags,
region
)
SELECT 
'{{ Description }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
global_network
;

Manifest

# Description fields are for documentation purposes
- name: global_networks
props:
  - name: global_network_id
    value: "{{ global_network_id }}"
    description: Required parameter for the global_networks resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the global_networks resource.
  - name: TransitGatewayArn
    value: "{{ TransitGatewayArn }}"
  - name: Description
    value: "{{ Description }}"
  - name: Tags
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

UPDATE examples

associate_customer_gateway

Associates a customer gateway with a device and optionally, with a link. If you specify a link, it must be associated with the specified device. You can only associate customer gateways that are connected to a VPN attachment on a transit gateway or core network registered in your global network. When you register a transit gateway or core network, customer gateways that are connected to the transit gateway are automatically included in the global network. To list customer gateways that are connected to a transit gateway, use the DescribeVpnConnections EC2 API and filter by transit-gateway-id. You cannot associate a customer gateway with more than one device and link.

UPDATE aws.networkmanager.global_networks
SET 
CustomerGatewayArn = '{{ CustomerGatewayArn }}',
DeviceId = '{{ DeviceId }}',
LinkId = '{{ LinkId }}'
WHERE 
global_network_id = '{{ global_network_id }}' --required
AND region = '{{ region }}' --required
AND CustomerGatewayArn = '{{ CustomerGatewayArn }}' --required
AND DeviceId = '{{ DeviceId }}' --required
RETURNING
customer_gateway_association;

disassociate_customer_gateway

Disassociates a customer gateway from a device and a link.

UPDATE aws.networkmanager.global_networks
SET 
-- No updatable properties
WHERE 
global_network_id = '{{ global_network_id }}' --required
AND customer_gateway_arn = '{{ customer_gateway_arn }}' --required
AND region = '{{ region }}' --required
RETURNING
customer_gateway_association;

update_global_network

Updates an existing global network. To remove information for any of the parameters, specify an empty string.

UPDATE aws.networkmanager.global_networks
SET 
Description = '{{ Description }}'
WHERE 
global_network_id = '{{ global_network_id }}' --required
AND region = '{{ region }}' --required
RETURNING
global_network;

DELETE examples

deregister_transit_gateway

Deregisters a transit gateway from your global network. This action does not delete your transit gateway, or modify any of its attachments. This action removes any customer gateway associations.

DELETE FROM aws.networkmanager.global_networks
WHERE global_network_id = '{{ global_network_id }}' --required
AND transit_gateway_arn = '{{ transit_gateway_arn }}' --required
AND region = '{{ region }}' --required
;

delete_global_network

Deletes an existing global network. You must first delete all global network objects (devices, links, and sites), deregister all transit gateways, and delete any core networks.

DELETE FROM aws.networkmanager.global_networks
WHERE global_network_id = '{{ global_network_id }}' --required
AND region = '{{ region }}' --required
;