RouteTableAssociation class

Provides a resource to create an association between a route table and a subnet or a route table and an internet gateway or virtual private gateway.

Example Usage

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

const example = new aws.ec2.RouteTableAssociation("example", {
    subnetId: exampleAwsSubnet.id,
    routeTableId: exampleAwsRouteTable.id,
});
import pulumi
import pulumi_aws as aws

example = aws.ec2.RouteTableAssociation("example",
    subnet_id=example_aws_subnet["id"],
    route_table_id=example_aws_route_table["id"])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.Ec2.RouteTableAssociation("example", new()
    {
        SubnetId = exampleAwsSubnet.Id,
        RouteTableId = exampleAwsRouteTable.Id,
    });

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ec2.NewRouteTableAssociation(ctx, "example", &ec2.RouteTableAssociationArgs{
			SubnetId:     pulumi.Any(exampleAwsSubnet.Id),
			RouteTableId: pulumi.Any(exampleAwsRouteTable.Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_ec2_routetableassociation" "example" {
  subnet_id      = exampleAwsSubnet.id
  route_table_id = exampleAwsRouteTable.id
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2.RouteTableAssociation;
import com.pulumi.aws.ec2.RouteTableAssociationArgs;
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 RouteTableAssociation("example", RouteTableAssociationArgs.builder()
            .subnetId(exampleAwsSubnet.id())
            .routeTableId(exampleAwsRouteTable.id())
            .build());

    }
}
resources:
  example:
    type: aws:ec2:RouteTableAssociation
    properties:
      subnetId: ${exampleAwsSubnet.id}
      routeTableId: ${exampleAwsRouteTable.id}
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.ec2.RouteTableAssociation("example", {
    gatewayId: exampleAwsInternetGateway.id,
    routeTableId: exampleAwsRouteTable.id,
});
import pulumi
import pulumi_aws as aws

example = aws.ec2.RouteTableAssociation("example",
    gateway_id=example_aws_internet_gateway["id"],
    route_table_id=example_aws_route_table["id"])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.Ec2.RouteTableAssociation("example", new()
    {
        GatewayId = exampleAwsInternetGateway.Id,
        RouteTableId = exampleAwsRouteTable.Id,
    });

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ec2.NewRouteTableAssociation(ctx, "example", &ec2.RouteTableAssociationArgs{
			GatewayId:    pulumi.Any(exampleAwsInternetGateway.Id),
			RouteTableId: pulumi.Any(exampleAwsRouteTable.Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_ec2_routetableassociation" "example" {
  gateway_id     = exampleAwsInternetGateway.id
  route_table_id = exampleAwsRouteTable.id
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2.RouteTableAssociation;
import com.pulumi.aws.ec2.RouteTableAssociationArgs;
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 RouteTableAssociation("example", RouteTableAssociationArgs.builder()
            .gatewayId(exampleAwsInternetGateway.id())
            .routeTableId(exampleAwsRouteTable.id())
            .build());

    }
}
resources:
  example:
    type: aws:ec2:RouteTableAssociation
    properties:
      gatewayId: ${exampleAwsInternetGateway.id}
      routeTableId: ${exampleAwsRouteTable.id}

Import

Identity Schema

Required

  • id - (String) ID of the association.

Optional

  • accountId (String) AWS Account where this resource is managed.
  • region (String) Region where this resource is managed.

With EC2 Internet Gateways:

Using pulumi import to import EC2 Route Table Associations using the associated resource ID and Route Table ID separated by a forward slash (/). For example:

With EC2 Subnets:

$ pulumi import aws:ec2/routeTableAssociation:RouteTableAssociation example subnet-6777656e646f6c796e/rtb-656c65616e6f72

With EC2 Internet Gateways:

$ pulumi import aws:ec2/routeTableAssociation:RouteTableAssociation example igw-01b3a60780f8d034a/rtb-656c65616e6f72

Constructors

RouteTableAssociation(String name, {RouteTableAssociationArgs? args, CustomResourceOptions? options})
Creates a new RouteTableAssociation. name The Pulumi resource name. args Arguments used to configure this RouteTableAssociation. The set of arguments for RouteTableAssociation. options Resource options controlling this resource's behavior.
RouteTableAssociation.reference(String urn)
Creates a typed reference to an existing RouteTableAssociation resource.

Properties

childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
gatewayId ↔ Output<String?>
The gateway ID to create an association. Conflicts with subnetId.
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
routeTableId ↔ Output<String>
The ID of the routing table to associate with.
latefinal
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
subnetId ↔ Output<String?>
The subnet ID to create an association. Conflicts with gatewayId.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
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

Static Methods

get(String name, Input<String> id, {RouteTableAssociationState? state, CustomResourceOptions? options}) → RouteTableAssociation
Gets an existing RouteTableAssociation resource's state with the given name and id.