@volcengine/pulumi/kms/replicateKey.d.ts

A Pulumi package for creating and managing volcengine cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
 * Provides a resource to manage kms replicate key
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as volcengine from "@volcengine/pulumi";
 *
 * // Only create a backup key in the replica region;
 * // Next, managing key requires the use of resource "volcengine_kms_key".
 * const replica = new volcengine.kms.ReplicateKey("replica", {
 *     description: "replica description",
 *     keyName: "mrk-Tf-Test-1",
 *     keyringName: "test",
 *     replicaRegion: "cn-shanghai",
 *     tags: [{
 *         key: "tfk1",
 *         value: "tfv1",
 *     }],
 * });
 * ```
 *
 * ## Import
 *
 * The KmsReplicateKey is not support imported.
 */
export declare class ReplicateKey extends pulumi.CustomResource {
    /**
     * Get an existing ReplicateKey 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?: ReplicateKeyState, opts?: pulumi.CustomResourceOptions): ReplicateKey;
    /**
     * Returns true if the given object is an instance of ReplicateKey.  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 ReplicateKey;
    /**
     * The description of the replicated regional key.
     */
    readonly description: pulumi.Output<string | undefined>;
    /**
     * The id of the key. When keyId is not specified, both keyringName and keyName must be specified.
     */
    readonly keyId: pulumi.Output<string | undefined>;
    /**
     * The name of the key. Note: Only multi-region keys support replication.
     */
    readonly keyName: pulumi.Output<string | undefined>;
    /**
     * The name of the keyring.
     */
    readonly keyringName: pulumi.Output<string | undefined>;
    /**
     * The id of the replica key.
     */
    readonly replicaKeyId: pulumi.Output<string>;
    /**
     * The target region for replica key.
     */
    readonly replicaRegion: pulumi.Output<string>;
    /**
     * Tags.
     */
    readonly tags: pulumi.Output<outputs.kms.ReplicateKeyTag[] | undefined>;
    /**
     * Create a ReplicateKey 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: ReplicateKeyArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering ReplicateKey resources.
 */
export interface ReplicateKeyState {
    /**
     * The description of the replicated regional key.
     */
    description?: pulumi.Input<string>;
    /**
     * The id of the key. When keyId is not specified, both keyringName and keyName must be specified.
     */
    keyId?: pulumi.Input<string>;
    /**
     * The name of the key. Note: Only multi-region keys support replication.
     */
    keyName?: pulumi.Input<string>;
    /**
     * The name of the keyring.
     */
    keyringName?: pulumi.Input<string>;
    /**
     * The id of the replica key.
     */
    replicaKeyId?: pulumi.Input<string>;
    /**
     * The target region for replica key.
     */
    replicaRegion?: pulumi.Input<string>;
    /**
     * Tags.
     */
    tags?: pulumi.Input<pulumi.Input<inputs.kms.ReplicateKeyTag>[]>;
}
/**
 * The set of arguments for constructing a ReplicateKey resource.
 */
export interface ReplicateKeyArgs {
    /**
     * The description of the replicated regional key.
     */
    description?: pulumi.Input<string>;
    /**
     * The id of the key. When keyId is not specified, both keyringName and keyName must be specified.
     */
    keyId?: pulumi.Input<string>;
    /**
     * The name of the key. Note: Only multi-region keys support replication.
     */
    keyName?: pulumi.Input<string>;
    /**
     * The name of the keyring.
     */
    keyringName?: pulumi.Input<string>;
    /**
     * The target region for replica key.
     */
    replicaRegion: pulumi.Input<string>;
    /**
     * Tags.
     */
    tags?: pulumi.Input<pulumi.Input<inputs.kms.ReplicateKeyTag>[]>;
}