transit_gateway_registrations

Creates, updates, deletes or gets a transit_gateway_registration resource or lists transit_gateway_registrations in a region

Overview

Name	transit_gateway_registrations
Type	Resource
Description	The AWS::NetworkManager::TransitGatewayRegistration type registers a transit gateway in your global network. The transit gateway can be in any AWS Region, but it must be owned by the same AWS account that owns the global network. You cannot register a transit gateway in more than one global network.
Id	aws.networkmanager.transit_gateway_registrations

Fields

Name	Datatype	Description
global_network_id	string	The ID of the global network.
transit_gateway_arn	string	The Amazon Resource Name (ARN) of the transit gateway.
region	string	AWS region.

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

Methods

Name	Accessible by	Required Params
create_resource	INSERT	GlobalNetworkId, TransitGatewayArn, region
delete_resource	DELETE	data__Identifier, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all transit_gateway_registrations in a region.

SELECT
region,
global_network_id,
transit_gateway_arn
FROM aws.networkmanager.transit_gateway_registrations
WHERE region = 'us-east-1';

Gets all properties from an individual transit_gateway_registration.

SELECT
region,
global_network_id,
transit_gateway_arn
FROM aws.networkmanager.transit_gateway_registrations
WHERE region = 'us-east-1' AND data__Identifier = '<GlobalNetworkId>|<TransitGatewayArn>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.networkmanager.transit_gateway_registrations (
 GlobalNetworkId,
 TransitGatewayArn,
 region
)
SELECT 
'{{ GlobalNetworkId }}',
 '{{ TransitGatewayArn }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.networkmanager.transit_gateway_registrations (
 GlobalNetworkId,
 TransitGatewayArn,
 region
)
SELECT 
 '{{ GlobalNetworkId }}',
 '{{ TransitGatewayArn }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: transit_gateway_registration
    props:
      - name: GlobalNetworkId
        value: '{{ GlobalNetworkId }}'
      - name: TransitGatewayArn
        value: '{{ TransitGatewayArn }}'

DELETE example

/*+ delete */
DELETE FROM aws.networkmanager.transit_gateway_registrations
WHERE data__Identifier = '<GlobalNetworkId|TransitGatewayArn>'
AND region = 'us-east-1';

Permissions

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

Create

networkmanager:RegisterTransitGateway,
networkmanager:GetTransitGatewayRegistrations

Read

networkmanager:GetTransitGatewayRegistrations

List

networkmanager:GetTransitGatewayRegistrations

Delete

networkmanager:DeregisterTransitGateway,
networkmanager:GetTransitGatewayRegistrations