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

aviatrix.AviatrixAwsTgwConnect

Explore with Pulumi AI

The aviatrix_aws_tgw_connect resource allows the creation and management of AWS TGW Connect connections. To create and manage TGW Connect peers, please use aviatrix.AviatrixAwsTgwConnectPeer resources. This resource is available as of provider version R2.18.1+.

NOTE: Before creating an AWS TGW Connect, the AWS TGW must have an attached VPC via the aviatrix.AviatrixAwsTgwVpcAttachment resource. Also, the AWS TGW must have configured CIDRs via the aviatrix.AviatrixAwsTgw cidrs attribute.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    // Create an Aviatrix AWS TGW Connect
    var testAwsTgwConnect = new Aviatrix.AviatrixAwsTgwConnect("testAwsTgwConnect", new()
    {
        TgwName = aviatrix_aws_tgw.Test_aws_tgw.Tgw_name,
        ConnectionName = "aws-tgw-connect",
        TransportVpcId = aviatrix_aws_tgw_vpc_attachment.Test_aws_tgw_vpc_attachment.Vpc_id,
        NetworkDomainName = aviatrix_aws_tgw_vpc_attachment.Test_aws_tgw_vpc_attachment.Network_domain_name,
    });

});
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.NewAviatrixAwsTgwConnect(ctx, "testAwsTgwConnect", &aviatrix.AviatrixAwsTgwConnectArgs{
			TgwName:           pulumi.Any(aviatrix_aws_tgw.Test_aws_tgw.Tgw_name),
			ConnectionName:    pulumi.String("aws-tgw-connect"),
			TransportVpcId:    pulumi.Any(aviatrix_aws_tgw_vpc_attachment.Test_aws_tgw_vpc_attachment.Vpc_id),
			NetworkDomainName: pulumi.Any(aviatrix_aws_tgw_vpc_attachment.Test_aws_tgw_vpc_attachment.Network_domain_name),
		})
		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.AviatrixAwsTgwConnect;
import com.pulumi.aviatrix.AviatrixAwsTgwConnectArgs;
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 testAwsTgwConnect = new AviatrixAwsTgwConnect("testAwsTgwConnect", AviatrixAwsTgwConnectArgs.builder()        
            .tgwName(aviatrix_aws_tgw.test_aws_tgw().tgw_name())
            .connectionName("aws-tgw-connect")
            .transportVpcId(aviatrix_aws_tgw_vpc_attachment.test_aws_tgw_vpc_attachment().vpc_id())
            .networkDomainName(aviatrix_aws_tgw_vpc_attachment.test_aws_tgw_vpc_attachment().network_domain_name())
            .build());

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

// Create an Aviatrix AWS TGW Connect
const testAwsTgwConnect = new aviatrix.AviatrixAwsTgwConnect("testAwsTgwConnect", {
    tgwName: aviatrix_aws_tgw.test_aws_tgw.tgw_name,
    connectionName: "aws-tgw-connect",
    transportVpcId: aviatrix_aws_tgw_vpc_attachment.test_aws_tgw_vpc_attachment.vpc_id,
    networkDomainName: aviatrix_aws_tgw_vpc_attachment.test_aws_tgw_vpc_attachment.network_domain_name,
});
Copy
import pulumi
import pulumi_aviatrix as aviatrix

# Create an Aviatrix AWS TGW Connect
test_aws_tgw_connect = aviatrix.AviatrixAwsTgwConnect("testAwsTgwConnect",
    tgw_name=aviatrix_aws_tgw["test_aws_tgw"]["tgw_name"],
    connection_name="aws-tgw-connect",
    transport_vpc_id=aviatrix_aws_tgw_vpc_attachment["test_aws_tgw_vpc_attachment"]["vpc_id"],
    network_domain_name=aviatrix_aws_tgw_vpc_attachment["test_aws_tgw_vpc_attachment"]["network_domain_name"])
