@pulumi/aws/apigateway/getKey.d.ts

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

import * as pulumi from "@pulumi/pulumi";
/**
 * Use this data source to get the name and value of a pre-existing API Key, for
 * example to supply credentials for a dependency microservice.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const myApiKey = aws.apigateway.getKey({
 *     id: "ru3mpjgse6",
 * });
 * ```
 */
export declare function getKey(args: GetKeyArgs, opts?: pulumi.InvokeOptions): Promise<GetKeyResult>;
/**
 * A collection of arguments for invoking getKey.
 */
export interface GetKeyArgs {
    /**
     * ID of the API Key to look up.
     */
    id: 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 getKey.
 */
export interface GetKeyResult {
    readonly arn: string;
    /**
     * Date and time when the API Key was created.
     */
    readonly createdDate: string;
    /**
     * Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.
     */
    readonly customerId: string;
    /**
     * Description of the API Key.
     */
    readonly description: string;
    /**
     * Whether the API Key is enabled.
     */
    readonly enabled: boolean;
    /**
     * Set to the ID of the API Key.
     */
    readonly id: string;
    /**
     * Date and time when the API Key was last updated.
     */
    readonly lastUpdatedDate: string;
    /**
     * Set to the name of the API Key.
     */
    readonly name: string;
    readonly region: string;
    /**
     * Map of tags for the resource.
     */
    readonly tags: {
        [key: string]: string;
    };
    /**
     * Set to the value of the API Key.
     */
    readonly value: string;
}
/**
 * Use this data source to get the name and value of a pre-existing API Key, for
 * example to supply credentials for a dependency microservice.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const myApiKey = aws.apigateway.getKey({
 *     id: "ru3mpjgse6",
 * });
 * ```
 */
export declare function getKeyOutput(args: GetKeyOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetKeyResult>;
/**
 * A collection of arguments for invoking getKey.
 */
export interface GetKeyOutputArgs {
    /**
     * ID of the API Key to look up.
     */
    id: 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>;
    }>;
}