DistributedDatabaseShardWithExadbXsNewVaultAndCluster¶

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

Bases: oci.distributed_database.models.distributed_database_shard.DistributedDatabaseShard

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
`STATUS_CONFIGURED`	A constant which can be used with the status property of a DistributedDatabaseShardWithExadbXsNewVaultAndCluster.
`STATUS_CREATED`	A constant which can be used with the status property of a DistributedDatabaseShardWithExadbXsNewVaultAndCluster.
`STATUS_CREATING`	A constant which can be used with the status property of a DistributedDatabaseShardWithExadbXsNewVaultAndCluster.
`STATUS_DELETED`	A constant which can be used with the status property of a DistributedDatabaseShardWithExadbXsNewVaultAndCluster.
`STATUS_DELETING`	A constant which can be used with the status property of a DistributedDatabaseShardWithExadbXsNewVaultAndCluster.
`STATUS_FAILED`	A constant which can be used with the status property of a DistributedDatabaseShardWithExadbXsNewVaultAndCluster.
`STATUS_NEEDS_ATTENTION`	A constant which can be used with the status property of a DistributedDatabaseShardWithExadbXsNewVaultAndCluster.
`STATUS_READY_FOR_CONFIGURATION`	A constant which can be used with the status property of a DistributedDatabaseShardWithExadbXsNewVaultAndCluster.
`STATUS_UPDATING`	A constant which can be used with the status property of a DistributedDatabaseShardWithExadbXsNewVaultAndCluster.
`availability_domain`	Gets the availability_domain of this DistributedDatabaseShardWithExadbXsNewVaultAndCluster.
`container_database_id`	Gets the container_database_id of this DistributedDatabaseShardWithExadbXsNewVaultAndCluster.
`db_home_id`	Gets the db_home_id of this DistributedDatabaseShardWithExadbXsNewVaultAndCluster.
`db_storage_vault_details`	Gets the db_storage_vault_details of this DistributedDatabaseShardWithExadbXsNewVaultAndCluster.
`kms_key_id`	Gets the kms_key_id of this DistributedDatabaseShardWithExadbXsNewVaultAndCluster.
`kms_key_version_id`	Gets the kms_key_version_id of this DistributedDatabaseShardWithExadbXsNewVaultAndCluster.
`metadata`	Gets the metadata of this DistributedDatabaseShardWithExadbXsNewVaultAndCluster.
`name`	[Required] Gets the name of this DistributedDatabaseShard.
`peer_details`	Gets the peer_details of this DistributedDatabaseShardWithExadbXsNewVaultAndCluster.
`shard_group`	[Required] Gets the shard_group of this DistributedDatabaseShardWithExadbXsNewVaultAndCluster.
`shard_space`	Gets the shard_space of this DistributedDatabaseShardWithExadbXsNewVaultAndCluster.
`source`	[Required] Gets the source of this DistributedDatabaseShard.
`status`	[Required] Gets the status of this DistributedDatabaseShardWithExadbXsNewVaultAndCluster.
`supporting_resource_id`	Gets the supporting_resource_id of this DistributedDatabaseShardWithExadbXsNewVaultAndCluster.
`time_created`	[Required] Gets the time_created of this DistributedDatabaseShard.
`time_updated`	[Required] Gets the time_updated of this DistributedDatabaseShard.
`vault_id`	Gets the vault_id of this DistributedDatabaseShardWithExadbXsNewVaultAndCluster.
`vm_cluster_details`	Gets the vm_cluster_details of this DistributedDatabaseShardWithExadbXsNewVaultAndCluster.

Methods

`__init__`(**kwargs)	Initializes a new DistributedDatabaseShardWithExadbXsNewVaultAndCluster 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'¶

STATUS_CONFIGURED = 'CONFIGURED'¶: A constant which can be used with the status property of a DistributedDatabaseShardWithExadbXsNewVaultAndCluster. This constant has a value of “CONFIGURED”

STATUS_CREATED = 'CREATED'¶: A constant which can be used with the status property of a DistributedDatabaseShardWithExadbXsNewVaultAndCluster. This constant has a value of “CREATED”

STATUS_CREATING = 'CREATING'¶: A constant which can be used with the status property of a DistributedDatabaseShardWithExadbXsNewVaultAndCluster. This constant has a value of “CREATING”

STATUS_DELETED = 'DELETED'¶: A constant which can be used with the status property of a DistributedDatabaseShardWithExadbXsNewVaultAndCluster. This constant has a value of “DELETED”

