CreateDistributedDatabaseCatalogWithExadbXsDetails¶

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

Bases: oci.distributed_database.models.create_distributed_database_catalog_details.CreateDistributedDatabaseCatalogDetails

Globally distributed database catalog based on exadbxs.

Attributes

`SOURCE_EXADB_XS`	str(object=’’) -> str
`admin_password`	[Required] Gets the admin_password of this CreateDistributedDatabaseCatalogWithExadbXsDetails.
`kms_key_id`	Gets the kms_key_id of this CreateDistributedDatabaseCatalogWithExadbXsDetails.
`kms_key_version_id`	Gets the kms_key_version_id of this CreateDistributedDatabaseCatalogWithExadbXsDetails.
`peer_vm_cluster_ids`	Gets the peer_vm_cluster_ids of this CreateDistributedDatabaseCatalogWithExadbXsDetails.
`shard_space`	Gets the shard_space of this CreateDistributedDatabaseCatalogWithExadbXsDetails.
`source`	[Required] Gets the source of this CreateDistributedDatabaseCatalogDetails.
`vault_id`	Gets the vault_id of this CreateDistributedDatabaseCatalogWithExadbXsDetails.
`vm_cluster_id`	[Required] Gets the vm_cluster_id of this CreateDistributedDatabaseCatalogWithExadbXsDetails.

Methods

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

__init__(**kwargs)¶

Initializes a new CreateDistributedDatabaseCatalogWithExadbXsDetails object with values from keyword arguments. The default value of the source attribute of this class is EXADB_XS 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 CreateDistributedDatabaseCatalogWithExadbXsDetails. Allowed values for this property are: “EXADB_XS”
vm_cluster_id (str) – The value to assign to the vm_cluster_id property of this CreateDistributedDatabaseCatalogWithExadbXsDetails.
admin_password (str) – The value to assign to the admin_password property of this CreateDistributedDatabaseCatalogWithExadbXsDetails.
peer_vm_cluster_ids (list[str]) – The value to assign to the peer_vm_cluster_ids property of this CreateDistributedDatabaseCatalogWithExadbXsDetails.
shard_space (str) – The value to assign to the shard_space property of this CreateDistributedDatabaseCatalogWithExadbXsDetails.
vault_id (str) – The value to assign to the vault_id property of this CreateDistributedDatabaseCatalogWithExadbXsDetails.
kms_key_id (str) – The value to assign to the kms_key_id property of this CreateDistributedDatabaseCatalogWithExadbXsDetails.
kms_key_version_id (str) – The value to assign to the kms_key_version_id property of this CreateDistributedDatabaseCatalogWithExadbXsDetails.

admin_password¶

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

Returns:	The admin_password of this CreateDistributedDatabaseCatalogWithExadbXsDetails.
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.

kms_key_id¶

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

kms_key_version_id¶

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

peer_vm_cluster_ids¶

Gets the peer_vm_cluster_ids of this CreateDistributedDatabaseCatalogWithExadbXsDetails. The collection of OCID of the peer VmClusterIds.

Returns:	The peer_vm_cluster_ids of this CreateDistributedDatabaseCatalogWithExadbXsDetails.
Return type:	list[str]

shard_space¶

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

source¶

[Required] Gets the source of this CreateDistributedDatabaseCatalogDetails. The source of Globally distributed database type: Use EXADB_XS for the Globally distributed database with Exascale based distributed database.

Allowed values for this property are: “EXADB_XS”

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

vault_id¶

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

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

vm_cluster_id¶

[Required] Gets the vm_cluster_id of this CreateDistributedDatabaseCatalogWithExadbXsDetails. The OCID of the VmCluster.

Returns:	The vm_cluster_id of this CreateDistributedDatabaseCatalogWithExadbXsDetails.
Return type:	str