@volcengine/pulumi
Version:
A Pulumi package for creating and managing volcengine cloud resources.
123 lines (122 loc) • 4.31 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides a resource to manage kms ciphertext
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as volcengine from "@volcengine/pulumi";
*
* const encryptStable = new volcengine.kms.Ciphertext("encryptStable", {
* keyId: "c44870c3-f33b-421a-****-a2bba37c993e",
* plaintext: "VGhpcyBpcyBhIHBsYWludGV4dCBleGFtcGxlLg==",
* });
* ```
*
* ## Import
*
* The KmsCiphertext is not support import.
*/
export declare class Ciphertext extends pulumi.CustomResource {
/**
* Get an existing Ciphertext 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?: CiphertextState, opts?: pulumi.CustomResourceOptions): Ciphertext;
/**
* Returns true if the given object is an instance of Ciphertext. 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 Ciphertext;
/**
* The ciphertext, Base64 encoded. The produced ciphertextBlob stays stable across applies. If the plaintext should be re-encrypted on each apply use the `volcengine.kms.getCiphertexts` data source.
*/
readonly ciphertextBlob: pulumi.Output<string>;
/**
* The JSON string of key/value pairs.
*/
readonly encryptionContext: 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.
*/
readonly keyName: pulumi.Output<string | undefined>;
/**
* The name of the keyring.
*/
readonly keyringName: pulumi.Output<string | undefined>;
/**
* The plaintext to be symmetrically encrypted, Base64 encoded.
*/
readonly plaintext: pulumi.Output<string>;
/**
* Create a Ciphertext 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: CiphertextArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Ciphertext resources.
*/
export interface CiphertextState {
/**
* The ciphertext, Base64 encoded. The produced ciphertextBlob stays stable across applies. If the plaintext should be re-encrypted on each apply use the `volcengine.kms.getCiphertexts` data source.
*/
ciphertextBlob?: pulumi.Input<string>;
/**
* The JSON string of key/value pairs.
*/
encryptionContext?: 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.
*/
keyName?: pulumi.Input<string>;
/**
* The name of the keyring.
*/
keyringName?: pulumi.Input<string>;
/**
* The plaintext to be symmetrically encrypted, Base64 encoded.
*/
plaintext?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Ciphertext resource.
*/
export interface CiphertextArgs {
/**
* The JSON string of key/value pairs.
*/
encryptionContext?: 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.
*/
keyName?: pulumi.Input<string>;
/**
* The name of the keyring.
*/
keyringName?: pulumi.Input<string>;
/**
* The plaintext to be symmetrically encrypted, Base64 encoded.
*/
plaintext: pulumi.Input<string>;
}