STATUS_DELETING = 'DELETING'¶: A constant which can be used with the status property of a DistributedDatabaseShardWithExadbXsNewVaultAndCluster. This constant has a value of “DELETING”

STATUS_FAILED = 'FAILED'¶: A constant which can be used with the status property of a DistributedDatabaseShardWithExadbXsNewVaultAndCluster. This constant has a value of “FAILED”

STATUS_NEEDS_ATTENTION = 'NEEDS_ATTENTION'¶: A constant which can be used with the status property of a DistributedDatabaseShardWithExadbXsNewVaultAndCluster. This constant has a value of “NEEDS_ATTENTION”

STATUS_READY_FOR_CONFIGURATION = 'READY_FOR_CONFIGURATION'¶: A constant which can be used with the status property of a DistributedDatabaseShardWithExadbXsNewVaultAndCluster. This constant has a value of “READY_FOR_CONFIGURATION”

STATUS_UPDATING = 'UPDATING'¶: A constant which can be used with the status property of a DistributedDatabaseShardWithExadbXsNewVaultAndCluster. This constant has a value of “UPDATING”

__init__(**kwargs)¶

Initializes a new DistributedDatabaseShardWithExadbXsNewVaultAndCluster 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 DistributedDatabaseShardWithExadbXsNewVaultAndCluster. Allowed values for this property are: “EXADB_XS”, “NEW_VAULT_AND_CLUSTER”, “EXISTING_CLUSTER”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
name (str) – The value to assign to the name property of this DistributedDatabaseShardWithExadbXsNewVaultAndCluster.
time_created (datetime) – The value to assign to the time_created property of this DistributedDatabaseShardWithExadbXsNewVaultAndCluster.
time_updated (datetime) – The value to assign to the time_updated property of this DistributedDatabaseShardWithExadbXsNewVaultAndCluster.
db_home_id (str) – The value to assign to the db_home_id property of this DistributedDatabaseShardWithExadbXsNewVaultAndCluster.
shard_group (str) – The value to assign to the shard_group property of this DistributedDatabaseShardWithExadbXsNewVaultAndCluster.
shard_space (str) – The value to assign to the shard_space property of this DistributedDatabaseShardWithExadbXsNewVaultAndCluster.
vault_id (str) – The value to assign to the vault_id property of this DistributedDatabaseShardWithExadbXsNewVaultAndCluster.
kms_key_id (str) – The value to assign to the kms_key_id property of this DistributedDatabaseShardWithExadbXsNewVaultAndCluster.
kms_key_version_id (str) – The value to assign to the kms_key_version_id property of this DistributedDatabaseShardWithExadbXsNewVaultAndCluster.
status (str) – The value to assign to the status property of this DistributedDatabaseShardWithExadbXsNewVaultAndCluster. Allowed values for this property are: “FAILED”, “DELETING”, “DELETED”, “UPDATING”, “CREATING”, “CREATED”, “READY_FOR_CONFIGURATION”, “CONFIGURED”, “NEEDS_ATTENTION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
supporting_resource_id (str) – The value to assign to the supporting_resource_id property of this DistributedDatabaseShardWithExadbXsNewVaultAndCluster.
container_database_id (str) – The value to assign to the container_database_id property of this DistributedDatabaseShardWithExadbXsNewVaultAndCluster.
availability_domain (str) – The value to assign to the availability_domain property of this DistributedDatabaseShardWithExadbXsNewVaultAndCluster.
db_storage_vault_details (oci.distributed_database.models.DistributedDbStorageVault) – The value to assign to the db_storage_vault_details property of this DistributedDatabaseShardWithExadbXsNewVaultAndCluster.
vm_cluster_details (oci.distributed_database.models.DistributedDbVmCluster) – The value to assign to the vm_cluster_details property of this DistributedDatabaseShardWithExadbXsNewVaultAndCluster.
peer_details (list[oci.distributed_database.models.ShardPeerWithExadbXsNewVaultAndCluster]) – The value to assign to the peer_details property of this DistributedDatabaseShardWithExadbXsNewVaultAndCluster.
metadata (oci.distributed_database.models.DistributedDbMetadata) – The value to assign to the metadata property of this DistributedDatabaseShardWithExadbXsNewVaultAndCluster.

availability_domain¶

