@pulumi/aws/kms/getAlias.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 ARN of a KMS key alias.
 * By using this data source, you can reference key alias
 * without having to hard code the ARN as input.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const s3 = aws.kms.getAlias({
 *     name: "alias/aws/s3",
 * });
 * ```
 */
export declare function getAlias(args: GetAliasArgs, opts?: pulumi.InvokeOptions): Promise<GetAliasResult>;
/**
 * A collection of arguments for invoking getAlias.
 */
export interface GetAliasArgs {
    /**
     * Display name of the alias. The name must start with the word "alias" followed by a forward slash (alias/)
     */
    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;
}
/**
 * A collection of values returned by getAlias.
 */
export interface GetAliasResult {
    /**
     * Amazon Resource Name(ARN) of the key alias.
     */
    readonly arn: string;
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    /**
     * Name of the alias
     */
    readonly name: string;
    readonly region: string;
    /**
     * ARN pointed to by the alias.
     */
    readonly targetKeyArn: string;
    /**
     * Key identifier pointed to by the alias.
     */
    readonly targetKeyId: string;
}
/**
 * Use this data source to get the ARN of a KMS key alias.
 * By using this data source, you can reference key alias
 * without having to hard code the ARN as input.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const s3 = aws.kms.getAlias({
 *     name: "alias/aws/s3",
 * });
 * ```
 */
export declare function getAliasOutput(args: GetAliasOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetAliasResult>;
/**
 * A collection of arguments for invoking getAlias.
 */
export interface GetAliasOutputArgs {
    /**
     * Display name of the alias. The name must start with the word "alias" followed by a forward slash (alias/)
     */
    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>;
}