1. Packages
  2. Aviatrix
  3. API Docs
  4. AviatrixAwsTgwVpcAttachment
Aviatrix v0.0.11 published on Saturday, Jun 17, 2023 by Aviatrix

aviatrix.AviatrixAwsTgwVpcAttachment

Explore with Pulumi AI

The aviatrix_aws_tgw_vpc_attachment resource manages the attaching & detaching of the VPC to & from an AWS TGW, and FireNet Gateway to TGW Firewall Domain.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Aviatrix = Pulumi.Aviatrix;

return await Deployment.RunAsync(() => 
{
    // Create an Aviatrix AWS TGW VPC Attachment
    var testAwsTgwVpcAttachment = new Aviatrix.AviatrixAwsTgwVpcAttachment("testAwsTgwVpcAttachment", new()
    {
        NetworkDomainName = "my-ndn",
        Region = "us-east-1",
        TgwName = "test-tgw",
        VpcAccountName = "test-account",
        VpcId = "vpc-0e2fac2b91c6697b3",
    });

});
Copy
package main

import (
	"github.com/astipkovits/pulumi-aviatrix/sdk/go/aviatrix"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := aviatrix.NewAviatrixAwsTgwVpcAttachment(ctx, "testAwsTgwVpcAttachment", &aviatrix.AviatrixAwsTgwVpcAttachmentArgs{
			NetworkDomainName: pulumi.String("my-ndn"),
			Region:            pulumi.String("us-east-1"),
			TgwName:           pulumi.String("test-tgw"),
			VpcAccountName:    pulumi.String("test-account"),
			VpcId:             pulumi.String("vpc-0e2fac2b91c6697b3"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aviatrix.AviatrixAwsTgwVpcAttachment;
import com.pulumi.aviatrix.AviatrixAwsTgwVpcAttachmentArgs;
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 testAwsTgwVpcAttachment = new AviatrixAwsTgwVpcAttachment("testAwsTgwVpcAttachment", AviatrixAwsTgwVpcAttachmentArgs.builder()        
            .networkDomainName("my-ndn")
            .region("us-east-1")
            .tgwName("test-tgw")
            .vpcAccountName("test-account")
            .vpcId("vpc-0e2fac2b91c6697b3")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as aviatrix from "@pulumi/aviatrix";

// Create an Aviatrix AWS TGW VPC Attachment
const testAwsTgwVpcAttachment = new aviatrix.AviatrixAwsTgwVpcAttachment("test_aws_tgw_vpc_attachment", {
    networkDomainName: "my-ndn",
    region: "us-east-1",
    tgwName: "test-tgw",
    vpcAccountName: "test-account",
    vpcId: "vpc-0e2fac2b91c6697b3",
});
Copy
import pulumi
import pulumi_aviatrix as aviatrix

# Create an Aviatrix AWS TGW VPC Attachment
test_aws_tgw_vpc_attachment = aviatrix.AviatrixAwsTgwVpcAttachment("testAwsTgwVpcAttachment",
    network_domain_name="my-ndn",
    region="us-east-1",
    tgw_name="test-tgw",
    vpc_account_name="test-account",
    vpc_id="vpc-0e2fac2b91c6697b3")
Copy
resources:
  # Create an Aviatrix AWS TGW VPC Attachment
  testAwsTgwVpcAttachment:
    type: aviatrix:AviatrixAwsTgwVpcAttachment
    properties:
      networkDomainName: my-ndn
      region: us-east-1
      tgwName: test-tgw
      vpcAccountName: test-account
      vpcId: vpc-0e2fac2b91c6697b3
Copy

Create AviatrixAwsTgwVpcAttachment Resource

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

Constructor syntax

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

@overload
def AviatrixAwsTgwVpcAttachment(resource_name: str,
                                opts: Optional[ResourceOptions] = None,
                                region: Optional[str] = None,
                                tgw_name: Optional[str] = None,
                                vpc_account_name: Optional[str] = None,
                                vpc_id: Optional[str] = None,
                                customized_route_advertisement: Optional[str] = None,
                                customized_routes: Optional[str] = None,
                                disable_local_route_propagation: Optional[bool] = None,
                                edge_attachment: Optional[str] = None,
                                network_domain_name: Optional[str] = None,
                                route_tables: Optional[str] = None,
                                security_domain_name: Optional[str] = None,
                                subnets: Optional[str] = None)
func NewAviatrixAwsTgwVpcAttachment(ctx *Context, name string, args AviatrixAwsTgwVpcAttachmentArgs, opts ...ResourceOption) (*AviatrixAwsTgwVpcAttachment, error)
public AviatrixAwsTgwVpcAttachment(string name, AviatrixAwsTgwVpcAttachmentArgs args, CustomResourceOptions? opts = null)
public AviatrixAwsTgwVpcAttachment(String name, AviatrixAwsTgwVpcAttachmentArgs args)
public AviatrixAwsTgwVpcAttachment(String name, AviatrixAwsTgwVpcAttachmentArgs args, CustomResourceOptions options)
type: aviatrix:AviatrixAwsTgwVpcAttachment
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. AviatrixAwsTgwVpcAttachmentArgs
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. AviatrixAwsTgwVpcAttachmentArgs
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. AviatrixAwsTgwVpcAttachmentArgs
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. AviatrixAwsTgwVpcAttachmentArgs
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. AviatrixAwsTgwVpcAttachmentArgs
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 aviatrixAwsTgwVpcAttachmentResource = new Aviatrix.AviatrixAwsTgwVpcAttachment("aviatrixAwsTgwVpcAttachmentResource", new()
{
    Region = "string",
    TgwName = "string",
    VpcAccountName = "string",
    VpcId = "string",
    CustomizedRouteAdvertisement = "string",
    CustomizedRoutes = "string",
    DisableLocalRoutePropagation = false,
    EdgeAttachment = "string",
    NetworkDomainName = "string",
    RouteTables = "string",
    Subnets = "string",
});
Copy
example, err := aviatrix.NewAviatrixAwsTgwVpcAttachment(ctx, "aviatrixAwsTgwVpcAttachmentResource", &aviatrix.AviatrixAwsTgwVpcAttachmentArgs{
	Region:                       pulumi.String("string"),
	TgwName:                      pulumi.String("string"),
	VpcAccountName:               pulumi.String("string"),
	VpcId:                        pulumi.String("string"),
	CustomizedRouteAdvertisement: pulumi.String("string"),
	CustomizedRoutes:             pulumi.String("string"),
	DisableLocalRoutePropagation: pulumi.Bool(false),
	EdgeAttachment:               pulumi.String("string"),
	NetworkDomainName:            pulumi.String("string"),
	RouteTables:                  pulumi.String("string"),
	Subnets:                      pulumi.String("string"),
})
Copy
var aviatrixAwsTgwVpcAttachmentResource = new AviatrixAwsTgwVpcAttachment("aviatrixAwsTgwVpcAttachmentResource", AviatrixAwsTgwVpcAttachmentArgs.builder()
    .region("string")
    .tgwName("string")
    .vpcAccountName("string")
    .vpcId("string")
    .customizedRouteAdvertisement("string")
    .customizedRoutes("string")
    .disableLocalRoutePropagation(false)
    .edgeAttachment("string")
    .networkDomainName("string")
    .routeTables("string")
    .subnets("string")
    .build());
Copy
aviatrix_aws_tgw_vpc_attachment_resource = aviatrix.AviatrixAwsTgwVpcAttachment("aviatrixAwsTgwVpcAttachmentResource",
    region="string",
    tgw_name="string",
    vpc_account_name="string",
    vpc_id="string",
    customized_route_advertisement="string",
    customized_routes="string",
    disable_local_route_propagation=False,
    edge_attachment="string",
    network_domain_name="string",
    route_tables="string",
    subnets="string")
Copy
const aviatrixAwsTgwVpcAttachmentResource = new aviatrix.AviatrixAwsTgwVpcAttachment("aviatrixAwsTgwVpcAttachmentResource", {
    region: "string",
    tgwName: "string",
    vpcAccountName: "string",
    vpcId: "string",
    customizedRouteAdvertisement: "string",
    customizedRoutes: "string",
    disableLocalRoutePropagation: false,
    edgeAttachment: "string",
    networkDomainName: "string",
    routeTables: "string",
    subnets: "string",
});
Copy
type: aviatrix:AviatrixAwsTgwVpcAttachment
properties:
    customizedRouteAdvertisement: string
    customizedRoutes: string
    disableLocalRoutePropagation: false
    edgeAttachment: string
    networkDomainName: string
    region: string
    routeTables: string
    subnets: string
    tgwName: string
    vpcAccountName: string
    vpcId: string
Copy

AviatrixAwsTgwVpcAttachment 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 AviatrixAwsTgwVpcAttachment resource accepts the following input properties:

Region This property is required. string
AWS Region of the TGW.
TgwName
This property is required.
Changes to this property will trigger replacement.
string
Name of the AWS TGW.
VpcAccountName This property is required. string
The name of the cloud account in the Aviatrix controller, which is associated with the VPC.
VpcId
This property is required.
Changes to this property will trigger replacement.
string
VPC ID of the VPC to be attached to the specified security_domain_name.
CustomizedRouteAdvertisement string
Advanced option. Customized route(s) to be advertised to other VPCs that are connected to the same TGW. Example: "10.8.0.0/16,10.9.0.0/16,10.10.0.0/16".
CustomizedRoutes string
Advanced option. Customized Spoke VPC Routes. It allows the admin to enter non-RFC1918 routes in the VPC route table targeting the TGW. Example: "10.8.0.0/16,10.9.0.0/16,10.10.0.0/16".
DisableLocalRoutePropagation Changes to this property will trigger replacement. bool
Advanced option. If set to true, it disables automatic route propagation of this VPC to other VPCs within the same security domain. Valid values: true, false. Default value: false.
EdgeAttachment string
Advanced option. To allow access to the private IP of the MGMT interface of the Firewalls, set this attribute to enable Management Access From Onprem. This feature advertises the Firewalls private MGMT subnet to your Edge domain. Example: "vpn-0068bb31917ff2289".
NetworkDomainName Changes to this property will trigger replacement. string
The name of the network domain, to which the VPC will be attached to. If changed, the VPC will be detached from the old domain, and attached to the new domain.
RouteTables Changes to this property will trigger replacement. string
Advanced option. Route tables separated by ',' to participate in TGW Orchestrator, i.e., learned routes will be propagated to these route tables. Example: "rtb-212ff547,rtb-045397874c170c745".
SecurityDomainName Changes to this property will trigger replacement. string
The name of the security domain, to which the VPC will be attached to. If changed, the VPC will be detached from the old domain, and attached to the new domain.

Deprecated: Please use network_domain_name instead.

Subnets Changes to this property will trigger replacement. string
Advanced option. VPC subnets separated by ',' to attach to the VPC. If left blank, Aviatrix Controller automatically selects a subnet representing each AZ for the VPC attachment.
Region This property is required. string
AWS Region of the TGW.
TgwName
This property is required.
Changes to this property will trigger replacement.
string
Name of the AWS TGW.
VpcAccountName This property is required. string
The name of the cloud account in the Aviatrix controller, which is associated with the VPC.
VpcId
This property is required.
Changes to this property will trigger replacement.
string
VPC ID of the VPC to be attached to the specified security_domain_name.
CustomizedRouteAdvertisement string
Advanced option. Customized route(s) to be advertised to other VPCs that are connected to the same TGW. Example: "10.8.0.0/16,10.9.0.0/16,10.10.0.0/16".
CustomizedRoutes string
Advanced option. Customized Spoke VPC Routes. It allows the admin to enter non-RFC1918 routes in the VPC route table targeting the TGW. Example: "10.8.0.0/16,10.9.0.0/16,10.10.0.0/16".
DisableLocalRoutePropagation Changes to this property will trigger replacement. bool
Advanced option. If set to true, it disables automatic route propagation of this VPC to other VPCs within the same security domain. Valid values: true, false. Default value: false.
EdgeAttachment string
Advanced option. To allow access to the private IP of the MGMT interface of the Firewalls, set this attribute to enable Management Access From Onprem. This feature advertises the Firewalls private MGMT subnet to your Edge domain. Example: "vpn-0068bb31917ff2289".
NetworkDomainName Changes to this property will trigger replacement. string
The name of the network domain, to which the VPC will be attached to. If changed, the VPC will be detached from the old domain, and attached to the new domain.
RouteTables Changes to this property will trigger replacement. string
Advanced option. Route tables separated by ',' to participate in TGW Orchestrator, i.e., learned routes will be propagated to these route tables. Example: "rtb-212ff547,rtb-045397874c170c745".
SecurityDomainName Changes to this property will trigger replacement. string
The name of the security domain, to which the VPC will be attached to. If changed, the VPC will be detached from the old domain, and attached to the new domain.

Deprecated: Please use network_domain_name instead.

Subnets Changes to this property will trigger replacement. string
Advanced option. VPC subnets separated by ',' to attach to the VPC. If left blank, Aviatrix Controller automatically selects a subnet representing each AZ for the VPC attachment.
region This property is required. String
AWS Region of the TGW.
tgwName
This property is required.
Changes to this property will trigger replacement.
String
Name of the AWS TGW.
vpcAccountName This property is required. String
The name of the cloud account in the Aviatrix controller, which is associated with the VPC.
vpcId
This property is required.
Changes to this property will trigger replacement.
String
VPC ID of the VPC to be attached to the specified security_domain_name.
customizedRouteAdvertisement String
Advanced option. Customized route(s) to be advertised to other VPCs that are connected to the same TGW. Example: "10.8.0.0/16,10.9.0.0/16,10.10.0.0/16".
customizedRoutes String
Advanced option. Customized Spoke VPC Routes. It allows the admin to enter non-RFC1918 routes in the VPC route table targeting the TGW. Example: "10.8.0.0/16,10.9.0.0/16,10.10.0.0/16".
disableLocalRoutePropagation Changes to this property will trigger replacement. Boolean
Advanced option. If set to true, it disables automatic route propagation of this VPC to other VPCs within the same security domain. Valid values: true, false. Default value: false.
edgeAttachment String
Advanced option. To allow access to the private IP of the MGMT interface of the Firewalls, set this attribute to enable Management Access From Onprem. This feature advertises the Firewalls private MGMT subnet to your Edge domain. Example: "vpn-0068bb31917ff2289".
networkDomainName Changes to this property will trigger replacement. String
The name of the network domain, to which the VPC will be attached to. If changed, the VPC will be detached from the old domain, and attached to the new domain.
routeTables Changes to this property will trigger replacement. String
Advanced option. Route tables separated by ',' to participate in TGW Orchestrator, i.e., learned routes will be propagated to these route tables. Example: "rtb-212ff547,rtb-045397874c170c745".
securityDomainName Changes to this property will trigger replacement. String
The name of the security domain, to which the VPC will be attached to. If changed, the VPC will be detached from the old domain, and attached to the new domain.

Deprecated: Please use network_domain_name instead.

subnets Changes to this property will trigger replacement. String
Advanced option. VPC subnets separated by ',' to attach to the VPC. If left blank, Aviatrix Controller automatically selects a subnet representing each AZ for the VPC attachment.
region This property is required. string
AWS Region of the TGW.
tgwName
This property is required.
Changes to this property will trigger replacement.
string
Name of the AWS TGW.
vpcAccountName This property is required. string
The name of the cloud account in the Aviatrix controller, which is associated with the VPC.
vpcId
This property is required.
Changes to this property will trigger replacement.
string
VPC ID of the VPC to be attached to the specified security_domain_name.
customizedRouteAdvertisement string
Advanced option. Customized route(s) to be advertised to other VPCs that are connected to the same TGW. Example: "10.8.0.0/16,10.9.0.0/16,10.10.0.0/16".
customizedRoutes string
Advanced option. Customized Spoke VPC Routes. It allows the admin to enter non-RFC1918 routes in the VPC route table targeting the TGW. Example: "10.8.0.0/16,10.9.0.0/16,10.10.0.0/16".
disableLocalRoutePropagation Changes to this property will trigger replacement. boolean
Advanced option. If set to true, it disables automatic route propagation of this VPC to other VPCs within the same security domain. Valid values: true, false. Default value: false.
edgeAttachment string
Advanced option. To allow access to the private IP of the MGMT interface of the Firewalls, set this attribute to enable Management Access From Onprem. This feature advertises the Firewalls private MGMT subnet to your Edge domain. Example: "vpn-0068bb31917ff2289".
networkDomainName Changes to this property will trigger replacement. string
The name of the network domain, to which the VPC will be attached to. If changed, the VPC will be detached from the old domain, and attached to the new domain.
routeTables Changes to this property will trigger replacement. string
Advanced option. Route tables separated by ',' to participate in TGW Orchestrator, i.e., learned routes will be propagated to these route tables. Example: "rtb-212ff547,rtb-045397874c170c745".
securityDomainName Changes to this property will trigger replacement. string
The name of the security domain, to which the VPC will be attached to. If changed, the VPC will be detached from the old domain, and attached to the new domain.

Deprecated: Please use network_domain_name instead.

subnets Changes to this property will trigger replacement. string
Advanced option. VPC subnets separated by ',' to attach to the VPC. If left blank, Aviatrix Controller automatically selects a subnet representing each AZ for the VPC attachment.
region This property is required. str
AWS Region of the TGW.
tgw_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the AWS TGW.
vpc_account_name This property is required. str
The name of the cloud account in the Aviatrix controller, which is associated with the VPC.
vpc_id
This property is required.
Changes to this property will trigger replacement.
str
VPC ID of the VPC to be attached to the specified security_domain_name.
customized_route_advertisement str
Advanced option. Customized route(s) to be advertised to other VPCs that are connected to the same TGW. Example: "10.8.0.0/16,10.9.0.0/16,10.10.0.0/16".
customized_routes str
Advanced option. Customized Spoke VPC Routes. It allows the admin to enter non-RFC1918 routes in the VPC route table targeting the TGW. Example: "10.8.0.0/16,10.9.0.0/16,10.10.0.0/16".
disable_local_route_propagation Changes to this property will trigger replacement. bool
Advanced option. If set to true, it disables automatic route propagation of this VPC to other VPCs within the same security domain. Valid values: true, false. Default value: false.
edge_attachment str
Advanced option. To allow access to the private IP of the MGMT interface of the Firewalls, set this attribute to enable Management Access From Onprem. This feature advertises the Firewalls private MGMT subnet to your Edge domain. Example: "vpn-0068bb31917ff2289".
network_domain_name Changes to this property will trigger replacement. str
The name of the network domain, to which the VPC will be attached to. If changed, the VPC will be detached from the old domain, and attached to the new domain.
route_tables Changes to this property will trigger replacement. str
Advanced option. Route tables separated by ',' to participate in TGW Orchestrator, i.e., learned routes will be propagated to these route tables. Example: "rtb-212ff547,rtb-045397874c170c745".
security_domain_name Changes to this property will trigger replacement. str
The name of the security domain, to which the VPC will be attached to. If changed, the VPC will be detached from the old domain, and attached to the new domain.

Deprecated: Please use network_domain_name instead.

subnets Changes to this property will trigger replacement. str
Advanced option. VPC subnets separated by ',' to attach to the VPC. If left blank, Aviatrix Controller automatically selects a subnet representing each AZ for the VPC attachment.
region This property is required. String
AWS Region of the TGW.
tgwName
This property is required.
Changes to this property will trigger replacement.
String
Name of the AWS TGW.
vpcAccountName This property is required. String
The name of the cloud account in the Aviatrix controller, which is associated with the VPC.
vpcId
This property is required.
Changes to this property will trigger replacement.
String
VPC ID of the VPC to be attached to the specified security_domain_name.
customizedRouteAdvertisement String
Advanced option. Customized route(s) to be advertised to other VPCs that are connected to the same TGW. Example: "10.8.0.0/16,10.9.0.0/16,10.10.0.0/16".
customizedRoutes String
Advanced option. Customized Spoke VPC Routes. It allows the admin to enter non-RFC1918 routes in the VPC route table targeting the TGW. Example: "10.8.0.0/16,10.9.0.0/16,10.10.0.0/16".
disableLocalRoutePropagation Changes to this property will trigger replacement. Boolean
Advanced option. If set to true, it disables automatic route propagation of this VPC to other VPCs within the same security domain. Valid values: true, false. Default value: false.
edgeAttachment String
Advanced option. To allow access to the private IP of the MGMT interface of the Firewalls, set this attribute to enable Management Access From Onprem. This feature advertises the Firewalls private MGMT subnet to your Edge domain. Example: "vpn-0068bb31917ff2289".
networkDomainName Changes to this property will trigger replacement. String
The name of the network domain, to which the VPC will be attached to. If changed, the VPC will be detached from the old domain, and attached to the new domain.
routeTables Changes to this property will trigger replacement. String
Advanced option. Route tables separated by ',' to participate in TGW Orchestrator, i.e., learned routes will be propagated to these route tables. Example: "rtb-212ff547,rtb-045397874c170c745".
securityDomainName Changes to this property will trigger replacement. String
The name of the security domain, to which the VPC will be attached to. If changed, the VPC will be detached from the old domain, and attached to the new domain.

Deprecated: Please use network_domain_name instead.

subnets Changes to this property will trigger replacement. String
Advanced option. VPC subnets separated by ',' to attach to the VPC. If left blank, Aviatrix Controller automatically selects a subnet representing each AZ for the VPC attachment.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing AviatrixAwsTgwVpcAttachment Resource

Get an existing AviatrixAwsTgwVpcAttachment 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?: AviatrixAwsTgwVpcAttachmentState, opts?: CustomResourceOptions): AviatrixAwsTgwVpcAttachment
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        customized_route_advertisement: Optional[str] = None,
        customized_routes: Optional[str] = None,
        disable_local_route_propagation: Optional[bool] = None,
        edge_attachment: Optional[str] = None,
        network_domain_name: Optional[str] = None,
        region: Optional[str] = None,
        route_tables: Optional[str] = None,
        security_domain_name: Optional[str] = None,
        subnets: Optional[str] = None,
        tgw_name: Optional[str] = None,
        vpc_account_name: Optional[str] = None,
        vpc_id: Optional[str] = None) -> AviatrixAwsTgwVpcAttachment
func GetAviatrixAwsTgwVpcAttachment(ctx *Context, name string, id IDInput, state *AviatrixAwsTgwVpcAttachmentState, opts ...ResourceOption) (*AviatrixAwsTgwVpcAttachment, error)
public static AviatrixAwsTgwVpcAttachment Get(string name, Input<string> id, AviatrixAwsTgwVpcAttachmentState? state, CustomResourceOptions? opts = null)
public static AviatrixAwsTgwVpcAttachment get(String name, Output<String> id, AviatrixAwsTgwVpcAttachmentState state, CustomResourceOptions options)
resources:  _:    type: aviatrix:AviatrixAwsTgwVpcAttachment    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:
CustomizedRouteAdvertisement string
Advanced option. Customized route(s) to be advertised to other VPCs that are connected to the same TGW. Example: "10.8.0.0/16,10.9.0.0/16,10.10.0.0/16".
CustomizedRoutes string
Advanced option. Customized Spoke VPC Routes. It allows the admin to enter non-RFC1918 routes in the VPC route table targeting the TGW. Example: "10.8.0.0/16,10.9.0.0/16,10.10.0.0/16".
DisableLocalRoutePropagation Changes to this property will trigger replacement. bool
Advanced option. If set to true, it disables automatic route propagation of this VPC to other VPCs within the same security domain. Valid values: true, false. Default value: false.
EdgeAttachment string
Advanced option. To allow access to the private IP of the MGMT interface of the Firewalls, set this attribute to enable Management Access From Onprem. This feature advertises the Firewalls private MGMT subnet to your Edge domain. Example: "vpn-0068bb31917ff2289".
NetworkDomainName Changes to this property will trigger replacement. string
The name of the network domain, to which the VPC will be attached to. If changed, the VPC will be detached from the old domain, and attached to the new domain.
Region string
AWS Region of the TGW.
RouteTables Changes to this property will trigger replacement. string
Advanced option. Route tables separated by ',' to participate in TGW Orchestrator, i.e., learned routes will be propagated to these route tables. Example: "rtb-212ff547,rtb-045397874c170c745".
SecurityDomainName Changes to this property will trigger replacement. string
The name of the security domain, to which the VPC will be attached to. If changed, the VPC will be detached from the old domain, and attached to the new domain.

Deprecated: Please use network_domain_name instead.

Subnets Changes to this property will trigger replacement. string
Advanced option. VPC subnets separated by ',' to attach to the VPC. If left blank, Aviatrix Controller automatically selects a subnet representing each AZ for the VPC attachment.
TgwName Changes to this property will trigger replacement. string
Name of the AWS TGW.
VpcAccountName string
The name of the cloud account in the Aviatrix controller, which is associated with the VPC.
VpcId Changes to this property will trigger replacement. string
VPC ID of the VPC to be attached to the specified security_domain_name.
CustomizedRouteAdvertisement string
Advanced option. Customized route(s) to be advertised to other VPCs that are connected to the same TGW. Example: "10.8.0.0/16,10.9.0.0/16,10.10.0.0/16".
CustomizedRoutes string
Advanced option. Customized Spoke VPC Routes. It allows the admin to enter non-RFC1918 routes in the VPC route table targeting the TGW. Example: "10.8.0.0/16,10.9.0.0/16,10.10.0.0/16".
DisableLocalRoutePropagation Changes to this property will trigger replacement. bool
Advanced option. If set to true, it disables automatic route propagation of this VPC to other VPCs within the same security domain. Valid values: true, false. Default value: false.
EdgeAttachment string
Advanced option. To allow access to the private IP of the MGMT interface of the Firewalls, set this attribute to enable Management Access From Onprem. This feature advertises the Firewalls private MGMT subnet to your Edge domain. Example: "vpn-0068bb31917ff2289".
NetworkDomainName Changes to this property will trigger replacement. string
The name of the network domain, to which the VPC will be attached to. If changed, the VPC will be detached from the old domain, and attached to the new domain.
Region string
AWS Region of the TGW.
RouteTables Changes to this property will trigger replacement. string
Advanced option. Route tables separated by ',' to participate in TGW Orchestrator, i.e., learned routes will be propagated to these route tables. Example: "rtb-212ff547,rtb-045397874c170c745".
SecurityDomainName Changes to this property will trigger replacement. string
The name of the security domain, to which the VPC will be attached to. If changed, the VPC will be detached from the old domain, and attached to the new domain.

Deprecated: Please use network_domain_name instead.

Subnets Changes to this property will trigger replacement. string
Advanced option. VPC subnets separated by ',' to attach to the VPC. If left blank, Aviatrix Controller automatically selects a subnet representing each AZ for the VPC attachment.
TgwName Changes to this property will trigger replacement. string
Name of the AWS TGW.
VpcAccountName string
The name of the cloud account in the Aviatrix controller, which is associated with the VPC.
VpcId Changes to this property will trigger replacement. string
VPC ID of the VPC to be attached to the specified security_domain_name.
customizedRouteAdvertisement String
Advanced option. Customized route(s) to be advertised to other VPCs that are connected to the same TGW. Example: "10.8.0.0/16,10.9.0.0/16,10.10.0.0/16".
customizedRoutes String
Advanced option. Customized Spoke VPC Routes. It allows the admin to enter non-RFC1918 routes in the VPC route table targeting the TGW. Example: "10.8.0.0/16,10.9.0.0/16,10.10.0.0/16".
disableLocalRoutePropagation Changes to this property will trigger replacement. Boolean
Advanced option. If set to true, it disables automatic route propagation of this VPC to other VPCs within the same security domain. Valid values: true, false. Default value: false.
edgeAttachment String
Advanced option. To allow access to the private IP of the MGMT interface of the Firewalls, set this attribute to enable Management Access From Onprem. This feature advertises the Firewalls private MGMT subnet to your Edge domain. Example: "vpn-0068bb31917ff2289".
networkDomainName Changes to this property will trigger replacement. String
The name of the network domain, to which the VPC will be attached to. If changed, the VPC will be detached from the old domain, and attached to the new domain.
region String
AWS Region of the TGW.
routeTables Changes to this property will trigger replacement. String
Advanced option. Route tables separated by ',' to participate in TGW Orchestrator, i.e., learned routes will be propagated to these route tables. Example: "rtb-212ff547,rtb-045397874c170c745".
securityDomainName Changes to this property will trigger replacement. String
The name of the security domain, to which the VPC will be attached to. If changed, the VPC will be detached from the old domain, and attached to the new domain.

Deprecated: Please use network_domain_name instead.

subnets Changes to this property will trigger replacement. String
Advanced option. VPC subnets separated by ',' to attach to the VPC. If left blank, Aviatrix Controller automatically selects a subnet representing each AZ for the VPC attachment.
tgwName Changes to this property will trigger replacement. String
Name of the AWS TGW.
vpcAccountName String
The name of the cloud account in the Aviatrix controller, which is associated with the VPC.
vpcId Changes to this property will trigger replacement. String
VPC ID of the VPC to be attached to the specified security_domain_name.
customizedRouteAdvertisement string
Advanced option. Customized route(s) to be advertised to other VPCs that are connected to the same TGW. Example: "10.8.0.0/16,10.9.0.0/16,10.10.0.0/16".
customizedRoutes string
Advanced option. Customized Spoke VPC Routes. It allows the admin to enter non-RFC1918 routes in the VPC route table targeting the TGW. Example: "10.8.0.0/16,10.9.0.0/16,10.10.0.0/16".
disableLocalRoutePropagation Changes to this property will trigger replacement. boolean
Advanced option. If set to true, it disables automatic route propagation of this VPC to other VPCs within the same security domain. Valid values: true, false. Default value: false.
edgeAttachment string
Advanced option. To allow access to the private IP of the MGMT interface of the Firewalls, set this attribute to enable Management Access From Onprem. This feature advertises the Firewalls private MGMT subnet to your Edge domain. Example: "vpn-0068bb31917ff2289".
networkDomainName Changes to this property will trigger replacement. string
The name of the network domain, to which the VPC will be attached to. If changed, the VPC will be detached from the old domain, and attached to the new domain.
region string
AWS Region of the TGW.
routeTables Changes to this property will trigger replacement. string
Advanced option. Route tables separated by ',' to participate in TGW Orchestrator, i.e., learned routes will be propagated to these route tables. Example: "rtb-212ff547,rtb-045397874c170c745".
securityDomainName Changes to this property will trigger replacement. string
The name of the security domain, to which the VPC will be attached to. If changed, the VPC will be detached from the old domain, and attached to the new domain.

Deprecated: Please use network_domain_name instead.

subnets Changes to this property will trigger replacement. string
Advanced option. VPC subnets separated by ',' to attach to the VPC. If left blank, Aviatrix Controller automatically selects a subnet representing each AZ for the VPC attachment.
tgwName Changes to this property will trigger replacement. string
Name of the AWS TGW.
vpcAccountName string
The name of the cloud account in the Aviatrix controller, which is associated with the VPC.
vpcId Changes to this property will trigger replacement. string
VPC ID of the VPC to be attached to the specified security_domain_name.
customized_route_advertisement str
Advanced option. Customized route(s) to be advertised to other VPCs that are connected to the same TGW. Example: "10.8.0.0/16,10.9.0.0/16,10.10.0.0/16".
customized_routes str
Advanced option. Customized Spoke VPC Routes. It allows the admin to enter non-RFC1918 routes in the VPC route table targeting the TGW. Example: "10.8.0.0/16,10.9.0.0/16,10.10.0.0/16".
disable_local_route_propagation Changes to this property will trigger replacement. bool
Advanced option. If set to true, it disables automatic route propagation of this VPC to other VPCs within the same security domain. Valid values: true, false. Default value: false.
edge_attachment str
Advanced option. To allow access to the private IP of the MGMT interface of the Firewalls, set this attribute to enable Management Access From Onprem. This feature advertises the Firewalls private MGMT subnet to your Edge domain. Example: "vpn-0068bb31917ff2289".
network_domain_name Changes to this property will trigger replacement. str
The name of the network domain, to which the VPC will be attached to. If changed, the VPC will be detached from the old domain, and attached to the new domain.
region str
AWS Region of the TGW.
route_tables Changes to this property will trigger replacement. str
Advanced option. Route tables separated by ',' to participate in TGW Orchestrator, i.e., learned routes will be propagated to these route tables. Example: "rtb-212ff547,rtb-045397874c170c745".
security_domain_name Changes to this property will trigger replacement. str
The name of the security domain, to which the VPC will be attached to. If changed, the VPC will be detached from the old domain, and attached to the new domain.

Deprecated: Please use network_domain_name instead.

subnets Changes to this property will trigger replacement. str
Advanced option. VPC subnets separated by ',' to attach to the VPC. If left blank, Aviatrix Controller automatically selects a subnet representing each AZ for the VPC attachment.
tgw_name Changes to this property will trigger replacement. str
Name of the AWS TGW.
vpc_account_name str
The name of the cloud account in the Aviatrix controller, which is associated with the VPC.
vpc_id Changes to this property will trigger replacement. str
VPC ID of the VPC to be attached to the specified security_domain_name.
customizedRouteAdvertisement String
Advanced option. Customized route(s) to be advertised to other VPCs that are connected to the same TGW. Example: "10.8.0.0/16,10.9.0.0/16,10.10.0.0/16".
customizedRoutes String
Advanced option. Customized Spoke VPC Routes. It allows the admin to enter non-RFC1918 routes in the VPC route table targeting the TGW. Example: "10.8.0.0/16,10.9.0.0/16,10.10.0.0/16".
disableLocalRoutePropagation Changes to this property will trigger replacement. Boolean
Advanced option. If set to true, it disables automatic route propagation of this VPC to other VPCs within the same security domain. Valid values: true, false. Default value: false.
edgeAttachment String
Advanced option. To allow access to the private IP of the MGMT interface of the Firewalls, set this attribute to enable Management Access From Onprem. This feature advertises the Firewalls private MGMT subnet to your Edge domain. Example: "vpn-0068bb31917ff2289".
networkDomainName Changes to this property will trigger replacement. String
The name of the network domain, to which the VPC will be attached to. If changed, the VPC will be detached from the old domain, and attached to the new domain.
region String
AWS Region of the TGW.
routeTables Changes to this property will trigger replacement. String
Advanced option. Route tables separated by ',' to participate in TGW Orchestrator, i.e., learned routes will be propagated to these route tables. Example: "rtb-212ff547,rtb-045397874c170c745".
securityDomainName Changes to this property will trigger replacement. String
The name of the security domain, to which the VPC will be attached to. If changed, the VPC will be detached from the old domain, and attached to the new domain.

Deprecated: Please use network_domain_name instead.

subnets Changes to this property will trigger replacement. String
Advanced option. VPC subnets separated by ',' to attach to the VPC. If left blank, Aviatrix Controller automatically selects a subnet representing each AZ for the VPC attachment.
tgwName Changes to this property will trigger replacement. String
Name of the AWS TGW.
vpcAccountName String
The name of the cloud account in the Aviatrix controller, which is associated with the VPC.
vpcId Changes to this property will trigger replacement. String
VPC ID of the VPC to be attached to the specified security_domain_name.

Import

aws_tgw_vpc_attachment can be imported using the tgw_name, security_domain_name and vpc_id, e.g.

 $ pulumi import aviatrix:index/aviatrixAwsTgwVpcAttachment:AviatrixAwsTgwVpcAttachment test tgw_name~security_domain_name~vpc_id
Copy

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

Package Details

Repository
aviatrix astipkovits/pulumi-aviatrix
License
Apache-2.0
Notes
This Pulumi package is based on the aviatrix Terraform Provider.