CreateDistributedDatabaseCatalogDatabaseWithExadbXsDetails¶

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

Bases: oci.distributed_database.models.create_distributed_database_catalog_database_details.CreateDistributedDatabaseCatalogDatabaseDetails

Configuration for creating a distributed database catalog using an existing ExaDB-XS VM cluster.

Attributes

`PROTECTION_MODE_MAXIMUM_AVAILABILITY`	A constant which can be used with the protection_mode property of a CreateDistributedDatabaseCatalogDatabaseWithExadbXsDetails.
`PROTECTION_MODE_MAXIMUM_PERFORMANCE`	A constant which can be used with the protection_mode property of a CreateDistributedDatabaseCatalogDatabaseWithExadbXsDetails.
`PROTECTION_MODE_MAXIMUM_PROTECTION`	A constant which can be used with the protection_mode property of a CreateDistributedDatabaseCatalogDatabaseWithExadbXsDetails.
`SOURCE_EXISTING_DB_HOME`	str(object=’’) -> str
`SOURCE_XD_EXISTING_CLUSTER`	str(object=’’) -> str
`SOURCE_XS_EXISTING_CLUSTER`	str(object=’’) -> str
`SOURCE_XS_NEW_CLUSTER`	str(object=’’) -> str
`SOURCE_XS_NEW_VAULT_AND_CLUSTER`	str(object=’’) -> str
`TRANSPORT_TYPE_ASYNC`	A constant which can be used with the transport_type property of a CreateDistributedDatabaseCatalogDatabaseWithExadbXsDetails.
`TRANSPORT_TYPE_FASTSYNC`	A constant which can be used with the transport_type property of a CreateDistributedDatabaseCatalogDatabaseWithExadbXsDetails.
`TRANSPORT_TYPE_SYNC`	A constant which can be used with the transport_type property of a CreateDistributedDatabaseCatalogDatabaseWithExadbXsDetails.
`admin_password`	Gets the admin_password of this CreateDistributedDatabaseCatalogDatabaseWithExadbXsDetails.
`admin_password_secret_id`	Gets the admin_password_secret_id of this CreateDistributedDatabaseCatalogDatabaseWithExadbXsDetails.
`admin_password_secret_version_number`	Gets the admin_password_secret_version_number of this CreateDistributedDatabaseCatalogDatabaseWithExadbXsDetails.
`kms_key_id`	Gets the kms_key_id of this CreateDistributedDatabaseCatalogDatabaseWithExadbXsDetails.
`kms_key_version_id`	Gets the kms_key_version_id of this CreateDistributedDatabaseCatalogDatabaseWithExadbXsDetails.
`protection_mode`	Gets the protection_mode of this CreateDistributedDatabaseCatalogDatabaseWithExadbXsDetails.
`source`	[Required] Gets the source of this CreateDistributedDatabaseCatalogDatabaseDetails.
`tde_wallet_password`	Gets the tde_wallet_password of this CreateDistributedDatabaseCatalogDatabaseDetails.
`tde_wallet_password_secret_id`	Gets the tde_wallet_password_secret_id of this CreateDistributedDatabaseCatalogDatabaseDetails.
`tde_wallet_password_secret_version_number`	Gets the tde_wallet_password_secret_version_number of this CreateDistributedDatabaseCatalogDatabaseDetails.
`transport_type`	Gets the transport_type of this CreateDistributedDatabaseCatalogDatabaseWithExadbXsDetails.
`vault_id`	Gets the vault_id of this CreateDistributedDatabaseCatalogDatabaseWithExadbXsDetails.
`vm_cluster_id`	[Required] Gets the vm_cluster_id of this CreateDistributedDatabaseCatalogDatabaseWithExadbXsDetails.

Methods

`__init__`(**kwargs)	Initializes a new CreateDistributedDatabaseCatalogDatabaseWithExadbXsDetails 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 CreateDistributedDatabaseCatalogDatabaseWithExadbXsDetails. 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 CreateDistributedDatabaseCatalogDatabaseWithExadbXsDetails. 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 CreateDistributedDatabaseCatalogDatabaseWithExadbXsDetails. This constant has a value of “MAXIMUM_PROTECTION”

SOURCE_EXISTING_DB_HOME = 'EXISTING_DB_HOME'¶

SOURCE_XD_EXISTING_CLUSTER = 'XD_EXISTING_CLUSTER'¶

SOURCE_XS_EXISTING_CLUSTER = 'XS_EXISTING_CLUSTER'¶

SOURCE_XS_NEW_CLUSTER = 'XS_NEW_CLUSTER'¶

SOURCE_XS_NEW_VAULT_AND_CLUSTER = 'XS_NEW_VAULT_AND_CLUSTER'¶

TRANSPORT_TYPE_ASYNC = 'ASYNC'¶: A constant which can be used with the transport_type property of a CreateDistributedDatabaseCatalogDatabaseWithExadbXsDetails. This constant has a value of “ASYNC”

TRANSPORT_TYPE_FASTSYNC = 'FASTSYNC'¶: A constant which can be used with the transport_type property of a CreateDistributedDatabaseCatalogDatabaseWithExadbXsDetails. This constant has a value of “FASTSYNC”

TRANSPORT_TYPE_SYNC = 'SYNC'¶: A constant which can be used with the transport_type property of a CreateDistributedDatabaseCatalogDatabaseWithExadbXsDetails. This constant has a value of “SYNC”

__init__(**kwargs)¶

