CreateDistributedDatabaseShardDatabaseWithDbHomeDetails¶
- class oci.distributed_database.models.CreateDistributedDatabaseShardDatabaseWithDbHomeDetails(**kwargs)¶
Bases:
CreateDistributedDatabaseShardDatabaseDetailsConfiguration for creating a distributed database shard using a pre-existing Database Home.
Attributes:
A constant which can be used with the protection_mode property of a CreateDistributedDatabaseShardDatabaseWithDbHomeDetails.
A constant which can be used with the protection_mode property of a CreateDistributedDatabaseShardDatabaseWithDbHomeDetails.
A constant which can be used with the protection_mode property of a CreateDistributedDatabaseShardDatabaseWithDbHomeDetails.
A constant which can be used with the source property of a CreateDistributedDatabaseShardDatabaseDetails.
A constant which can be used with the source property of a CreateDistributedDatabaseShardDatabaseDetails.
A constant which can be used with the source property of a CreateDistributedDatabaseShardDatabaseDetails.
A constant which can be used with the source property of a CreateDistributedDatabaseShardDatabaseDetails.
A constant which can be used with the source property of a CreateDistributedDatabaseShardDatabaseDetails.
A constant which can be used with the transport_type property of a CreateDistributedDatabaseShardDatabaseWithDbHomeDetails.
A constant which can be used with the transport_type property of a CreateDistributedDatabaseShardDatabaseWithDbHomeDetails.
A constant which can be used with the transport_type property of a CreateDistributedDatabaseShardDatabaseWithDbHomeDetails.
Gets the admin_password of this CreateDistributedDatabaseShardDatabaseWithDbHomeDetails.
Gets the admin_password_secret_id of this CreateDistributedDatabaseShardDatabaseWithDbHomeDetails.
Gets the admin_password_secret_version_number of this CreateDistributedDatabaseShardDatabaseWithDbHomeDetails.
[Required] Gets the db_home_id of this CreateDistributedDatabaseShardDatabaseWithDbHomeDetails.
Gets the kms_key_id of this CreateDistributedDatabaseShardDatabaseWithDbHomeDetails.
Gets the kms_key_version_id of this CreateDistributedDatabaseShardDatabaseWithDbHomeDetails.
Gets the protection_mode of this CreateDistributedDatabaseShardDatabaseWithDbHomeDetails.
[Required] Gets the source of this CreateDistributedDatabaseShardDatabaseDetails.
Gets the tde_wallet_password of this CreateDistributedDatabaseShardDatabaseDetails.
Gets the tde_wallet_password_secret_id of this CreateDistributedDatabaseShardDatabaseDetails.
Gets the tde_wallet_password_secret_version_number of this CreateDistributedDatabaseShardDatabaseDetails.
Gets the transport_type of this CreateDistributedDatabaseShardDatabaseWithDbHomeDetails.
Gets the vault_id of this CreateDistributedDatabaseShardDatabaseWithDbHomeDetails.
Methods:
__init__(**kwargs)Initializes a new CreateDistributedDatabaseShardDatabaseWithDbHomeDetails 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 CreateDistributedDatabaseShardDatabaseWithDbHomeDetails. 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 CreateDistributedDatabaseShardDatabaseWithDbHomeDetails. 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 CreateDistributedDatabaseShardDatabaseWithDbHomeDetails. 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 CreateDistributedDatabaseShardDatabaseDetails. 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 CreateDistributedDatabaseShardDatabaseDetails. 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 CreateDistributedDatabaseShardDatabaseDetails. 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 CreateDistributedDatabaseShardDatabaseDetails. 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 CreateDistributedDatabaseShardDatabaseDetails. This constant has a value of “XS_NEW_VAULT_AND_CLUSTER”
- TRANSPORT_TYPE_ASYNC = 'ASYNC'¶
A constant which can be used with the transport_type property of a CreateDistributedDatabaseShardDatabaseWithDbHomeDetails. This constant has a value of “ASYNC”
- TRANSPORT_TYPE_FASTSYNC = 'FASTSYNC'¶
A constant which can be used with the transport_type property of a CreateDistributedDatabaseShardDatabaseWithDbHomeDetails. This constant has a value of “FASTSYNC”
- TRANSPORT_TYPE_SYNC = 'SYNC'¶
A constant which can be used with the transport_type property of a CreateDistributedDatabaseShardDatabaseWithDbHomeDetails. This constant has a value of “SYNC”
- __init__(**kwargs)¶
Initializes a new CreateDistributedDatabaseShardDatabaseWithDbHomeDetails object with values from keyword arguments. The default value of the
sourceattribute of this class isEXISTING_DB_HOMEand 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 CreateDistributedDatabaseShardDatabaseWithDbHomeDetails. 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 CreateDistributedDatabaseShardDatabaseWithDbHomeDetails.
tde_wallet_password_secret_id (str) – The value to assign to the tde_wallet_password_secret_id property of this CreateDistributedDatabaseShardDatabaseWithDbHomeDetails.
tde_wallet_password_secret_version_number (int) – The value to assign to the tde_wallet_password_secret_version_number property of this CreateDistributedDatabaseShardDatabaseWithDbHomeDetails.
db_home_id (str) – The value to assign to the db_home_id property of this CreateDistributedDatabaseShardDatabaseWithDbHomeDetails.
admin_password (str) – The value to assign to the admin_password property of this CreateDistributedDatabaseShardDatabaseWithDbHomeDetails.
admin_password_secret_id (str) – The value to assign to the admin_password_secret_id property of this CreateDistributedDatabaseShardDatabaseWithDbHomeDetails.
admin_password_secret_version_number (int) – The value to assign to the admin_password_secret_version_number property of this CreateDistributedDatabaseShardDatabaseWithDbHomeDetails.
vault_id (str) – The value to assign to the vault_id property of this CreateDistributedDatabaseShardDatabaseWithDbHomeDetails.
kms_key_id (str) – The value to assign to the kms_key_id property of this CreateDistributedDatabaseShardDatabaseWithDbHomeDetails.
kms_key_version_id (str) – The value to assign to the kms_key_version_id property of this CreateDistributedDatabaseShardDatabaseWithDbHomeDetails.
protection_mode (str) – The value to assign to the protection_mode property of this CreateDistributedDatabaseShardDatabaseWithDbHomeDetails. 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 CreateDistributedDatabaseShardDatabaseWithDbHomeDetails. Allowed values for this property are: “SYNC”, “ASYNC”, “FASTSYNC”
- property admin_password¶
Gets the admin_password of this CreateDistributedDatabaseShardDatabaseWithDbHomeDetails. The admin password for the shard associated with Globally distributed database.
- Returns
The admin_password of this CreateDistributedDatabaseShardDatabaseWithDbHomeDetails.
- Return type
str
- property admin_password_secret_id¶
Gets the admin_password_secret_id of this CreateDistributedDatabaseShardDatabaseWithDbHomeDetails. 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 CreateDistributedDatabaseShardDatabaseWithDbHomeDetails.
- Return type
str
- property admin_password_secret_version_number¶
Gets the admin_password_secret_version_number of this CreateDistributedDatabaseShardDatabaseWithDbHomeDetails. 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 CreateDistributedDatabaseShardDatabaseWithDbHomeDetails.
- Return type
int
- property db_home_id¶
[Required] Gets the db_home_id of this CreateDistributedDatabaseShardDatabaseWithDbHomeDetails. The OCID of the Database Home.
- Returns
The db_home_id of this CreateDistributedDatabaseShardDatabaseWithDbHomeDetails.
- 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 CreateDistributedDatabaseShardDatabaseWithDbHomeDetails. 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 CreateDistributedDatabaseShardDatabaseWithDbHomeDetails.
- Return type
str
- property kms_key_version_id¶
Gets the kms_key_version_id of this CreateDistributedDatabaseShardDatabaseWithDbHomeDetails. 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 CreateDistributedDatabaseShardDatabaseWithDbHomeDetails.
- Return type
str
- property protection_mode¶
Gets the protection_mode of this CreateDistributedDatabaseShardDatabaseWithDbHomeDetails. 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 CreateDistributedDatabaseShardDatabaseWithDbHomeDetails.
- Return type
str
- property source¶
[Required] Gets the source of this CreateDistributedDatabaseShardDatabaseDetails. 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 CreateDistributedDatabaseShardDatabaseDetails.
- Return type
str
- property tde_wallet_password¶
Gets the tde_wallet_password of this CreateDistributedDatabaseShardDatabaseDetails. 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 CreateDistributedDatabaseShardDatabaseDetails.
- Return type
str
- property tde_wallet_password_secret_id¶
Gets the tde_wallet_password_secret_id of this CreateDistributedDatabaseShardDatabaseDetails. The OCID of the OCI vault secret. This cannot be used in conjunction with tdeWalletPassword.
- Returns
The tde_wallet_password_secret_id of this CreateDistributedDatabaseShardDatabaseDetails.
- Return type
str
- property tde_wallet_password_secret_version_number¶
Gets the tde_wallet_password_secret_version_number of this CreateDistributedDatabaseShardDatabaseDetails. 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 CreateDistributedDatabaseShardDatabaseDetails.
- Return type
int
- property transport_type¶
Gets the transport_type of this CreateDistributedDatabaseShardDatabaseWithDbHomeDetails. The transport type used for the Data Guard association.
Allowed values for this property are: “SYNC”, “ASYNC”, “FASTSYNC”
- Returns
The transport_type of this CreateDistributedDatabaseShardDatabaseWithDbHomeDetails.
- Return type
str
- property vault_id¶
Gets the vault_id of this CreateDistributedDatabaseShardDatabaseWithDbHomeDetails. The OCID of the Oracle Cloud Infrastructure vault. This parameter and kmsKeyId are required for Customer Managed Keys.
- Returns
The vault_id of this CreateDistributedDatabaseShardDatabaseWithDbHomeDetails.
- Return type
str