@pulumiverse/scaleway/getKeyManagerKey.d.ts

A Pulumi package for creating and managing Scaleway cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as outputs from "./types/output";
/**
 * Gets information about a Key Manager Key. For more information, refer to the [Key Manager API documentation](https://www.scaleway.com/en/developers/api/key-manager/#path-keys-get-key-metadata).
 *
 * ## Example Usage
 *
 * ### Create a key and get its information
 *
 * The following commands allow you to:
 *
 * - create a key named `my-kms-key`
 * - retrieve the key's information using the key's ID
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as scaleway from "@pulumiverse/scaleway";
 *
 * // Create a key
 * const symmetric = new scaleway.keymanager.Key("symmetric", {
 *     name: "my-kms-key",
 *     region: "fr-par",
 *     projectId: "your-project-id",
 *     usage: "symmetric_encryption",
 *     algorithm: "aes_256_gcm",
 *     description: "Key for encrypting secrets",
 *     tags: [
 *         "env:prod",
 *         "kms",
 *     ],
 *     unprotected: true,
 *     rotationPolicy: {
 *         rotationPeriod: "720h",
 *     },
 * });
 * // Get the key information by its ID
 * const byID = scaleway.keymanager.getKey({
 *     keyId: "11111111-1111-1111-1111-111111111111",
 * });
 * ```
 */
/** @deprecated scaleway.index/getkeymanagerkey.getKeyManagerKey has been deprecated in favor of scaleway.keymanager/getkey.getKey */
export declare function getKeyManagerKey(args: GetKeyManagerKeyArgs, opts?: pulumi.InvokeOptions): Promise<GetKeyManagerKeyResult>;
/**
 * A collection of arguments for invoking getKeyManagerKey.
 */
export interface GetKeyManagerKeyArgs {
    /**
     * ID of the key to target. Can be a plain UUID or a regional ID.
     */
    keyId: string;
    /**
     * `region`) The region in which the key was created.
     */
    region?: string;
}
/**
 * A collection of values returned by getKeyManagerKey.
 */
export interface GetKeyManagerKeyResult {
    readonly algorithm: string;
    readonly createdAt: string;
    readonly description: string;
    readonly id: string;
    readonly keyId: string;
    readonly locked: boolean;
    readonly name: string;
    readonly origin: string;
    readonly projectId: string;
    readonly protected: boolean;
    readonly region?: string;
    readonly rotatedAt: string;
    readonly rotationCount: number;
    readonly rotationPolicies: outputs.GetKeyManagerKeyRotationPolicy[];
    readonly state: string;
    readonly tags: string[];
    readonly unprotected: boolean;
    readonly updatedAt: string;
    readonly usage: string;
}
/**
 * Gets information about a Key Manager Key. For more information, refer to the [Key Manager API documentation](https://www.scaleway.com/en/developers/api/key-manager/#path-keys-get-key-metadata).
 *
 * ## Example Usage
 *
 * ### Create a key and get its information
 *
 * The following commands allow you to:
 *
 * - create a key named `my-kms-key`
 * - retrieve the key's information using the key's ID
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as scaleway from "@pulumiverse/scaleway";
 *
 * // Create a key
 * const symmetric = new scaleway.keymanager.Key("symmetric", {
 *     name: "my-kms-key",
 *     region: "fr-par",
 *     projectId: "your-project-id",
 *     usage: "symmetric_encryption",
 *     algorithm: "aes_256_gcm",
 *     description: "Key for encrypting secrets",
 *     tags: [
 *         "env:prod",
 *         "kms",
 *     ],
 *     unprotected: true,
 *     rotationPolicy: {
 *         rotationPeriod: "720h",
 *     },
 * });
 * // Get the key information by its ID
 * const byID = scaleway.keymanager.getKey({
 *     keyId: "11111111-1111-1111-1111-111111111111",
 * });
 * ```
 */
/** @deprecated scaleway.index/getkeymanagerkey.getKeyManagerKey has been deprecated in favor of scaleway.keymanager/getkey.getKey */
export declare function getKeyManagerKeyOutput(args: GetKeyManagerKeyOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetKeyManagerKeyResult>;
/**
 * A collection of arguments for invoking getKeyManagerKey.
 */
export interface GetKeyManagerKeyOutputArgs {
    /**
     * ID of the key to target. Can be a plain UUID or a regional ID.
     */
    keyId: pulumi.Input<string>;
    /**
     * `region`) The region in which the key was created.
     */
    region?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=getKeyManagerKey.d.ts.map