Initializes a new CreateDistributedDatabaseCatalogDatabaseWithExadbXsDetails object with values from keyword arguments. The default value of the source attribute of this class is XS_EXISTING_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 CreateDistributedDatabaseCatalogDatabaseWithExadbXsDetails. Allowed values for this property are: “XS_EXISTING_CLUSTER”, “XS_NEW_CLUSTER”, “XS_NEW_VAULT_AND_CLUSTER”, “XD_EXISTING_CLUSTER”, “EXISTING_DB_HOME”
tde_wallet_password (str) – The value to assign to the tde_wallet_password property of this CreateDistributedDatabaseCatalogDatabaseWithExadbXsDetails.
tde_wallet_password_secret_id (str) – The value to assign to the tde_wallet_password_secret_id property of this CreateDistributedDatabaseCatalogDatabaseWithExadbXsDetails.
tde_wallet_password_secret_version_number (int) – The value to assign to the tde_wallet_password_secret_version_number property of this CreateDistributedDatabaseCatalogDatabaseWithExadbXsDetails.
vm_cluster_id (str) – The value to assign to the vm_cluster_id property of this CreateDistributedDatabaseCatalogDatabaseWithExadbXsDetails.
admin_password (str) – The value to assign to the admin_password property of this CreateDistributedDatabaseCatalogDatabaseWithExadbXsDetails.
admin_password_secret_id (str) – The value to assign to the admin_password_secret_id property of this CreateDistributedDatabaseCatalogDatabaseWithExadbXsDetails.
admin_password_secret_version_number (int) – The value to assign to the admin_password_secret_version_number property of this CreateDistributedDatabaseCatalogDatabaseWithExadbXsDetails.
vault_id (str) – The value to assign to the vault_id property of this CreateDistributedDatabaseCatalogDatabaseWithExadbXsDetails.
kms_key_id (str) – The value to assign to the kms_key_id property of this CreateDistributedDatabaseCatalogDatabaseWithExadbXsDetails.
kms_key_version_id (str) – The value to assign to the kms_key_version_id property of this CreateDistributedDatabaseCatalogDatabaseWithExadbXsDetails.
protection_mode (str) – The value to assign to the protection_mode property of this CreateDistributedDatabaseCatalogDatabaseWithExadbXsDetails. Allowed values for this property are: “MAXIMUM_AVAILABILITY”, “MAXIMUM_PERFORMANCE”, “MAXIMUM_PROTECTION”
transport_type (str) – The value to assign to the transport_type property of this CreateDistributedDatabaseCatalogDatabaseWithExadbXsDetails. Allowed values for this property are: “SYNC”, “ASYNC”, “FASTSYNC”

admin_password¶

Gets the admin_password of this CreateDistributedDatabaseCatalogDatabaseWithExadbXsDetails. The admin password for the catalog associated with the distributed database.

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

admin_password_secret_id¶

Gets the admin_password_secret_id of this CreateDistributedDatabaseCatalogDatabaseWithExadbXsDetails. The OCI vault secret [/Content/General/Concepts/identifiers.htm]OCID. This cannot be used in conjunction with adminPassword.

Returns:	The admin_password_secret_id of this CreateDistributedDatabaseCatalogDatabaseWithExadbXsDetails.
Return type:	str

admin_password_secret_version_number¶

Gets the admin_password_secret_version_number of this CreateDistributedDatabaseCatalogDatabaseWithExadbXsDetails. The version of the vault secret. If no version is specified, the latest version will be used.

Returns:	The admin_password_secret_version_number of this CreateDistributedDatabaseCatalogDatabaseWithExadbXsDetails.
Return type:	int

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

kms_key_version_id¶

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

protection_mode¶

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

Allowed values for this property are: “MAXIMUM_AVAILABILITY”, “MAXIMUM_PERFORMANCE”, “MAXIMUM_PROTECTION”

Returns:	The protection_mode of this CreateDistributedDatabaseCatalogDatabaseWithExadbXsDetails.
Return type:	str

source¶

[Required] Gets the source of this CreateDistributedDatabaseCatalogDatabaseDetails. 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”

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

tde_wallet_password¶

Gets the tde_wallet_password of this CreateDistributedDatabaseCatalogDatabaseDetails. The password to open the TDE wallet. The password must be 9 to 255 characters and contain at least two uppercase letters, two lowercase letters, two numeric characters, and two special characters. The allowed special characters are _, #, and -.

Returns:	The tde_wallet_password of this CreateDistributedDatabaseCatalogDatabaseDetails.
Return type:	str

tde_wallet_password_secret_id¶

Gets the tde_wallet_password_secret_id of this CreateDistributedDatabaseCatalogDatabaseDetails. The OCID of the OCI vault secret. This cannot be used in conjunction with tdeWalletPassword.

Returns:	The tde_wallet_password_secret_id of this CreateDistributedDatabaseCatalogDatabaseDetails.
Return type:	str

tde_wallet_password_secret_version_number¶

Gets the tde_wallet_password_secret_version_number of this CreateDistributedDatabaseCatalogDatabaseDetails. The version of the vault secret. If no version is specified, the latest version will be used.

Returns:	The tde_wallet_password_secret_version_number of this CreateDistributedDatabaseCatalogDatabaseDetails.
Return type:	int

transport_type¶

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

Allowed values for this property are: “SYNC”, “ASYNC”, “FASTSYNC”

Returns:	The transport_type of this CreateDistributedDatabaseCatalogDatabaseWithExadbXsDetails.
Return type:	str

vault_id¶

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

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

vm_cluster_id¶

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

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