Docs Home
Oracle Cloud Infrastructure v2.30.0 published on Monday, Apr 14, 2025 by Pulumi
oci.Kms.EncryptedData
Explore with Pulumi AI
This resource provides the Encrypted Data resource in Oracle Cloud Infrastructure Kms service.
Encrypts data using the given EncryptDataDetails resource. Plaintext included in the example request is a base64-encoded value of a UTF-8 string.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testEncryptedData = new oci.kms.EncryptedData("test_encrypted_data", {
cryptoEndpoint: encryptedDataCryptoEndpoint,
keyId: testKey.id,
plaintext: encryptedDataPlaintext,
associatedData: encryptedDataAssociatedData,
encryptionAlgorithm: encryptedDataEncryptionAlgorithm,
keyVersionId: testKeyVersion.id,
loggingContext: encryptedDataLoggingContext,
});
import pulumi
import pulumi_oci as oci
test_encrypted_data = oci.kms.EncryptedData("test_encrypted_data",
crypto_endpoint=encrypted_data_crypto_endpoint,
key_id=test_key["id"],
plaintext=encrypted_data_plaintext,
associated_data=encrypted_data_associated_data,
encryption_algorithm=encrypted_data_encryption_algorithm,
key_version_id=test_key_version["id"],
logging_context=encrypted_data_logging_context)
package main
import (
"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/kms"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := kms.NewEncryptedData(ctx, "test_encrypted_data", &kms.EncryptedDataArgs{
CryptoEndpoint: pulumi.Any(encryptedDataCryptoEndpoint),
KeyId: pulumi.Any(testKey.Id),
Plaintext: pulumi.Any(encryptedDataPlaintext),
AssociatedData: pulumi.Any(encryptedDataAssociatedData),
EncryptionAlgorithm: pulumi.Any(encryptedDataEncryptionAlgorithm),
KeyVersionId: pulumi.Any(testKeyVersion.Id),
LoggingContext: pulumi.Any(encryptedDataLoggingContext),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;
return await Deployment.RunAsync(() =>
{
var testEncryptedData = new Oci.Kms.EncryptedData("test_encrypted_data", new()
{
CryptoEndpoint = encryptedDataCryptoEndpoint,
KeyId = testKey.Id,
Plaintext = encryptedDataPlaintext,
AssociatedData = encryptedDataAssociatedData,
EncryptionAlgorithm = encryptedDataEncryptionAlgorithm,
KeyVersionId = testKeyVersion.Id,
LoggingContext = encryptedDataLoggingContext,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Kms.EncryptedData;
import com.pulumi.oci.Kms.EncryptedDataArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var testEncryptedData = new EncryptedData("testEncryptedData", EncryptedDataArgs.builder()
.cryptoEndpoint(encryptedDataCryptoEndpoint)
.keyId(testKey.id())
.plaintext(encryptedDataPlaintext)
.associatedData(encryptedDataAssociatedData)
.encryptionAlgorithm(encryptedDataEncryptionAlgorithm)
.keyVersionId(testKeyVersion.id())
.loggingContext(encryptedDataLoggingContext)
.build());
}
}
resources:
testEncryptedData:
type: oci:Kms:EncryptedData
name: test_encrypted_data
properties:
cryptoEndpoint: ${encryptedDataCryptoEndpoint}
keyId: ${testKey.id}
plaintext: ${encryptedDataPlaintext}
associatedData: ${encryptedDataAssociatedData}
encryptionAlgorithm: ${encryptedDataEncryptionAlgorithm}
keyVersionId: ${testKeyVersion.id}
loggingContext: ${encryptedDataLoggingContext}
Create EncryptedData Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new EncryptedData(name: string, args: EncryptedDataArgs, opts?: CustomResourceOptions);@overload
def EncryptedData(resource_name: str,
args: EncryptedDataArgs,
opts: Optional[ResourceOptions] = None)
@overload
def EncryptedData(resource_name: str,
opts: Optional[ResourceOptions] = None,
crypto_endpoint: Optional[str] = None,
key_id: Optional[str] = None,
plaintext: Optional[str] = None,
associated_data: Optional[Mapping[str, str]] = None,
encryption_algorithm: Optional[str] = None,
key_version_id: Optional[str] = None,
logging_context: Optional[Mapping[str, str]] = None)func NewEncryptedData(ctx *Context, name string, args EncryptedDataArgs, opts ...ResourceOption) (*EncryptedData, error)public EncryptedData(string name, EncryptedDataArgs args, CustomResourceOptions? opts = null)public EncryptedData(String name, EncryptedDataArgs args)
public EncryptedData(String name, EncryptedDataArgs args, CustomResourceOptions options)
type: oci:Kms:EncryptedData
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name
This property is required. string - The unique name of the resource.
- args
This property is required. EncryptedDataArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
This property is required. str - The unique name of the resource.
- args
This property is required. EncryptedDataArgs - The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. EncryptedDataArgs - The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. EncryptedDataArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name
This property is required. String - The unique name of the resource.
- args
This property is required. EncryptedDataArgs - The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var encryptedDataResource = new Oci.Kms.EncryptedData("encryptedDataResource", new()
{
CryptoEndpoint = "string",
KeyId = "string",
Plaintext = "string",
AssociatedData =
{
{ "string", "string" },
},
EncryptionAlgorithm = "string",
KeyVersionId = "string",
LoggingContext =
{
{ "string", "string" },
},
});
example, err := Kms.NewEncryptedData(ctx, "encryptedDataResource", &Kms.EncryptedDataArgs{
CryptoEndpoint: pulumi.String("string"),
KeyId: pulumi.String("string"),
Plaintext: pulumi.String("string"),
AssociatedData: pulumi.StringMap{
"string": pulumi.String("string"),
},
EncryptionAlgorithm: pulumi.String("string"),
KeyVersionId: pulumi.String("string"),
LoggingContext: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
var encryptedDataResource = new EncryptedData("encryptedDataResource", EncryptedDataArgs.builder()
.cryptoEndpoint("string")
.keyId("string")
.plaintext("string")
.associatedData(Map.of("string", "string"))
.encryptionAlgorithm("string")
.keyVersionId("string")
.loggingContext(Map.of("string", "string"))
.build());
encrypted_data_resource = oci.kms.EncryptedData("encryptedDataResource",
crypto_endpoint="string",
key_id="string",
plaintext="string",
associated_data={
"string": "string",
},
encryption_algorithm="string",
key_version_id="string",
logging_context={
"string": "string",
})
const encryptedDataResource = new oci.kms.EncryptedData("encryptedDataResource", {
cryptoEndpoint: "string",
keyId: "string",
plaintext: "string",
associatedData: {
string: "string",
},
encryptionAlgorithm: "string",
keyVersionId: "string",
loggingContext: {
string: "string",
},
});
type: oci:Kms:EncryptedData
properties:
associatedData:
string: string
cryptoEndpoint: string
encryptionAlgorithm: string
keyId: string
keyVersionId: string
loggingContext:
string: string
plaintext: string
EncryptedData Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The EncryptedData resource accepts the following input properties:
- Crypto
Endpoint stringThis property is required. 
Changes to this property will trigger replacement. - The service endpoint to perform cryptographic operations against. Cryptographic operations include 'Encrypt,' 'Decrypt,' and 'GenerateDataEncryptionKey' operations. see Vault Crypto endpoint.
- Key
Id stringThis property is required. Changes to this property will trigger replacement. - The OCID of the key to encrypt with.
- Plaintext
string
This property is required. Changes to this property will trigger replacement. The plaintext data to encrypt.
** 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
- Associated
Data - 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.
- Encryption
Algorithm - The encryption algorithm to use to encrypt and decrypt data with a customer-managed key.
AES_256_GCMindicates that the key is a symmetric key that uses the Advanced Encryption Standard (AES) algorithm and that the mode of encryption is the Galois/Counter Mode (GCM).RSA_OAEP_SHA_1indicates that the key is an asymmetric key that uses the RSA encryption algorithm and uses Optimal Asymmetric Encryption Padding (OAEP).RSA_OAEP_SHA_256indicates that the key is an asymmetric key that uses the RSA encryption algorithm with a SHA-256 hash and uses OAEP. - Key
Version Id - The OCID of the key version used to encrypt the ciphertext.
- Logging
Context - Information that provides context for audit logging. You can provide this additional data as key-value pairs to include in the audit logs when audit logging is enabled.
- Crypto
Endpoint stringThis property is required. Changes to this property will trigger replacement. - The service endpoint to perform cryptographic operations against. Cryptographic operations include 'Encrypt,' 'Decrypt,' and 'GenerateDataEncryptionKey' operations. see Vault Crypto endpoint.
- Key
Id stringThis property is required. Changes to this property will trigger replacement. - The OCID of the key to encrypt with.
- Plaintext
string
This property is required. Changes to this property will trigger replacement. The plaintext data to encrypt.
** 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
- Associated
Data - 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.
- Encryption
Algorithm - The encryption algorithm to use to encrypt and decrypt data with a customer-managed key.
AES_256_GCMindicates that the key is a symmetric key that uses the Advanced Encryption Standard (AES) algorithm and that the mode of encryption is the Galois/Counter Mode (GCM).RSA_OAEP_SHA_1indicates that the key is an asymmetric key that uses the RSA encryption algorithm and uses Optimal Asymmetric Encryption Padding (OAEP).RSA_OAEP_SHA_256indicates that the key is an asymmetric key that uses the RSA encryption algorithm with a SHA-256 hash and uses OAEP. - Key
Version Id - The OCID of the key version used to encrypt the ciphertext.
- Logging
Context - Information that provides context for audit logging. You can provide this additional data as key-value pairs to include in the audit logs when audit logging is enabled.
- crypto
Endpoint StringThis property is required. Changes to this property will trigger replacement. - The service endpoint to perform cryptographic operations against. Cryptographic operations include 'Encrypt,' 'Decrypt,' and 'GenerateDataEncryptionKey' operations. see Vault Crypto endpoint.
- key
Id StringThis property is required. Changes to this property will trigger replacement. - The OCID of the key to encrypt with.
- plaintext
String
This property is required. Changes to this property will trigger replacement. The plaintext data to encrypt.
** 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
- associated
Data - 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.
- encryption
Algorithm - The encryption algorithm to use to encrypt and decrypt data with a customer-managed key.
AES_256_GCMindicates that the key is a symmetric key that uses the Advanced Encryption Standard (AES) algorithm and that the mode of encryption is the Galois/Counter Mode (GCM).RSA_OAEP_SHA_1indicates that the key is an asymmetric key that uses the RSA encryption algorithm and uses Optimal Asymmetric Encryption Padding (OAEP).RSA_OAEP_SHA_256indicates that the key is an asymmetric key that uses the RSA encryption algorithm with a SHA-256 hash and uses OAEP. - key
Version Id - The OCID of the key version used to encrypt the ciphertext.
- logging
Context - Information that provides context for audit logging. You can provide this additional data as key-value pairs to include in the audit logs when audit logging is enabled.
- crypto
Endpoint stringThis property is required. Changes to this property will trigger replacement. - The service endpoint to perform cryptographic operations against. Cryptographic operations include 'Encrypt,' 'Decrypt,' and 'GenerateDataEncryptionKey' operations. see Vault Crypto endpoint.
- key
Id stringThis property is required. Changes to this property will trigger replacement. - The OCID of the key to encrypt with.
- plaintext
string
This property is required. Changes to this property will trigger replacement. The plaintext data to encrypt.
** 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
- associated
Data - 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.
- encryption
Algorithm - The encryption algorithm to use to encrypt and decrypt data with a customer-managed key.
AES_256_GCMindicates that the key is a symmetric key that uses the Advanced Encryption Standard (AES) algorithm and that the mode of encryption is the Galois/Counter Mode (GCM).RSA_OAEP_SHA_1indicates that the key is an asymmetric key that uses the RSA encryption algorithm and uses Optimal Asymmetric Encryption Padding (OAEP).RSA_OAEP_SHA_256indicates that the key is an asymmetric key that uses the RSA encryption algorithm with a SHA-256 hash and uses OAEP. - key
Version Id - The OCID of the key version used to encrypt the ciphertext.
- logging
Context - Information that provides context for audit logging. You can provide this additional data as key-value pairs to include in the audit logs when audit logging is enabled.
- crypto_
endpoint strThis property is required. Changes to this property will trigger replacement. - The service endpoint to perform cryptographic operations against. Cryptographic operations include 'Encrypt,' 'Decrypt,' and 'GenerateDataEncryptionKey' operations. see Vault Crypto endpoint.
- key_
id strThis property is required. Changes to this property will trigger replacement. - The OCID of the key to encrypt with.
- plaintext
str
This property is required. Changes to this property will trigger replacement. The plaintext data to encrypt.
** 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
- associated_
data - 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.
- encryption_
algorithm - The encryption algorithm to use to encrypt and decrypt data with a customer-managed key.
AES_256_GCMindicates that the key is a symmetric key that uses the Advanced Encryption Standard (AES) algorithm and that the mode of encryption is the Galois/Counter Mode (GCM).RSA_OAEP_SHA_1indicates that the key is an asymmetric key that uses the RSA encryption algorithm and uses Optimal Asymmetric Encryption Padding (OAEP).RSA_OAEP_SHA_256indicates that the key is an asymmetric key that uses the RSA encryption algorithm with a SHA-256 hash and uses OAEP. - key_
version_ id - The OCID of the key version used to encrypt the ciphertext.
- logging_
context - Information that provides context for audit logging. You can provide this additional data as key-value pairs to include in the audit logs when audit logging is enabled.
- crypto
Endpoint StringThis property is required. Changes to this property will trigger replacement. - The service endpoint to perform cryptographic operations against. Cryptographic operations include 'Encrypt,' 'Decrypt,' and 'GenerateDataEncryptionKey' operations. see Vault Crypto endpoint.
- key
Id StringThis property is required. Changes to this property will trigger replacement. - The OCID of the key to encrypt with.
- plaintext
String
This property is required. Changes to this property will trigger replacement. The plaintext data to encrypt.
** 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
- associated
Data - 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.
- encryption
Algorithm - The encryption algorithm to use to encrypt and decrypt data with a customer-managed key.
AES_256_GCMindicates that the key is a symmetric key that uses the Advanced Encryption Standard (AES) algorithm and that the mode of encryption is the Galois/Counter Mode (GCM).RSA_OAEP_SHA_1indicates that the key is an asymmetric key that uses the RSA encryption algorithm and uses Optimal Asymmetric Encryption Padding (OAEP).RSA_OAEP_SHA_256indicates that the key is an asymmetric key that uses the RSA encryption algorithm with a SHA-256 hash and uses OAEP. - key
Version Id - The OCID of the key version used to encrypt the ciphertext.
- logging
Context - Information that provides context for audit logging. You can provide this additional data as key-value pairs to include in the audit logs when audit logging is enabled.
Outputs
All input properties are implicitly available as output properties. Additionally, the EncryptedData resource produces the following output properties:
- Ciphertext string
- The encrypted data.
- Id string
- The provider-assigned unique ID for this managed resource.
- Ciphertext string
- The encrypted data.
- Id string
- The provider-assigned unique ID for this managed resource.
- ciphertext String
- The encrypted data.
- id String
- The provider-assigned unique ID for this managed resource.
- ciphertext string
- The encrypted data.
- id string
- The provider-assigned unique ID for this managed resource.
- ciphertext str
- The encrypted data.
- id str
- The provider-assigned unique ID for this managed resource.
- ciphertext String
- The encrypted data.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing EncryptedData Resource
Get an existing EncryptedData resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: EncryptedDataState, opts?: CustomResourceOptions): EncryptedData@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
associated_data: Optional[Mapping[str, str]] = None,
ciphertext: Optional[str] = None,
crypto_endpoint: Optional[str] = None,
encryption_algorithm: Optional[str] = None,
key_id: Optional[str] = None,
key_version_id: Optional[str] = None,
logging_context: Optional[Mapping[str, str]] = None,
plaintext: Optional[str] = None) -> EncryptedDatafunc GetEncryptedData(ctx *Context, name string, id IDInput, state *EncryptedDataState, opts ...ResourceOption) (*EncryptedData, error)public static EncryptedData Get(string name, Input<string> id, EncryptedDataState? state, CustomResourceOptions? opts = null)public static EncryptedData get(String name, Output<String> id, EncryptedDataState state, CustomResourceOptions options)resources: _: type: oci:Kms:EncryptedData get: id: ${id}- name
This property is required. - The unique name of the resulting resource.
- id
This property is required. - The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
This property is required. - The unique name of the resulting resource.
- id
This property is required. - The unique provider ID of the resource to lookup.
- name
This property is required. - The unique name of the resulting resource.
- id
This property is required. - The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
This property is required. - The unique name of the resulting resource.
- id
This property is required. - The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
This property is required. - The unique name of the resulting resource.
- id
This property is required. - The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
The following state arguments are supported:
- Associated
Data - 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.
- Ciphertext string
- The encrypted data.
- Crypto
Endpoint - The service endpoint to perform cryptographic operations against. Cryptographic operations include 'Encrypt,' 'Decrypt,' and 'GenerateDataEncryptionKey' operations. see Vault Crypto endpoint.
- Encryption
Algorithm - The encryption algorithm to use to encrypt and decrypt data with a customer-managed key.
AES_256_GCMindicates that the key is a symmetric key that uses the Advanced Encryption Standard (AES) algorithm and that the mode of encryption is the Galois/Counter Mode (GCM).RSA_OAEP_SHA_1indicates that the key is an asymmetric key that uses the RSA encryption algorithm and uses Optimal Asymmetric Encryption Padding (OAEP).RSA_OAEP_SHA_256indicates that the key is an asymmetric key that uses the RSA encryption algorithm with a SHA-256 hash and uses OAEP. - Key
Id - The OCID of the key to encrypt with.
- Key
Version Id - The OCID of the key version used to encrypt the ciphertext.
- Logging
Context - Information that provides context for audit logging. You can provide this additional data as key-value pairs to include in the audit logs when audit logging is enabled.
- Plaintext
The plaintext data to encrypt.
** 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
- Associated
Data - 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.
- Ciphertext string
- The encrypted data.
- Crypto
Endpoint - The service endpoint to perform cryptographic operations against. Cryptographic operations include 'Encrypt,' 'Decrypt,' and 'GenerateDataEncryptionKey' operations. see Vault Crypto endpoint.
- Encryption
Algorithm - The encryption algorithm to use to encrypt and decrypt data with a customer-managed key.
AES_256_GCMindicates that the key is a symmetric key that uses the Advanced Encryption Standard (AES) algorithm and that the mode of encryption is the Galois/Counter Mode (GCM).RSA_OAEP_SHA_1indicates that the key is an asymmetric key that uses the RSA encryption algorithm and uses Optimal Asymmetric Encryption Padding (OAEP).RSA_OAEP_SHA_256indicates that the key is an asymmetric key that uses the RSA encryption algorithm with a SHA-256 hash and uses OAEP. - Key
Id - The OCID of the key to encrypt with.
- Key
Version Id - The OCID of the key version used to encrypt the ciphertext.
- Logging
Context - Information that provides context for audit logging. You can provide this additional data as key-value pairs to include in the audit logs when audit logging is enabled.
- Plaintext
The plaintext data to encrypt.
** 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
- associated
Data - 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.
- ciphertext String
- The encrypted data.
- crypto
Endpoint - The service endpoint to perform cryptographic operations against. Cryptographic operations include 'Encrypt,' 'Decrypt,' and 'GenerateDataEncryptionKey' operations. see Vault Crypto endpoint.
- encryption
Algorithm - The encryption algorithm to use to encrypt and decrypt data with a customer-managed key.
AES_256_GCMindicates that the key is a symmetric key that uses the Advanced Encryption Standard (AES) algorithm and that the mode of encryption is the Galois/Counter Mode (GCM).RSA_OAEP_SHA_1indicates that the key is an asymmetric key that uses the RSA encryption algorithm and uses Optimal Asymmetric Encryption Padding (OAEP).RSA_OAEP_SHA_256indicates that the key is an asymmetric key that uses the RSA encryption algorithm with a SHA-256 hash and uses OAEP. - key
Id - The OCID of the key to encrypt with.
- key
Version Id - The OCID of the key version used to encrypt the ciphertext.
- logging
Context - Information that provides context for audit logging. You can provide this additional data as key-value pairs to include in the audit logs when audit logging is enabled.
- plaintext
The plaintext data to encrypt.
** 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
- associated
Data - 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.
- ciphertext string
- The encrypted data.
- crypto
Endpoint - The service endpoint to perform cryptographic operations against. Cryptographic operations include 'Encrypt,' 'Decrypt,' and 'GenerateDataEncryptionKey' operations. see Vault Crypto endpoint.
- encryption
Algorithm - The encryption algorithm to use to encrypt and decrypt data with a customer-managed key.
AES_256_GCMindicates that the key is a symmetric key that uses the Advanced Encryption Standard (AES) algorithm and that the mode of encryption is the Galois/Counter Mode (GCM).RSA_OAEP_SHA_1indicates that the key is an asymmetric key that uses the RSA encryption algorithm and uses Optimal Asymmetric Encryption Padding (OAEP).RSA_OAEP_SHA_256indicates that the key is an asymmetric key that uses the RSA encryption algorithm with a SHA-256 hash and uses OAEP. - key
Id - The OCID of the key to encrypt with.
- key
Version Id - The OCID of the key version used to encrypt the ciphertext.
- logging
Context - Information that provides context for audit logging. You can provide this additional data as key-value pairs to include in the audit logs when audit logging is enabled.
- plaintext
The plaintext data to encrypt.
** 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
- associated_
data - 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.
- ciphertext str
- The encrypted data.
- crypto_
endpoint - The service endpoint to perform cryptographic operations against. Cryptographic operations include 'Encrypt,' 'Decrypt,' and 'GenerateDataEncryptionKey' operations. see Vault Crypto endpoint.
- encryption_
algorithm - The encryption algorithm to use to encrypt and decrypt data with a customer-managed key.
AES_256_GCMindicates that the key is a symmetric key that uses the Advanced Encryption Standard (AES) algorithm and that the mode of encryption is the Galois/Counter Mode (GCM).RSA_OAEP_SHA_1indicates that the key is an asymmetric key that uses the RSA encryption algorithm and uses Optimal Asymmetric Encryption Padding (OAEP).RSA_OAEP_SHA_256indicates that the key is an asymmetric key that uses the RSA encryption algorithm with a SHA-256 hash and uses OAEP. - key_
id - The OCID of the key to encrypt with.
- key_
version_ id - The OCID of the key version used to encrypt the ciphertext.
- logging_
context - Information that provides context for audit logging. You can provide this additional data as key-value pairs to include in the audit logs when audit logging is enabled.
- plaintext
The plaintext data to encrypt.
** 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
- associated
Data - 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.
- ciphertext String
- The encrypted data.
- crypto
Endpoint - The service endpoint to perform cryptographic operations against. Cryptographic operations include 'Encrypt,' 'Decrypt,' and 'GenerateDataEncryptionKey' operations. see Vault Crypto endpoint.
- encryption
Algorithm - The encryption algorithm to use to encrypt and decrypt data with a customer-managed key.
AES_256_GCMindicates that the key is a symmetric key that uses the Advanced Encryption Standard (AES) algorithm and that the mode of encryption is the Galois/Counter Mode (GCM).RSA_OAEP_SHA_1indicates that the key is an asymmetric key that uses the RSA encryption algorithm and uses Optimal Asymmetric Encryption Padding (OAEP).RSA_OAEP_SHA_256indicates that the key is an asymmetric key that uses the RSA encryption algorithm with a SHA-256 hash and uses OAEP. - key
Id - The OCID of the key to encrypt with.
- key
Version Id - The OCID of the key version used to encrypt the ciphertext.
- logging
Context - Information that provides context for audit logging. You can provide this additional data as key-value pairs to include in the audit logs when audit logging is enabled.
- plaintext
The plaintext data to encrypt.
** 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
Import
Import is not supported for this resource.
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
ociTerraform Provider.