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

aviatrix.AviatrixAwsTgwTransitGatewayAttachment

Explore with Pulumi AI

The aviatrix_aws_tgw_transit_gateway_attachment resource manages the attachment of the Aviatrix transit gateway to the AWS TGW.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    // Create an Aviatrix AWS TGW Transit Gateway Attachment
    var testTransitGatewayAttachment = new Aviatrix.AviatrixAwsTgwTransitGatewayAttachment("testTransitGatewayAttachment", new()
    {
        Region = "us-east-1",
        TgwName = "test-tgw",
        TransitGatewayName = "transit-gw-1",
        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.NewAviatrixAwsTgwTransitGatewayAttachment(ctx, "testTransitGatewayAttachment", &aviatrix.AviatrixAwsTgwTransitGatewayAttachmentArgs{
			Region:             pulumi.String("us-east-1"),
			TgwName:            pulumi.String("test-tgw"),
			TransitGatewayName: pulumi.String("transit-gw-1"),
			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.AviatrixAwsTgwTransitGatewayAttachment;
import com.pulumi.aviatrix.AviatrixAwsTgwTransitGatewayAttachmentArgs;
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 testTransitGatewayAttachment = new AviatrixAwsTgwTransitGatewayAttachment("testTransitGatewayAttachment", AviatrixAwsTgwTransitGatewayAttachmentArgs.builder()        
            .region("us-east-1")
            .tgwName("test-tgw")
            .transitGatewayName("transit-gw-1")
            .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 Transit Gateway Attachment
const testTransitGatewayAttachment = new aviatrix.AviatrixAwsTgwTransitGatewayAttachment("test_transit_gateway_attachment", {
    region: "us-east-1",
    tgwName: "test-tgw",
    transitGatewayName: "transit-gw-1",
    vpcAccountName: "test-account",
    vpcId: "vpc-0e2fac2b91c6697b3",
});
Copy
import pulumi
import pulumi_aviatrix as aviatrix

# Create an Aviatrix AWS TGW Transit Gateway Attachment
test_transit_gateway_attachment = aviatrix.AviatrixAwsTgwTransitGatewayAttachment("testTransitGatewayAttachment",
    region="us-east-1",
    tgw_name="test-tgw",
    transit_gateway_name="transit-gw-1",
    vpc_account_name="test-account",
    vpc_id="vpc-0e2fac2b91c6697b3")
Copy
resources:
  # Create an Aviatrix AWS TGW Transit Gateway Attachment
  testTransitGatewayAttachment:
    type: aviatrix:AviatrixAwsTgwTransitGatewayAttachment
    properties:
      region: us-east-1
      tgwName: test-tgw
      transitGatewayName: transit-gw-1
      vpcAccountName: test-account
      vpcId: vpc-0e2fac2b91c6697b3
Copy

Create AviatrixAwsTgwTransitGatewayAttachment Resource

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

Constructor syntax

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

@overload
def AviatrixAwsTgwTransitGatewayAttachment(resource_name: str,
                                           opts: Optional[ResourceOptions] = None,
                                           region: Optional[str] = None,
                                           tgw_name: Optional[str] = None,
                                           transit_gateway_name: Optional[str] = None,
                                           vpc_account_name: Optional[str] = None,
                                           vpc_id: Optional[str] = None)
func NewAviatrixAwsTgwTransitGatewayAttachment(ctx *Context, name string, args AviatrixAwsTgwTransitGatewayAttachmentArgs, opts ...ResourceOption) (*AviatrixAwsTgwTransitGatewayAttachment, error)
public AviatrixAwsTgwTransitGatewayAttachment(string name, AviatrixAwsTgwTransitGatewayAttachmentArgs args, CustomResourceOptions? opts = null)
public AviatrixAwsTgwTransitGatewayAttachment(String name, AviatrixAwsTgwTransitGatewayAttachmentArgs args)
public AviatrixAwsTgwTransitGatewayAttachment(String name, AviatrixAwsTgwTransitGatewayAttachmentArgs args, CustomResourceOptions options)
type: aviatrix:AviatrixAwsTgwTransitGatewayAttachment
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. AviatrixAwsTgwTransitGatewayAttachmentArgs
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. AviatrixAwsTgwTransitGatewayAttachmentArgs
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. AviatrixAwsTgwTransitGatewayAttachmentArgs
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. AviatrixAwsTgwTransitGatewayAttachmentArgs
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. AviatrixAwsTgwTransitGatewayAttachmentArgs
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 aviatrixAwsTgwTransitGatewayAttachmentResource = new Aviatrix.AviatrixAwsTgwTransitGatewayAttachment("aviatrixAwsTgwTransitGatewayAttachmentResource", new()
{
    Region = "string",
    TgwName = "string",
    TransitGatewayName = "string",
    VpcAccountName = "string",
    VpcId = "string",
});
Copy
example, err := aviatrix.NewAviatrixAwsTgwTransitGatewayAttachment(ctx, "aviatrixAwsTgwTransitGatewayAttachmentResource", &aviatrix.AviatrixAwsTgwTransitGatewayAttachmentArgs{
	Region:             pulumi.String("string"),
	TgwName:            pulumi.String("string"),
	TransitGatewayName: pulumi.String("string"),
	VpcAccountName:     pulumi.String("string"),
	VpcId:              pulumi.String("string"),
})
Copy
var aviatrixAwsTgwTransitGatewayAttachmentResource = new AviatrixAwsTgwTransitGatewayAttachment("aviatrixAwsTgwTransitGatewayAttachmentResource", AviatrixAwsTgwTransitGatewayAttachmentArgs.builder()
    .region("string")
    .tgwName("string")
    .transitGatewayName("string")
    .vpcAccountName("string")
    .vpcId("string")
    .build());
Copy
aviatrix_aws_tgw_transit_gateway_attachment_resource = aviatrix.AviatrixAwsTgwTransitGatewayAttachment("aviatrixAwsTgwTransitGatewayAttachmentResource",
    region="string",
    tgw_name="string",
    transit_gateway_name="string",
    vpc_account_name="string",
    vpc_id="string")
Copy
const aviatrixAwsTgwTransitGatewayAttachmentResource = new aviatrix.AviatrixAwsTgwTransitGatewayAttachment("aviatrixAwsTgwTransitGatewayAttachmentResource", {
    region: "string",
    tgwName: "string",
    transitGatewayName: "string",
    vpcAccountName: "string",
    vpcId: "string",
});
Copy
type: aviatrix:AviatrixAwsTgwTransitGatewayAttachment
properties:
    region: string
    tgwName: string
    transitGatewayName: string
    vpcAccountName: string
    vpcId: string
Copy

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

Region
This property is required.
Changes to this property will trigger replacement.
string
AWS Region of the TGW.
TgwName
This property is required.
Changes to this property will trigger replacement.
string
Name of the AWS TGW.
TransitGatewayName
This property is required.
Changes to this property will trigger replacement.
string
Name of the transit gateway to be attached to the AWS TGW.
VpcAccountName
This property is required.
Changes to this property will trigger replacement.
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, where transit gateway is launched.
Region
This property is required.
Changes to this property will trigger replacement.
string
AWS Region of the TGW.
TgwName
This property is required.
Changes to this property will trigger replacement.
string
Name of the AWS TGW.
TransitGatewayName
This property is required.
Changes to this property will trigger replacement.
string
Name of the transit gateway to be attached to the AWS TGW.
VpcAccountName
This property is required.
Changes to this property will trigger replacement.
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, where transit gateway is launched.
region
This property is required.
Changes to this property will trigger replacement.
String
AWS Region of the TGW.
tgwName
This property is required.
Changes to this property will trigger replacement.
String
Name of the AWS TGW.
transitGatewayName
This property is required.
Changes to this property will trigger replacement.
String
Name of the transit gateway to be attached to the AWS TGW.
vpcAccountName
This property is required.
Changes to this property will trigger replacement.
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, where transit gateway is launched.
region
This property is required.
Changes to this property will trigger replacement.
string
AWS Region of the TGW.
tgwName
This property is required.
Changes to this property will trigger replacement.
string
Name of the AWS TGW.
transitGatewayName
This property is required.
Changes to this property will trigger replacement.
string
Name of the transit gateway to be attached to the AWS TGW.
vpcAccountName
This property is required.
Changes to this property will trigger replacement.
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, where transit gateway is launched.
region
This property is required.
Changes to this property will trigger replacement.
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.
transit_gateway_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the transit gateway to be attached to the AWS TGW.
vpc_account_name
This property is required.
Changes to this property will trigger replacement.
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, where transit gateway is launched.
region
This property is required.
Changes to this property will trigger replacement.
String
AWS Region of the TGW.
tgwName
This property is required.
Changes to this property will trigger replacement.
String
Name of the AWS TGW.
transitGatewayName
This property is required.
Changes to this property will trigger replacement.
String
Name of the transit gateway to be attached to the AWS TGW.
vpcAccountName
This property is required.
Changes to this property will trigger replacement.
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, where transit gateway is launched.

Outputs

All input properties are implicitly available as output properties. Additionally, the AviatrixAwsTgwTransitGatewayAttachment 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 AviatrixAwsTgwTransitGatewayAttachment Resource

Get an existing AviatrixAwsTgwTransitGatewayAttachment 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?: AviatrixAwsTgwTransitGatewayAttachmentState, opts?: CustomResourceOptions): AviatrixAwsTgwTransitGatewayAttachment
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        region: Optional[str] = None,
        tgw_name: Optional[str] = None,
        transit_gateway_name: Optional[str] = None,
        vpc_account_name: Optional[str] = None,
        vpc_id: Optional[str] = None) -> AviatrixAwsTgwTransitGatewayAttachment
func GetAviatrixAwsTgwTransitGatewayAttachment(ctx *Context, name string, id IDInput, state *AviatrixAwsTgwTransitGatewayAttachmentState, opts ...ResourceOption) (*AviatrixAwsTgwTransitGatewayAttachment, error)
public static AviatrixAwsTgwTransitGatewayAttachment Get(string name, Input<string> id, AviatrixAwsTgwTransitGatewayAttachmentState? state, CustomResourceOptions? opts = null)
public static AviatrixAwsTgwTransitGatewayAttachment get(String name, Output<String> id, AviatrixAwsTgwTransitGatewayAttachmentState state, CustomResourceOptions options)
resources:  _:    type: aviatrix:AviatrixAwsTgwTransitGatewayAttachment    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:
Region Changes to this property will trigger replacement. string
AWS Region of the TGW.
TgwName Changes to this property will trigger replacement. string
Name of the AWS TGW.
TransitGatewayName Changes to this property will trigger replacement. string
Name of the transit gateway to be attached to the AWS TGW.
VpcAccountName Changes to this property will trigger replacement. 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, where transit gateway is launched.
Region Changes to this property will trigger replacement. string
AWS Region of the TGW.
TgwName Changes to this property will trigger replacement. string
Name of the AWS TGW.
TransitGatewayName Changes to this property will trigger replacement. string
Name of the transit gateway to be attached to the AWS TGW.
VpcAccountName Changes to this property will trigger replacement. 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, where transit gateway is launched.
region Changes to this property will trigger replacement. String
AWS Region of the TGW.
tgwName Changes to this property will trigger replacement. String
Name of the AWS TGW.
transitGatewayName Changes to this property will trigger replacement. String
Name of the transit gateway to be attached to the AWS TGW.
vpcAccountName Changes to this property will trigger replacement. 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, where transit gateway is launched.
region Changes to this property will trigger replacement. string
AWS Region of the TGW.
tgwName Changes to this property will trigger replacement. string
Name of the AWS TGW.
transitGatewayName Changes to this property will trigger replacement. string
Name of the transit gateway to be attached to the AWS TGW.
vpcAccountName Changes to this property will trigger replacement. 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, where transit gateway is launched.
region Changes to this property will trigger replacement. str
AWS Region of the TGW.
tgw_name Changes to this property will trigger replacement. str
Name of the AWS TGW.
transit_gateway_name Changes to this property will trigger replacement. str
Name of the transit gateway to be attached to the AWS TGW.
vpc_account_name Changes to this property will trigger replacement. 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, where transit gateway is launched.
region Changes to this property will trigger replacement. String
AWS Region of the TGW.
tgwName Changes to this property will trigger replacement. String
Name of the AWS TGW.
transitGatewayName Changes to this property will trigger replacement. String
Name of the transit gateway to be attached to the AWS TGW.
vpcAccountName Changes to this property will trigger replacement. 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, where transit gateway is launched.

Import

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

 $ pulumi import aviatrix:index/aviatrixAwsTgwTransitGatewayAttachment:AviatrixAwsTgwTransitGatewayAttachment test tgw_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.