← All packages

AWS Classic

Pulumi Official

Package maintained by Pulumi

v5.9.1 published on Tuesday, Jun 21, 2022 by Pulumi

Source code

getConnection

Retrieve information about a Direct Connect Connection.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var example = Output.Create(Aws.DirectConnect.GetConnection.InvokeAsync(new Aws.DirectConnect.GetConnectionArgs
        {
            Name = "tf-dx-connection",
        }));
    }

}

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/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
	})
}

package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = Output.of(DirectconnectFunctions.getConnection(GetConnectionArgs.builder()
            .name("tf-dx-connection")
            .build()));

    }
}

import pulumi
import pulumi_aws as aws

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

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

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

variables:
  example:
    Fn::Invoke:
      Function: aws:directconnect:getConnection
      Arguments:
        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?: InvokeOptions): Output<GetConnectionResult>

def get_connection(name: Optional[str] = None,
                   tags: Optional[Mapping[str, str]] = None,
                   opts: Optional[InvokeOptions] = None) -> GetConnectionResult
def get_connection_output(name: Optional[pulumi.Input[str]] = None,
                   tags: Optional[pulumi.Input[Mapping[str, 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)
// Output-based functions aren't available in Java yet

Fn::Invoke:
  Function: aws:directconnect/getConnection:getConnection
  Arguments:
    # Arguments dictionary

The following arguments are supported:

Name string: The name of the connection to retrieve.
Tags Dictionary<string, string>: A map of tags for the resource.

Name string: The name of the connection to retrieve.
Tags map[string]string: A map of tags for the resource.

name String: The name of the connection to retrieve.
tags Map<String,String>: A map of tags for the resource.

name string: The name of the connection to retrieve.
tags {[key: string]: string}: A map of tags for the resource.

name str: The name of the connection to retrieve.
tags Mapping[str, str]: A map of tags for the resource.

name String: The name of the connection to retrieve.
tags Map<String>: A map of tags for the resource.

getConnection Result

The following output properties are available:

Arn string: The ARN of the connection.
AwsDevice string: The Direct Connect endpoint on which the physical connection terminates.
Bandwidth string: The bandwidth of the connection.
Id string: The provider-assigned unique ID for this managed resource.
Location string: The AWS Direct Connect location where the connection is located.
Name string
OwnerAccountId string: The ID of the AWS account that owns the connection.
ProviderName string: The name of the service provider associated with the connection.
Tags Dictionary<string, string>: A map of tags for the resource.

Arn string: The ARN of the connection.
AwsDevice string: The Direct Connect endpoint on which the physical connection terminates.
Bandwidth string: The bandwidth of the connection.
Id string: The provider-assigned unique ID for this managed resource.
Location string: The AWS Direct Connect location where the connection is located.
Name string
OwnerAccountId string: The ID of the AWS account that owns the connection.
ProviderName string: The name of the service provider associated with the connection.
Tags map[string]string: A map of tags for the resource.

arn String: The ARN of the connection.
awsDevice String: The Direct Connect endpoint on which the physical connection terminates.
bandwidth String: The bandwidth of the connection.
id String: The provider-assigned unique ID for this managed resource.
location String: The AWS Direct Connect location where the connection is located.
name String
ownerAccountId String: The ID of the AWS account that owns the connection.
providerName String: The name of the service provider associated with the connection.
tags Map<String,String>: A map of tags for the resource.

arn string: The ARN of the connection.
awsDevice string: The Direct Connect endpoint on which the physical connection terminates.
bandwidth string: The bandwidth of the connection.
id string: The provider-assigned unique ID for this managed resource.
location string: The AWS Direct Connect location where the connection is located.
name string
ownerAccountId string: The ID of the AWS account that owns the connection.
providerName string: The name of the service provider associated with the connection.
tags {[key: string]: string}: A map of tags for the resource.

arn str: The ARN of the connection.
aws_device str: The Direct Connect endpoint on which the physical connection terminates.
bandwidth str: The bandwidth of the connection.
id str: The provider-assigned unique ID for this managed resource.
location str: The AWS Direct Connect location where the connection is located.
name str
owner_account_id str: The ID of the AWS account that owns the connection.
provider_name str: The name of the service provider associated with the connection.
tags Mapping[str, str]: A map of tags for the resource.

arn String: The ARN of the connection.
awsDevice String: The Direct Connect endpoint on which the physical connection terminates.
bandwidth String: The bandwidth of the connection.
id String: The provider-assigned unique ID for this managed resource.
location String: The AWS Direct Connect location where the connection is located.
name String
ownerAccountId String: The ID of the AWS account that owns the connection.
providerName String: The name of the service provider associated with the connection.
tags Map<String>: A map of tags for the resource.

Package Details

Repository: https://github.com/pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.