DistributedDatabaseShardDatabaseWithExadbXsNewCluster

class oci.distributed_database.models.DistributedDatabaseShardDatabaseWithExadbXsNewCluster(**kwargs)

Bases: DistributedDatabaseShardDatabase

Details of a distributed database shard on ExaDB-XS with a new cluster.

Attributes:

PROTECTION_MODE_MAXIMUM_AVAILABILITY

A constant which can be used with the protection_mode property of a DistributedDatabaseShardDatabaseWithExadbXsNewCluster.

PROTECTION_MODE_MAXIMUM_PERFORMANCE

A constant which can be used with the protection_mode property of a DistributedDatabaseShardDatabaseWithExadbXsNewCluster.

PROTECTION_MODE_MAXIMUM_PROTECTION

A constant which can be used with the protection_mode property of a DistributedDatabaseShardDatabaseWithExadbXsNewCluster.

SOURCE_EXISTING_DB_HOME

A constant which can be used with the source property of a DistributedDatabaseShardDatabase.

SOURCE_XD_EXISTING_CLUSTER

A constant which can be used with the source property of a DistributedDatabaseShardDatabase.

SOURCE_XS_EXISTING_CLUSTER

A constant which can be used with the source property of a DistributedDatabaseShardDatabase.

SOURCE_XS_NEW_CLUSTER

A constant which can be used with the source property of a DistributedDatabaseShardDatabase.

SOURCE_XS_NEW_VAULT_AND_CLUSTER

A constant which can be used with the source property of a DistributedDatabaseShardDatabase.

STATUS_CONFIGURED

A constant which can be used with the status property of a DistributedDatabaseShardDatabaseWithExadbXsNewCluster.

STATUS_CREATED

A constant which can be used with the status property of a DistributedDatabaseShardDatabaseWithExadbXsNewCluster.

STATUS_CREATING

A constant which can be used with the status property of a DistributedDatabaseShardDatabaseWithExadbXsNewCluster.

STATUS_DELETED

A constant which can be used with the status property of a DistributedDatabaseShardDatabaseWithExadbXsNewCluster.

STATUS_DELETING

A constant which can be used with the status property of a DistributedDatabaseShardDatabaseWithExadbXsNewCluster.

STATUS_FAILED

A constant which can be used with the status property of a DistributedDatabaseShardDatabaseWithExadbXsNewCluster.

STATUS_NEEDS_ATTENTION

A constant which can be used with the status property of a DistributedDatabaseShardDatabaseWithExadbXsNewCluster.

STATUS_READY_FOR_CONFIGURATION

A constant which can be used with the status property of a DistributedDatabaseShardDatabaseWithExadbXsNewCluster.

STATUS_UPDATING

A constant which can be used with the status property of a DistributedDatabaseShardDatabaseWithExadbXsNewCluster.

TRANSPORT_TYPE_ASYNC

A constant which can be used with the transport_type property of a DistributedDatabaseShardDatabaseWithExadbXsNewCluster.

TRANSPORT_TYPE_FASTSYNC

A constant which can be used with the transport_type property of a DistributedDatabaseShardDatabaseWithExadbXsNewCluster.

TRANSPORT_TYPE_SYNC

A constant which can be used with the transport_type property of a DistributedDatabaseShardDatabaseWithExadbXsNewCluster.

availability_domain

Gets the availability_domain of this DistributedDatabaseShardDatabaseWithExadbXsNewCluster.

container_database_id

Gets the container_database_id of this DistributedDatabaseShardDatabaseWithExadbXsNewCluster.

db_home_id

Gets the db_home_id of this DistributedDatabaseShardDatabaseWithExadbXsNewCluster.

exascale_db_storage_vault_id

[Required] Gets the exascale_db_storage_vault_id of this DistributedDatabaseShardDatabaseWithExadbXsNewCluster.

kms_key_id

Gets the kms_key_id of this DistributedDatabaseShardDatabaseWithExadbXsNewCluster.

kms_key_version_id

Gets the kms_key_version_id of this DistributedDatabaseShardDatabaseWithExadbXsNewCluster.

metadata

Gets the metadata of this DistributedDatabaseShardDatabase.

name

[Required] Gets the name of this DistributedDatabaseShardDatabase.

protection_mode

