Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. ec2transitgateway
  5. Connect
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

aws.ec2transitgateway.Connect

Explore with Pulumi AI

aws logo
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

    Manages an EC2 Transit Gateway Connect.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.ec2transitgateway.VpcAttachment("example", {
    subnetIds: [exampleAwsSubnet.id],
    transitGatewayId: exampleAwsEc2TransitGateway.id,
    vpcId: exampleAwsVpc.id,
});
const attachment = new aws.ec2transitgateway.Connect("attachment", {
    transportAttachmentId: example.id,
    transitGatewayId: exampleAwsEc2TransitGateway.id,
});

    import pulumi
import pulumi_aws as aws

example = aws.ec2transitgateway.VpcAttachment("example",
    subnet_ids=[example_aws_subnet["id"]],
    transit_gateway_id=example_aws_ec2_transit_gateway["id"],
    vpc_id=example_aws_vpc["id"])
attachment = aws.ec2transitgateway.Connect("attachment",
    transport_attachment_id=example.id,
    transit_gateway_id=example_aws_ec2_transit_gateway["id"])

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ec2transitgateway"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := ec2transitgateway.NewVpcAttachment(ctx, "example", &ec2transitgateway.VpcAttachmentArgs{
			SubnetIds: pulumi.StringArray{
				exampleAwsSubnet.Id,
			},
			TransitGatewayId: pulumi.Any(exampleAwsEc2TransitGateway.Id),
			VpcId:            pulumi.Any(exampleAwsVpc.Id),
		})
		if err != nil {
			return err
		}
		_, err = ec2transitgateway.NewConnect(ctx, "attachment", &ec2transitgateway.ConnectArgs{
			TransportAttachmentId: example.ID(),
			TransitGatewayId:      pulumi.Any(exampleAwsEc2TransitGateway.Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Ec2TransitGateway.VpcAttachment("example", new()
    {
        SubnetIds = new[]
        {
            exampleAwsSubnet.Id,
        },
        TransitGatewayId = exampleAwsEc2TransitGateway.Id,
        VpcId = exampleAwsVpc.Id,
    });

    var attachment = new Aws.Ec2TransitGateway.Connect("attachment", new()
    {
        TransportAttachmentId = example.Id,
        TransitGatewayId = exampleAwsEc2TransitGateway.Id,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2transitgateway.VpcAttachment;
import com.pulumi.aws.ec2transitgateway.VpcAttachmentArgs;
import com.pulumi.aws.ec2transitgateway.Connect;
import com.pulumi.aws.ec2transitgateway.ConnectArgs;
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 example = new VpcAttachment("example", VpcAttachmentArgs.builder()
            .subnetIds(exampleAwsSubnet.id())
            .transitGatewayId(exampleAwsEc2TransitGateway.id())
            .vpcId(exampleAwsVpc.id())
            .build());

        var attachment = new Connect("attachment", ConnectArgs.builder()
            .transportAttachmentId(example.id())
            .transitGatewayId(exampleAwsEc2TransitGateway.id())
            .build());

    }
}

    resources:
  example:
    type: aws:ec2transitgateway:VpcAttachment
    properties:
      subnetIds:
        - ${exampleAwsSubnet.id}
      transitGatewayId: ${exampleAwsEc2TransitGateway.id}
      vpcId: ${exampleAwsVpc.id}
  attachment:
    type: aws:ec2transitgateway:Connect
    properties:
      transportAttachmentId: ${example.id}
      transitGatewayId: ${exampleAwsEc2TransitGateway.id}

    Create Connect Resource

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

    Constructor syntax

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

@overload
def Connect(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            transit_gateway_id: Optional[str] = None,
            transport_attachment_id: Optional[str] = None,
            protocol: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            transit_gateway_default_route_table_association: Optional[bool] = None,
            transit_gateway_default_route_table_propagation: Optional[bool] = None)
    func NewConnect(ctx *Context, name string, args ConnectArgs, opts ...ResourceOption) (*Connect, error)
    public Connect(string name, ConnectArgs args, CustomResourceOptions? opts = null)
    public Connect(String name, ConnectArgs args)
public Connect(String name, ConnectArgs args, CustomResourceOptions options)

    type: aws:ec2transitgateway:Connect
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 ConnectArgs
    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 ConnectArgs
    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 ConnectArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ConnectArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ConnectArgs
    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 connectResource = new Aws.Ec2TransitGateway.Connect("connectResource", new()
{
    TransitGatewayId = "string",
    TransportAttachmentId = "string",
    Protocol = "string",
    Tags = 
    {
        { "string", "string" },
    },
    TransitGatewayDefaultRouteTableAssociation = false,
    TransitGatewayDefaultRouteTablePropagation = false,
});

    example, err := ec2transitgateway.NewConnect(ctx, "connectResource", &ec2transitgateway.ConnectArgs{
	TransitGatewayId:      pulumi.String("string"),
	TransportAttachmentId: pulumi.String("string"),
	Protocol:              pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	TransitGatewayDefaultRouteTableAssociation: pulumi.Bool(false),
	TransitGatewayDefaultRouteTablePropagation: pulumi.Bool(false),
})

    var connectResource = new Connect("connectResource", ConnectArgs.builder()
    .transitGatewayId("string")
    .transportAttachmentId("string")
    .protocol("string")
    .tags(Map.of("string", "string"))
    .transitGatewayDefaultRouteTableAssociation(false)
    .transitGatewayDefaultRouteTablePropagation(false)
    .build());

    connect_resource = aws.ec2transitgateway.Connect("connectResource",
    transit_gateway_id="string",
    transport_attachment_id="string",
    protocol="string",
    tags={
        "string": "string",
    },
    transit_gateway_default_route_table_association=False,
    transit_gateway_default_route_table_propagation=False)

    const connectResource = new aws.ec2transitgateway.Connect("connectResource", {
    transitGatewayId: "string",
    transportAttachmentId: "string",
    protocol: "string",
    tags: {
        string: "string",
    },
    transitGatewayDefaultRouteTableAssociation: false,
    transitGatewayDefaultRouteTablePropagation: false,
});

    type: aws:ec2transitgateway:Connect
properties:
    protocol: string
    tags:
        string: string
    transitGatewayDefaultRouteTableAssociation: false
    transitGatewayDefaultRouteTablePropagation: false
    transitGatewayId: string
    transportAttachmentId: string

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

    TransitGatewayId string
    Identifier of EC2 Transit Gateway.
    TransportAttachmentId string
    The underlaying VPC attachment
    Protocol string
    The tunnel protocol. Valid values: gre. Default is gre.
    Tags Dictionary<string, string>
    Key-value tags for the EC2 Transit Gateway Connect. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TransitGatewayDefaultRouteTableAssociation bool
    Boolean whether the Connect should be associated with the EC2 Transit Gateway association default route table. This cannot be configured or perform drift detection with Resource Access Manager shared EC2 Transit Gateways. Default value: true.
    TransitGatewayDefaultRouteTablePropagation bool
    Boolean whether the Connect should propagate routes with the EC2 Transit Gateway propagation default route table. This cannot be configured or perform drift detection with Resource Access Manager shared EC2 Transit Gateways. Default value: true.
    TransitGatewayId string
    Identifier of EC2 Transit Gateway.
    TransportAttachmentId string
    The underlaying VPC attachment
    Protocol string
    The tunnel protocol. Valid values: gre. Default is gre.
    Tags map[string]string
    Key-value tags for the EC2 Transit Gateway Connect. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TransitGatewayDefaultRouteTableAssociation bool
    Boolean whether the Connect should be associated with the EC2 Transit Gateway association default route table. This cannot be configured or perform drift detection with Resource Access Manager shared EC2 Transit Gateways. Default value: true.
    TransitGatewayDefaultRouteTablePropagation bool
    Boolean whether the Connect should propagate routes with the EC2 Transit Gateway propagation default route table. This cannot be configured or perform drift detection with Resource Access Manager shared EC2 Transit Gateways. Default value: true.
    transitGatewayId String
    Identifier of EC2 Transit Gateway.
    transportAttachmentId String
    The underlaying VPC attachment
    protocol String
    The tunnel protocol. Valid values: gre. Default is gre.
    tags Map<String,String>
    Key-value tags for the EC2 Transit Gateway Connect. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    transitGatewayDefaultRouteTableAssociation Boolean
    Boolean whether the Connect should be associated with the EC2 Transit Gateway association default route table. This cannot be configured or perform drift detection with Resource Access Manager shared EC2 Transit Gateways. Default value: true.
    transitGatewayDefaultRouteTablePropagation Boolean
    Boolean whether the Connect should propagate routes with the EC2 Transit Gateway propagation default route table. This cannot be configured or perform drift detection with Resource Access Manager shared EC2 Transit Gateways. Default value: true.
    transitGatewayId string
    Identifier of EC2 Transit Gateway.
    transportAttachmentId string
    The underlaying VPC attachment
    protocol string
    The tunnel protocol. Valid values: gre. Default is gre.
    tags {[key: string]: string}
    Key-value tags for the EC2 Transit Gateway Connect. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    transitGatewayDefaultRouteTableAssociation boolean
    Boolean whether the Connect should be associated with the EC2 Transit Gateway association default route table. This cannot be configured or perform drift detection with Resource Access Manager shared EC2 Transit Gateways. Default value: true.
    transitGatewayDefaultRouteTablePropagation boolean
    Boolean whether the Connect should propagate routes with the EC2 Transit Gateway propagation default route table. This cannot be configured or perform drift detection with Resource Access Manager shared EC2 Transit Gateways. Default value: true.
    transit_gateway_id str
    Identifier of EC2 Transit Gateway.
    transport_attachment_id str
    The underlaying VPC attachment
    protocol str
    The tunnel protocol. Valid values: gre. Default is gre.
    tags Mapping[str, str]
    Key-value tags for the EC2 Transit Gateway Connect. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    transit_gateway_default_route_table_association bool
    Boolean whether the Connect should be associated with the EC2 Transit Gateway association default route table. This cannot be configured or perform drift detection with Resource Access Manager shared EC2 Transit Gateways. Default value: true.
    transit_gateway_default_route_table_propagation bool
    Boolean whether the Connect should propagate routes with the EC2 Transit Gateway propagation default route table. This cannot be configured or perform drift detection with Resource Access Manager shared EC2 Transit Gateways. Default value: true.
    transitGatewayId String
    Identifier of EC2 Transit Gateway.
    transportAttachmentId String
    The underlaying VPC attachment
    protocol String
    The tunnel protocol. Valid values: gre. Default is gre.
    tags Map<String>
    Key-value tags for the EC2 Transit Gateway Connect. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    transitGatewayDefaultRouteTableAssociation Boolean
    Boolean whether the Connect should be associated with the EC2 Transit Gateway association default route table. This cannot be configured or perform drift detection with Resource Access Manager shared EC2 Transit Gateways. Default value: true.
    transitGatewayDefaultRouteTablePropagation Boolean
    Boolean whether the Connect should propagate routes with the EC2 Transit Gateway propagation default route table. This cannot be configured or perform drift detection with Resource Access Manager shared EC2 Transit Gateways. Default value: true.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up Existing Connect Resource

    Get an existing Connect 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?: ConnectState, opts?: CustomResourceOptions): Connect
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        protocol: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        transit_gateway_default_route_table_association: Optional[bool] = None,
        transit_gateway_default_route_table_propagation: Optional[bool] = None,
        transit_gateway_id: Optional[str] = None,
        transport_attachment_id: Optional[str] = None) -> Connect
    func GetConnect(ctx *Context, name string, id IDInput, state *ConnectState, opts ...ResourceOption) (*Connect, error)
    public static Connect Get(string name, Input<string> id, ConnectState? state, CustomResourceOptions? opts = null)
    public static Connect get(String name, Output<String> id, ConnectState 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:
    Protocol string
    The tunnel protocol. Valid values: gre. Default is gre.
    Tags Dictionary<string, string>
    Key-value tags for the EC2 Transit Gateway Connect. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    TransitGatewayDefaultRouteTableAssociation bool
    Boolean whether the Connect should be associated with the EC2 Transit Gateway association default route table. This cannot be configured or perform drift detection with Resource Access Manager shared EC2 Transit Gateways. Default value: true.
    TransitGatewayDefaultRouteTablePropagation bool
    Boolean whether the Connect should propagate routes with the EC2 Transit Gateway propagation default route table. This cannot be configured or perform drift detection with Resource Access Manager shared EC2 Transit Gateways. Default value: true.
    TransitGatewayId string
    Identifier of EC2 Transit Gateway.
    TransportAttachmentId string
    The underlaying VPC attachment
    Protocol string
    The tunnel protocol. Valid values: gre. Default is gre.
    Tags map[string]string
    Key-value tags for the EC2 Transit Gateway Connect. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    TransitGatewayDefaultRouteTableAssociation bool
    Boolean whether the Connect should be associated with the EC2 Transit Gateway association default route table. This cannot be configured or perform drift detection with Resource Access Manager shared EC2 Transit Gateways. Default value: true.
    TransitGatewayDefaultRouteTablePropagation bool
    Boolean whether the Connect should propagate routes with the EC2 Transit Gateway propagation default route table. This cannot be configured or perform drift detection with Resource Access Manager shared EC2 Transit Gateways. Default value: true.
    TransitGatewayId string
    Identifier of EC2 Transit Gateway.
    TransportAttachmentId string
    The underlaying VPC attachment
    protocol String
    The tunnel protocol. Valid values: gre. Default is gre.
    tags Map<String,String>
    Key-value tags for the EC2 Transit Gateway Connect. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    transitGatewayDefaultRouteTableAssociation Boolean
    Boolean whether the Connect should be associated with the EC2 Transit Gateway association default route table. This cannot be configured or perform drift detection with Resource Access Manager shared EC2 Transit Gateways. Default value: true.
    transitGatewayDefaultRouteTablePropagation Boolean
    Boolean whether the Connect should propagate routes with the EC2 Transit Gateway propagation default route table. This cannot be configured or perform drift detection with Resource Access Manager shared EC2 Transit Gateways. Default value: true.
    transitGatewayId String
    Identifier of EC2 Transit Gateway.
    transportAttachmentId String
    The underlaying VPC attachment
    protocol string
    The tunnel protocol. Valid values: gre. Default is gre.
    tags {[key: string]: string}
    Key-value tags for the EC2 Transit Gateway Connect. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    transitGatewayDefaultRouteTableAssociation boolean
    Boolean whether the Connect should be associated with the EC2 Transit Gateway association default route table. This cannot be configured or perform drift detection with Resource Access Manager shared EC2 Transit Gateways. Default value: true.
    transitGatewayDefaultRouteTablePropagation boolean
    Boolean whether the Connect should propagate routes with the EC2 Transit Gateway propagation default route table. This cannot be configured or perform drift detection with Resource Access Manager shared EC2 Transit Gateways. Default value: true.
    transitGatewayId string
    Identifier of EC2 Transit Gateway.
    transportAttachmentId string
    The underlaying VPC attachment
    protocol str
    The tunnel protocol. Valid values: gre. Default is gre.
    tags Mapping[str, str]
    Key-value tags for the EC2 Transit Gateway Connect. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    transit_gateway_default_route_table_association bool
    Boolean whether the Connect should be associated with the EC2 Transit Gateway association default route table. This cannot be configured or perform drift detection with Resource Access Manager shared EC2 Transit Gateways. Default value: true.
    transit_gateway_default_route_table_propagation bool
    Boolean whether the Connect should propagate routes with the EC2 Transit Gateway propagation default route table. This cannot be configured or perform drift detection with Resource Access Manager shared EC2 Transit Gateways. Default value: true.
    transit_gateway_id str
    Identifier of EC2 Transit Gateway.
    transport_attachment_id str
    The underlaying VPC attachment
    protocol String
    The tunnel protocol. Valid values: gre. Default is gre.
    tags Map<String>
    Key-value tags for the EC2 Transit Gateway Connect. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    transitGatewayDefaultRouteTableAssociation Boolean
    Boolean whether the Connect should be associated with the EC2 Transit Gateway association default route table. This cannot be configured or perform drift detection with Resource Access Manager shared EC2 Transit Gateways. Default value: true.
    transitGatewayDefaultRouteTablePropagation Boolean
    Boolean whether the Connect should propagate routes with the EC2 Transit Gateway propagation default route table. This cannot be configured or perform drift detection with Resource Access Manager shared EC2 Transit Gateways. Default value: true.
    transitGatewayId String
    Identifier of EC2 Transit Gateway.
    transportAttachmentId String
    The underlaying VPC attachment

    Import

    Using pulumi import, import aws_ec2_transit_gateway_connect using the EC2 Transit Gateway Connect identifier. For example:

    $ pulumi import aws:ec2transitgateway/connect:Connect example tgw-attach-12345678

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

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-aws