DefaultRouteTable

Provides a resource to manage a Default VPC Routing Table.

Each VPC created in AWS comes with a Default Route Table that can be managed, but not destroyed. This is an advanced resource, and has special caveats to be aware of when using it. Please read this document in its entirety before using this resource. It is recommended you do not use both aws.ec2.DefaultRouteTable to manage the default route table and use the aws.ec2.MainRouteTableAssociation, due to possible conflict in routes.

The aws.ec2.DefaultRouteTable behaves differently from normal resources, in that this provider does not create this resource, but instead attempts to “adopt” it into management. We can do this because each VPC created has a Default Route Table that cannot be destroyed, and is created with a single route.

When this provider first adopts the Default Route Table, it immediately removes all defined routes. It then proceeds to create any routes specified in the configuration. This step is required so that only the routes specified in the configuration present in the Default Route Table.

For more information about Route Tables, see the AWS Documentation on [Route Tables][aws-route-tables].

For more information about managing normal Route Tables in this provider, see our documentation on [aws.ec2.RouteTable][tf-route-tables].

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 routes.

Example Usage

With Tags

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var defaultRouteTable = new Aws.Ec2.DefaultRouteTable("defaultRouteTable", new Aws.Ec2.DefaultRouteTableArgs
        {
            DefaultRouteTableId = aws_vpc.Foo.Default_route_table_id,
            Routes = 
            {
                ,
            },
            Tags = 
            {
                { "Name", "default table" },
            },
        });
    }

}

package main

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

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := ec2.NewDefaultRouteTable(ctx, "defaultRouteTable", &ec2.DefaultRouteTableArgs{
            DefaultRouteTableId: pulumi.Any(aws_vpc.Foo.Default_route_table_id),
            Routes: ec2.DefaultRouteTableRouteArray{
                nil,
            },
            Tags: pulumi.StringMap{
                "Name": pulumi.String("default table"),
            },
        })
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_aws as aws

default_route_table = aws.ec2.DefaultRouteTable("defaultRouteTable",
    default_route_table_id=aws_vpc["foo"]["default_route_table_id"],
    routes=[aws.ec2.DefaultRouteTableRouteArgs()],
    tags={
        "Name": "default table",
    })

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const defaultRouteTable = new aws.ec2.DefaultRouteTable("defaultRouteTable", {
    defaultRouteTableId: aws_vpc.foo.default_route_table_id,
    routes: [{}],
    tags: {
        Name: "default table",
    },
});

Create a DefaultRouteTable Resource

new DefaultRouteTable(name: string, args: DefaultRouteTableArgs, opts?: CustomResourceOptions);

def DefaultRouteTable(resource_name: str, opts: Optional[ResourceOptions] = None, default_route_table_id: Optional[str] = None, propagating_vgws: Optional[Sequence[str]] = None, routes: Optional[Sequence[DefaultRouteTableRouteArgs]] = None, tags: Optional[Mapping[str, str]] = None)

func NewDefaultRouteTable(ctx *Context, name string, args DefaultRouteTableArgs, opts ...ResourceOption) (*DefaultRouteTable, error)

public DefaultRouteTable(string name, DefaultRouteTableArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args DefaultRouteTableArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args DefaultRouteTableArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args DefaultRouteTableArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.