RouteArgs

data class RouteArgs(val blackhole: Output<Boolean>? = null, val destinationCidrBlock: Output<String>? = null, val transitGatewayAttachmentId: Output<String>? = null, val transitGatewayRouteTableId: Output<String>? = null) : ConvertibleToJava<RouteArgs>

Manages an EC2 Transit Gateway Route.

Example Usage

Standard usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.ec2transitgateway.Route("example", {
destinationCidrBlock: "0.0.0.0/0",
transitGatewayAttachmentId: exampleAwsEc2TransitGatewayVpcAttachment.id,
transitGatewayRouteTableId: exampleAwsEc2TransitGateway.associationDefaultRouteTableId,
});
import pulumi
import pulumi_aws as aws
example = aws.ec2transitgateway.Route("example",
destination_cidr_block="0.0.0.0/0",
transit_gateway_attachment_id=example_aws_ec2_transit_gateway_vpc_attachment["id"],
transit_gateway_route_table_id=example_aws_ec2_transit_gateway["associationDefaultRouteTableId"])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Ec2TransitGateway.Route("example", new()
{
DestinationCidrBlock = "0.0.0.0/0",
TransitGatewayAttachmentId = exampleAwsEc2TransitGatewayVpcAttachment.Id,
TransitGatewayRouteTableId = exampleAwsEc2TransitGateway.AssociationDefaultRouteTableId,
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ec2transitgateway"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := ec2transitgateway.NewRoute(ctx, "example", &ec2transitgateway.RouteArgs{
DestinationCidrBlock: pulumi.String("0.0.0.0/0"),
TransitGatewayAttachmentId: pulumi.Any(exampleAwsEc2TransitGatewayVpcAttachment.Id),
TransitGatewayRouteTableId: pulumi.Any(exampleAwsEc2TransitGateway.AssociationDefaultRouteTableId),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2transitgateway.Route;
import com.pulumi.aws.ec2transitgateway.RouteArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new Route("example", RouteArgs.builder()
.destinationCidrBlock("0.0.0.0/0")
.transitGatewayAttachmentId(exampleAwsEc2TransitGatewayVpcAttachment.id())
.transitGatewayRouteTableId(exampleAwsEc2TransitGateway.associationDefaultRouteTableId())
.build());
}
}
resources:
example:
type: aws:ec2transitgateway:Route
properties:
destinationCidrBlock: 0.0.0.0/0
transitGatewayAttachmentId: ${exampleAwsEc2TransitGatewayVpcAttachment.id}
transitGatewayRouteTableId: ${exampleAwsEc2TransitGateway.associationDefaultRouteTableId}

Blackhole route

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.ec2transitgateway.Route("example", {
destinationCidrBlock: "0.0.0.0/0",
blackhole: true,
transitGatewayRouteTableId: exampleAwsEc2TransitGateway.associationDefaultRouteTableId,
});
import pulumi
import pulumi_aws as aws
example = aws.ec2transitgateway.Route("example",
destination_cidr_block="0.0.0.0/0",
blackhole=True,
transit_gateway_route_table_id=example_aws_ec2_transit_gateway["associationDefaultRouteTableId"])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Ec2TransitGateway.Route("example", new()
{
DestinationCidrBlock = "0.0.0.0/0",
Blackhole = true,
TransitGatewayRouteTableId = exampleAwsEc2TransitGateway.AssociationDefaultRouteTableId,
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ec2transitgateway"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := ec2transitgateway.NewRoute(ctx, "example", &ec2transitgateway.RouteArgs{
DestinationCidrBlock: pulumi.String("0.0.0.0/0"),
Blackhole: pulumi.Bool(true),
TransitGatewayRouteTableId: pulumi.Any(exampleAwsEc2TransitGateway.AssociationDefaultRouteTableId),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2transitgateway.Route;
import com.pulumi.aws.ec2transitgateway.RouteArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new Route("example", RouteArgs.builder()
.destinationCidrBlock("0.0.0.0/0")
.blackhole(true)
.transitGatewayRouteTableId(exampleAwsEc2TransitGateway.associationDefaultRouteTableId())
.build());
}
}
resources:
example:
type: aws:ec2transitgateway:Route
properties:
destinationCidrBlock: 0.0.0.0/0
blackhole: true
transitGatewayRouteTableId: ${exampleAwsEc2TransitGateway.associationDefaultRouteTableId}

Import

Using pulumi import, import aws_ec2_transit_gateway_route using the EC2 Transit Gateway Route Table, an underscore, and the destination. For example:

$ pulumi import aws:ec2transitgateway/route:Route example tgw-rtb-12345678_0.0.0.0/0

Constructors

Link copied to clipboard
constructor(blackhole: Output<Boolean>? = null, destinationCidrBlock: Output<String>? = null, transitGatewayAttachmentId: Output<String>? = null, transitGatewayRouteTableId: Output<String>? = null)

Properties

Link copied to clipboard
val blackhole: Output<Boolean>? = null

Indicates whether to drop traffic that matches this route (default to false).

Link copied to clipboard
val destinationCidrBlock: Output<String>? = null

IPv4 or IPv6 RFC1924 CIDR used for destination matches. Routing decisions are based on the most specific match.

Link copied to clipboard
val transitGatewayAttachmentId: Output<String>? = null

Identifier of EC2 Transit Gateway Attachment (required if blackhole is set to false).

Link copied to clipboard
val transitGatewayRouteTableId: Output<String>? = null

Identifier of EC2 Transit Gateway Route Table.

Functions

Link copied to clipboard
open override fun toJava(): RouteArgs