Gets the protection_mode of this DistributedDatabaseShardDatabaseWithExadbXsNewCluster.

source

[Required] Gets the source of this DistributedDatabaseShardDatabase.

status

[Required] Gets the status of this DistributedDatabaseShardDatabaseWithExadbXsNewCluster.

supporting_resource_id

Gets the supporting_resource_id of this DistributedDatabaseShardDatabaseWithExadbXsNewCluster.

time_created

[Required] Gets the time_created of this DistributedDatabaseShardDatabase.

time_updated

[Required] Gets the time_updated of this DistributedDatabaseShardDatabase.

transport_type

Gets the transport_type of this DistributedDatabaseShardDatabaseWithExadbXsNewCluster.

vault_id

Gets the vault_id of this DistributedDatabaseShardDatabaseWithExadbXsNewCluster.

vm_cluster_details

Gets the vm_cluster_details of this DistributedDatabaseShardDatabaseWithExadbXsNewCluster.

Methods:

__init__(**kwargs)

Initializes a new DistributedDatabaseShardDatabaseWithExadbXsNewCluster 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.

PROTECTION_MODE_MAXIMUM_AVAILABILITY = 'MAXIMUM_AVAILABILITY'

A constant which can be used with the protection_mode property of a DistributedDatabaseShardDatabaseWithExadbXsNewCluster. This constant has a value of “MAXIMUM_AVAILABILITY”

PROTECTION_MODE_MAXIMUM_PERFORMANCE = 'MAXIMUM_PERFORMANCE'

A constant which can be used with the protection_mode property of a DistributedDatabaseShardDatabaseWithExadbXsNewCluster. This constant has a value of “MAXIMUM_PERFORMANCE”

PROTECTION_MODE_MAXIMUM_PROTECTION = 'MAXIMUM_PROTECTION'

A constant which can be used with the protection_mode property of a DistributedDatabaseShardDatabaseWithExadbXsNewCluster. This constant has a value of “MAXIMUM_PROTECTION”

SOURCE_EXISTING_DB_HOME = 'EXISTING_DB_HOME'

A constant which can be used with the source property of a DistributedDatabaseShardDatabase. This constant has a value of “EXISTING_DB_HOME”

SOURCE_XD_EXISTING_CLUSTER = 'XD_EXISTING_CLUSTER'

A constant which can be used with the source property of a DistributedDatabaseShardDatabase. This constant has a value of “XD_EXISTING_CLUSTER”

SOURCE_XS_EXISTING_CLUSTER = 'XS_EXISTING_CLUSTER'

A constant which can be used with the source property of a DistributedDatabaseShardDatabase. This constant has a value of “XS_EXISTING_CLUSTER”

SOURCE_XS_NEW_CLUSTER = 'XS_NEW_CLUSTER'

A constant which can be used with the source property of a DistributedDatabaseShardDatabase. This constant has a value of “XS_NEW_CLUSTER”

SOURCE_XS_NEW_VAULT_AND_CLUSTER = 'XS_NEW_VAULT_AND_CLUSTER'

A constant which can be used with the source property of a DistributedDatabaseShardDatabase. This constant has a value of “XS_NEW_VAULT_AND_CLUSTER”

STATUS_CONFIGURED = 'CONFIGURED'

A constant which can be used with the status property of a DistributedDatabaseShardDatabaseWithExadbXsNewCluster. This constant has a value of “CONFIGURED”

STATUS_CREATED = 'CREATED'

A constant which can be used with the status property of a DistributedDatabaseShardDatabaseWithExadbXsNewCluster. This constant has a value of “CREATED”

STATUS_CREATING = 'CREATING'

A constant which can be used with the status property of a DistributedDatabaseShardDatabaseWithExadbXsNewCluster. This constant has a value of “CREATING”

STATUS_DELETED = 'DELETED'

A constant which can be used with the status property of a DistributedDatabaseShardDatabaseWithExadbXsNewCluster. This constant has a value of “DELETED”

STATUS_DELETING = 'DELETING'

A constant which can be used with the status property of a DistributedDatabaseShardDatabaseWithExadbXsNewCluster. This constant has a value of “DELETING”

STATUS_FAILED = 'FAILED'

A constant which can be used with the status property of a DistributedDatabaseShardDatabaseWithExadbXsNewCluster. This constant has a value of “FAILED”

