import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * This resource provides the Generated Key resource in Oracle Cloud Infrastructure Kms service. * Api doc link for the resource: https://docs.oracle.com/iaas/api/#/en/key/latest/GeneratedKey * * Example terraform configs related to the resource : https://github.com/oracle/terraform-provider-oci/tree/master/examples/kms * * Generates a key that you can use to encrypt or decrypt data. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as oci from "@pulumi/oci"; * * const testGeneratedKey = new oci.kms.GeneratedKey("test_generated_key", { * cryptoEndpoint: generatedKeyCryptoEndpoint, * includePlaintextKey: generatedKeyIncludePlaintextKey === "true", * keyId: testKey.id, * keyShape: { * algorithm: generatedKeyKeyShapeAlgorithm, * length: Number(generatedKeyKeyShapeLength), * curveId: testCurve.id, * }, * associatedData: generatedKeyAssociatedData, * loggingContext: generatedKeyLoggingContext, * }); * ``` * * ## Import * * Import is not supported for this resource. */ export declare class GeneratedKey extends pulumi.CustomResource { /** * Get an existing GeneratedKey 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, state?: GeneratedKeyState, opts?: pulumi.CustomResourceOptions): GeneratedKey; /** * Returns true if the given object is an instance of GeneratedKey. 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 GeneratedKey; /** * Information that can be used to provide an encryption context for the encrypted data. The length of the string representation of the associated data must be fewer than 4096 characters. */ readonly associatedData: pulumi.Output<{ [key: string]: string; } | undefined>; /** * The encrypted data encryption key generated from a master encryption key. */ readonly ciphertext: pulumi.Output; /** * The service endpoint to perform cryptographic operations against. Cryptographic operations include 'Encrypt,' 'Decrypt,' and 'GenerateDataEncryptionKey' operations. see Vault Crypto endpoint. */ readonly cryptoEndpoint: pulumi.Output; /** * If true, the generated key is also returned unencrypted. */ readonly includePlaintextKey: pulumi.Output; /** * The OCID of the master encryption key to encrypt the generated data encryption key with. */ readonly keyId: pulumi.Output; /** * The cryptographic properties of a key. */ readonly keyShape: pulumi.Output; /** * Information that provides context for audit logging. You can provide this additional data by formatting it as key-value pairs to include in audit logs when audit logging is enabled. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ readonly loggingContext: pulumi.Output<{ [key: string]: string; } | undefined>; /** * The plaintext data encryption key, a base64-encoded sequence of random bytes, which is included if the [GenerateDataEncryptionKey](https://docs.cloud.oracle.com/iaas/api/#/en/key/latest/GeneratedKey/GenerateDataEncryptionKey) request includes the `includePlaintextKey` parameter and sets its value to "true". */ readonly plaintext: pulumi.Output; /** * The checksum of the plaintext data encryption key, which is included if the [GenerateDataEncryptionKey](https://docs.cloud.oracle.com/iaas/api/#/en/key/latest/GeneratedKey/GenerateDataEncryptionKey) request includes the `includePlaintextKey` parameter and sets its value to "true". */ readonly plaintextChecksum: pulumi.Output; /** * Create a GeneratedKey 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: GeneratedKeyArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering GeneratedKey resources. */ export interface GeneratedKeyState { /** * Information that can be used to provide an encryption context for the encrypted data. The length of the string representation of the associated data must be fewer than 4096 characters. */ associatedData?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * The encrypted data encryption key generated from a master encryption key. */ ciphertext?: pulumi.Input; /** * The service endpoint to perform cryptographic operations against. Cryptographic operations include 'Encrypt,' 'Decrypt,' and 'GenerateDataEncryptionKey' operations. see Vault Crypto endpoint. */ cryptoEndpoint?: pulumi.Input; /** * If true, the generated key is also returned unencrypted. */ includePlaintextKey?: pulumi.Input; /** * The OCID of the master encryption key to encrypt the generated data encryption key with. */ keyId?: pulumi.Input; /** * The cryptographic properties of a key. */ keyShape?: pulumi.Input; /** * Information that provides context for audit logging. You can provide this additional data by formatting it as key-value pairs to include in audit logs when audit logging is enabled. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ loggingContext?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * The plaintext data encryption key, a base64-encoded sequence of random bytes, which is included if the [GenerateDataEncryptionKey](https://docs.cloud.oracle.com/iaas/api/#/en/key/latest/GeneratedKey/GenerateDataEncryptionKey) request includes the `includePlaintextKey` parameter and sets its value to "true". */ plaintext?: pulumi.Input; /** * The checksum of the plaintext data encryption key, which is included if the [GenerateDataEncryptionKey](https://docs.cloud.oracle.com/iaas/api/#/en/key/latest/GeneratedKey/GenerateDataEncryptionKey) request includes the `includePlaintextKey` parameter and sets its value to "true". */ plaintextChecksum?: pulumi.Input; } /** * The set of arguments for constructing a GeneratedKey resource. */ export interface GeneratedKeyArgs { /** * Information that can be used to provide an encryption context for the encrypted data. The length of the string representation of the associated data must be fewer than 4096 characters. */ associatedData?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * The service endpoint to perform cryptographic operations against. Cryptographic operations include 'Encrypt,' 'Decrypt,' and 'GenerateDataEncryptionKey' operations. see Vault Crypto endpoint. */ cryptoEndpoint: pulumi.Input; /** * If true, the generated key is also returned unencrypted. */ includePlaintextKey: pulumi.Input; /** * The OCID of the master encryption key to encrypt the generated data encryption key with. */ keyId: pulumi.Input; /** * The cryptographic properties of a key. */ keyShape: pulumi.Input; /** * Information that provides context for audit logging. You can provide this additional data by formatting it as key-value pairs to include in audit logs when audit logging is enabled. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ loggingContext?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; } //# sourceMappingURL=generatedKey.d.ts.map