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	awscc.networkmanager.transit_gateway_registrations

Fields

get (all properties)

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.

list (identifiers only)

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	Resource	Accessible by	Required Params
create_resource	transit_gateway_registrations	INSERT	GlobalNetworkId, TransitGatewayArn, region
delete_resource	transit_gateway_registrations	DELETE	Identifier, region
list_resources	transit_gateway_registrations_list_only	SELECT	region
get_resource	transit_gateway_registrations	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual transit_gateway_registration.

SELECT
  region,
  global_network_id,
  transit_gateway_arn
FROM awscc.networkmanager.transit_gateway_registrations
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ global_network_id }}|{{ transit_gateway_arn }}';

list (identifiers only)

Lists all transit_gateway_registrations in a region.

SELECT
  region,
  global_network_id,
  transit_gateway_arn
FROM awscc.networkmanager.transit_gateway_registrations_list_only
WHERE
  region = '{{ region }}';

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 awscc.networkmanager.transit_gateway_registrations (
  GlobalNetworkId,
  TransitGatewayArn,
  region
)
SELECT
  '{{ global_network_id }}',
  '{{ transit_gateway_arn }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.networkmanager.transit_gateway_registrations (
  GlobalNetworkId,
  TransitGatewayArn,
  region
)
SELECT
  '{{ global_network_id }}',
  '{{ transit_gateway_arn }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

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: global_network_id
      value: '{{ global_network_id }}'
    - name: transit_gateway_arn
      value: '{{ transit_gateway_arn }}'

DELETE example

/*+ delete */
DELETE FROM awscc.networkmanager.transit_gateway_registrations
WHERE
  Identifier = '{{ global_network_id }}|{{ transit_gateway_arn }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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