@volcengine/pulumi
Version:
A Pulumi package for creating and managing volcengine cloud resources.
143 lines (142 loc) • 5.81 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides a resource to manage kms asymmetric signature
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as volcengine from "@volcengine/pulumi";
*
* const signStable1 = new volcengine.kms.AsymmetricSignature("signStable1", {
* algorithm: "RSA_PSS_SHA_256",
* keyId: "516274b3-0cba-4fad-****-c8355e3e8213",
* message: "VGhpcyBpcyBhIG1lc3NhZ2UgZXhhbXBsZS4=",
* messageType: "RAW",
* });
* const signStable2 = new volcengine.kms.AsymmetricSignature("signStable2", {
* algorithm: "RSA_PSS_SHA_256",
* keyId: "516274b3-0cba-4fad-****-c8355e3e8213",
* message: "KsFMwOobjOMHfYaPl2IgXX6tzziiT+SucmfmXTo2f6U=",
* messageType: "DIGEST",
* });
* ```
*
* ## Import
*
* The KmsAsymmetricSignature is not support import.
*/
export declare class AsymmetricSignature extends pulumi.CustomResource {
/**
* Get an existing AsymmetricSignature 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?: AsymmetricSignatureState, opts?: pulumi.CustomResourceOptions): AsymmetricSignature;
/**
* Returns true if the given object is an instance of AsymmetricSignature. 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 AsymmetricSignature;
/**
* The signing algorithm. valid values: `RSA_PSS_SHA_256`, `RSA_PKCS1_SHA_256`, `RSA_PSS_SHA_384`, `RSA_PKCS1_SHA_384`, `RSA_PSS_SHA_512`, `RSA_PKCS1_SHA_512`.
*/
readonly algorithm: pulumi.Output<string>;
/**
* 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 message to be signed, Base64 encoded.
*/
readonly message: pulumi.Output<string>;
/**
* The type of message. Valid values: RAW or DIGEST. When messageType is DIGEST, KMS does not process the message digest of the original data source, it will sign directly with the private key.
*/
readonly messageType: pulumi.Output<string | undefined>;
/**
* The signature, Base64 encoded. The produced signature stays stable across applies. If the message should be re-signed on each apply use the `volcengine.kms.getAsymmetricSignatures` data source.
*/
readonly signature: pulumi.Output<string>;
/**
* Create a AsymmetricSignature 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: AsymmetricSignatureArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering AsymmetricSignature resources.
*/
export interface AsymmetricSignatureState {
/**
* The signing algorithm. valid values: `RSA_PSS_SHA_256`, `RSA_PKCS1_SHA_256`, `RSA_PSS_SHA_384`, `RSA_PKCS1_SHA_384`, `RSA_PSS_SHA_512`, `RSA_PKCS1_SHA_512`.
*/
algorithm?: 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 message to be signed, Base64 encoded.
*/
message?: pulumi.Input<string>;
/**
* The type of message. Valid values: RAW or DIGEST. When messageType is DIGEST, KMS does not process the message digest of the original data source, it will sign directly with the private key.
*/
messageType?: pulumi.Input<string>;
/**
* The signature, Base64 encoded. The produced signature stays stable across applies. If the message should be re-signed on each apply use the `volcengine.kms.getAsymmetricSignatures` data source.
*/
signature?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a AsymmetricSignature resource.
*/
export interface AsymmetricSignatureArgs {
/**
* The signing algorithm. valid values: `RSA_PSS_SHA_256`, `RSA_PKCS1_SHA_256`, `RSA_PSS_SHA_384`, `RSA_PKCS1_SHA_384`, `RSA_PSS_SHA_512`, `RSA_PKCS1_SHA_512`.
*/
algorithm: 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 message to be signed, Base64 encoded.
*/
message: pulumi.Input<string>;
/**
* The type of message. Valid values: RAW or DIGEST. When messageType is DIGEST, KMS does not process the message digest of the original data source, it will sign directly with the private key.
*/
messageType?: pulumi.Input<string>;
}