Route class
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/v7/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
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_ec2transitgateway_route" "example" {
destination_cidr_block = "0.0.0.0/0"
transit_gateway_attachment_id = exampleAwsEc2TransitGatewayVpcAttachment.id
transit_gateway_route_table_id = exampleAwsEc2TransitGateway.associationDefaultRouteTableId
}
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.ArrayList;
import java.util.Arrays;
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/v7/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
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_ec2transitgateway_route" "example" {
destination_cidr_block = "0.0.0.0/0"
blackhole = true
transit_gateway_route_table_id = exampleAwsEc2TransitGateway.associationDefaultRouteTableId
}
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.ArrayList;
import java.util.Arrays;
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.ec2transitgateway.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
- Route(String name, {RouteArgs? args, CustomResourceOptions? options})
-
Creates a new Route.
nameThe Pulumi resource name.argsArguments used to configure this Route. The set of arguments for Route.optionsResource options controlling this resource's behavior. - Route.reference(String urn)
- Creates a typed reference to an existing Route resource.
Properties
-
blackhole
↔ Output<
bool?> -
Indicates whether to drop traffic that matches this route (default to
false).latefinal -
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
destinationCidrBlock
↔ Output<
String> -
IPv4 or IPv6 RFC1924 CIDR used for destination matches. Routing decisions are based on the most specific match.
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
transitGatewayAttachmentId
↔ Output<
String?> -
Identifier of EC2 Transit Gateway Attachment (required if
blackholeis set to false).latefinal -
transitGatewayRouteTableId
↔ Output<
String> -
Identifier of EC2 Transit Gateway Route Table.
latefinal
-
urn
↔ Output<
String> -
latefinalinherited
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited