This page documents the language specification for the aws package. If you're looking for help working with the inputs, outputs, or functions of aws resources in a Pulumi program, please see the resource documentation for examples and API reference.

ec2transitgateway¶

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-aws repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-aws repo.

class pulumi_aws.ec2transitgateway.AwaitableGetDirectConnectGatewayAttachmentResult(dx_gateway_id=None, filters=None, id=None, tags=None, transit_gateway_id=None)¶

class pulumi_aws.ec2transitgateway.AwaitableGetPeeringAttachmentResult(filters=None, id=None, peer_account_id=None, peer_region=None, peer_transit_gateway_id=None, tags=None, transit_gateway_id=None)¶

class pulumi_aws.ec2transitgateway.AwaitableGetRouteTableResult(default_association_route_table=None, default_propagation_route_table=None, filters=None, id=None, tags=None, transit_gateway_id=None)¶

class pulumi_aws.ec2transitgateway.AwaitableGetTransitGatewayResult(amazon_side_asn=None, arn=None, association_default_route_table_id=None, auto_accept_shared_attachments=None, default_route_table_association=None, default_route_table_propagation=None, description=None, dns_support=None, filters=None, id=None, owner_id=None, propagation_default_route_table_id=None, tags=None, vpn_ecmp_support=None)¶

class pulumi_aws.ec2transitgateway.AwaitableGetVpcAttachmentResult(dns_support=None, filters=None, id=None, ipv6_support=None, subnet_ids=None, tags=None, transit_gateway_id=None, vpc_id=None, vpc_owner_id=None)¶

class pulumi_aws.ec2transitgateway.AwaitableGetVpnAttachmentResult(filters=None, id=None, tags=None, transit_gateway_id=None, vpn_connection_id=None)¶

class pulumi_aws.ec2transitgateway.GetDirectConnectGatewayAttachmentResult(dx_gateway_id=None, filters=None, id=None, tags=None, transit_gateway_id=None)¶

A collection of values returned by getDirectConnectGatewayAttachment.

id = None¶: The provider-assigned unique ID for this managed resource.

tags = None¶: Key-value tags for the EC2 Transit Gateway Attachment

class pulumi_aws.ec2transitgateway.GetPeeringAttachmentResult(filters=None, id=None, peer_account_id=None, peer_region=None, peer_transit_gateway_id=None, tags=None, transit_gateway_id=None)¶

A collection of values returned by getPeeringAttachment.

peer_account_id = None¶: Identifier of the peer AWS account

peer_region = None¶: Identifier of the peer AWS region

peer_transit_gateway_id = None¶: Identifier of the peer EC2 Transit Gateway

transit_gateway_id = None¶: Identifier of the local EC2 Transit Gateway

class pulumi_aws.ec2transitgateway.GetRouteTableResult(default_association_route_table=None, default_propagation_route_table=None, filters=None, id=None, tags=None, transit_gateway_id=None)¶

A collection of values returned by getRouteTable.

default_association_route_table = None¶: Boolean whether this is the default association route table for the EC2 Transit Gateway

default_propagation_route_table = None¶: Boolean whether this is the default propagation route table for the EC2 Transit Gateway

id = None¶: EC2 Transit Gateway Route Table identifier

tags = None¶: Key-value tags for the EC2 Transit Gateway Route Table

transit_gateway_id = None¶: EC2 Transit Gateway identifier

class pulumi_aws.ec2transitgateway.GetTransitGatewayResult(amazon_side_asn=None, arn=None, association_default_route_table_id=None, auto_accept_shared_attachments=None, default_route_table_association=None, default_route_table_propagation=None, description=None, dns_support=None, filters=None, id=None, owner_id=None, propagation_default_route_table_id=None, tags=None, vpn_ecmp_support=None)¶

A collection of values returned by getTransitGateway.

amazon_side_asn = None¶: Private Autonomous System Number (ASN) for the Amazon side of a BGP session

arn = None¶: EC2 Transit Gateway Amazon Resource Name (ARN)

association_default_route_table_id = None¶: Identifier of the default association route table

auto_accept_shared_attachments = None¶: Whether resource attachment requests are automatically accepted.

default_route_table_association = None¶: Whether resource attachments are automatically associated with the default association route table.

default_route_table_propagation = None¶: Whether resource attachments automatically propagate routes to the default propagation route table.

description = None¶: Description of the EC2 Transit Gateway

dns_support = None¶: Whether DNS support is enabled.

id = None¶: EC2 Transit Gateway identifier

owner_id = None¶: Identifier of the AWS account that owns the EC2 Transit Gateway

propagation_default_route_table_id = None¶: Identifier of the default propagation route table.

tags = None¶: Key-value tags for the EC2 Transit Gateway

