Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. AWS
  4. API Docs
  5. directconnect
  6. getConnection
Viewing docs for AWS v7.46.0
published on Thursday, Sep 10, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

aws.directconnect.getConnection

aws logo aws logo
Viewing docs for AWS v7.46.0
published on Thursday, Sep 10, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

    Retrieve information about a Direct Connect Connection.

    Example Usage

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

const example = aws.directconnect.getConnection({
    name: "tf-dx-connection",
});

    import pulumi
import pulumi_aws as aws

example = aws.directconnect.get_connection(name="tf-dx-connection")

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/directconnect"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := directconnect.LookupConnection(ctx, &directconnect.LookupConnectionArgs{
			Name: "tf-dx-connection",
		}, nil)
		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 = Aws.DirectConnect.GetConnection.Invoke(new()
    {
        Name = "tf-dx-connection",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.directconnect.DirectconnectFunctions;
import com.pulumi.aws.directconnect.inputs.GetConnectionArgs;
import java.util.ArrayList;
import java.util.Arrays;
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) {
        final var example = DirectconnectFunctions.getConnection(GetConnectionArgs.builder()
            .name("tf-dx-connection")
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      function: aws:directconnect:getConnection
      arguments:
        name: tf-dx-connection

    pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

data "aws_directconnect_getconnection" "example" {
  name = "tf-dx-connection"
}

    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?: InvokeOutputOptions): Output<GetConnectionResult>
    def get_connection(name: Optional[str] = None,
                   region: Optional[str] = None,
                   tags: Optional[Mapping[str, str]] = None,
                   opts: Optional[InvokeOptions] = None) -> GetConnectionResult
def get_connection_output(name: pulumi.Input[Optional[str]] = None,
                   region: pulumi.Input[Optional[str]] = None,
                   tags: pulumi.Input[Optional[Mapping[str, pulumi.Input[str]]]] = None,
                   opts: Optional[InvokeOutputOptions] = 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 Output<GetConnectionResult> Invoke(GetConnectionInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetConnectionResult> getConnection(GetConnectionArgs args, InvokeOptions options)
public static Output<GetConnectionResult> getConnection(GetConnectionArgs args, InvokeOptions options)
public static Output<GetConnectionResult> getConnection(GetConnectionArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: aws:directconnect/getConnection:getConnection
  arguments:
    # arguments dictionary
    data "aws_directconnect_get_connection" "name" {
    # arguments
}

    The following arguments are supported:

    Name string
    Name of the connection to retrieve.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Tags Dictionary<string, string>
    Map of tags for the resource.
    Name string
    Name of the connection to retrieve.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Tags map[string]string
    Map of tags for the resource.
    name string
    Name of the connection to retrieve.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags map(string)
    Map of tags for the resource.
    name String
    Name of the connection to retrieve.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Map<String,String>
    Map of tags for the resource.
    name string
    Name of the connection to retrieve.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags {[key: string]: string}
    Map of tags for the resource.
    name str
    Name of the connection to retrieve.
    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Mapping[str, str]
    Map of tags for the resource.
    name String
    Name of the connection to retrieve.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Map<String>
    Map of tags for the resource.

    getConnection Result

    The following output properties are available:

    Arn string
    ARN of the connection.
    AwsDevice string
    Direct Connect endpoint on which the physical connection terminates.
    Bandwidth string
    Bandwidth of the connection.
    Id string
    The provider-assigned unique ID for this managed resource.
    Location string
    AWS Direct Connect location where the connection is located.
    Name string
    OwnerAccountId string
    ID of the AWS account that owns the connection.
    PartnerName string
    The name of the AWS Direct Connect service provider associated with the connection.
    PrefixPoolSizeIpv4 int
    The total number of inbound IPv4 route prefixes that can be allocated across the virtual interfaces on the connection.
    PrefixPoolSizeIpv6 int
    The total number of inbound IPv6 route prefixes that can be allocated across the virtual interfaces on the connection.
    PrefixPoolUnallocatedCountIpv4 int
    The number of inbound IPv4 route prefixes in the connection prefix pool not yet allocated to a virtual interface.
    PrefixPoolUnallocatedCountIpv6 int
    The number of inbound IPv6 route prefixes in the connection prefix pool not yet allocated to a virtual interface.
    ProviderName string
    Name of the service provider associated with the connection.
    RateLimiterStatuses List<GetConnectionRateLimiterStatus>
    Rate limiter status for the connection. See rateLimiterStatus Block below.
    Region string
    State string
    State of the connection.
    Tags Dictionary<string, string>
    Map of tags for the resource.
    VlanId int
    The VLAN ID.
    Arn string
    ARN of the connection.
    AwsDevice string
    Direct Connect endpoint on which the physical connection terminates.
    Bandwidth string
    Bandwidth of the connection.
    Id string
    The provider-assigned unique ID for this managed resource.
    Location string
    AWS Direct Connect location where the connection is located.
    Name string
    OwnerAccountId string
    ID of the AWS account that owns the connection.
    PartnerName string
    The name of the AWS Direct Connect service provider associated with the connection.
    PrefixPoolSizeIpv4 int
    The total number of inbound IPv4 route prefixes that can be allocated across the virtual interfaces on the connection.
    PrefixPoolSizeIpv6 int
    The total number of inbound IPv6 route prefixes that can be allocated across the virtual interfaces on the connection.
    PrefixPoolUnallocatedCountIpv4 int
    The number of inbound IPv4 route prefixes in the connection prefix pool not yet allocated to a virtual interface.
    PrefixPoolUnallocatedCountIpv6 int
    The number of inbound IPv6 route prefixes in the connection prefix pool not yet allocated to a virtual interface.
    ProviderName string
    Name of the service provider associated with the connection.
    RateLimiterStatuses []GetConnectionRateLimiterStatus
    Rate limiter status for the connection. See rateLimiterStatus Block below.
    Region string
    State string
    State of the connection.
    Tags map[string]string
    Map of tags for the resource.
    VlanId int
    The VLAN ID.
    arn string
    ARN of the connection.
    aws_device string
    Direct Connect endpoint on which the physical connection terminates.
    bandwidth string
    Bandwidth of the connection.
    id string
    The provider-assigned unique ID for this managed resource.
    location string
    AWS Direct Connect location where the connection is located.
    name string
    owner_account_id string
    ID of the AWS account that owns the connection.
    partner_name string
    The name of the AWS Direct Connect service provider associated with the connection.
    prefix_pool_size_ipv4 number
    The total number of inbound IPv4 route prefixes that can be allocated across the virtual interfaces on the connection.
    prefix_pool_size_ipv6 number
    The total number of inbound IPv6 route prefixes that can be allocated across the virtual interfaces on the connection.
    prefix_pool_unallocated_count_ipv4 number
    The number of inbound IPv4 route prefixes in the connection prefix pool not yet allocated to a virtual interface.
    prefix_pool_unallocated_count_ipv6 number
    The number of inbound IPv6 route prefixes in the connection prefix pool not yet allocated to a virtual interface.
    provider_name string
    Name of the service provider associated with the connection.
    rate_limiter_statuses list(object)
    Rate limiter status for the connection. See rateLimiterStatus Block below.
    region string
    state string
    State of the connection.
    tags map(string)
    Map of tags for the resource.
    vlan_id number
    The VLAN ID.
    arn String
    ARN of the connection.
    awsDevice String
    Direct Connect endpoint on which the physical connection terminates.
    bandwidth String
    Bandwidth of the connection.
    id String
    The provider-assigned unique ID for this managed resource.
    location String
    AWS Direct Connect location where the connection is located.
    name String
    ownerAccountId String
    ID of the AWS account that owns the connection.
    partnerName String
    The name of the AWS Direct Connect service provider associated with the connection.
    prefixPoolSizeIpv4 Integer
    The total number of inbound IPv4 route prefixes that can be allocated across the virtual interfaces on the connection.
    prefixPoolSizeIpv6 Integer
    The total number of inbound IPv6 route prefixes that can be allocated across the virtual interfaces on the connection.
    prefixPoolUnallocatedCountIpv4 Integer
    The number of inbound IPv4 route prefixes in the connection prefix pool not yet allocated to a virtual interface.
    prefixPoolUnallocatedCountIpv6 Integer
    The number of inbound IPv6 route prefixes in the connection prefix pool not yet allocated to a virtual interface.
    providerName String
    Name of the service provider associated with the connection.
    rateLimiterStatuses List<GetConnectionRateLimiterStatus>
    Rate limiter status for the connection. See rateLimiterStatus Block below.
    region String
    state String
    State of the connection.
    tags Map<String,String>
    Map of tags for the resource.
    vlanId Integer
    The VLAN ID.
    arn string
    ARN of the connection.
    awsDevice string
    Direct Connect endpoint on which the physical connection terminates.
    bandwidth string
    Bandwidth of the connection.
    id string
    The provider-assigned unique ID for this managed resource.
    location string
    AWS Direct Connect location where the connection is located.
    name string
    ownerAccountId string
    ID of the AWS account that owns the connection.
    partnerName string
    The name of the AWS Direct Connect service provider associated with the connection.
    prefixPoolSizeIpv4 number
    The total number of inbound IPv4 route prefixes that can be allocated across the virtual interfaces on the connection.
    prefixPoolSizeIpv6 number
    The total number of inbound IPv6 route prefixes that can be allocated across the virtual interfaces on the connection.
    prefixPoolUnallocatedCountIpv4 number
    The number of inbound IPv4 route prefixes in the connection prefix pool not yet allocated to a virtual interface.
    prefixPoolUnallocatedCountIpv6 number
    The number of inbound IPv6 route prefixes in the connection prefix pool not yet allocated to a virtual interface.
    providerName string
    Name of the service provider associated with the connection.
    rateLimiterStatuses GetConnectionRateLimiterStatus[]
    Rate limiter status for the connection. See rateLimiterStatus Block below.
    region string
    state string
    State of the connection.
    tags {[key: string]: string}
    Map of tags for the resource.
    vlanId number
    The VLAN ID.
    arn str
    ARN of the connection.
    aws_device str
    Direct Connect endpoint on which the physical connection terminates.
    bandwidth str
    Bandwidth of the connection.
    id str
    The provider-assigned unique ID for this managed resource.
    location str
    AWS Direct Connect location where the connection is located.
    name str
    owner_account_id str
    ID of the AWS account that owns the connection.
    partner_name str
    The name of the AWS Direct Connect service provider associated with the connection.
    prefix_pool_size_ipv4 int
    The total number of inbound IPv4 route prefixes that can be allocated across the virtual interfaces on the connection.
    prefix_pool_size_ipv6 int
    The total number of inbound IPv6 route prefixes that can be allocated across the virtual interfaces on the connection.
    prefix_pool_unallocated_count_ipv4 int
    The number of inbound IPv4 route prefixes in the connection prefix pool not yet allocated to a virtual interface.
    prefix_pool_unallocated_count_ipv6 int
    The number of inbound IPv6 route prefixes in the connection prefix pool not yet allocated to a virtual interface.
    provider_name str
    Name of the service provider associated with the connection.
    rate_limiter_statuses Sequence[GetConnectionRateLimiterStatus]
    Rate limiter status for the connection. See rateLimiterStatus Block below.
    region str
    state str
    State of the connection.
    tags Mapping[str, str]
    Map of tags for the resource.
    vlan_id int
    The VLAN ID.
    arn String
    ARN of the connection.
    awsDevice String
    Direct Connect endpoint on which the physical connection terminates.
    bandwidth String
    Bandwidth of the connection.
    id String
    The provider-assigned unique ID for this managed resource.
    location String
    AWS Direct Connect location where the connection is located.
    name String
    ownerAccountId String
    ID of the AWS account that owns the connection.
    partnerName String
    The name of the AWS Direct Connect service provider associated with the connection.
    prefixPoolSizeIpv4 Number
    The total number of inbound IPv4 route prefixes that can be allocated across the virtual interfaces on the connection.
    prefixPoolSizeIpv6 Number
    The total number of inbound IPv6 route prefixes that can be allocated across the virtual interfaces on the connection.
    prefixPoolUnallocatedCountIpv4 Number
    The number of inbound IPv4 route prefixes in the connection prefix pool not yet allocated to a virtual interface.
    prefixPoolUnallocatedCountIpv6 Number
    The number of inbound IPv6 route prefixes in the connection prefix pool not yet allocated to a virtual interface.
    providerName String
    Name of the service provider associated with the connection.
    rateLimiterStatuses List<Property Map>
    Rate limiter status for the connection. See rateLimiterStatus Block below.
    region String
    state String
    State of the connection.
    tags Map<String>
    Map of tags for the resource.
    vlanId Number
    The VLAN ID.

    Supporting Types

    GetConnectionRateLimiterStatus

    InUse int
    Number of rate limiters currently in use.
    MaxAllowed int
    Maximum number of rate limiters allowed on the connection.
    Remaining int
    Number of rate limiters remaining (available).
    TotalBandwidth string
    Total bandwidth allocated across all rate limiters.
    InUse int
    Number of rate limiters currently in use.
    MaxAllowed int
    Maximum number of rate limiters allowed on the connection.
    Remaining int
    Number of rate limiters remaining (available).
    TotalBandwidth string
    Total bandwidth allocated across all rate limiters.
    in_use number
    Number of rate limiters currently in use.
    max_allowed number
    Maximum number of rate limiters allowed on the connection.
    remaining number
    Number of rate limiters remaining (available).
    total_bandwidth string
    Total bandwidth allocated across all rate limiters.
    inUse Integer
    Number of rate limiters currently in use.
    maxAllowed Integer
    Maximum number of rate limiters allowed on the connection.
    remaining Integer
    Number of rate limiters remaining (available).
    totalBandwidth String
    Total bandwidth allocated across all rate limiters.
    inUse number
    Number of rate limiters currently in use.
    maxAllowed number
    Maximum number of rate limiters allowed on the connection.
    remaining number
    Number of rate limiters remaining (available).
    totalBandwidth string
    Total bandwidth allocated across all rate limiters.
    in_use int
    Number of rate limiters currently in use.
    max_allowed int
    Maximum number of rate limiters allowed on the connection.
    remaining int
    Number of rate limiters remaining (available).
    total_bandwidth str
    Total bandwidth allocated across all rate limiters.
    inUse Number
    Number of rate limiters currently in use.
    maxAllowed Number
    Maximum number of rate limiters allowed on the connection.
    remaining Number
    Number of rate limiters remaining (available).
    totalBandwidth String
    Total bandwidth allocated across all rate limiters.

    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 logo
    Viewing docs for AWS v7.46.0
    published on Thursday, Sep 10, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial