@pulumi/aws/directconnect/getConnection.d.ts

A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * Retrieve information about a Direct Connect Connection.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const example = aws.directconnect.getConnection({
 *     name: "tf-dx-connection",
 * });
 * ```
 */
export declare function getConnection(args: GetConnectionArgs, opts?: pulumi.InvokeOptions): Promise<GetConnectionResult>;
/**
 * A collection of arguments for invoking getConnection.
 */
export interface GetConnectionArgs {
    /**
     * Name of the connection to retrieve.
     */
    name: string;
    /**
     * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
     */
    region?: string;
    /**
     * Map of tags for the resource.
     */
    tags?: {
        [key: string]: string;
    };
}
/**
 * A collection of values returned by getConnection.
 */
export interface GetConnectionResult {
    /**
     * ARN of the connection.
     */
    readonly arn: string;
    /**
     * Direct Connect endpoint on which the physical connection terminates.
     */
    readonly awsDevice: string;
    /**
     * Bandwidth of the connection.
     */
    readonly bandwidth: string;
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    /**
     * AWS Direct Connect location where the connection is located.
     */
    readonly location: string;
    readonly name: string;
    /**
     * ID of the AWS account that owns the connection.
     */
    readonly ownerAccountId: string;
    /**
     * The name of the AWS Direct Connect service provider associated with the connection.
     */
    readonly partnerName: string;
    /**
     * Name of the service provider associated with the connection.
     */
    readonly providerName: string;
    readonly region: string;
    /**
     * State of the connection.
     */
    readonly state: string;
    /**
     * Map of tags for the resource.
     */
    readonly tags: {
        [key: string]: string;
    };
    /**
     * The VLAN ID.
     */
    readonly vlanId: number;
}
/**
 * Retrieve information about a Direct Connect Connection.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const example = aws.directconnect.getConnection({
 *     name: "tf-dx-connection",
 * });
 * ```
 */
export declare function getConnectionOutput(args: GetConnectionOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetConnectionResult>;
/**
 * A collection of arguments for invoking getConnection.
 */
export interface GetConnectionOutputArgs {
    /**
     * Name of the connection to retrieve.
     */
    name: pulumi.Input<string>;
    /**
     * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
     */
    region?: pulumi.Input<string>;
    /**
     * Map of tags for the resource.
     */
    tags?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
}