vpn_ecmp_support = None¶: Whether VPN Equal Cost Multipath Protocol support is enabled.

class pulumi_aws.ec2transitgateway.GetVpcAttachmentResult(dns_support=None, filters=None, id=None, ipv6_support=None, subnet_ids=None, tags=None, transit_gateway_id=None, vpc_id=None, vpc_owner_id=None)¶

A collection of values returned by getVpcAttachment.

dns_support = None¶: Whether DNS support is enabled.

id = None¶: EC2 Transit Gateway VPC Attachment identifier

ipv6_support = None¶: Whether IPv6 support is enabled.

subnet_ids = None¶: Identifiers of EC2 Subnets.

tags = None¶: Key-value tags for the EC2 Transit Gateway VPC Attachment

transit_gateway_id = None¶: EC2 Transit Gateway identifier

vpc_id = None¶: Identifier of EC2 VPC.

vpc_owner_id = None¶: Identifier of the AWS account that owns the EC2 VPC.

class pulumi_aws.ec2transitgateway.GetVpnAttachmentResult(filters=None, id=None, tags=None, transit_gateway_id=None, vpn_connection_id=None)¶

A collection of values returned by getVpnAttachment.

id = None¶: The provider-assigned unique ID for this managed resource.

tags = None¶: Key-value tags for the EC2 Transit Gateway VPN Attachment

class pulumi_aws.ec2transitgateway.PeeringAttachment(resource_name, opts=None, peer_account_id=None, peer_region=None, peer_transit_gateway_id=None, tags=None, transit_gateway_id=None, __props__=None, __name__=None, __opts__=None)¶

Manages an EC2 Transit Gateway Peering Attachment. For examples of custom route table association and propagation, see the EC2 Transit Gateway Networking Examples Guide.

import pulumi
import pulumi_aws as aws
import pulumi_pulumi as pulumi

local = pulumi.providers.Aws("local", region="us-east-1")
peer = pulumi.providers.Aws("peer", region="us-west-2")
peer_region = aws.get_region()
local_transit_gateway = aws.ec2transitgateway.TransitGateway("localTransitGateway", tags={
    "Name": "Local TGW",
})
peer_transit_gateway = aws.ec2transitgateway.TransitGateway("peerTransitGateway", tags={
    "Name": "Peer TGW",
})
example = aws.ec2transitgateway.PeeringAttachment("example",
    peer_account_id=peer_transit_gateway.owner_id,
    peer_region=peer_region.name,
    peer_transit_gateway_id=peer_transit_gateway.id,
    transit_gateway_id=local_transit_gateway.id,
    tags={
        "Name": "TGW Peering Requestor",
    })

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
peer_account_id (pulumi.Input[str]) – Account ID of EC2 Transit Gateway to peer with. Defaults to the account ID the current provider is currently connected to.
peer_region (pulumi.Input[str]) – Region of EC2 Transit Gateway to peer with.
peer_transit_gateway_id (pulumi.Input[str]) – Identifier of EC2 Transit Gateway to peer with.
tags (pulumi.Input[dict]) – Key-value tags for the EC2 Transit Gateway Peering Attachment.
transit_gateway_id (pulumi.Input[str]) – Identifier of EC2 Transit Gateway.

peer_account_id: pulumi.Output[str] = None¶: Account ID of EC2 Transit Gateway to peer with. Defaults to the account ID the current provider is currently connected to.

peer_region: pulumi.Output[str] = None¶: Region of EC2 Transit Gateway to peer with.

peer_transit_gateway_id: pulumi.Output[str] = None¶: Identifier of EC2 Transit Gateway to peer with.

tags: pulumi.Output[dict] = None¶: Key-value tags for the EC2 Transit Gateway Peering Attachment.

transit_gateway_id: pulumi.Output[str] = None¶: Identifier of EC2 Transit Gateway.

