@volcengine/pulumi
Version:
A Pulumi package for creating and managing volcengine cloud resources.
142 lines (141 loc) • 5.14 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides a resource to manage kms key material
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as volcengine from "@volcengine/pulumi";
*
* // It is necessary to first use data volcengine_kms_key_materials to obtain the import materials, such as import_token, public_key.
* // Reference document: https://www.volcengine.com/docs/6476/144950?lang=zh
* const _default = new volcengine.kms.KeyMaterial("default", {
* encryptedKeyMaterial: "***",
* expirationModel: "KEY_MATERIAL_EXPIRES",
* importToken: "***",
* keyId: "8798cd1e-****-4f9b-****-d51847ad53ae",
* keyName: "Test-3",
* keyringName: "Tf-test-1",
* validTo: 1770969621,
* });
* ```
*/
export declare class KeyMaterial extends pulumi.CustomResource {
/**
* Get an existing KeyMaterial 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?: KeyMaterialState, opts?: pulumi.CustomResourceOptions): KeyMaterial;
/**
* Returns true if the given object is an instance of KeyMaterial. 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 KeyMaterial;
/**
* The encrypted key material, Base64 encoded.
*/
readonly encryptedKeyMaterial: pulumi.Output<string>;
/**
* The expiration model of key material. Valid values: `KEY_MATERIAL_DOES_NOT_EXPIRE`, `KEY_MATERIAL_EXPIRES`. Default value: `KEY_MATERIAL_DOES_NOT_EXPIRE`.
*/
readonly expirationModel: pulumi.Output<string | undefined>;
/**
* The import token.
*/
readonly importToken: pulumi.Output<string>;
/**
* The id of key. When keyId is not specified, both keyringName and keyName must be specified.
*/
readonly keyId: pulumi.Output<string | undefined>;
/**
* The name of key.
*/
readonly keyName: pulumi.Output<string | undefined>;
/**
* The name of keyring.
*/
readonly keyringName: pulumi.Output<string | undefined>;
/**
* The valid to timestamp of key material. Required when expirationModel is KEY_MATERIAL_EXPIRES. Unit: second.
*/
readonly validTo: pulumi.Output<number | undefined>;
/**
* Create a KeyMaterial 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: KeyMaterialArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering KeyMaterial resources.
*/
export interface KeyMaterialState {
/**
* The encrypted key material, Base64 encoded.
*/
encryptedKeyMaterial?: pulumi.Input<string>;
/**
* The expiration model of key material. Valid values: `KEY_MATERIAL_DOES_NOT_EXPIRE`, `KEY_MATERIAL_EXPIRES`. Default value: `KEY_MATERIAL_DOES_NOT_EXPIRE`.
*/
expirationModel?: pulumi.Input<string>;
/**
* The import token.
*/
importToken?: pulumi.Input<string>;
/**
* The id of key. When keyId is not specified, both keyringName and keyName must be specified.
*/
keyId?: pulumi.Input<string>;
/**
* The name of key.
*/
keyName?: pulumi.Input<string>;
/**
* The name of keyring.
*/
keyringName?: pulumi.Input<string>;
/**
* The valid to timestamp of key material. Required when expirationModel is KEY_MATERIAL_EXPIRES. Unit: second.
*/
validTo?: pulumi.Input<number>;
}
/**
* The set of arguments for constructing a KeyMaterial resource.
*/
export interface KeyMaterialArgs {
/**
* The encrypted key material, Base64 encoded.
*/
encryptedKeyMaterial: pulumi.Input<string>;
/**
* The expiration model of key material. Valid values: `KEY_MATERIAL_DOES_NOT_EXPIRE`, `KEY_MATERIAL_EXPIRES`. Default value: `KEY_MATERIAL_DOES_NOT_EXPIRE`.
*/
expirationModel?: pulumi.Input<string>;
/**
* The import token.
*/
importToken: pulumi.Input<string>;
/**
* The id of key. When keyId is not specified, both keyringName and keyName must be specified.
*/
keyId?: pulumi.Input<string>;
/**
* The name of key.
*/
keyName?: pulumi.Input<string>;
/**
* The name of keyring.
*/
keyringName?: pulumi.Input<string>;
/**
* The valid to timestamp of key material. Required when expirationModel is KEY_MATERIAL_EXPIRES. Unit: second.
*/
validTo?: pulumi.Input<number>;
}