DedicatedShardOrCatalogEncryptionKeyDetails¶

class oci.globally_distributed_database.models.DedicatedShardOrCatalogEncryptionKeyDetails(**kwargs)¶

Bases: object

Details of encryption key to be used to encrypt data for shards and catalog for sharded database. For system-defined sharding type, all shards have to use same encryptionKeyDetails. For system-defined sharding, if encryptionKeyDetails are not specified for catalog, then Oracle managed key will be used for catalog. For user-defined sharding type, if encryptionKeyDetails are not provided for any shard or catalog, then Oracle managed key will be used for such shard or catalog. For system-defined or user-defined sharding type, if the shard or catalog has a peer in region other than primary shard or catalog region, then make sure to provide virtual vault for such shard or catalog, which is also replicated to peer region (the region where peer or standby shard or catalog exists).

Methods

__init__(**kwargs) Initializes a new DedicatedShardOrCatalogEncryptionKeyDetails object with values from keyword arguments.

Attributes

`kms_key_id`	[Required] Gets the kms_key_id of this DedicatedShardOrCatalogEncryptionKeyDetails.
`kms_key_version_id`	Gets the kms_key_version_id of this DedicatedShardOrCatalogEncryptionKeyDetails.
`vault_id`	[Required] Gets the vault_id of this DedicatedShardOrCatalogEncryptionKeyDetails.

__init__(**kwargs)¶

Initializes a new DedicatedShardOrCatalogEncryptionKeyDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:	vault_id (str) – The value to assign to the vault_id property of this DedicatedShardOrCatalogEncryptionKeyDetails. kms_key_id (str) – The value to assign to the kms_key_id property of this DedicatedShardOrCatalogEncryptionKeyDetails. kms_key_version_id (str) – The value to assign to the kms_key_version_id property of this DedicatedShardOrCatalogEncryptionKeyDetails.

kms_key_id¶

[Required] Gets the kms_key_id of this DedicatedShardOrCatalogEncryptionKeyDetails. The OCID of the KMS key in vault identified by vaultId in customer tenancy that is used as the master encryption key.

Returns:	The kms_key_id of this DedicatedShardOrCatalogEncryptionKeyDetails.
Return type:	str

kms_key_version_id¶

Gets the kms_key_version_id of this DedicatedShardOrCatalogEncryptionKeyDetails. The OCID of the KMS key version for key identified by kmsKeyId that is used in data encryption (TDE) operations.

Returns:	The kms_key_version_id of this DedicatedShardOrCatalogEncryptionKeyDetails.
Return type:	str

vault_id¶

[Required] Gets the vault_id of this DedicatedShardOrCatalogEncryptionKeyDetails. The OCID of the vault in customer tenancy where KMS key is present. For shard or catalog with cross-region data guard enabled, user needs to make sure to provide virtual private vault only, which is also replicated in the region of standby shard.

Returns:	The vault_id of this DedicatedShardOrCatalogEncryptionKeyDetails.
Return type:	str