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

aviatrix logo
Aviatrix v0.0.11 published on Saturday, Jun 17, 2023 by Aviatrix

    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",
        });
    
    });
    
    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
    	})
    }
    
    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());
    
        }
    }
    
    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")
    
    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",
    });
    
    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
    

    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 string
    The unique name of the resource.
    args AviatrixAwsTgwTransitGatewayAttachmentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args 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 string
    The unique name of the resource.
    args AviatrixAwsTgwTransitGatewayAttachmentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AviatrixAwsTgwTransitGatewayAttachmentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args 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",
    });
    
    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"),
    })
    
    var aviatrixAwsTgwTransitGatewayAttachmentResource = new AviatrixAwsTgwTransitGatewayAttachment("aviatrixAwsTgwTransitGatewayAttachmentResource", AviatrixAwsTgwTransitGatewayAttachmentArgs.builder()
        .region("string")
        .tgwName("string")
        .transitGatewayName("string")
        .vpcAccountName("string")
        .vpcId("string")
        .build());
    
    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")
    
    const aviatrixAwsTgwTransitGatewayAttachmentResource = new aviatrix.AviatrixAwsTgwTransitGatewayAttachment("aviatrixAwsTgwTransitGatewayAttachmentResource", {
        region: "string",
        tgwName: "string",
        transitGatewayName: "string",
        vpcAccountName: "string",
        vpcId: "string",
    });
    
    type: aviatrix:AviatrixAwsTgwTransitGatewayAttachment
    properties:
        region: string
        tgwName: string
        transitGatewayName: string
        vpcAccountName: string
        vpcId: string
    

    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 string
    AWS Region of the TGW.
    TgwName string
    Name of the AWS TGW.
    TransitGatewayName string
    Name of the transit gateway to be attached to the AWS TGW.
    VpcAccountName string
    The name of the cloud account in the Aviatrix controller, which is associated with the VPC.
    VpcId string
    VPC ID of the VPC, where transit gateway is launched.
    Region string
    AWS Region of the TGW.
    TgwName string
    Name of the AWS TGW.
    TransitGatewayName string
    Name of the transit gateway to be attached to the AWS TGW.
    VpcAccountName string
    The name of the cloud account in the Aviatrix controller, which is associated with the VPC.
    VpcId string
    VPC ID of the VPC, where transit gateway is launched.
    region String
    AWS Region of the TGW.
    tgwName String
    Name of the AWS TGW.
    transitGatewayName String
    Name of the transit gateway to be attached to the AWS TGW.
    vpcAccountName String
    The name of the cloud account in the Aviatrix controller, which is associated with the VPC.
    vpcId String
    VPC ID of the VPC, where transit gateway is launched.
    region string
    AWS Region of the TGW.
    tgwName string
    Name of the AWS TGW.
    transitGatewayName string
    Name of the transit gateway to be attached to the AWS TGW.
    vpcAccountName string
    The name of the cloud account in the Aviatrix controller, which is associated with the VPC.
    vpcId string
    VPC ID of the VPC, where transit gateway is launched.
    region str
    AWS Region of the TGW.
    tgw_name str
    Name of the AWS TGW.
    transit_gateway_name str
    Name of the transit gateway to be attached to 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 str
    VPC ID of the VPC, where transit gateway is launched.
    region String
    AWS Region of the TGW.
    tgwName String
    Name of the AWS TGW.
    transitGatewayName String
    Name of the transit gateway to be attached to the AWS TGW.
    vpcAccountName String
    The name of the cloud account in the Aviatrix controller, which is associated with the VPC.
    vpcId 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)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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 string
    AWS Region of the TGW.
    TgwName string
    Name of the AWS TGW.
    TransitGatewayName string
    Name of the transit gateway to be attached to the AWS TGW.
    VpcAccountName string
    The name of the cloud account in the Aviatrix controller, which is associated with the VPC.
    VpcId string
    VPC ID of the VPC, where transit gateway is launched.
    Region string
    AWS Region of the TGW.
    TgwName string
    Name of the AWS TGW.
    TransitGatewayName string
    Name of the transit gateway to be attached to the AWS TGW.
    VpcAccountName string
    The name of the cloud account in the Aviatrix controller, which is associated with the VPC.
    VpcId string
    VPC ID of the VPC, where transit gateway is launched.
    region String
    AWS Region of the TGW.
    tgwName String
    Name of the AWS TGW.
    transitGatewayName String
    Name of the transit gateway to be attached to the AWS TGW.
    vpcAccountName String
    The name of the cloud account in the Aviatrix controller, which is associated with the VPC.
    vpcId String
    VPC ID of the VPC, where transit gateway is launched.
    region string
    AWS Region of the TGW.
    tgwName string
    Name of the AWS TGW.
    transitGatewayName string
    Name of the transit gateway to be attached to the AWS TGW.
    vpcAccountName string
    The name of the cloud account in the Aviatrix controller, which is associated with the VPC.
    vpcId string
    VPC ID of the VPC, where transit gateway is launched.
    region str
    AWS Region of the TGW.
    tgw_name str
    Name of the AWS TGW.
    transit_gateway_name str
    Name of the transit gateway to be attached to 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 str
    VPC ID of the VPC, where transit gateway is launched.
    region String
    AWS Region of the TGW.
    tgwName String
    Name of the AWS TGW.
    transitGatewayName String
    Name of the transit gateway to be attached to the AWS TGW.
    vpcAccountName String
    The name of the cloud account in the Aviatrix controller, which is associated with the VPC.
    vpcId 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
    

    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.
    aviatrix logo
    Aviatrix v0.0.11 published on Saturday, Jun 17, 2023 by Aviatrix