transit_gateway_registrations

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

Overview

Name	transit_gateway_registrations
Type	Resource
Id	aws.networkmanager.transit_gateway_registrations

Fields

The following fields are returned by SELECT queries:

get_transit_gateway_registrations

Name	Datatype	Description
global_network_id	string	The ID of the global network. (pattern: <code>[\s\S]*</code>)
state	object	The state of the transit gateway registration.
transit_gateway_arn	string	The Amazon Resource Name (ARN) of the transit gateway. (pattern: <code>[\s\S]*</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_transit_gateway_registrations	select	global_network_id, region	transitGatewayArns, maxResults, nextToken	Gets information about the transit gateway registrations in a specified global network.

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
global_network_id	string	The ID of the global network.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of results to return.
nextToken	string	The token for the next page of results.
transitGatewayArns	array	The Amazon Resource Names (ARNs) of one or more transit gateways. The maximum is 10.

SELECT examples

get_transit_gateway_registrations

Gets information about the transit gateway registrations in a specified global network.

SELECT
global_network_id,
state,
transit_gateway_arn
FROM aws.networkmanager.transit_gateway_registrations
WHERE global_network_id = '{{ global_network_id }}' -- required
AND region = '{{ region }}' -- required
AND transitGatewayArns = '{{ transitGatewayArns }}'
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;