Gets the availability_domain of this DistributedDatabaseShardWithExadbXsNewVaultAndCluster. The name of the availability domain that the distributed database shard will be located in.

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

container_database_id¶

Gets the container_database_id of this DistributedDatabaseShardWithExadbXsNewVaultAndCluster. the identifier of the container database for underlying supporting resource.

Returns:	The container_database_id of this DistributedDatabaseShardWithExadbXsNewVaultAndCluster.
Return type:	str

db_home_id¶

Gets the db_home_id of this DistributedDatabaseShardWithExadbXsNewVaultAndCluster. The OCID of the Database Home.

Returns:	The db_home_id of this DistributedDatabaseShardWithExadbXsNewVaultAndCluster.
Return type:	str

db_storage_vault_details¶

Gets the db_storage_vault_details of this DistributedDatabaseShardWithExadbXsNewVaultAndCluster.

Returns:	The db_storage_vault_details of this DistributedDatabaseShardWithExadbXsNewVaultAndCluster.
Return type:	oci.distributed_database.models.DistributedDbStorageVault

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 DistributedDatabaseShardWithExadbXsNewVaultAndCluster. 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 DistributedDatabaseShardWithExadbXsNewVaultAndCluster.
Return type:	str

kms_key_version_id¶

Gets the kms_key_version_id of this DistributedDatabaseShardWithExadbXsNewVaultAndCluster. 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 DistributedDatabaseShardWithExadbXsNewVaultAndCluster.
Return type:	str

metadata¶

Gets the metadata of this DistributedDatabaseShardWithExadbXsNewVaultAndCluster.

Returns:	The metadata of this DistributedDatabaseShardWithExadbXsNewVaultAndCluster.
Return type:	oci.distributed_database.models.DistributedDbMetadata

name¶

[Required] Gets the name of this DistributedDatabaseShard. Name of the shard.

Returns:	The name of this DistributedDatabaseShard.
Return type:	str

peer_details¶

Gets the peer_details of this DistributedDatabaseShardWithExadbXsNewVaultAndCluster. Peer details for the shard.

Returns:	The peer_details of this DistributedDatabaseShardWithExadbXsNewVaultAndCluster.
Return type:	list[oci.distributed_database.models.ShardPeerWithExadbXsNewVaultAndCluster]

shard_group¶

[Required] Gets the shard_group of this DistributedDatabaseShardWithExadbXsNewVaultAndCluster. The name of the shardGroup for the shard.

Returns:	The shard_group of this DistributedDatabaseShardWithExadbXsNewVaultAndCluster.
Return type:	str

shard_space¶

Gets the shard_space of this DistributedDatabaseShardWithExadbXsNewVaultAndCluster. 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 DistributedDatabaseShardWithExadbXsNewVaultAndCluster.
Return type:	str

source¶

[Required] Gets the source of this DistributedDatabaseShard. 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”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

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

status¶

[Required] Gets the status of this DistributedDatabaseShardWithExadbXsNewVaultAndCluster. Status of EXADB_XS based shard.

Allowed values for this property are: “FAILED”, “DELETING”, “DELETED”, “UPDATING”, “CREATING”, “CREATED”, “READY_FOR_CONFIGURATION”, “CONFIGURED”, “NEEDS_ATTENTION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The status of this DistributedDatabaseShardWithExadbXsNewVaultAndCluster.
Return type:	str

supporting_resource_id¶

Gets the supporting_resource_id of this DistributedDatabaseShardWithExadbXsNewVaultAndCluster. the identifier of the underlying supporting resource.

Returns:	The supporting_resource_id of this DistributedDatabaseShardWithExadbXsNewVaultAndCluster.
Return type:	str

time_created¶

[Required] Gets the time_created of this DistributedDatabaseShard. The time the shard was created. An RFC3339 formatted datetime string

Returns:	The time_created of this DistributedDatabaseShard.
Return type:	datetime

time_updated¶

[Required] Gets the time_updated of this DistributedDatabaseShard. The time the shard was last updated. An RFC3339 formatted datetime string

Returns:	The time_updated of this DistributedDatabaseShard.
Return type:	datetime

vault_id¶

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

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

vm_cluster_details¶

Gets the vm_cluster_details of this DistributedDatabaseShardWithExadbXsNewVaultAndCluster.

Returns:	The vm_cluster_details of this DistributedDatabaseShardWithExadbXsNewVaultAndCluster.
Return type:	oci.distributed_database.models.DistributedDbVmCluster