1. Packages
  2. Confluent Cloud
  3. API Docs
  4. TransitGatewayAttachment
Confluent v1.26.0 published on Thursday, Sep 28, 2023 by Pulumi

confluentcloud.TransitGatewayAttachment

Explore with Pulumi AI

confluentcloud logo
Confluent v1.26.0 published on Thursday, Sep 28, 2023 by Pulumi

    Import

    You can import a Transit Gateway Attachment by using Environment ID and Transit Gateway Attachment ID, in the format <Environment ID>/<Transit Gateway Attachment ID>. The following example shows how to import a Transit Gateway Attachment$ export CONFLUENT_CLOUD_API_KEY="<cloud_api_key>" $ export CONFLUENT_CLOUD_API_SECRET="<cloud_api_secret>"

     $ pulumi import confluentcloud:index/transitGatewayAttachment:TransitGatewayAttachment my_tgwa env-abc123/tgwa-abc123
    

    !> Warning: Do not forget to delete terminal command history afterwards for security purposes.

    Create TransitGatewayAttachment Resource

    new TransitGatewayAttachment(name: string, args: TransitGatewayAttachmentArgs, opts?: CustomResourceOptions);
    @overload
    def TransitGatewayAttachment(resource_name: str,
                                 opts: Optional[ResourceOptions] = None,
                                 aws: Optional[TransitGatewayAttachmentAwsArgs] = None,
                                 display_name: Optional[str] = None,
                                 environment: Optional[TransitGatewayAttachmentEnvironmentArgs] = None,
                                 network: Optional[TransitGatewayAttachmentNetworkArgs] = None)
    @overload
    def TransitGatewayAttachment(resource_name: str,
                                 args: TransitGatewayAttachmentArgs,
                                 opts: Optional[ResourceOptions] = None)
    func NewTransitGatewayAttachment(ctx *Context, name string, args TransitGatewayAttachmentArgs, opts ...ResourceOption) (*TransitGatewayAttachment, error)
    public TransitGatewayAttachment(string name, TransitGatewayAttachmentArgs args, CustomResourceOptions? opts = null)
    public TransitGatewayAttachment(String name, TransitGatewayAttachmentArgs args)
    public TransitGatewayAttachment(String name, TransitGatewayAttachmentArgs args, CustomResourceOptions options)
    
    type: confluentcloud:TransitGatewayAttachment
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args TransitGatewayAttachmentArgs
    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 TransitGatewayAttachmentArgs
    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 TransitGatewayAttachmentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TransitGatewayAttachmentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TransitGatewayAttachmentArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    TransitGatewayAttachment Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The TransitGatewayAttachment resource accepts the following input properties:

    Environment Pulumi.ConfluentCloud.Inputs.TransitGatewayAttachmentEnvironment

    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.

    Network Pulumi.ConfluentCloud.Inputs.TransitGatewayAttachmentNetwork

    Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.

    Aws Pulumi.ConfluentCloud.Inputs.TransitGatewayAttachmentAws

    (Required Configuration Block) The AWS-specific Transit Gateway Attachment details. It supports the following:

    DisplayName string

    The name of the Transit Gateway Attachment.

    Environment TransitGatewayAttachmentEnvironmentArgs

    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.

    Network TransitGatewayAttachmentNetworkArgs

    Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.

    Aws TransitGatewayAttachmentAwsArgs

    (Required Configuration Block) The AWS-specific Transit Gateway Attachment details. It supports the following:

    DisplayName string

    The name of the Transit Gateway Attachment.

    environment TransitGatewayAttachmentEnvironment

    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.

    network TransitGatewayAttachmentNetwork

    Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.

    aws TransitGatewayAttachmentAws

    (Required Configuration Block) The AWS-specific Transit Gateway Attachment details. It supports the following:

    displayName String

    The name of the Transit Gateway Attachment.

    environment TransitGatewayAttachmentEnvironment

    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.

    network TransitGatewayAttachmentNetwork

    Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.

    aws TransitGatewayAttachmentAws

    (Required Configuration Block) The AWS-specific Transit Gateway Attachment details. It supports the following:

    displayName string

    The name of the Transit Gateway Attachment.

    environment TransitGatewayAttachmentEnvironmentArgs

    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.

    network TransitGatewayAttachmentNetworkArgs

    Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.

    aws TransitGatewayAttachmentAwsArgs

    (Required Configuration Block) The AWS-specific Transit Gateway Attachment details. It supports the following:

    display_name str

    The name of the Transit Gateway Attachment.

    environment Property Map

    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.

    network Property Map

    Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.

    aws Property Map

    (Required Configuration Block) The AWS-specific Transit Gateway Attachment details. It supports the following:

    displayName String

    The name of the Transit Gateway Attachment.

    Outputs

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

    Get an existing TransitGatewayAttachment 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?: TransitGatewayAttachmentState, opts?: CustomResourceOptions): TransitGatewayAttachment
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            aws: Optional[TransitGatewayAttachmentAwsArgs] = None,
            display_name: Optional[str] = None,
            environment: Optional[TransitGatewayAttachmentEnvironmentArgs] = None,
            network: Optional[TransitGatewayAttachmentNetworkArgs] = None) -> TransitGatewayAttachment
    func GetTransitGatewayAttachment(ctx *Context, name string, id IDInput, state *TransitGatewayAttachmentState, opts ...ResourceOption) (*TransitGatewayAttachment, error)
    public static TransitGatewayAttachment Get(string name, Input<string> id, TransitGatewayAttachmentState? state, CustomResourceOptions? opts = null)
    public static TransitGatewayAttachment get(String name, Output<String> id, TransitGatewayAttachmentState 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:
    Aws Pulumi.ConfluentCloud.Inputs.TransitGatewayAttachmentAws

    (Required Configuration Block) The AWS-specific Transit Gateway Attachment details. It supports the following:

    DisplayName string

    The name of the Transit Gateway Attachment.

    Environment Pulumi.ConfluentCloud.Inputs.TransitGatewayAttachmentEnvironment

    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.

    Network Pulumi.ConfluentCloud.Inputs.TransitGatewayAttachmentNetwork

    Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.

    Aws TransitGatewayAttachmentAwsArgs

    (Required Configuration Block) The AWS-specific Transit Gateway Attachment details. It supports the following:

    DisplayName string

    The name of the Transit Gateway Attachment.

    Environment TransitGatewayAttachmentEnvironmentArgs

    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.

    Network TransitGatewayAttachmentNetworkArgs

    Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.

    aws TransitGatewayAttachmentAws

    (Required Configuration Block) The AWS-specific Transit Gateway Attachment details. It supports the following:

    displayName String

    The name of the Transit Gateway Attachment.

    environment TransitGatewayAttachmentEnvironment

    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.

    network TransitGatewayAttachmentNetwork

    Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.

    aws TransitGatewayAttachmentAws

    (Required Configuration Block) The AWS-specific Transit Gateway Attachment details. It supports the following:

    displayName string

    The name of the Transit Gateway Attachment.

    environment TransitGatewayAttachmentEnvironment

    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.

    network TransitGatewayAttachmentNetwork

    Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.

    aws TransitGatewayAttachmentAwsArgs

    (Required Configuration Block) The AWS-specific Transit Gateway Attachment details. It supports the following:

    display_name str

    The name of the Transit Gateway Attachment.

    environment TransitGatewayAttachmentEnvironmentArgs

    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.

    network TransitGatewayAttachmentNetworkArgs

    Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.

    aws Property Map

    (Required Configuration Block) The AWS-specific Transit Gateway Attachment details. It supports the following:

    displayName String

    The name of the Transit Gateway Attachment.

    environment Property Map

    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.

    network Property Map

    Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.

    Supporting Types

    TransitGatewayAttachmentAws, TransitGatewayAttachmentAwsArgs

    RamResourceShareArn string

    The Amazon Resource Name (ARN) of the Resource Access Manager (RAM) Resource Share of the transit gateway your Confluent Cloud network attaches to.

    Routes List<string>

    List of destination routes for traffic from Confluent VPC to customer VPC via Transit Gateway.

    Note: Learn more about Transit Gateway Attachment limitations on AWS here.

    TransitGatewayId string

    The ID of the AWS Transit Gateway that you want Confluent CLoud to be attached to. Must start with tgw-.

    TransitGatewayAttachmentId string

    (Required String) The ID of the AWS Transit Gateway VPC Attachment that attaches Confluent VPC to Transit Gateway.

    RamResourceShareArn string

    The Amazon Resource Name (ARN) of the Resource Access Manager (RAM) Resource Share of the transit gateway your Confluent Cloud network attaches to.

    Routes []string

    List of destination routes for traffic from Confluent VPC to customer VPC via Transit Gateway.

    Note: Learn more about Transit Gateway Attachment limitations on AWS here.

    TransitGatewayId string

    The ID of the AWS Transit Gateway that you want Confluent CLoud to be attached to. Must start with tgw-.

    TransitGatewayAttachmentId string

    (Required String) The ID of the AWS Transit Gateway VPC Attachment that attaches Confluent VPC to Transit Gateway.

    ramResourceShareArn String

    The Amazon Resource Name (ARN) of the Resource Access Manager (RAM) Resource Share of the transit gateway your Confluent Cloud network attaches to.

    routes List<String>

    List of destination routes for traffic from Confluent VPC to customer VPC via Transit Gateway.

    Note: Learn more about Transit Gateway Attachment limitations on AWS here.

    transitGatewayId String

    The ID of the AWS Transit Gateway that you want Confluent CLoud to be attached to. Must start with tgw-.

    transitGatewayAttachmentId String

    (Required String) The ID of the AWS Transit Gateway VPC Attachment that attaches Confluent VPC to Transit Gateway.

    ramResourceShareArn string

    The Amazon Resource Name (ARN) of the Resource Access Manager (RAM) Resource Share of the transit gateway your Confluent Cloud network attaches to.

    routes string[]

    List of destination routes for traffic from Confluent VPC to customer VPC via Transit Gateway.

    Note: Learn more about Transit Gateway Attachment limitations on AWS here.

    transitGatewayId string

    The ID of the AWS Transit Gateway that you want Confluent CLoud to be attached to. Must start with tgw-.

    transitGatewayAttachmentId string

    (Required String) The ID of the AWS Transit Gateway VPC Attachment that attaches Confluent VPC to Transit Gateway.

    ram_resource_share_arn str

    The Amazon Resource Name (ARN) of the Resource Access Manager (RAM) Resource Share of the transit gateway your Confluent Cloud network attaches to.

    routes Sequence[str]

    List of destination routes for traffic from Confluent VPC to customer VPC via Transit Gateway.

    Note: Learn more about Transit Gateway Attachment limitations on AWS here.

    transit_gateway_id str

    The ID of the AWS Transit Gateway that you want Confluent CLoud to be attached to. Must start with tgw-.

    transit_gateway_attachment_id str

    (Required String) The ID of the AWS Transit Gateway VPC Attachment that attaches Confluent VPC to Transit Gateway.

    ramResourceShareArn String

    The Amazon Resource Name (ARN) of the Resource Access Manager (RAM) Resource Share of the transit gateway your Confluent Cloud network attaches to.

    routes List<String>

    List of destination routes for traffic from Confluent VPC to customer VPC via Transit Gateway.

    Note: Learn more about Transit Gateway Attachment limitations on AWS here.

    transitGatewayId String

    The ID of the AWS Transit Gateway that you want Confluent CLoud to be attached to. Must start with tgw-.

    transitGatewayAttachmentId String

    (Required String) The ID of the AWS Transit Gateway VPC Attachment that attaches Confluent VPC to Transit Gateway.

    TransitGatewayAttachmentEnvironment, TransitGatewayAttachmentEnvironmentArgs

    Id string

    The ID of the Network that the Transit Gateway Attachment belongs to, for example, n-abc123.

    Id string

    The ID of the Network that the Transit Gateway Attachment belongs to, for example, n-abc123.

    id String

    The ID of the Network that the Transit Gateway Attachment belongs to, for example, n-abc123.

    id string

    The ID of the Network that the Transit Gateway Attachment belongs to, for example, n-abc123.

    id str

    The ID of the Network that the Transit Gateway Attachment belongs to, for example, n-abc123.

    id String

    The ID of the Network that the Transit Gateway Attachment belongs to, for example, n-abc123.

    TransitGatewayAttachmentNetwork, TransitGatewayAttachmentNetworkArgs

    Id string

    The ID of the Network that the Transit Gateway Attachment belongs to, for example, n-abc123.

    Id string

    The ID of the Network that the Transit Gateway Attachment belongs to, for example, n-abc123.

    id String

    The ID of the Network that the Transit Gateway Attachment belongs to, for example, n-abc123.

    id string

    The ID of the Network that the Transit Gateway Attachment belongs to, for example, n-abc123.

    id str

    The ID of the Network that the Transit Gateway Attachment belongs to, for example, n-abc123.

    id String

    The ID of the Network that the Transit Gateway Attachment belongs to, for example, n-abc123.

    Package Details

    Repository
    Confluent Cloud pulumi/pulumi-confluentcloud
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the confluent Terraform Provider.

    confluentcloud logo
    Confluent v1.26.0 published on Thursday, Sep 28, 2023 by Pulumi