Copy
resources:
  # Create an Aviatrix AWS TGW Connect
  testAwsTgwConnect:
    type: aviatrix:AviatrixAwsTgwConnect
    properties:
      tgwName: ${aviatrix_aws_tgw.test_aws_tgw.tgw_name}
      connectionName: aws-tgw-connect
      transportVpcId: ${aviatrix_aws_tgw_vpc_attachment.test_aws_tgw_vpc_attachment.vpc_id}
      networkDomainName: ${aviatrix_aws_tgw_vpc_attachment.test_aws_tgw_vpc_attachment.network_domain_name}
Copy

Create AviatrixAwsTgwConnect Resource

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

Constructor syntax

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

@overload
def AviatrixAwsTgwConnect(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          connection_name: Optional[str] = None,
                          tgw_name: Optional[str] = None,
                          transport_vpc_id: Optional[str] = None,
                          network_domain_name: Optional[str] = None,
                          security_domain_name: Optional[str] = None)
func NewAviatrixAwsTgwConnect(ctx *Context, name string, args AviatrixAwsTgwConnectArgs, opts ...ResourceOption) (*AviatrixAwsTgwConnect, error)
public AviatrixAwsTgwConnect(string name, AviatrixAwsTgwConnectArgs args, CustomResourceOptions? opts = null)
public AviatrixAwsTgwConnect(String name, AviatrixAwsTgwConnectArgs args)
public AviatrixAwsTgwConnect(String name, AviatrixAwsTgwConnectArgs args, CustomResourceOptions options)
type: aviatrix:AviatrixAwsTgwConnect
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. AviatrixAwsTgwConnectArgs
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. AviatrixAwsTgwConnectArgs
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. AviatrixAwsTgwConnectArgs
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. AviatrixAwsTgwConnectArgs
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. AviatrixAwsTgwConnectArgs
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 aviatrixAwsTgwConnectResource = new Aviatrix.AviatrixAwsTgwConnect("aviatrixAwsTgwConnectResource", new()
{
    ConnectionName = "string",
    TgwName = "string",
    TransportVpcId = "string",
    NetworkDomainName = "string",
});
Copy
example, err := aviatrix.NewAviatrixAwsTgwConnect(ctx, "aviatrixAwsTgwConnectResource", &aviatrix.AviatrixAwsTgwConnectArgs{
	ConnectionName:    pulumi.String("string"),
	TgwName:           pulumi.String("string"),
	TransportVpcId:    pulumi.String("string"),
	NetworkDomainName: pulumi.String("string"),
})
Copy
var aviatrixAwsTgwConnectResource = new AviatrixAwsTgwConnect("aviatrixAwsTgwConnectResource", AviatrixAwsTgwConnectArgs.builder()
    .connectionName("string")
    .tgwName("string")
    .transportVpcId("string")
    .networkDomainName("string")
    .build());
Copy
aviatrix_aws_tgw_connect_resource = aviatrix.AviatrixAwsTgwConnect("aviatrixAwsTgwConnectResource",
    connection_name="string",
    tgw_name="string",
    transport_vpc_id="string",
    network_domain_name="string")
Copy
const aviatrixAwsTgwConnectResource = new aviatrix.AviatrixAwsTgwConnect("aviatrixAwsTgwConnectResource", {
    connectionName: "string",
    tgwName: "string",
    transportVpcId: "string",
    networkDomainName: "string",
});
Copy
type: aviatrix:AviatrixAwsTgwConnect
properties:
    connectionName: string
    networkDomainName: string
    tgwName: string
    transportVpcId: string
Copy

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

ConnectionName
This property is required.
Changes to this property will trigger replacement.
string
Connection name.
TgwName
This property is required.
Changes to this property will trigger replacement.
string
AWS TGW name.
TransportVpcId
This property is required.
Changes to this property will trigger replacement.
string
Transport Attachment VPC ID.
NetworkDomainName Changes to this property will trigger replacement. string
Network Domain name.
SecurityDomainName Changes to this property will trigger replacement. string
Security Domain name.

Deprecated: Please use network_domain_name instead.

