Sign In to the Console
AWS CloudFormation
User Guide (API Version 2010-05-15)

AWS Documentation » AWS CloudFormation » User Guide » Template Reference » AWS Resource and Property Types Reference » Amazon EC2 Resource Types Reference » AWS::EC2::TransitGatewayRoute

AWS::EC2::TransitGatewayRoute

Creates a static route for a transit gateway route table. For more information, see Amazon VPC Transit Gateways.

Syntax

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

JSON

{
  "Type" : "AWS::EC2::TransitGatewayRoute",
  "Properties" : {
    "Blackhole" : Boolean,
    "DestinationCidrBlock" : String,
    "TransitGatewayAttachmentId" : String,
    "TransitGatewayRouteTableId" : String
  }
}

YAML

Type: "AWS::EC2::TransitGatewayRoute"
Properties:
  Blackhole: Boolean
  DestinationCidrBlock: String
  TransitGatewayAttachmentId: String
  TransitGatewayRouteTableId: String

Properties

Blackhole

Indicates whether to drop traffic if the target isn't available.

Required: No

Type: Boolean

Update requires: Replacement

DestinationCidrBlock

The CIDR range used for destination matches. Routing decisions are based on the most specific match.

Required: No

Type: String

Update requires: Replacement

TransitGatewayAttachmentId

The ID of the attachment.

Required: No

Type: String

Update requires: Replacement

TransitGatewayRouteTableId

The ID of the transit gateway route table.

Required: Yes

Type: String

Update requires: Replacement

Return Values

Ref

When you pass the logical ID of an AWS::EC2::TransitGatewayRoute resource to the intrinsic Ref function, the function returns the ID of the route table and the destination CIDR, separated by an underscore, such as tgw-rtb-0ea209e5dcc99f3a3_0.0.0.0/0.

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

See Also