AWS::NetworkManager::TransitGatewayRegistration

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 Transit Gateways for Global Networks User Guide. The transit gateway can be in any of the supported Amazon Regions, but it must be owned by the same Amazon account that owns the global network. You cannot register a transit gateway in more than one global network.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

{
  "Type" : "AWS::NetworkManager::TransitGatewayRegistration",
  "Properties" : {
      "GlobalNetworkId" : String,
      "TransitGatewayArn" : String
    }
}

Type: AWS::NetworkManager::TransitGatewayRegistration
Properties:
  GlobalNetworkId: String
  TransitGatewayArn: String

Properties

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ID of the global network and the ARN of the transit gateway. For example: global-network-01231231231231231|arn:aws:ec2:us-west-2:123456789012:transit-gateway/tgw-123abc05e04123abc.

For more information about using the Ref function, see Ref.

Examples

Transit Gateway Registration

The following example registers a transit gateway in a global network.

{
    "Type": "AWS::NetworkManager::TransitGatewayRegistration",
    "Properties": {
        "GlobalNetworkId": {
            "Ref": "GlobalNetwork"
        },
        "TransitGatewayArn": {
            "Fn::Sub": "arn:aws:ec2:${AWS::Region}:${AWS::AccountId}:transit-gateway/${TransitGateway}"
        }
    }
}

Type: AWS::NetworkManager::TransitGatewayRegistration
Properties:
  GlobalNetworkId: !Ref GlobalNetwork
  TransitGatewayArn: !Sub 'arn:aws:ec2:${AWS::Region}:${AWS::AccountId}:transit-gateway/${TransitGateway}'