1. Packages
  2. AWS
  3. API Docs
  4. ec2transitgateway
  5. RouteTableAssociation
AWS v6.75.0 published on Wednesday, Apr 2, 2025 by Pulumi

aws.ec2transitgateway.RouteTableAssociation

Explore with Pulumi AI

Manages an EC2 Transit Gateway Route Table association.

Example Usage

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

const example = new aws.ec2transitgateway.RouteTableAssociation("example", {
    transitGatewayAttachmentId: exampleAwsEc2TransitGatewayVpcAttachment.id,
    transitGatewayRouteTableId: exampleAwsEc2TransitGatewayRouteTable.id,
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.ec2transitgateway.RouteTableAssociation("example",
    transit_gateway_attachment_id=example_aws_ec2_transit_gateway_vpc_attachment["id"],
    transit_gateway_route_table_id=example_aws_ec2_transit_gateway_route_table["id"])
Copy
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.NewRouteTableAssociation(ctx, "example", &ec2transitgateway.RouteTableAssociationArgs{
			TransitGatewayAttachmentId: pulumi.Any(exampleAwsEc2TransitGatewayVpcAttachment.Id),
			TransitGatewayRouteTableId: pulumi.Any(exampleAwsEc2TransitGatewayRouteTable.Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Ec2TransitGateway.RouteTableAssociation("example", new()
    {
        TransitGatewayAttachmentId = exampleAwsEc2TransitGatewayVpcAttachment.Id,
        TransitGatewayRouteTableId = exampleAwsEc2TransitGatewayRouteTable.Id,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2transitgateway.RouteTableAssociation;
import com.pulumi.aws.ec2transitgateway.RouteTableAssociationArgs;
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 RouteTableAssociation("example", RouteTableAssociationArgs.builder()
            .transitGatewayAttachmentId(exampleAwsEc2TransitGatewayVpcAttachment.id())
            .transitGatewayRouteTableId(exampleAwsEc2TransitGatewayRouteTable.id())
            .build());

    }
}
Copy
resources:
  example:
    type: aws:ec2transitgateway:RouteTableAssociation
    properties:
      transitGatewayAttachmentId: ${exampleAwsEc2TransitGatewayVpcAttachment.id}
      transitGatewayRouteTableId: ${exampleAwsEc2TransitGatewayRouteTable.id}
Copy

Create RouteTableAssociation Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new RouteTableAssociation(name: string, args: RouteTableAssociationArgs, opts?: CustomResourceOptions);
@overload
def RouteTableAssociation(resource_name: str,
                          args: RouteTableAssociationArgs,
                          opts: Optional[ResourceOptions] = None)

@overload
def RouteTableAssociation(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          transit_gateway_attachment_id: Optional[str] = None,
                          transit_gateway_route_table_id: Optional[str] = None,
                          replace_existing_association: Optional[bool] = None)
func NewRouteTableAssociation(ctx *Context, name string, args RouteTableAssociationArgs, opts ...ResourceOption) (*RouteTableAssociation, error)
public RouteTableAssociation(string name, RouteTableAssociationArgs args, CustomResourceOptions? opts = null)
public RouteTableAssociation(String name, RouteTableAssociationArgs args)
public RouteTableAssociation(String name, RouteTableAssociationArgs args, CustomResourceOptions options)
type: aws:ec2transitgateway:RouteTableAssociation
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. RouteTableAssociationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. RouteTableAssociationArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. RouteTableAssociationArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. RouteTableAssociationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. RouteTableAssociationArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var awsRouteTableAssociationResource = new Aws.Ec2TransitGateway.RouteTableAssociation("awsRouteTableAssociationResource", new()
{
    TransitGatewayAttachmentId = "string",
    TransitGatewayRouteTableId = "string",
    ReplaceExistingAssociation = false,
});
Copy
example, err := ec2transitgateway.NewRouteTableAssociation(ctx, "awsRouteTableAssociationResource", &ec2transitgateway.RouteTableAssociationArgs{
	TransitGatewayAttachmentId: pulumi.String("string"),
	TransitGatewayRouteTableId: pulumi.String("string"),
	ReplaceExistingAssociation: pulumi.Bool(false),
})
Copy
var awsRouteTableAssociationResource = new RouteTableAssociation("awsRouteTableAssociationResource", RouteTableAssociationArgs.builder()
    .transitGatewayAttachmentId("string")
    .transitGatewayRouteTableId("string")
    .replaceExistingAssociation(false)
    .build());
Copy
aws_route_table_association_resource = aws.ec2transitgateway.RouteTableAssociation("awsRouteTableAssociationResource",
    transit_gateway_attachment_id="string",
    transit_gateway_route_table_id="string",
    replace_existing_association=False)
Copy
const awsRouteTableAssociationResource = new aws.ec2transitgateway.RouteTableAssociation("awsRouteTableAssociationResource", {
    transitGatewayAttachmentId: "string",
    transitGatewayRouteTableId: "string",
    replaceExistingAssociation: false,
});
Copy
type: aws:ec2transitgateway:RouteTableAssociation
properties:
    replaceExistingAssociation: false
    transitGatewayAttachmentId: string
    transitGatewayRouteTableId: string
Copy

RouteTableAssociation Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The RouteTableAssociation resource accepts the following input properties:

TransitGatewayAttachmentId This property is required. string
Identifier of EC2 Transit Gateway Attachment.
TransitGatewayRouteTableId
This property is required.
Changes to this property will trigger replacement.
string
Identifier of EC2 Transit Gateway Route Table.
ReplaceExistingAssociation bool
Boolean whether the Gateway Attachment should remove any current Route Table association before associating with the specified Route Table. Default value: false. This argument is intended for use with EC2 Transit Gateways shared into the current account, otherwise the transit_gateway_default_route_table_association argument of the aws.ec2transitgateway.VpcAttachment resource should be used.
TransitGatewayAttachmentId This property is required. string
Identifier of EC2 Transit Gateway Attachment.
TransitGatewayRouteTableId
This property is required.
Changes to this property will trigger replacement.
string
Identifier of EC2 Transit Gateway Route Table.
ReplaceExistingAssociation bool
Boolean whether the Gateway Attachment should remove any current Route Table association before associating with the specified Route Table. Default value: false. This argument is intended for use with EC2 Transit Gateways shared into the current account, otherwise the transit_gateway_default_route_table_association argument of the aws.ec2transitgateway.VpcAttachment resource should be used.
transitGatewayAttachmentId This property is required. String
Identifier of EC2 Transit Gateway Attachment.
transitGatewayRouteTableId
This property is required.
Changes to this property will trigger replacement.
String
Identifier of EC2 Transit Gateway Route Table.
replaceExistingAssociation Boolean
Boolean whether the Gateway Attachment should remove any current Route Table association before associating with the specified Route Table. Default value: false. This argument is intended for use with EC2 Transit Gateways shared into the current account, otherwise the transit_gateway_default_route_table_association argument of the aws.ec2transitgateway.VpcAttachment resource should be used.
transitGatewayAttachmentId This property is required. string
Identifier of EC2 Transit Gateway Attachment.
transitGatewayRouteTableId
This property is required.
Changes to this property will trigger replacement.
string
Identifier of EC2 Transit Gateway Route Table.
replaceExistingAssociation boolean
Boolean whether the Gateway Attachment should remove any current Route Table association before associating with the specified Route Table. Default value: false. This argument is intended for use with EC2 Transit Gateways shared into the current account, otherwise the transit_gateway_default_route_table_association argument of the aws.ec2transitgateway.VpcAttachment resource should be used.
transit_gateway_attachment_id This property is required. str
Identifier of EC2 Transit Gateway Attachment.
transit_gateway_route_table_id
This property is required.
Changes to this property will trigger replacement.
str
Identifier of EC2 Transit Gateway Route Table.
replace_existing_association bool
Boolean whether the Gateway Attachment should remove any current Route Table association before associating with the specified Route Table. Default value: false. This argument is intended for use with EC2 Transit Gateways shared into the current account, otherwise the transit_gateway_default_route_table_association argument of the aws.ec2transitgateway.VpcAttachment resource should be used.
transitGatewayAttachmentId This property is required. String
Identifier of EC2 Transit Gateway Attachment.
transitGatewayRouteTableId
This property is required.
Changes to this property will trigger replacement.
String
Identifier of EC2 Transit Gateway Route Table.
replaceExistingAssociation Boolean
Boolean whether the Gateway Attachment should remove any current Route Table association before associating with the specified Route Table. Default value: false. This argument is intended for use with EC2 Transit Gateways shared into the current account, otherwise the transit_gateway_default_route_table_association argument of the aws.ec2transitgateway.VpcAttachment resource should be used.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
ResourceId string
Identifier of the resource
ResourceType string
Type of the resource
Id string
The provider-assigned unique ID for this managed resource.
ResourceId string
Identifier of the resource
ResourceType string
Type of the resource
id String
The provider-assigned unique ID for this managed resource.
resourceId String
Identifier of the resource
resourceType String
Type of the resource
id string
The provider-assigned unique ID for this managed resource.
resourceId string
Identifier of the resource
resourceType string
Type of the resource
id str
The provider-assigned unique ID for this managed resource.
resource_id str
Identifier of the resource
resource_type str
Type of the resource
id String
The provider-assigned unique ID for this managed resource.
resourceId String
Identifier of the resource
resourceType String
Type of the resource

Look up Existing RouteTableAssociation Resource

Get an existing RouteTableAssociation 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?: RouteTableAssociationState, opts?: CustomResourceOptions): RouteTableAssociation
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        replace_existing_association: Optional[bool] = None,
        resource_id: Optional[str] = None,
        resource_type: Optional[str] = None,
        transit_gateway_attachment_id: Optional[str] = None,
        transit_gateway_route_table_id: Optional[str] = None) -> RouteTableAssociation
func GetRouteTableAssociation(ctx *Context, name string, id IDInput, state *RouteTableAssociationState, opts ...ResourceOption) (*RouteTableAssociation, error)
public static RouteTableAssociation Get(string name, Input<string> id, RouteTableAssociationState? state, CustomResourceOptions? opts = null)
public static RouteTableAssociation get(String name, Output<String> id, RouteTableAssociationState state, CustomResourceOptions options)
resources:  _:    type: aws:ec2transitgateway:RouteTableAssociation    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
ReplaceExistingAssociation bool
Boolean whether the Gateway Attachment should remove any current Route Table association before associating with the specified Route Table. Default value: false. This argument is intended for use with EC2 Transit Gateways shared into the current account, otherwise the transit_gateway_default_route_table_association argument of the aws.ec2transitgateway.VpcAttachment resource should be used.
ResourceId string
Identifier of the resource
ResourceType string
Type of the resource
TransitGatewayAttachmentId string
Identifier of EC2 Transit Gateway Attachment.
TransitGatewayRouteTableId Changes to this property will trigger replacement. string
Identifier of EC2 Transit Gateway Route Table.
ReplaceExistingAssociation bool
Boolean whether the Gateway Attachment should remove any current Route Table association before associating with the specified Route Table. Default value: false. This argument is intended for use with EC2 Transit Gateways shared into the current account, otherwise the transit_gateway_default_route_table_association argument of the aws.ec2transitgateway.VpcAttachment resource should be used.
ResourceId string
Identifier of the resource
ResourceType string
Type of the resource
TransitGatewayAttachmentId string
Identifier of EC2 Transit Gateway Attachment.
TransitGatewayRouteTableId Changes to this property will trigger replacement. string
Identifier of EC2 Transit Gateway Route Table.
replaceExistingAssociation Boolean
Boolean whether the Gateway Attachment should remove any current Route Table association before associating with the specified Route Table. Default value: false. This argument is intended for use with EC2 Transit Gateways shared into the current account, otherwise the transit_gateway_default_route_table_association argument of the aws.ec2transitgateway.VpcAttachment resource should be used.
resourceId String
Identifier of the resource
resourceType String
Type of the resource
transitGatewayAttachmentId String
Identifier of EC2 Transit Gateway Attachment.
transitGatewayRouteTableId Changes to this property will trigger replacement. String
Identifier of EC2 Transit Gateway Route Table.
replaceExistingAssociation boolean
Boolean whether the Gateway Attachment should remove any current Route Table association before associating with the specified Route Table. Default value: false. This argument is intended for use with EC2 Transit Gateways shared into the current account, otherwise the transit_gateway_default_route_table_association argument of the aws.ec2transitgateway.VpcAttachment resource should be used.
resourceId string
Identifier of the resource
resourceType string
Type of the resource
transitGatewayAttachmentId string
Identifier of EC2 Transit Gateway Attachment.
transitGatewayRouteTableId Changes to this property will trigger replacement. string
Identifier of EC2 Transit Gateway Route Table.
replace_existing_association bool
Boolean whether the Gateway Attachment should remove any current Route Table association before associating with the specified Route Table. Default value: false. This argument is intended for use with EC2 Transit Gateways shared into the current account, otherwise the transit_gateway_default_route_table_association argument of the aws.ec2transitgateway.VpcAttachment resource should be used.
resource_id str
Identifier of the resource
resource_type str
Type of the resource
transit_gateway_attachment_id str
Identifier of EC2 Transit Gateway Attachment.
transit_gateway_route_table_id Changes to this property will trigger replacement. str
Identifier of EC2 Transit Gateway Route Table.
replaceExistingAssociation Boolean
Boolean whether the Gateway Attachment should remove any current Route Table association before associating with the specified Route Table. Default value: false. This argument is intended for use with EC2 Transit Gateways shared into the current account, otherwise the transit_gateway_default_route_table_association argument of the aws.ec2transitgateway.VpcAttachment resource should be used.
resourceId String
Identifier of the resource
resourceType String
Type of the resource
transitGatewayAttachmentId String
Identifier of EC2 Transit Gateway Attachment.
transitGatewayRouteTableId Changes to this property will trigger replacement. String
Identifier of EC2 Transit Gateway Route Table.

Import

Using pulumi import, import aws_ec2_transit_gateway_route_table_association using the EC2 Transit Gateway Route Table identifier, an underscore, and the EC2 Transit Gateway Attachment identifier. For example:

$ pulumi import aws:ec2transitgateway/routeTableAssociation:RouteTableAssociation example tgw-rtb-12345678_tgw-attach-87654321
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.