CreateDataGuardAssociationToExistingDbSystemDetails¶
- class oci.database.models.CreateDataGuardAssociationToExistingDbSystemDetails(**kwargs)¶
Bases:
CreateDataGuardAssociationDetailsThe configuration details for creating a Data Guard association for a bare metal or Exadata DB system database. For these types of DB system databases, the creationType should be ExistingDbSystem. A standby database will be created in the DB system you specify.
To create a Data Guard association for a database in a virtual machine DB system, use the
create_data_guard_association_with_new_db_system_details()subtype instead.Attributes:
A constant which can be used with the protection_mode property of a CreateDataGuardAssociationDetails.
A constant which can be used with the protection_mode property of a CreateDataGuardAssociationDetails.
A constant which can be used with the protection_mode property of a CreateDataGuardAssociationDetails.
A constant which can be used with the transport_type property of a CreateDataGuardAssociationDetails.
A constant which can be used with the transport_type property of a CreateDataGuardAssociationDetails.
A constant which can be used with the transport_type property of a CreateDataGuardAssociationDetails.
[Required] Gets the creation_type of this CreateDataGuardAssociationDetails.
[Required] Gets the database_admin_password of this CreateDataGuardAssociationDetails.
Gets the database_software_image_id of this CreateDataGuardAssociationDetails.
Gets the is_active_data_guard_enabled of this CreateDataGuardAssociationDetails.
Gets the is_older_version_acknowledged of this CreateDataGuardAssociationDetails.
Gets the peer_db_home_id of this CreateDataGuardAssociationToExistingDbSystemDetails.
Gets the peer_db_system_id of this CreateDataGuardAssociationToExistingDbSystemDetails.
Gets the peer_db_unique_name of this CreateDataGuardAssociationDetails.
Gets the peer_sid_prefix of this CreateDataGuardAssociationDetails.
[Required] Gets the protection_mode of this CreateDataGuardAssociationDetails.
Gets the source_encryption_key_location_details of this CreateDataGuardAssociationDetails.
[Required] Gets the transport_type of this CreateDataGuardAssociationDetails.
Methods:
__init__(**kwargs)Initializes a new CreateDataGuardAssociationToExistingDbSystemDetails 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 CreateDataGuardAssociationDetails. 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 CreateDataGuardAssociationDetails. 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 CreateDataGuardAssociationDetails. This constant has a value of “MAXIMUM_PROTECTION”
- TRANSPORT_TYPE_ASYNC = 'ASYNC'¶
A constant which can be used with the transport_type property of a CreateDataGuardAssociationDetails. This constant has a value of “ASYNC”
- TRANSPORT_TYPE_FASTSYNC = 'FASTSYNC'¶
A constant which can be used with the transport_type property of a CreateDataGuardAssociationDetails. This constant has a value of “FASTSYNC”
- TRANSPORT_TYPE_SYNC = 'SYNC'¶
A constant which can be used with the transport_type property of a CreateDataGuardAssociationDetails. This constant has a value of “SYNC”
- __init__(**kwargs)¶
Initializes a new CreateDataGuardAssociationToExistingDbSystemDetails object with values from keyword arguments. The default value of the
creation_typeattribute of this class isExistingDbSystemand it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):- Parameters
database_software_image_id (str) – The value to assign to the database_software_image_id property of this CreateDataGuardAssociationToExistingDbSystemDetails.
is_older_version_acknowledged (bool) – The value to assign to the is_older_version_acknowledged property of this CreateDataGuardAssociationToExistingDbSystemDetails.
database_admin_password (str) – The value to assign to the database_admin_password property of this CreateDataGuardAssociationToExistingDbSystemDetails.
source_encryption_key_location_details (oci.database.models.EncryptionKeyLocationDetails) – The value to assign to the source_encryption_key_location_details property of this CreateDataGuardAssociationToExistingDbSystemDetails.
protection_mode (str) – The value to assign to the protection_mode property of this CreateDataGuardAssociationToExistingDbSystemDetails. 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 CreateDataGuardAssociationToExistingDbSystemDetails. Allowed values for this property are: “SYNC”, “ASYNC”, “FASTSYNC”
creation_type (str) – The value to assign to the creation_type property of this CreateDataGuardAssociationToExistingDbSystemDetails.
is_active_data_guard_enabled (bool) – The value to assign to the is_active_data_guard_enabled property of this CreateDataGuardAssociationToExistingDbSystemDetails.
peer_db_unique_name (str) – The value to assign to the peer_db_unique_name property of this CreateDataGuardAssociationToExistingDbSystemDetails.
peer_sid_prefix (str) – The value to assign to the peer_sid_prefix property of this CreateDataGuardAssociationToExistingDbSystemDetails.
peer_db_system_id (str) – The value to assign to the peer_db_system_id property of this CreateDataGuardAssociationToExistingDbSystemDetails.
peer_db_home_id (str) – The value to assign to the peer_db_home_id property of this CreateDataGuardAssociationToExistingDbSystemDetails.
- property creation_type¶
[Required] Gets the creation_type of this CreateDataGuardAssociationDetails. Specifies whether to create the peer database in an existing DB system or in a new DB system.
- Returns
The creation_type of this CreateDataGuardAssociationDetails.
- Return type
str
- property database_admin_password¶
[Required] Gets the database_admin_password of this CreateDataGuardAssociationDetails. A strong password for the SYS, SYSTEM, and PDB Admin users to apply during standby creation.
The password must contain no fewer than nine characters and include:
At least two uppercase characters.
At least two lowercase characters.
At least two numeric characters.
At least two special characters. Valid special characters include “_”, “#”, and “-” only.
The password MUST be the same as the primary admin password.
- Returns
The database_admin_password of this CreateDataGuardAssociationDetails.
- Return type
str
- property database_software_image_id¶
Gets the database_software_image_id of this CreateDataGuardAssociationDetails. The database software image OCID
- Returns
The database_software_image_id of this CreateDataGuardAssociationDetails.
- 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 is_active_data_guard_enabled¶
Gets the is_active_data_guard_enabled of this CreateDataGuardAssociationDetails. True if active Data Guard is enabled.
- Returns
The is_active_data_guard_enabled of this CreateDataGuardAssociationDetails.
- Return type
bool
- property is_older_version_acknowledged¶
Gets the is_older_version_acknowledged of this CreateDataGuardAssociationDetails. If true, the caller acknowledges selecting or applying an older DB, Grid Infrastructure, or operating system software version that is outside the latest default version window.
- Returns
The is_older_version_acknowledged of this CreateDataGuardAssociationDetails.
- Return type
bool
- property peer_db_home_id¶
Gets the peer_db_home_id of this CreateDataGuardAssociationToExistingDbSystemDetails. The OCID of the DB home in which to create the standby database. You must supply this value to create standby database with an existing DB home
- Returns
The peer_db_home_id of this CreateDataGuardAssociationToExistingDbSystemDetails.
- Return type
str
- property peer_db_system_id¶
Gets the peer_db_system_id of this CreateDataGuardAssociationToExistingDbSystemDetails. The OCID of the DB system in which to create the standby database. You must supply this value if creationType is ExistingDbSystem.
- Returns
The peer_db_system_id of this CreateDataGuardAssociationToExistingDbSystemDetails.
- Return type
str
- property peer_db_unique_name¶
Gets the peer_db_unique_name of this CreateDataGuardAssociationDetails. Specifies the DB_UNIQUE_NAME of the peer database to be created.
- Returns
The peer_db_unique_name of this CreateDataGuardAssociationDetails.
- Return type
str
- property peer_sid_prefix¶
Gets the peer_sid_prefix of this CreateDataGuardAssociationDetails. Specifies a prefix for the Oracle SID of the database to be created.
- Returns
The peer_sid_prefix of this CreateDataGuardAssociationDetails.
- Return type
str
- property protection_mode¶
[Required] Gets the protection_mode of this CreateDataGuardAssociationDetails. The protection mode to set up between the primary and standby databases. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.
IMPORTANT - The only protection mode currently supported by the Database service is MAXIMUM_PERFORMANCE.
Allowed values for this property are: “MAXIMUM_AVAILABILITY”, “MAXIMUM_PERFORMANCE”, “MAXIMUM_PROTECTION”
- Returns
The protection_mode of this CreateDataGuardAssociationDetails.
- Return type
str
- property source_encryption_key_location_details¶
Gets the source_encryption_key_location_details of this CreateDataGuardAssociationDetails.
- Returns
The source_encryption_key_location_details of this CreateDataGuardAssociationDetails.
- Return type
- property transport_type¶
[Required] Gets the transport_type of this CreateDataGuardAssociationDetails. The redo transport type to use for this Data Guard association. Valid values depend on the specified protectionMode:
MAXIMUM_AVAILABILITY - SYNC or FASTSYNC
MAXIMUM_PERFORMANCE - ASYNC
MAXIMUM_PROTECTION - SYNC
For more information, see Redo Transport Services in the Oracle Data Guard documentation.
IMPORTANT - The only transport type currently supported by the Database service is ASYNC.
Allowed values for this property are: “SYNC”, “ASYNC”, “FASTSYNC”
- Returns
The transport_type of this CreateDataGuardAssociationDetails.
- Return type
str