ConnectionName
This property is required.
Changes to this property will trigger replacement.
string
Connection name.
TgwName
This property is required.
Changes to this property will trigger replacement.
string
AWS TGW name.
TransportVpcId
This property is required.
Changes to this property will trigger replacement.
string
Transport Attachment VPC ID.
NetworkDomainName Changes to this property will trigger replacement. string
Network Domain name.
SecurityDomainName Changes to this property will trigger replacement. string
Security Domain name.

Deprecated: Please use network_domain_name instead.

connectionName
This property is required.
Changes to this property will trigger replacement.
String
Connection name.
tgwName
This property is required.
Changes to this property will trigger replacement.
String
AWS TGW name.
transportVpcId
This property is required.
Changes to this property will trigger replacement.
String
Transport Attachment VPC ID.
networkDomainName Changes to this property will trigger replacement. String
Network Domain name.
securityDomainName Changes to this property will trigger replacement. String
Security Domain name.

Deprecated: Please use network_domain_name instead.

connectionName
This property is required.
Changes to this property will trigger replacement.
string
Connection name.
tgwName
This property is required.
Changes to this property will trigger replacement.
string
AWS TGW name.
transportVpcId
This property is required.
Changes to this property will trigger replacement.
string
Transport Attachment VPC ID.
networkDomainName Changes to this property will trigger replacement. string
Network Domain name.
securityDomainName Changes to this property will trigger replacement. string
Security Domain name.

Deprecated: Please use network_domain_name instead.

connection_name
This property is required.
Changes to this property will trigger replacement.
str
Connection name.
tgw_name
This property is required.
Changes to this property will trigger replacement.
str
AWS TGW name.
transport_vpc_id
This property is required.
Changes to this property will trigger replacement.
str
Transport Attachment VPC ID.
network_domain_name Changes to this property will trigger replacement. str
Network Domain name.
security_domain_name Changes to this property will trigger replacement. str
Security Domain name.

Deprecated: Please use network_domain_name instead.

connectionName
This property is required.
Changes to this property will trigger replacement.
String
Connection name.
tgwName
This property is required.
Changes to this property will trigger replacement.
String
AWS TGW name.
transportVpcId
This property is required.
Changes to this property will trigger replacement.
String
Transport Attachment VPC ID.
networkDomainName Changes to this property will trigger replacement. String
Network Domain name.
securityDomainName Changes to this property will trigger replacement. String
Security Domain name.

Deprecated: Please use network_domain_name instead.

Outputs

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

ConnectAttachmentId string
Connect Attachment ID.
Id string
The provider-assigned unique ID for this managed resource.
TransportAttachmentId string
Transport Attachment ID.
ConnectAttachmentId string
Connect Attachment ID.
Id string
The provider-assigned unique ID for this managed resource.
TransportAttachmentId string
Transport Attachment ID.
connectAttachmentId String
Connect Attachment ID.
id String
The provider-assigned unique ID for this managed resource.
transportAttachmentId String
Transport Attachment ID.
connectAttachmentId string
Connect Attachment ID.
id string
The provider-assigned unique ID for this managed resource.
transportAttachmentId string
Transport Attachment ID.
connect_attachment_id str
Connect Attachment ID.
id str
The provider-assigned unique ID for this managed resource.
transport_attachment_id str
Transport Attachment ID.
connectAttachmentId String
Connect Attachment ID.
id String
The provider-assigned unique ID for this managed resource.
transportAttachmentId String
Transport Attachment ID.

Look up Existing AviatrixAwsTgwConnect Resource

Get an existing AviatrixAwsTgwConnect 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?: AviatrixAwsTgwConnectState, opts?: CustomResourceOptions): AviatrixAwsTgwConnect
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        connect_attachment_id: Optional[str] = None,
        connection_name: Optional[str] = None,
        network_domain_name: Optional[str] = None,
        security_domain_name: Optional[str] = None,
        tgw_name: Optional[str] = None,
        transport_attachment_id: Optional[str] = None,
        transport_vpc_id: Optional[str] = None) -> AviatrixAwsTgwConnect
