CreateDistributedDatabaseShardWithExadbXsNewVaultAndClusterDetails¶

class oci.distributed_database.models.CreateDistributedDatabaseShardWithExadbXsNewVaultAndClusterDetails(**kwargs)¶

Bases: oci.distributed_database.models.create_distributed_database_shard_details.CreateDistributedDatabaseShardDetails

Globally distributed database shard based on ExaDbXs.

Attributes

`SOURCE_EXADB_XS`	str(object=’’) -> str
`SOURCE_EXISTING_CLUSTER`	str(object=’’) -> str
`SOURCE_NEW_VAULT_AND_CLUSTER`	str(object=’’) -> str
`admin_password`	[Required] Gets the admin_password of this CreateDistributedDatabaseShardWithExadbXsNewVaultAndClusterDetails.
`availability_domain`	[Required] Gets the availability_domain of this CreateDistributedDatabaseShardWithExadbXsNewVaultAndClusterDetails.
`db_storage_vault_details`	[Required] Gets the db_storage_vault_details of this CreateDistributedDatabaseShardWithExadbXsNewVaultAndClusterDetails.
`kms_key_id`	Gets the kms_key_id of this CreateDistributedDatabaseShardWithExadbXsNewVaultAndClusterDetails.
`kms_key_version_id`	Gets the kms_key_version_id of this CreateDistributedDatabaseShardWithExadbXsNewVaultAndClusterDetails.
`peer_details`	Gets the peer_details of this CreateDistributedDatabaseShardWithExadbXsNewVaultAndClusterDetails.
`shard_space`	Gets the shard_space of this CreateDistributedDatabaseShardWithExadbXsNewVaultAndClusterDetails.
`source`	[Required] Gets the source of this CreateDistributedDatabaseShardDetails.
`vault_id`	Gets the vault_id of this CreateDistributedDatabaseShardWithExadbXsNewVaultAndClusterDetails.
`vm_cluster_details`	[Required] Gets the vm_cluster_details of this CreateDistributedDatabaseShardWithExadbXsNewVaultAndClusterDetails.

Methods

`__init__`(**kwargs)	Initializes a new CreateDistributedDatabaseShardWithExadbXsNewVaultAndClusterDetails object with values from keyword arguments.
`get_subtype`(object_dictionary)	Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

SOURCE_EXADB_XS = 'EXADB_XS'¶

SOURCE_EXISTING_CLUSTER = 'EXISTING_CLUSTER'¶

SOURCE_NEW_VAULT_AND_CLUSTER = 'NEW_VAULT_AND_CLUSTER'¶

__init__(**kwargs)¶

Initializes a new CreateDistributedDatabaseShardWithExadbXsNewVaultAndClusterDetails object with values from keyword arguments. The default value of the source attribute of this class is NEW_VAULT_AND_CLUSTER and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

source (str) – The value to assign to the source property of this CreateDistributedDatabaseShardWithExadbXsNewVaultAndClusterDetails. Allowed values for this property are: “EXADB_XS”, “NEW_VAULT_AND_CLUSTER”, “EXISTING_CLUSTER”
admin_password (str) – The value to assign to the admin_password property of this CreateDistributedDatabaseShardWithExadbXsNewVaultAndClusterDetails.
peer_details (list[oci.distributed_database.models.CreateShardPeerWithExadbXsNewVaultAndClusterDetails]) – The value to assign to the peer_details property of this CreateDistributedDatabaseShardWithExadbXsNewVaultAndClusterDetails.
shard_space (str) – The value to assign to the shard_space property of this CreateDistributedDatabaseShardWithExadbXsNewVaultAndClusterDetails.
vault_id (str) – The value to assign to the vault_id property of this CreateDistributedDatabaseShardWithExadbXsNewVaultAndClusterDetails.
kms_key_id (str) – The value to assign to the kms_key_id property of this CreateDistributedDatabaseShardWithExadbXsNewVaultAndClusterDetails.
kms_key_version_id (str) – The value to assign to the kms_key_version_id property of this CreateDistributedDatabaseShardWithExadbXsNewVaultAndClusterDetails.
availability_domain (str) – The value to assign to the availability_domain property of this CreateDistributedDatabaseShardWithExadbXsNewVaultAndClusterDetails.
db_storage_vault_details (oci.distributed_database.models.DbStorageVaultDetails) – The value to assign to the db_storage_vault_details property of this CreateDistributedDatabaseShardWithExadbXsNewVaultAndClusterDetails.
vm_cluster_details (oci.distributed_database.models.VmClusterDetails) – The value to assign to the vm_cluster_details property of this CreateDistributedDatabaseShardWithExadbXsNewVaultAndClusterDetails.

