@pulumi/yandex/kmsSymmetricKey.d.ts

A Pulumi package for creating and managing yandex cloud resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * ## Import
 *
 * A KMS symmetric key can be imported using the `id` of the resource, e.g.
 *
 * ```sh
 *  $ pulumi import yandex:index/kmsSymmetricKey:KmsSymmetricKey top-secret kms_key_id
 * ```
 */
export declare class KmsSymmetricKey extends pulumi.CustomResource {
    /**
     * Get an existing KmsSymmetricKey resource's state with the given name, ID, and optional extra
     * properties used to qualify the lookup.
     *
     * @param name The _unique_ name of the resulting resource.
     * @param id The _unique_ provider ID of the resource to lookup.
     * @param state Any extra arguments used during the lookup.
     * @param opts Optional settings to control the behavior of the CustomResource.
     */
    static get(name: string, id: pulumi.Input<pulumi.ID>, state?: KmsSymmetricKeyState, opts?: pulumi.CustomResourceOptions): KmsSymmetricKey;
    /**
     * Returns true if the given object is an instance of KmsSymmetricKey.  This is designed to work even
     * when multiple copies of the Pulumi SDK have been loaded into the same process.
     */
    static isInstance(obj: any): obj is KmsSymmetricKey;
    /**
     * Creation timestamp of the key.
     */
    readonly createdAt: pulumi.Output<string>;
    /**
     * Encryption algorithm to be used with a new key version,
     * generated with the next rotation. The default value is `AES_128`.
     */
    readonly defaultAlgorithm: pulumi.Output<string | undefined>;
    /**
     * An optional description of the key.
     */
    readonly description: pulumi.Output<string | undefined>;
    /**
     * The ID of the folder that the resource belongs to. If it
     * is not provided, the default provider folder is used.
     */
    readonly folderId: pulumi.Output<string>;
    /**
     * A set of key/value label pairs to assign to the key.
     */
    readonly labels: pulumi.Output<{
        [key: string]: string;
    } | undefined>;
    /**
     * Name of the key.
     */
    readonly name: pulumi.Output<string>;
    /**
     * Last rotation timestamp of the key.
     */
    readonly rotatedAt: pulumi.Output<string>;
    /**
     * Interval between automatic rotations. To disable automatic rotation, omit this parameter.
     */
    readonly rotationPeriod: pulumi.Output<string | undefined>;
    /**
     * The status of the key.
     */
    readonly status: pulumi.Output<string>;
    /**
     * Create a KmsSymmetricKey resource with the given unique name, arguments, and options.
     *
     * @param name The _unique_ name of the resource.
     * @param args The arguments to use to populate this resource's properties.
     * @param opts A bag of options that control this resource's behavior.
     */
    constructor(name: string, args?: KmsSymmetricKeyArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering KmsSymmetricKey resources.
 */
export interface KmsSymmetricKeyState {
    /**
     * Creation timestamp of the key.
     */
    createdAt?: pulumi.Input<string>;
    /**
     * Encryption algorithm to be used with a new key version,
     * generated with the next rotation. The default value is `AES_128`.
     */
    defaultAlgorithm?: pulumi.Input<string>;
    /**
     * An optional description of the key.
     */
    description?: pulumi.Input<string>;
    /**
     * The ID of the folder that the resource belongs to. If it
     * is not provided, the default provider folder is used.
     */
    folderId?: pulumi.Input<string>;
    /**
     * A set of key/value label pairs to assign to the key.
     */
    labels?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
    /**
     * Name of the key.
     */
    name?: pulumi.Input<string>;
    /**
     * Last rotation timestamp of the key.
     */
    rotatedAt?: pulumi.Input<string>;
    /**
     * Interval between automatic rotations. To disable automatic rotation, omit this parameter.
     */
    rotationPeriod?: pulumi.Input<string>;
    /**
     * The status of the key.
     */
    status?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a KmsSymmetricKey resource.
 */
export interface KmsSymmetricKeyArgs {
    /**
     * Encryption algorithm to be used with a new key version,
     * generated with the next rotation. The default value is `AES_128`.
     */
    defaultAlgorithm?: pulumi.Input<string>;
    /**
     * An optional description of the key.
     */
    description?: pulumi.Input<string>;
    /**
     * The ID of the folder that the resource belongs to. If it
     * is not provided, the default provider folder is used.
     */
    folderId?: pulumi.Input<string>;
    /**
     * A set of key/value label pairs to assign to the key.
     */
    labels?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
    /**
     * Name of the key.
     */
    name?: pulumi.Input<string>;
    /**
     * Interval between automatic rotations. To disable automatic rotation, omit this parameter.
     */
    rotationPeriod?: pulumi.Input<string>;
}