1. Packages
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. interconnect
  6. getConnection

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.62.0
published on Monday, Apr 20, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

aws-native.interconnect.getConnection

aws-native logo

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.62.0
published on Monday, Apr 20, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

    Resource Type definition for AWS::Interconnect::Connection. Creates a managed network connection between AWS and a partner cloud service provider.

    Using getConnection

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getConnection(args: GetConnectionArgs, opts?: InvokeOptions): Promise<GetConnectionResult>
function getConnectionOutput(args: GetConnectionOutputArgs, opts?: InvokeOptions): Output<GetConnectionResult>
    def get_connection(arn: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetConnectionResult
def get_connection_output(arn: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetConnectionResult]
    func LookupConnection(ctx *Context, args *LookupConnectionArgs, opts ...InvokeOption) (*LookupConnectionResult, error)
func LookupConnectionOutput(ctx *Context, args *LookupConnectionOutputArgs, opts ...InvokeOption) LookupConnectionResultOutput

    > Note: This function is named LookupConnection in the Go SDK.

    public static class GetConnection 
{
    public static Task<GetConnectionResult> InvokeAsync(GetConnectionArgs args, InvokeOptions? opts = null)
    public static Output<GetConnectionResult> Invoke(GetConnectionInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetConnectionResult> getConnection(GetConnectionArgs args, InvokeOptions options)
public static Output<GetConnectionResult> getConnection(GetConnectionArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:interconnect:getConnection
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Arn string
    The Amazon Resource Name (ARN) of the connection.
    Arn string
    The Amazon Resource Name (ARN) of the connection.
    arn String
    The Amazon Resource Name (ARN) of the connection.
    arn string
    The Amazon Resource Name (ARN) of the connection.
    arn str
    The Amazon Resource Name (ARN) of the connection.
    arn String
    The Amazon Resource Name (ARN) of the connection.

    getConnection Result

    The following output properties are available:

    Arn string
    The Amazon Resource Name (ARN) of the connection.
    Bandwidth string
    The bandwidth of the connection (e.g., 50Mbps, 1Gbps). Required when creating a connection through AWS.
    BillingTier int
    The billing tier for the connection.
    ConnectionId string
    The unique identifier for the connection.
    Description string
    A description of the connection.
    OwnerAccount string
    The AWS account ID of the connection owner.
    Provider Pulumi.AwsNative.Interconnect.Outputs.ConnectionProvider
    The partner cloud service provider.
    SharedId string
    The shared identifier for the connection pairing.
    State Pulumi.AwsNative.Interconnect.ConnectionState
    The current state of the connection.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    An array of key-value pairs to apply to this resource.
    Type string
    The type of managed connection.
    Arn string
    The Amazon Resource Name (ARN) of the connection.
    Bandwidth string
    The bandwidth of the connection (e.g., 50Mbps, 1Gbps). Required when creating a connection through AWS.
    BillingTier int
    The billing tier for the connection.
    ConnectionId string
    The unique identifier for the connection.
    Description string
    A description of the connection.
    OwnerAccount string
    The AWS account ID of the connection owner.
    Provider ConnectionProvider
    The partner cloud service provider.
    SharedId string
    The shared identifier for the connection pairing.
    State ConnectionStateEnum
    The current state of the connection.
    Tags Tag
    An array of key-value pairs to apply to this resource.
    Type string
    The type of managed connection.
    arn String
    The Amazon Resource Name (ARN) of the connection.
    bandwidth String
    The bandwidth of the connection (e.g., 50Mbps, 1Gbps). Required when creating a connection through AWS.
    billingTier Integer
    The billing tier for the connection.
    connectionId String
    The unique identifier for the connection.
    description String
    A description of the connection.
    ownerAccount String
    The AWS account ID of the connection owner.
    provider ConnectionProvider
    The partner cloud service provider.
    sharedId String
    The shared identifier for the connection pairing.
    state ConnectionState
    The current state of the connection.
    tags List<Tag>
    An array of key-value pairs to apply to this resource.
    type String
    The type of managed connection.
    arn string
    The Amazon Resource Name (ARN) of the connection.
    bandwidth string
    The bandwidth of the connection (e.g., 50Mbps, 1Gbps). Required when creating a connection through AWS.
    billingTier number
    The billing tier for the connection.
    connectionId string
    The unique identifier for the connection.
    description string
    A description of the connection.
    ownerAccount string
    The AWS account ID of the connection owner.
    provider ConnectionProvider
    The partner cloud service provider.
    sharedId string
    The shared identifier for the connection pairing.
    state ConnectionState
    The current state of the connection.
    tags Tag[]
    An array of key-value pairs to apply to this resource.
    type string
    The type of managed connection.
    arn str
    The Amazon Resource Name (ARN) of the connection.
    bandwidth str
    The bandwidth of the connection (e.g., 50Mbps, 1Gbps). Required when creating a connection through AWS.
    billing_tier int
    The billing tier for the connection.
    connection_id str
    The unique identifier for the connection.
    description str
    A description of the connection.
    owner_account str
    The AWS account ID of the connection owner.
    provider ConnectionProvider
    The partner cloud service provider.
    shared_id str
    The shared identifier for the connection pairing.
    state ConnectionState
    The current state of the connection.
    tags Sequence[root_Tag]
    An array of key-value pairs to apply to this resource.
    type str
    The type of managed connection.
    arn String
    The Amazon Resource Name (ARN) of the connection.
    bandwidth String
    The bandwidth of the connection (e.g., 50Mbps, 1Gbps). Required when creating a connection through AWS.
    billingTier Number
    The billing tier for the connection.
    connectionId String
    The unique identifier for the connection.
    description String
    A description of the connection.
    ownerAccount String
    The AWS account ID of the connection owner.
    provider Property Map
    The partner cloud service provider.
    sharedId String
    The shared identifier for the connection pairing.
    state "available" | "requested" | "pending" | "down" | "deleting" | "deleted" | "failed"
    The current state of the connection.
    tags List<Property Map>
    An array of key-value pairs to apply to this resource.
    type String
    The type of managed connection.

    Supporting Types

    ConnectionProvider

    CloudServiceProvider string
    The name of the cloud service provider.
    LastMileProvider string
    The name of the last mile provider.
    CloudServiceProvider string
    The name of the cloud service provider.
    LastMileProvider string
    The name of the last mile provider.
    cloudServiceProvider String
    The name of the cloud service provider.
    lastMileProvider String
    The name of the last mile provider.
    cloudServiceProvider string
    The name of the cloud service provider.
    lastMileProvider string
    The name of the last mile provider.
    cloud_service_provider str
    The name of the cloud service provider.
    last_mile_provider str
    The name of the last mile provider.
    cloudServiceProvider String
    The name of the cloud service provider.
    lastMileProvider String
    The name of the last mile provider.

    ConnectionState

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    Viewing docs for AWS Cloud Control v1.62.0
    published on Monday, Apr 20, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws-native
      Try Pulumi Cloud free. Your team will thank you.