STATUS_NEEDS_ATTENTION = 'NEEDS_ATTENTION'

A constant which can be used with the status property of a DistributedDatabaseShardDatabaseWithExadbXsNewCluster. 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 DistributedDatabaseShardDatabaseWithExadbXsNewCluster. This constant has a value of “READY_FOR_CONFIGURATION”

STATUS_UPDATING = 'UPDATING'

A constant which can be used with the status property of a DistributedDatabaseShardDatabaseWithExadbXsNewCluster. This constant has a value of “UPDATING”

TRANSPORT_TYPE_ASYNC = 'ASYNC'

A constant which can be used with the transport_type property of a DistributedDatabaseShardDatabaseWithExadbXsNewCluster. This constant has a value of “ASYNC”

TRANSPORT_TYPE_FASTSYNC = 'FASTSYNC'

A constant which can be used with the transport_type property of a DistributedDatabaseShardDatabaseWithExadbXsNewCluster. This constant has a value of “FASTSYNC”

TRANSPORT_TYPE_SYNC = 'SYNC'

A constant which can be used with the transport_type property of a DistributedDatabaseShardDatabaseWithExadbXsNewCluster. This constant has a value of “SYNC”

__init__(**kwargs)

Initializes a new DistributedDatabaseShardDatabaseWithExadbXsNewCluster object with values from keyword arguments. The default value of the source attribute of this class is XS_NEW_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 DistributedDatabaseShardDatabaseWithExadbXsNewCluster. Allowed values for this property are: “XS_EXISTING_CLUSTER”, “XS_NEW_CLUSTER”, “XS_NEW_VAULT_AND_CLUSTER”, “XD_EXISTING_CLUSTER”, “EXISTING_DB_HOME”, ‘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 DistributedDatabaseShardDatabaseWithExadbXsNewCluster.

  • time_created (datetime) – The value to assign to the time_created property of this DistributedDatabaseShardDatabaseWithExadbXsNewCluster.

  • time_updated (datetime) – The value to assign to the time_updated property of this DistributedDatabaseShardDatabaseWithExadbXsNewCluster.

  • metadata (oci.distributed_database.models.DistributedDbMetadata) – The value to assign to the metadata property of this DistributedDatabaseShardDatabaseWithExadbXsNewCluster.

  • db_home_id (str) – The value to assign to the db_home_id property of this DistributedDatabaseShardDatabaseWithExadbXsNewCluster.

  • vault_id (str) – The value to assign to the vault_id property of this DistributedDatabaseShardDatabaseWithExadbXsNewCluster.

  • kms_key_id (str) – The value to assign to the kms_key_id property of this DistributedDatabaseShardDatabaseWithExadbXsNewCluster.

  • kms_key_version_id (str) – The value to assign to the kms_key_version_id property of this DistributedDatabaseShardDatabaseWithExadbXsNewCluster.

  • status (str) – The value to assign to the status property of this DistributedDatabaseShardDatabaseWithExadbXsNewCluster. 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 DistributedDatabaseShardDatabaseWithExadbXsNewCluster.

  • container_database_id (str) – The value to assign to the container_database_id property of this DistributedDatabaseShardDatabaseWithExadbXsNewCluster.

  • availability_domain (str) – The value to assign to the availability_domain property of this DistributedDatabaseShardDatabaseWithExadbXsNewCluster.

  • exascale_db_storage_vault_id (str) – The value to assign to the exascale_db_storage_vault_id property of this DistributedDatabaseShardDatabaseWithExadbXsNewCluster.

  • vm_cluster_details (oci.distributed_database.models.DistributedDbVmCluster) – The value to assign to the vm_cluster_details property of this DistributedDatabaseShardDatabaseWithExadbXsNewCluster.

  • protection_mode (str) – The value to assign to the protection_mode property of this DistributedDatabaseShardDatabaseWithExadbXsNewCluster. Allowed values for this property are: “MAXIMUM_AVAILABILITY”, “MAXIMUM_PERFORMANCE”, “MAXIMUM_PROTECTION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • transport_type (str) – The value to assign to the transport_type property of this DistributedDatabaseShardDatabaseWithExadbXsNewCluster. Allowed values for this property are: “SYNC”, “ASYNC”, “FASTSYNC”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

property availability_domain

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

Returns