static get(resource_name, id, opts=None, peer_account_id=None, peer_region=None, peer_transit_gateway_id=None, tags=None, transit_gateway_id=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
peer_account_id (pulumi.Input[str]) – Account ID of EC2 Transit Gateway to peer with. Defaults to the account ID the current provider is currently connected to.
peer_region (pulumi.Input[str]) – Region of EC2 Transit Gateway to peer with.
peer_transit_gateway_id (pulumi.Input[str]) – Identifier of EC2 Transit Gateway to peer with.
tags (pulumi.Input[dict]) – Key-value tags for the EC2 Transit Gateway Peering Attachment.
transit_gateway_id (pulumi.Input[str]) – Identifier of EC2 Transit Gateway.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_aws.ec2transitgateway.Route(resource_name, opts=None, blackhole=None, destination_cidr_block=None, transit_gateway_attachment_id=None, transit_gateway_route_table_id=None, __props__=None, __name__=None, __opts__=None)¶

Manages an EC2 Transit Gateway Route.

import pulumi
import pulumi_aws as aws

example = aws.ec2transitgateway.Route("example",
    destination_cidr_block="0.0.0.0/0",
    transit_gateway_attachment_id=aws_ec2_transit_gateway_vpc_attachment["example"]["id"],
    transit_gateway_route_table_id=aws_ec2_transit_gateway["example"]["association_default_route_table_id"])

import pulumi
import pulumi_aws as aws

example = aws.ec2transitgateway.Route("example",
    blackhole=True,
    destination_cidr_block="0.0.0.0/0",
    transit_gateway_route_table_id=aws_ec2_transit_gateway["example"]["association_default_route_table_id"])

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
blackhole (pulumi.Input[bool]) – Indicates whether to drop traffic that matches this route (default to false).
destination_cidr_block (pulumi.Input[str]) – IPv4 CIDR range used for destination matches. Routing decisions are based on the most specific match.
transit_gateway_attachment_id (pulumi.Input[str]) – Identifier of EC2 Transit Gateway Attachment (required if blackhole is set to false).
transit_gateway_route_table_id (pulumi.Input[str]) – Identifier of EC2 Transit Gateway Route Table.

blackhole: pulumi.Output[bool] = None¶: Indicates whether to drop traffic that matches this route (default to false).

destination_cidr_block: pulumi.Output[str] = None¶: IPv4 CIDR range used for destination matches. Routing decisions are based on the most specific match.

transit_gateway_attachment_id: pulumi.Output[str] = None¶: Identifier of EC2 Transit Gateway Attachment (required if blackhole is set to false).

transit_gateway_route_table_id: pulumi.Output[str] = None¶: Identifier of EC2 Transit Gateway Route Table.

static get(resource_name, id, opts=None, blackhole=None, destination_cidr_block=None, transit_gateway_attachment_id=None, transit_gateway_route_table_id=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
blackhole (pulumi.Input[bool]) – Indicates whether to drop traffic that matches this route (default to false).
destination_cidr_block (pulumi.Input[str]) – IPv4 CIDR range used for destination matches. Routing decisions are based on the most specific match.
transit_gateway_attachment_id (pulumi.Input[str]) – Identifier of EC2 Transit Gateway Attachment (required if blackhole is set to false).
transit_gateway_route_table_id (pulumi.Input[str]) – Identifier of EC2 Transit Gateway Route Table.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_aws.ec2transitgateway.RouteTable(resource_name, opts=None, tags=None, transit_gateway_id=None, __props__=None, __name__=None, __opts__=None)¶

Manages an EC2 Transit Gateway Route Table.

import pulumi
import pulumi_aws as aws

example = aws.ec2transitgateway.RouteTable("example", transit_gateway_id=aws_ec2_transit_gateway["example"]["id"])

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
tags (pulumi.Input[dict]) – Key-value tags for the EC2 Transit Gateway Route Table.
transit_gateway_id (pulumi.Input[str]) – Identifier of EC2 Transit Gateway.

default_association_route_table: pulumi.Output[bool] = None¶: Boolean whether this is the default association route table for the EC2 Transit Gateway.

default_propagation_route_table: pulumi.Output[bool] = None¶: Boolean whether this is the default propagation route table for the EC2 Transit Gateway.

tags: pulumi.Output[dict] = None¶: Key-value tags for the EC2 Transit Gateway Route Table.

transit_gateway_id: pulumi.Output[str] = None¶: Identifier of EC2 Transit Gateway.

static get(resource_name, id, opts=None, default_association_route_table=None, default_propagation_route_table=None, tags=None, transit_gateway_id=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
default_association_route_table (pulumi.Input[bool]) – Boolean whether this is the default association route table for the EC2 Transit Gateway.
default_propagation_route_table (pulumi.Input[bool]) – Boolean whether this is the default propagation route table for the EC2 Transit Gateway.
tags (pulumi.Input[dict]) – Key-value tags for the EC2 Transit Gateway Route Table.
transit_gateway_id (pulumi.Input[str]) – Identifier of EC2 Transit Gateway.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_aws.ec2transitgateway.RouteTableAssociation(resource_name, opts=None, transit_gateway_attachment_id=None, transit_gateway_route_table_id=None, __props__=None, __name__=None, __opts__=None)¶

Manages an EC2 Transit Gateway Route Table association.

import pulumi
import pulumi_aws as aws

example = aws.ec2transitgateway.RouteTableAssociation("example",
    transit_gateway_attachment_id=aws_ec2_transit_gateway_vpc_attachment["example"]["id"],
    transit_gateway_route_table_id=aws_ec2_transit_gateway_route_table["example"]["id"])

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
transit_gateway_attachment_id (pulumi.Input[str]) – Identifier of EC2 Transit Gateway Attachment.
transit_gateway_route_table_id (pulumi.Input[str]) – Identifier of EC2 Transit Gateway Route Table.

resource_id: pulumi.Output[str] = None¶: Identifier of the resource

resource_type: pulumi.Output[str] = None¶: Type of the resource

transit_gateway_attachment_id: pulumi.Output[str] = None¶: Identifier of EC2 Transit Gateway Attachment.

transit_gateway_route_table_id: pulumi.Output[str] = None¶: Identifier of EC2 Transit Gateway Route Table.

static get(resource_name, id, opts=None, resource_id=None, resource_type=None, transit_gateway_attachment_id=None, transit_gateway_route_table_id=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
resource_id (pulumi.Input[str]) – Identifier of the resource
resource_type (pulumi.Input[str]) – Type of the resource
transit_gateway_attachment_id (pulumi.Input[str]) – Identifier of EC2 Transit Gateway Attachment.
transit_gateway_route_table_id (pulumi.Input[str]) – Identifier of EC2 Transit Gateway Route Table.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_aws.ec2transitgateway.RouteTablePropagation(resource_name, opts=None, transit_gateway_attachment_id=None, transit_gateway_route_table_id=None, __props__=None, __name__=None, __opts__=None)¶

Manages an EC2 Transit Gateway Route Table propagation.

import pulumi
import pulumi_aws as aws

example = aws.ec2transitgateway.RouteTablePropagation("example",
    transit_gateway_attachment_id=aws_ec2_transit_gateway_vpc_attachment["example"]["id"],
    transit_gateway_route_table_id=aws_ec2_transit_gateway_route_table["example"]["id"])

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
transit_gateway_attachment_id (pulumi.Input[str]) – Identifier of EC2 Transit Gateway Attachment.
transit_gateway_route_table_id (pulumi.Input[str]) – Identifier of EC2 Transit Gateway Route Table.

resource_id: pulumi.Output[str] = None¶: Identifier of the resource

resource_type: pulumi.Output[str] = None¶: Type of the resource

transit_gateway_attachment_id: pulumi.Output[str] = None¶: Identifier of EC2 Transit Gateway Attachment.

transit_gateway_route_table_id: pulumi.Output[str] = None¶: Identifier of EC2 Transit Gateway Route Table.

static get(resource_name, id, opts=None, resource_id=None, resource_type=None, transit_gateway_attachment_id=None, transit_gateway_route_table_id=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
resource_id (pulumi.Input[str]) – Identifier of the resource
resource_type (pulumi.Input[str]) – Type of the resource
transit_gateway_attachment_id (pulumi.Input[str]) – Identifier of EC2 Transit Gateway Attachment.
transit_gateway_route_table_id (pulumi.Input[str]) – Identifier of EC2 Transit Gateway Route Table.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_aws.ec2transitgateway.TransitGateway(resource_name, opts=None, amazon_side_asn=None, auto_accept_shared_attachments=None, default_route_table_association=None, default_route_table_propagation=None, description=None, dns_support=None, tags=None, vpn_ecmp_support=None, __props__=None, __name__=None, __opts__=None)¶

Manages an EC2 Transit Gateway.

import pulumi
import pulumi_aws as aws

example = aws.ec2transitgateway.TransitGateway("example", description="example")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
amazon_side_asn (pulumi.Input[float]) – Private Autonomous System Number (ASN) for the Amazon side of a BGP session. The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs. Default value: 64512.
auto_accept_shared_attachments (pulumi.Input[str]) – Whether resource attachment requests are automatically accepted. Valid values: disable, enable. Default value: disable.
default_route_table_association (pulumi.Input[str]) – Whether resource attachments are automatically associated with the default association route table. Valid values: disable, enable. Default value: enable.
default_route_table_propagation (pulumi.Input[str]) – Whether resource attachments automatically propagate routes to the default propagation route table. Valid values: disable, enable. Default value: enable.
description (pulumi.Input[str]) – Description of the EC2 Transit Gateway.
dns_support (pulumi.Input[str]) – Whether DNS support is enabled. Valid values: disable, enable. Default value: enable.
tags (pulumi.Input[dict]) – Key-value tags for the EC2 Transit Gateway.
vpn_ecmp_support (pulumi.Input[str]) – Whether VPN Equal Cost Multipath Protocol support is enabled. Valid values: disable, enable. Default value: enable.

amazon_side_asn: pulumi.Output[float] = None¶: Private Autonomous System Number (ASN) for the Amazon side of a BGP session. The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs. Default value: 64512.

arn: pulumi.Output[str] = None¶: EC2 Transit Gateway Amazon Resource Name (ARN)

association_default_route_table_id: pulumi.Output[str] = None¶: Identifier of the default association route table

auto_accept_shared_attachments: pulumi.Output[str] = None¶: Whether resource attachment requests are automatically accepted. Valid values: disable, enable. Default value: disable.

default_route_table_association: pulumi.Output[str] = None¶: Whether resource attachments are automatically associated with the default association route table. Valid values: disable, enable. Default value: enable.

default_route_table_propagation: pulumi.Output[str] = None¶: Whether resource attachments automatically propagate routes to the default propagation route table. Valid values: disable, enable. Default value: enable.

description: pulumi.Output[str] = None¶: Description of the EC2 Transit Gateway.

dns_support: pulumi.Output[str] = None¶: Whether DNS support is enabled. Valid values: disable, enable. Default value: enable.

owner_id: pulumi.Output[str] = None¶: Identifier of the AWS account that owns the EC2 Transit Gateway

propagation_default_route_table_id: pulumi.Output[str] = None¶: Identifier of the default propagation route table

tags: pulumi.Output[dict] = None¶: Key-value tags for the EC2 Transit Gateway.

vpn_ecmp_support: pulumi.Output[str] = None¶: Whether VPN Equal Cost Multipath Protocol support is enabled. Valid values: disable, enable. Default value: enable.

static get(resource_name, id, opts=None, amazon_side_asn=None, arn=None, association_default_route_table_id=None, auto_accept_shared_attachments=None, default_route_table_association=None, default_route_table_propagation=None, description=None, dns_support=None, owner_id=None, propagation_default_route_table_id=None, tags=None, vpn_ecmp_support=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
amazon_side_asn (pulumi.Input[float]) – Private Autonomous System Number (ASN) for the Amazon side of a BGP session. The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs. Default value: 64512.
arn (pulumi.Input[str]) – EC2 Transit Gateway Amazon Resource Name (ARN)
association_default_route_table_id (pulumi.Input[str]) – Identifier of the default association route table
auto_accept_shared_attachments (pulumi.Input[str]) – Whether resource attachment requests are automatically accepted. Valid values: disable, enable. Default value: disable.
default_route_table_association (pulumi.Input[str]) – Whether resource attachments are automatically associated with the default association route table. Valid values: disable, enable. Default value: enable.
default_route_table_propagation (pulumi.Input[str]) – Whether resource attachments automatically propagate routes to the default propagation route table. Valid values: disable, enable. Default value: enable.
description (pulumi.Input[str]) – Description of the EC2 Transit Gateway.
dns_support (pulumi.Input[str]) – Whether DNS support is enabled. Valid values: disable, enable. Default value: enable.
owner_id (pulumi.Input[str]) – Identifier of the AWS account that owns the EC2 Transit Gateway
propagation_default_route_table_id (pulumi.Input[str]) – Identifier of the default propagation route table
tags (pulumi.Input[dict]) – Key-value tags for the EC2 Transit Gateway.
vpn_ecmp_support (pulumi.Input[str]) – Whether VPN Equal Cost Multipath Protocol support is enabled. Valid values: disable, enable. Default value: enable.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_aws.ec2transitgateway.VpcAttachment(resource_name, opts=None, dns_support=None, ipv6_support=None, subnet_ids=None, tags=None, transit_gateway_default_route_table_association=None, transit_gateway_default_route_table_propagation=None, transit_gateway_id=None, vpc_id=None, __props__=None, __name__=None, __opts__=None)¶

Manages an EC2 Transit Gateway VPC Attachment. For examples of custom route table association and propagation, see the EC2 Transit Gateway Networking Examples Guide.

import pulumi
import pulumi_aws as aws

example = aws.ec2transitgateway.VpcAttachment("example",
    subnet_ids=[aws_subnet["example"]["id"]],
    transit_gateway_id=aws_ec2_transit_gateway["example"]["id"],
    vpc_id=aws_vpc["example"]["id"])

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
dns_support (pulumi.Input[str]) – Whether DNS support is enabled. Valid values: disable, enable. Default value: enable.
ipv6_support (pulumi.Input[str]) – Whether IPv6 support is enabled. Valid values: disable, enable. Default value: disable.
subnet_ids (pulumi.Input[list]) – Identifiers of EC2 Subnets.
tags (pulumi.Input[dict]) – Key-value tags for the EC2 Transit Gateway VPC Attachment.
transit_gateway_default_route_table_association (pulumi.Input[bool]) – Boolean whether the VPC Attachment should be associated with the EC2 Transit Gateway association default route table. This cannot be configured or perform drift detection with Resource Access Manager shared EC2 Transit Gateways. Default value: true.
transit_gateway_default_route_table_propagation (pulumi.Input[bool]) – Boolean whether the VPC Attachment should propagate routes with the EC2 Transit Gateway propagation default route table. This cannot be configured or perform drift detection with Resource Access Manager shared EC2 Transit Gateways. Default value: true.
transit_gateway_id (pulumi.Input[str]) – Identifier of EC2 Transit Gateway.
vpc_id (pulumi.Input[str]) – Identifier of EC2 VPC.

dns_support: pulumi.Output[str] = None¶: Whether DNS support is enabled. Valid values: disable, enable. Default value: enable.

ipv6_support: pulumi.Output[str] = None¶: Whether IPv6 support is enabled. Valid values: disable, enable. Default value: disable.

subnet_ids: pulumi.Output[list] = None¶: Identifiers of EC2 Subnets.

tags: pulumi.Output[dict] = None¶: Key-value tags for the EC2 Transit Gateway VPC Attachment.

transit_gateway_default_route_table_association: pulumi.Output[bool] = None¶: Boolean whether the VPC Attachment should be associated with the EC2 Transit Gateway association default route table. This cannot be configured or perform drift detection with Resource Access Manager shared EC2 Transit Gateways. Default value: true.

transit_gateway_default_route_table_propagation: pulumi.Output[bool] = None¶: Boolean whether the VPC Attachment should propagate routes with the EC2 Transit Gateway propagation default route table. This cannot be configured or perform drift detection with Resource Access Manager shared EC2 Transit Gateways. Default value: true.

transit_gateway_id: pulumi.Output[str] = None¶: Identifier of EC2 Transit Gateway.

vpc_id: pulumi.Output[str] = None¶: Identifier of EC2 VPC.

vpc_owner_id: pulumi.Output[str] = None¶: Identifier of the AWS account that owns the EC2 VPC.

static get(resource_name, id, opts=None, dns_support=None, ipv6_support=None, subnet_ids=None, tags=None, transit_gateway_default_route_table_association=None, transit_gateway_default_route_table_propagation=None, transit_gateway_id=None, vpc_id=None, vpc_owner_id=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
dns_support (pulumi.Input[str]) – Whether DNS support is enabled. Valid values: disable, enable. Default value: enable.
ipv6_support (pulumi.Input[str]) – Whether IPv6 support is enabled. Valid values: disable, enable. Default value: disable.
subnet_ids (pulumi.Input[list]) – Identifiers of EC2 Subnets.
tags (pulumi.Input[dict]) – Key-value tags for the EC2 Transit Gateway VPC Attachment.
transit_gateway_default_route_table_association (pulumi.Input[bool]) – Boolean whether the VPC Attachment should be associated with the EC2 Transit Gateway association default route table. This cannot be configured or perform drift detection with Resource Access Manager shared EC2 Transit Gateways. Default value: true.
transit_gateway_default_route_table_propagation (pulumi.Input[bool]) – Boolean whether the VPC Attachment should propagate routes with the EC2 Transit Gateway propagation default route table. This cannot be configured or perform drift detection with Resource Access Manager shared EC2 Transit Gateways. Default value: true.
transit_gateway_id (pulumi.Input[str]) – Identifier of EC2 Transit Gateway.
vpc_id (pulumi.Input[str]) – Identifier of EC2 VPC.
vpc_owner_id (pulumi.Input[str]) – Identifier of the AWS account that owns the EC2 VPC.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_aws.ec2transitgateway.VpcAttachmentAccepter(resource_name, opts=None, tags=None, transit_gateway_attachment_id=None, transit_gateway_default_route_table_association=None, transit_gateway_default_route_table_propagation=None, __props__=None, __name__=None, __opts__=None)¶

Manages the accepter’s side of an EC2 Transit Gateway VPC Attachment.

When a cross-account (requester’s AWS account differs from the accepter’s AWS account) EC2 Transit Gateway VPC Attachment is created, an EC2 Transit Gateway VPC Attachment resource is automatically created in the accepter’s account. The requester can use the ec2transitgateway.VpcAttachment resource to manage its side of the connection and the accepter can use the ec2transitgateway.VpcAttachmentAccepter resource to “adopt” its side of the connection into management.

import pulumi
import pulumi_aws as aws

example = aws.ec2transitgateway.VpcAttachmentAccepter("example",
    tags={
        "Name": "Example cross-account attachment",
    },
    transit_gateway_attachment_id=aws_ec2_transit_gateway_vpc_attachment["example"]["id"])

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
tags (pulumi.Input[dict]) – Key-value tags for the EC2 Transit Gateway VPC Attachment.
transit_gateway_attachment_id (pulumi.Input[str]) – The ID of the EC2 Transit Gateway Attachment to manage.
transit_gateway_default_route_table_association (pulumi.Input[bool]) – Boolean whether the VPC Attachment should be associated with the EC2 Transit Gateway association default route table. Default value: true.
transit_gateway_default_route_table_propagation (pulumi.Input[bool]) – Boolean whether the VPC Attachment should propagate routes with the EC2 Transit Gateway propagation default route table. Default value: true.

dns_support: pulumi.Output[str] = None¶: Whether DNS support is enabled. Valid values: disable, enable.

ipv6_support: pulumi.Output[str] = None¶: Whether IPv6 support is enabled. Valid values: disable, enable.

subnet_ids: pulumi.Output[list] = None¶: Identifiers of EC2 Subnets.

tags: pulumi.Output[dict] = None¶: Key-value tags for the EC2 Transit Gateway VPC Attachment.

transit_gateway_attachment_id: pulumi.Output[str] = None¶: The ID of the EC2 Transit Gateway Attachment to manage.

transit_gateway_default_route_table_association: pulumi.Output[bool] = None¶: Boolean whether the VPC Attachment should be associated with the EC2 Transit Gateway association default route table. Default value: true.

transit_gateway_default_route_table_propagation: pulumi.Output[bool] = None¶: Boolean whether the VPC Attachment should propagate routes with the EC2 Transit Gateway propagation default route table. Default value: true.

transit_gateway_id: pulumi.Output[str] = None¶: Identifier of EC2 Transit Gateway.

vpc_id: pulumi.Output[str] = None¶: Identifier of EC2 VPC.

vpc_owner_id: pulumi.Output[str] = None¶: Identifier of the AWS account that owns the EC2 VPC.

static get(resource_name, id, opts=None, dns_support=None, ipv6_support=None, subnet_ids=None, tags=None, transit_gateway_attachment_id=None, transit_gateway_default_route_table_association=None, transit_gateway_default_route_table_propagation=None, transit_gateway_id=None, vpc_id=None, vpc_owner_id=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
dns_support (pulumi.Input[str]) – Whether DNS support is enabled. Valid values: disable, enable.
ipv6_support (pulumi.Input[str]) – Whether IPv6 support is enabled. Valid values: disable, enable.
subnet_ids (pulumi.Input[list]) – Identifiers of EC2 Subnets.
tags (pulumi.Input[dict]) – Key-value tags for the EC2 Transit Gateway VPC Attachment.
transit_gateway_attachment_id (pulumi.Input[str]) – The ID of the EC2 Transit Gateway Attachment to manage.
transit_gateway_default_route_table_association (pulumi.Input[bool]) – Boolean whether the VPC Attachment should be associated with the EC2 Transit Gateway association default route table. Default value: true.
transit_gateway_default_route_table_propagation (pulumi.Input[bool]) – Boolean whether the VPC Attachment should propagate routes with the EC2 Transit Gateway propagation default route table. Default value: true.
transit_gateway_id (pulumi.Input[str]) – Identifier of EC2 Transit Gateway.
vpc_id (pulumi.Input[str]) – Identifier of EC2 VPC.
vpc_owner_id (pulumi.Input[str]) – Identifier of the AWS account that owns the EC2 VPC.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

pulumi_aws.ec2transitgateway.get_direct_connect_gateway_attachment(dx_gateway_id=None, filters=None, tags=None, transit_gateway_id=None, opts=None)¶

Get information on an EC2 Transit Gateway’s attachment to a Direct Connect Gateway.

import pulumi
import pulumi_aws as aws

example = aws.ec2transitgateway.get_direct_connect_gateway_attachment(dx_gateway_id=aws_dx_gateway["example"]["id"],
    transit_gateway_id=aws_ec2_transit_gateway["example"]["id"])

Parameters

dx_gateway_id (str) – Identifier of the Direct Connect Gateway.
filters (list) – Configuration block(s) for filtering. Detailed below.
tags (dict) – A map of tags, each pair of which must exactly match a pair on the desired Transit Gateway Direct Connect Gateway Attachment.
transit_gateway_id (str) – Identifier of the EC2 Transit Gateway.

The filters object supports the following:

name (str) - The name of the filter field. Valid values can be found in the EC2 DescribeTransitGatewayAttachments API Reference.
values (list) - Set of values that are accepted for the given filter field. Results will be selected if any given value matches.

pulumi_aws.ec2transitgateway.get_peering_attachment(filters=None, id=None, tags=None, opts=None)¶

Get information on an EC2 Transit Gateway Peering Attachment.

import pulumi
import pulumi_aws as aws

example = aws.ec2transitgateway.get_peering_attachment(filters=[{
    "name": "transit-gateway-attachment-id",
    "values": ["tgw-attach-12345678"],
}])

import pulumi
import pulumi_aws as aws

attachment = aws.ec2transitgateway.get_peering_attachment(id="tgw-attach-12345678")

Parameters

filters (list) – One or more configuration blocks containing name-values filters. Detailed below.
id (str) – Identifier of the EC2 Transit Gateway Peering Attachment.
tags (dict) – A mapping of tags, each pair of which must exactly match a pair on the specific EC2 Transit Gateway Peering Attachment to retrieve.

The filters object supports the following:

name (str) - The name of the field to filter by, as defined by the underlying AWS API.
values (list) - Set of values that are accepted for the given field. An EC2 Transit Gateway Peering Attachment be selected if any one of the given values matches.

pulumi_aws.ec2transitgateway.get_route_table(filters=None, id=None, tags=None, opts=None)¶

Get information on an EC2 Transit Gateway Route Table.

import pulumi
import pulumi_aws as aws

example = aws.ec2transitgateway.get_route_table(filters=[
    {
        "name": "default-association-route-table",
        "values": ["true"],
    },
    {
        "name": "transit-gateway-id",
        "values": ["tgw-12345678"],
    },
])

import pulumi
import pulumi_aws as aws

example = aws.ec2transitgateway.get_route_table(id="tgw-rtb-12345678")

Parameters

filters (list) – One or more configuration blocks containing name-values filters. Detailed below.
id (str) – Identifier of the EC2 Transit Gateway Route Table.
tags (dict) – Key-value tags for the EC2 Transit Gateway Route Table

The filters object supports the following:

name (str) - Name of the filter.
values (list) - List of one or more values for the filter.

pulumi_aws.ec2transitgateway.get_transit_gateway(filters=None, id=None, tags=None, opts=None)¶

Get information on an EC2 Transit Gateway.

import pulumi
import pulumi_aws as aws

example = aws.ec2transitgateway.get_transit_gateway(filters=[{
    "name": "options.amazon-side-asn",
    "values": ["64512"],
}])

import pulumi
import pulumi_aws as aws

example = aws.ec2transitgateway.get_transit_gateway(id="tgw-12345678")

Parameters

filters (list) – One or more configuration blocks containing name-values filters. Detailed below.
id (str) – Identifier of the EC2 Transit Gateway.
tags (dict) – Key-value tags for the EC2 Transit Gateway

The filters object supports the following:

name (str) - Name of the filter.
values (list) - List of one or more values for the filter.

pulumi_aws.ec2transitgateway.get_vpc_attachment(filters=None, id=None, tags=None, opts=None)¶

Get information on an EC2 Transit Gateway VPC Attachment.

import pulumi
import pulumi_aws as aws

example = aws.ec2transitgateway.get_vpc_attachment(filters=[{
    "name": "vpc-id",
    "values": ["vpc-12345678"],
}])

import pulumi
import pulumi_aws as aws

example = aws.ec2transitgateway.get_vpc_attachment(id="tgw-attach-12345678")

Parameters

filters (list) – One or more configuration blocks containing name-values filters. Detailed below.
id (str) – Identifier of the EC2 Transit Gateway VPC Attachment.
tags (dict) – Key-value tags for the EC2 Transit Gateway VPC Attachment

The filters object supports the following:

name (str) - Name of the filter.
values (list) - List of one or more values for the filter.

pulumi_aws.ec2transitgateway.get_vpn_attachment(filters=None, tags=None, transit_gateway_id=None, vpn_connection_id=None, opts=None)¶

Get information on an EC2 Transit Gateway VPN Attachment.

import pulumi
import pulumi_aws as aws

example = aws.ec2transitgateway.get_vpn_attachment(transit_gateway_id=aws_ec2_transit_gateway["example"]["id"],
    vpn_connection_id=aws_vpn_connection["example"]["id"])

import pulumi
import pulumi_aws as aws

test = aws.ec2transitgateway.get_vpn_attachment(filters=[{
    "name": "resource-id",
    "values": ["some-resource"],
}])

Parameters

filters (list) – Configuration block(s) for filtering. Detailed below.
tags (dict) – A map of tags, each pair of which must exactly match a pair on the desired Transit Gateway VPN Attachment.
transit_gateway_id (str) – Identifier of the EC2 Transit Gateway.
vpn_connection_id (str) – Identifier of the EC2 VPN Connection.

The filters object supports the following:

name (str) - The name of the filter field. Valid values can be found in the EC2 DescribeTransitGatewayAttachments API Reference.
values (list) - Set of values that are accepted for the given filter field. Results will be selected if any given value matches.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

ec2transitgateway¶

On This Page