UNPKG

@volcengine/pulumi

Version:

A Pulumi package for creating and managing volcengine cloud resources.

120 lines (119 loc) 3.53 kB
import * as pulumi from "@pulumi/pulumi"; /** * Provides a resource to manage kms key archive * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as volcengine from "@volcengine/pulumi"; * * const fooKeyring = new volcengine.kms.Keyring("fooKeyring", { * keyringName: "tf-test", * description: "tf-test", * projectName: "default", * }); * const fooKey = new volcengine.kms.Key("fooKey", { * keyringName: fooKeyring.keyringName, * keyName: "mrk-tf-key-mod", * description: "tf test key-mod", * tags: [{ * key: "tfkey3", * value: "tfvalue3", * }], * }); * const fooKeyArchive = new volcengine.kms.KeyArchive("fooKeyArchive", {keyId: fooKey.id}); * ``` * * ## Import * * KmsKeyArchive can be imported using the id, e.g. * * ```sh * $ pulumi import volcengine:kms/keyArchive:KeyArchive default resource_id * ``` * * or * * ```sh * $ pulumi import volcengine:kms/keyArchive:KeyArchive default key_name:keyring_name * ``` */ export declare class KeyArchive extends pulumi.CustomResource { /** * Get an existing KeyArchive 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?: KeyArchiveState, opts?: pulumi.CustomResourceOptions): KeyArchive; /** * Returns true if the given object is an instance of KeyArchive. 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 KeyArchive; /** * The id of the CMK. */ readonly keyId: pulumi.Output<string>; /** * The name of the CMK. */ readonly keyName: pulumi.Output<string>; /** * The state of the key. */ readonly keyState: pulumi.Output<string>; /** * The name of the keyring. */ readonly keyringName: pulumi.Output<string | undefined>; /** * Create a KeyArchive 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?: KeyArchiveArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering KeyArchive resources. */ export interface KeyArchiveState { /** * The id of the CMK. */ keyId?: pulumi.Input<string>; /** * The name of the CMK. */ keyName?: pulumi.Input<string>; /** * The state of the key. */ keyState?: pulumi.Input<string>; /** * The name of the keyring. */ keyringName?: pulumi.Input<string>; } /** * The set of arguments for constructing a KeyArchive resource. */ export interface KeyArchiveArgs { /** * The id of the CMK. */ keyId?: pulumi.Input<string>; /** * The name of the CMK. */ keyName?: pulumi.Input<string>; /** * The name of the keyring. */ keyringName?: pulumi.Input<string>; }