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

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

import * as pulumi from "@pulumi/pulumi";
/**
 * Provides details about CodeStar Connection.
 *
 * ## Example Usage
 *
 * ### By ARN
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const example = aws.codestarconnections.getConnection({
 *     arn: exampleAwsCodestarconnectionsConnection.arn,
 * });
 * ```
 *
 * ### By Name
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const example = aws.codestarconnections.getConnection({
 *     name: exampleAwsCodestarconnectionsConnection.name,
 * });
 * ```
 */
export declare function getConnection(args?: GetConnectionArgs, opts?: pulumi.InvokeOptions): Promise<GetConnectionResult>;
/**
 * A collection of arguments for invoking getConnection.
 */
export interface GetConnectionArgs {
    /**
     * CodeStar Connection ARN.
     */
    arn?: string;
    /**
     * CodeStar Connection name.
     *
     * > **NOTE:** When both `arn` and `name` are specified, `arn` takes precedence.
     */
    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 key-value resource tags to associate with the resource.
     */
    tags?: {
        [key: string]: string;
    };
}
/**
 * A collection of values returned by getConnection.
 */
export interface GetConnectionResult {
    readonly arn: string;
    /**
     * CodeStar Connection status. Possible values are `PENDING`, `AVAILABLE` and `ERROR`.
     */
    readonly connectionStatus: string;
    /**
     * ARN of the host associated with the connection.
     */
    readonly hostArn: string;
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    /**
     * Name of the CodeStar Connection. The name is unique in the calling AWS account.
     */
    readonly name: string;
    /**
     * Name of the external provider where your third-party code repository is configured. Possible values are `Bitbucket`, `GitHub` and `GitLab`. For connections to GitHub Enterprise Server or GitLab Self-Managed instances, you must create an aws.codestarconnections.Host resource and use `hostArn` instead.
     */
    readonly providerType: string;
    readonly region: string;
    /**
     * Map of key-value resource tags to associate with the resource.
     */
    readonly tags: {
        [key: string]: string;
    };
}
/**
 * Provides details about CodeStar Connection.
 *
 * ## Example Usage
 *
 * ### By ARN
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const example = aws.codestarconnections.getConnection({
 *     arn: exampleAwsCodestarconnectionsConnection.arn,
 * });
 * ```
 *
 * ### By Name
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const example = aws.codestarconnections.getConnection({
 *     name: exampleAwsCodestarconnectionsConnection.name,
 * });
 * ```
 */
export declare function getConnectionOutput(args?: GetConnectionOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetConnectionResult>;
/**
 * A collection of arguments for invoking getConnection.
 */
export interface GetConnectionOutputArgs {
    /**
     * CodeStar Connection ARN.
     */
    arn?: pulumi.Input<string>;
    /**
     * CodeStar Connection name.
     *
     * > **NOTE:** When both `arn` and `name` are specified, `arn` takes precedence.
     */
    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 key-value resource tags to associate with the resource.
     */
    tags?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
}