admin_password¶

[Required] Gets the admin_password of this CreateDistributedDatabaseShardWithExadbXsNewVaultAndClusterDetails. The admin password for the shard associated with Globally distributed database.

Returns:	The admin_password of this CreateDistributedDatabaseShardWithExadbXsNewVaultAndClusterDetails.
Return type:	str

availability_domain¶

[Required] Gets the availability_domain of this CreateDistributedDatabaseShardWithExadbXsNewVaultAndClusterDetails. The name of the availability domain that the distributed database shard will be located in.

Returns:	The availability_domain of this CreateDistributedDatabaseShardWithExadbXsNewVaultAndClusterDetails.
Return type:	str

db_storage_vault_details¶

[Required] Gets the db_storage_vault_details of this CreateDistributedDatabaseShardWithExadbXsNewVaultAndClusterDetails.

Returns:	The db_storage_vault_details of this CreateDistributedDatabaseShardWithExadbXsNewVaultAndClusterDetails.
Return type:	oci.distributed_database.models.DbStorageVaultDetails

static get_subtype(object_dictionary)¶: Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

kms_key_id¶

Gets the kms_key_id of this CreateDistributedDatabaseShardWithExadbXsNewVaultAndClusterDetails. The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.

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

kms_key_version_id¶

Gets the kms_key_version_id of this CreateDistributedDatabaseShardWithExadbXsNewVaultAndClusterDetails. The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions.

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

peer_details¶

Gets the peer_details of this CreateDistributedDatabaseShardWithExadbXsNewVaultAndClusterDetails. The details required for creation of the peer for the ExadbXs infrastructure based shard.

Returns:	The peer_details of this CreateDistributedDatabaseShardWithExadbXsNewVaultAndClusterDetails.
Return type:	list[oci.distributed_database.models.CreateShardPeerWithExadbXsNewVaultAndClusterDetails]

shard_space¶

Gets the shard_space of this CreateDistributedDatabaseShardWithExadbXsNewVaultAndClusterDetails. The shard space name for the Globally distributed database. Shard space for existing shard cannot be changed, once shard is created. Shard space name shall be used while creation of new shards.

Returns:	The shard_space of this CreateDistributedDatabaseShardWithExadbXsNewVaultAndClusterDetails.
Return type:	str

source¶

[Required] Gets the source of this CreateDistributedDatabaseShardDetails. Type of Globally distributed database Shard or Catalog. Use NEW_VAULT_AND_CLUSTER for a Globally distributed database on Exascale with new vaults and clusters created from scratch. Use EXISTING_CLUSTER for a Globally distributed database on Exascale based on pre-existing clusters. EXADB_XS is currently the same as EXISTING_CLUSTER and will be deprecated after the deprecation cycle.

Allowed values for this property are: “EXADB_XS”, “NEW_VAULT_AND_CLUSTER”, “EXISTING_CLUSTER”

Returns:	The source of this CreateDistributedDatabaseShardDetails.
Return type:	str

vault_id¶

Gets the vault_id of this CreateDistributedDatabaseShardWithExadbXsNewVaultAndClusterDetails. The OCID of the Oracle Cloud Infrastructure vault. This parameter and kmsKeyId are required for Customer Managed Keys.

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

vm_cluster_details¶

[Required] Gets the vm_cluster_details of this CreateDistributedDatabaseShardWithExadbXsNewVaultAndClusterDetails.

Returns:	The vm_cluster_details of this CreateDistributedDatabaseShardWithExadbXsNewVaultAndClusterDetails.
Return type:	oci.distributed_database.models.VmClusterDetails