The availability_domain of this DistributedDatabaseShardDatabaseWithExadbXsNewCluster.

Return type

str

property container_database_id

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

Returns

The container_database_id of this DistributedDatabaseShardDatabaseWithExadbXsNewCluster.

Return type

str

property db_home_id

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

Returns

The db_home_id of this DistributedDatabaseShardDatabaseWithExadbXsNewCluster.

Return type

str

property exascale_db_storage_vault_id

[Required] Gets the exascale_db_storage_vault_id of this DistributedDatabaseShardDatabaseWithExadbXsNewCluster. The OCID of the exascale db storage vault.

Returns

The exascale_db_storage_vault_id of this DistributedDatabaseShardDatabaseWithExadbXsNewCluster.

Return type

str

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.

property kms_key_id

Gets the kms_key_id of this DistributedDatabaseShardDatabaseWithExadbXsNewCluster. 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 DistributedDatabaseShardDatabaseWithExadbXsNewCluster.

Return type

str

property kms_key_version_id

Gets the kms_key_version_id of this DistributedDatabaseShardDatabaseWithExadbXsNewCluster. 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 DistributedDatabaseShardDatabaseWithExadbXsNewCluster.

Return type

str

property metadata

Gets the metadata of this DistributedDatabaseShardDatabase.

Returns

The metadata of this DistributedDatabaseShardDatabase.

Return type

oci.distributed_database.models.DistributedDbMetadata

property name

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

Returns

The name of this DistributedDatabaseShardDatabase.

Return type

str

property protection_mode

Gets the protection_mode of this DistributedDatabaseShardDatabaseWithExadbXsNewCluster. The protection mode used for the Data Guard association.

Allowed values for this property are: “MAXIMUM_AVAILABILITY”, “MAXIMUM_PERFORMANCE”, “MAXIMUM_PROTECTION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The protection_mode of this DistributedDatabaseShardDatabaseWithExadbXsNewCluster.

Return type

str

property source

[Required] Gets the source of this DistributedDatabaseShardDatabase. The source of the Globally distributed database type. Use XS_EXISTING_CLUSTER for a database on Exascale Infrastructure that uses a pre-existing cluster. Use XS_NEW_CLUSTER for a database on Exascale Infrastructure that requires a new cluster created from scratch. Use XS_NEW_VAULT_AND_CLUSTER for a database on Exascale Infrastructure that requires a new vault and cluster created from scratch. Use XD_EXISTING_CLUSTER for a database on Dedicated Infrastructure that uses a pre-existing cluster. Use EXISTING_DB_HOME for a database on a pre-existing database home.

Allowed values for this property are: “XS_EXISTING_CLUSTER”, “XS_NEW_CLUSTER”, “XS_NEW_VAULT_AND_CLUSTER”, “XD_EXISTING_CLUSTER”, “EXISTING_DB_HOME”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The source of this DistributedDatabaseShardDatabase.

Return type

str

property status

[Required] Gets the status of this DistributedDatabaseShardDatabaseWithExadbXsNewCluster. Status of distributed database 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 DistributedDatabaseShardDatabaseWithExadbXsNewCluster.

Return type

str

property supporting_resource_id

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

Returns

The supporting_resource_id of this DistributedDatabaseShardDatabaseWithExadbXsNewCluster.

Return type

str

property time_created

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

Returns

The time_created of this DistributedDatabaseShardDatabase.

Return type

datetime

property time_updated

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

Returns

The time_updated of this DistributedDatabaseShardDatabase.

Return type

datetime

property transport_type

Gets the transport_type of this DistributedDatabaseShardDatabaseWithExadbXsNewCluster. The transport type used for the Data Guard association.

Allowed values for this property are: “SYNC”, “ASYNC”, “FASTSYNC”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The transport_type of this DistributedDatabaseShardDatabaseWithExadbXsNewCluster.

Return type

str

property vault_id

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

Returns

The vault_id of this DistributedDatabaseShardDatabaseWithExadbXsNewCluster.

Return type

str

property vm_cluster_details

Gets the vm_cluster_details of this DistributedDatabaseShardDatabaseWithExadbXsNewCluster.

Returns

The vm_cluster_details of this DistributedDatabaseShardDatabaseWithExadbXsNewCluster.

Return type

oci.distributed_database.models.DistributedDbVmCluster