func GetAviatrixAwsTgwConnect(ctx *Context, name string, id IDInput, state *AviatrixAwsTgwConnectState, opts ...ResourceOption) (*AviatrixAwsTgwConnect, error)
public static AviatrixAwsTgwConnect Get(string name, Input<string> id, AviatrixAwsTgwConnectState? state, CustomResourceOptions? opts = null)
public static AviatrixAwsTgwConnect get(String name, Output<String> id, AviatrixAwsTgwConnectState state, CustomResourceOptions options)
resources:  _:    type: aviatrix:AviatrixAwsTgwConnect    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:
ConnectAttachmentId string
Connect Attachment ID.
ConnectionName Changes to this property will trigger replacement. string
Connection name.
NetworkDomainName Changes to this property will trigger replacement. string
Network Domain name.
SecurityDomainName Changes to this property will trigger replacement. string
Security Domain name.

Deprecated: Please use network_domain_name instead.

TgwName Changes to this property will trigger replacement. string
AWS TGW name.
TransportAttachmentId string
Transport Attachment ID.
TransportVpcId Changes to this property will trigger replacement. string
Transport Attachment VPC ID.
ConnectAttachmentId string
Connect Attachment ID.
ConnectionName Changes to this property will trigger replacement. string
Connection name.
NetworkDomainName Changes to this property will trigger replacement. string
Network Domain name.
SecurityDomainName Changes to this property will trigger replacement. string
Security Domain name.

Deprecated: Please use network_domain_name instead.

TgwName Changes to this property will trigger replacement. string
AWS TGW name.
TransportAttachmentId string
Transport Attachment ID.
TransportVpcId Changes to this property will trigger replacement. string
Transport Attachment VPC ID.
connectAttachmentId String
Connect Attachment ID.
connectionName Changes to this property will trigger replacement. String
Connection name.
networkDomainName Changes to this property will trigger replacement. String
Network Domain name.
securityDomainName Changes to this property will trigger replacement. String
Security Domain name.

Deprecated: Please use network_domain_name instead.

tgwName Changes to this property will trigger replacement. String
AWS TGW name.
transportAttachmentId String
Transport Attachment ID.
transportVpcId Changes to this property will trigger replacement. String
Transport Attachment VPC ID.
connectAttachmentId string
Connect Attachment ID.
connectionName Changes to this property will trigger replacement. string
Connection name.
networkDomainName Changes to this property will trigger replacement. string
Network Domain name.
securityDomainName Changes to this property will trigger replacement. string
Security Domain name.

Deprecated: Please use network_domain_name instead.

tgwName Changes to this property will trigger replacement. string
AWS TGW name.
transportAttachmentId string
Transport Attachment ID.
transportVpcId Changes to this property will trigger replacement. string
Transport Attachment VPC ID.
connect_attachment_id str
Connect Attachment ID.
connection_name Changes to this property will trigger replacement. str
Connection name.
network_domain_name Changes to this property will trigger replacement. str
Network Domain name.
security_domain_name Changes to this property will trigger replacement. str
Security Domain name.

Deprecated: Please use network_domain_name instead.

tgw_name Changes to this property will trigger replacement. str
AWS TGW name.
transport_attachment_id str
Transport Attachment ID.
transport_vpc_id Changes to this property will trigger replacement. str
Transport Attachment VPC ID.
connectAttachmentId String
Connect Attachment ID.
connectionName Changes to this property will trigger replacement. String
Connection name.
networkDomainName Changes to this property will trigger replacement. String
Network Domain name.
securityDomainName Changes to this property will trigger replacement. String
Security Domain name.

Deprecated: Please use network_domain_name instead.

tgwName Changes to this property will trigger replacement. String
AWS TGW name.
transportAttachmentId String
Transport Attachment ID.
transportVpcId Changes to this property will trigger replacement. String
Transport Attachment VPC ID.

Import

aws_tgw_connect can be imported using the tgw_name and connection_name, e.g.

 $ pulumi import aviatrix:index/aviatrixAwsTgwConnect:AviatrixAwsTgwConnect test tgw_name~~connection_name
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.