1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. ec2
  5. TransitGatewayRoute

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi

aws-native.ec2.TransitGatewayRoute

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi

Resource Type definition for AWS::EC2::TransitGatewayRoute

Create TransitGatewayRoute Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new TransitGatewayRoute(name: string, args: TransitGatewayRouteArgs, opts?: CustomResourceOptions);
@overload
def TransitGatewayRoute(resource_name: str,
                        args: TransitGatewayRouteArgs,
                        opts: Optional[ResourceOptions] = None)

@overload
def TransitGatewayRoute(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        destination_cidr_block: Optional[str] = None,
                        transit_gateway_route_table_id: Optional[str] = None,
                        blackhole: Optional[bool] = None,
                        transit_gateway_attachment_id: Optional[str] = None)
func NewTransitGatewayRoute(ctx *Context, name string, args TransitGatewayRouteArgs, opts ...ResourceOption) (*TransitGatewayRoute, error)
public TransitGatewayRoute(string name, TransitGatewayRouteArgs args, CustomResourceOptions? opts = null)
public TransitGatewayRoute(String name, TransitGatewayRouteArgs args)
public TransitGatewayRoute(String name, TransitGatewayRouteArgs args, CustomResourceOptions options)
type: aws-native:ec2:TransitGatewayRoute
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. TransitGatewayRouteArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. TransitGatewayRouteArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. TransitGatewayRouteArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. TransitGatewayRouteArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. TransitGatewayRouteArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

TransitGatewayRoute Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The TransitGatewayRoute resource accepts the following input properties:

DestinationCidrBlock This property is required. string
The CIDR range used for destination matches. Routing decisions are based on the most specific match.
TransitGatewayRouteTableId This property is required. string
The ID of transit gateway route table.
Blackhole bool
Indicates whether to drop traffic that matches this route.
TransitGatewayAttachmentId string
The ID of transit gateway attachment.
DestinationCidrBlock This property is required. string
The CIDR range used for destination matches. Routing decisions are based on the most specific match.
TransitGatewayRouteTableId This property is required. string
The ID of transit gateway route table.
Blackhole bool
Indicates whether to drop traffic that matches this route.
TransitGatewayAttachmentId string
The ID of transit gateway attachment.
destinationCidrBlock This property is required. String
The CIDR range used for destination matches. Routing decisions are based on the most specific match.
transitGatewayRouteTableId This property is required. String
The ID of transit gateway route table.
blackhole Boolean
Indicates whether to drop traffic that matches this route.
transitGatewayAttachmentId String
The ID of transit gateway attachment.
destinationCidrBlock This property is required. string
The CIDR range used for destination matches. Routing decisions are based on the most specific match.
transitGatewayRouteTableId This property is required. string
The ID of transit gateway route table.
blackhole boolean
Indicates whether to drop traffic that matches this route.
transitGatewayAttachmentId string
The ID of transit gateway attachment.
destination_cidr_block This property is required. str
The CIDR range used for destination matches. Routing decisions are based on the most specific match.
transit_gateway_route_table_id This property is required. str
The ID of transit gateway route table.
blackhole bool
Indicates whether to drop traffic that matches this route.
transit_gateway_attachment_id str
The ID of transit gateway attachment.
destinationCidrBlock This property is required. String
The CIDR range used for destination matches. Routing decisions are based on the most specific match.
transitGatewayRouteTableId This property is required. String
The ID of transit gateway route table.
blackhole Boolean
Indicates whether to drop traffic that matches this route.
transitGatewayAttachmentId String
The ID of transit gateway attachment.

Outputs

All input properties are implicitly available as output properties. Additionally, the TransitGatewayRoute resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi