RouteTable

Provides a resource to create a VPC routing table.

NOTE on Route Tables and Routes: This provider currently provides both a standalone Route resource and a Route Table resource with routes defined in-line. At this time you cannot use a Route Table with in-line routes in conjunction with any Route resources. Doing so will cause a conflict of rule settings and will overwrite rules.

NOTE on gateway_id and nat_gateway_id: The AWS API is very forgiving with these two attributes and the aws.ec2.RouteTable resource can be created with a NAT ID specified as a Gateway ID attribute. This will lead to a permanent diff between your configuration and statefile, as the API returns the correct parameters in the returned route table. If you’re experiencing constant diffs in your aws.ec2.RouteTable resources, the first thing to check is whether or not you’re specifying a NAT ID instead of a Gateway ID, or vice-versa.

NOTE on propagating_vgws and the aws.ec2.VpnGatewayRoutePropagation resource: If the propagating_vgws argument is present, it’s not supported to also define route propagations using aws.ec2.VpnGatewayRoutePropagation, since this resource will delete any propagating gateways not explicitly listed in propagating_vgws. Omit this argument when defining route propagation using the separate resource.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new Aws.Ec2.RouteTable("example", new Aws.Ec2.RouteTableArgs
        {
            VpcId = aws_vpc.Example.Id,
            Routes = 
            {
                new Aws.Ec2.Inputs.RouteTableRouteArgs
                {
                    CidrBlock = "10.0.1.0/24",
                    GatewayId = aws_internet_gateway.Example.Id,
                },
                new Aws.Ec2.Inputs.RouteTableRouteArgs
                {
                    Ipv6CidrBlock = "::/0",
                    EgressOnlyGatewayId = aws_egress_only_internet_gateway.Example.Id,
                },
            },
            Tags = 
            {
                { "Name", "example" },
            },
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v4/go/aws/ec2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ec2.NewRouteTable(ctx, "example", &ec2.RouteTableArgs{
			VpcId: pulumi.Any(aws_vpc.Example.Id),
			Routes: ec2.RouteTableRouteArray{
				&ec2.RouteTableRouteArgs{
					CidrBlock: pulumi.String("10.0.1.0/24"),
					GatewayId: pulumi.Any(aws_internet_gateway.Example.Id),
				},
				&ec2.RouteTableRouteArgs{
					Ipv6CidrBlock:       pulumi.String("::/0"),
					EgressOnlyGatewayId: pulumi.Any(aws_egress_only_internet_gateway.Example.Id),
				},
			},
			Tags: pulumi.StringMap{
				"Name": pulumi.String("example"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
import pulumi
import pulumi_aws as aws

example = aws.ec2.RouteTable("example",
    vpc_id=aws_vpc["example"]["id"],
    routes=[
        aws.ec2.RouteTableRouteArgs(
            cidr_block="10.0.1.0/24",
            gateway_id=aws_internet_gateway["example"]["id"],
        ),
        aws.ec2.RouteTableRouteArgs(
            ipv6_cidr_block="::/0",
            egress_only_gateway_id=aws_egress_only_internet_gateway["example"]["id"],
        ),
    ],
    tags={
        "Name": "example",
    })
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.ec2.RouteTable("example", {
    vpcId: aws_vpc.example.id,
    routes: [
        {
            cidrBlock: "10.0.1.0/24",
            gatewayId: aws_internet_gateway.example.id,
        },
        {
            ipv6CidrBlock: "::/0",
            egressOnlyGatewayId: aws_egress_only_internet_gateway.example.id,
        },
    ],
    tags: {
        Name: "example",
    },
});

Create a RouteTable Resource

new RouteTable(name: string, args: RouteTableArgs, opts?: CustomResourceOptions);
@overload
def RouteTable(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               propagating_vgws: Optional[Sequence[str]] = None,
               routes: Optional[Sequence[RouteTableRouteArgs]] = None,
               tags: Optional[Mapping[str, str]] = None,
               tags_all: Optional[Mapping[str, str]] = None,
               vpc_id: Optional[str] = None)
@overload
def RouteTable(resource_name: str,
               args: RouteTableArgs,
               opts: Optional[ResourceOptions] = None)
func NewRouteTable(ctx *Context, name string, args RouteTableArgs, opts ...ResourceOption) (*RouteTable, error)
public RouteTable(string name, RouteTableArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args RouteTableArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args RouteTableArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args RouteTableArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args RouteTableArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

RouteTable Resource Properties

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

Inputs

The RouteTable resource accepts the following input properties:

VpcId string
The VPC ID.
PropagatingVgws List<string>
A list of virtual gateways for propagation.
Routes List<RouteTableRouteArgs>
A list of route objects. Their keys are documented below.
Tags Dictionary<string, string>
A map of tags to assign to the resource.
TagsAll Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider .
VpcId string
The VPC ID.
PropagatingVgws []string
A list of virtual gateways for propagation.
Routes []RouteTableRoute
A list of route objects. Their keys are documented below.
Tags map[string]string
A map of tags to assign to the resource.
TagsAll map[string]string
A map of tags assigned to the resource, including those inherited from the provider .
vpcId string
The VPC ID.
propagatingVgws string[]
A list of virtual gateways for propagation.
routes RouteTableRouteArgs[]
A list of route objects. Their keys are documented below.
tags {[key: string]: string}
A map of tags to assign to the resource.
tagsAll {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider .
vpc_id str
The VPC ID.
propagating_vgws Sequence[str]
A list of virtual gateways for propagation.
routes Sequence[RouteTableRouteArgs]
A list of route objects. Their keys are documented below.
tags Mapping[str, str]
A map of tags to assign to the resource.
tags_all Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider .

Outputs

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

Arn string
The ARN of the route table.
Id string
The provider-assigned unique ID for this managed resource.
OwnerId string
The ID of the AWS account that owns the route table.
Arn string
The ARN of the route table.
Id string
The provider-assigned unique ID for this managed resource.
OwnerId string
The ID of the AWS account that owns the route table.
arn string
The ARN of the route table.
id string
The provider-assigned unique ID for this managed resource.
ownerId string
The ID of the AWS account that owns the route table.
arn str
The ARN of the route table.
id str
The provider-assigned unique ID for this managed resource.
owner_id str
The ID of the AWS account that owns the route table.

Look up an Existing RouteTable Resource

Get an existing RouteTable resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: RouteTableState, opts?: CustomResourceOptions): RouteTable
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        owner_id: Optional[str] = None,
        propagating_vgws: Optional[Sequence[str]] = None,
        routes: Optional[Sequence[RouteTableRouteArgs]] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        vpc_id: Optional[str] = None) -> RouteTable
func GetRouteTable(ctx *Context, name string, id IDInput, state *RouteTableState, opts ...ResourceOption) (*RouteTable, error)
public static RouteTable Get(string name, Input<string> id, RouteTableState? state, CustomResourceOptions? opts = null)
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.

The following state arguments are supported:

Arn string
The ARN of the route table.
OwnerId string
The ID of the AWS account that owns the route table.
PropagatingVgws List<string>
A list of virtual gateways for propagation.
Routes List<RouteTableRouteArgs>
A list of route objects. Their keys are documented below.
Tags Dictionary<string, string>
A map of tags to assign to the resource.
TagsAll Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider .
VpcId string
The VPC ID.
Arn string
The ARN of the route table.
OwnerId string
The ID of the AWS account that owns the route table.
PropagatingVgws []string
A list of virtual gateways for propagation.
Routes []RouteTableRoute
A list of route objects. Their keys are documented below.
Tags map[string]string
A map of tags to assign to the resource.
TagsAll map[string]string
A map of tags assigned to the resource, including those inherited from the provider .
VpcId string
The VPC ID.
arn string
The ARN of the route table.
ownerId string
The ID of the AWS account that owns the route table.
propagatingVgws string[]
A list of virtual gateways for propagation.
routes RouteTableRouteArgs[]
A list of route objects. Their keys are documented below.
tags {[key: string]: string}
A map of tags to assign to the resource.
tagsAll {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider .
vpcId string
The VPC ID.
arn str
The ARN of the route table.
owner_id str
The ID of the AWS account that owns the route table.
propagating_vgws Sequence[str]
A list of virtual gateways for propagation.
routes Sequence[RouteTableRouteArgs]
A list of route objects. Their keys are documented below.
tags Mapping[str, str]
A map of tags to assign to the resource.
tags_all Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider .
vpc_id str
The VPC ID.

Supporting Types

RouteTableRoute

CarrierGatewayId string
Identifier of a carrier gateway. This attribute can only be used when the VPC contains a subnet which is associated with a Wavelength Zone.
CidrBlock string
The CIDR block of the route.
DestinationPrefixListId string
The ID of a managed prefix list destination of the route.
EgressOnlyGatewayId string
Identifier of a VPC Egress Only Internet Gateway.
GatewayId string
Identifier of a VPC internet gateway or a virtual private gateway.
InstanceId string
Identifier of an EC2 instance.
Ipv6CidrBlock string
The Ipv6 CIDR block of the route.
LocalGatewayId string
Identifier of a Outpost local gateway.
NatGatewayId string
Identifier of a VPC NAT gateway.
NetworkInterfaceId string
Identifier of an EC2 network interface.
TransitGatewayId string
Identifier of an EC2 Transit Gateway.
VpcEndpointId string
Identifier of a VPC Endpoint.
VpcPeeringConnectionId string
Identifier of a VPC peering connection.
CarrierGatewayId string
Identifier of a carrier gateway. This attribute can only be used when the VPC contains a subnet which is associated with a Wavelength Zone.
CidrBlock string
The CIDR block of the route.
DestinationPrefixListId string
The ID of a managed prefix list destination of the route.
EgressOnlyGatewayId string
Identifier of a VPC Egress Only Internet Gateway.
GatewayId string
Identifier of a VPC internet gateway or a virtual private gateway.
InstanceId string
Identifier of an EC2 instance.
Ipv6CidrBlock string
The Ipv6 CIDR block of the route.
LocalGatewayId string
Identifier of a Outpost local gateway.
NatGatewayId string
Identifier of a VPC NAT gateway.
NetworkInterfaceId string
Identifier of an EC2 network interface.
TransitGatewayId string
Identifier of an EC2 Transit Gateway.
VpcEndpointId string
Identifier of a VPC Endpoint.
VpcPeeringConnectionId string
Identifier of a VPC peering connection.
carrierGatewayId string
Identifier of a carrier gateway. This attribute can only be used when the VPC contains a subnet which is associated with a Wavelength Zone.
cidrBlock string
The CIDR block of the route.
destinationPrefixListId string
The ID of a managed prefix list destination of the route.
egressOnlyGatewayId string
Identifier of a VPC Egress Only Internet Gateway.
gatewayId string
Identifier of a VPC internet gateway or a virtual private gateway.
instanceId string
Identifier of an EC2 instance.
ipv6CidrBlock string
The Ipv6 CIDR block of the route.
localGatewayId string
Identifier of a Outpost local gateway.
natGatewayId string
Identifier of a VPC NAT gateway.
networkInterfaceId string
Identifier of an EC2 network interface.
transitGatewayId string
Identifier of an EC2 Transit Gateway.
vpcEndpointId string
Identifier of a VPC Endpoint.
vpcPeeringConnectionId string
Identifier of a VPC peering connection.
carrier_gateway_id str
Identifier of a carrier gateway. This attribute can only be used when the VPC contains a subnet which is associated with a Wavelength Zone.
cidr_block str
The CIDR block of the route.
destination_prefix_list_id str
The ID of a managed prefix list destination of the route.
egress_only_gateway_id str
Identifier of a VPC Egress Only Internet Gateway.
gateway_id str
Identifier of a VPC internet gateway or a virtual private gateway.
instance_id str
Identifier of an EC2 instance.
ipv6_cidr_block str
The Ipv6 CIDR block of the route.
local_gateway_id str
Identifier of a Outpost local gateway.
nat_gateway_id str
Identifier of a VPC NAT gateway.
network_interface_id str
Identifier of an EC2 network interface.
transit_gateway_id str
Identifier of an EC2 Transit Gateway.
vpc_endpoint_id str
Identifier of a VPC Endpoint.
vpc_peering_connection_id str
Identifier of a VPC peering connection.

Import

Route Tables can be imported using the route table id. For example, to import route table rtb-4e616f6d69, use this command

 $ pulumi import aws:ec2/routeTable:RouteTable public_rt rtb-4e616f6d69

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.