CreateDataGuardAssociationWithNewDbSystemDetails¶

class oci.database.models.CreateDataGuardAssociationWithNewDbSystemDetails(**kwargs)¶

Bases: oci.database.models.create_data_guard_association_details.CreateDataGuardAssociationDetails

The configuration details for creating a Data Guard association for a virtual machine DB system database. For this type of DB system database, the creationType should be NewDbSystem. A new DB system will be launched to create the standby database.

To create a Data Guard association for a database in a bare metal or Exadata DB system, use the create_data_guard_association_to_existing_db_system_details() subtype instead.

Attributes

`LICENSE_MODEL_BRING_YOUR_OWN_LICENSE`	A constant which can be used with the license_model property of a CreateDataGuardAssociationWithNewDbSystemDetails.
`LICENSE_MODEL_LICENSE_INCLUDED`	A constant which can be used with the license_model property of a CreateDataGuardAssociationWithNewDbSystemDetails.
`PROTECTION_MODE_MAXIMUM_AVAILABILITY`	str(object=’’) -> str
`PROTECTION_MODE_MAXIMUM_PERFORMANCE`	str(object=’’) -> str
`PROTECTION_MODE_MAXIMUM_PROTECTION`	str(object=’’) -> str
`STORAGE_VOLUME_PERFORMANCE_MODE_BALANCED`	A constant which can be used with the storage_volume_performance_mode property of a CreateDataGuardAssociationWithNewDbSystemDetails.
`STORAGE_VOLUME_PERFORMANCE_MODE_HIGH_PERFORMANCE`	A constant which can be used with the storage_volume_performance_mode property of a CreateDataGuardAssociationWithNewDbSystemDetails.
`TRANSPORT_TYPE_ASYNC`	str(object=’’) -> str
`TRANSPORT_TYPE_FASTSYNC`	str(object=’’) -> str
`TRANSPORT_TYPE_SYNC`	str(object=’’) -> str
`availability_domain`	Gets the availability_domain of this CreateDataGuardAssociationWithNewDbSystemDetails.
`backup_network_nsg_ids`	Gets the backup_network_nsg_ids of this CreateDataGuardAssociationWithNewDbSystemDetails.
`cpu_core_count`	Gets the cpu_core_count of this CreateDataGuardAssociationWithNewDbSystemDetails.
`creation_type`	[Required] Gets the creation_type of this CreateDataGuardAssociationDetails.
`data_collection_options`	Gets the data_collection_options of this CreateDataGuardAssociationWithNewDbSystemDetails.
`database_admin_password`	[Required] Gets the database_admin_password of this CreateDataGuardAssociationDetails.
`database_defined_tags`	Gets the database_defined_tags of this CreateDataGuardAssociationWithNewDbSystemDetails.
`database_freeform_tags`	Gets the database_freeform_tags of this CreateDataGuardAssociationWithNewDbSystemDetails.
`database_software_image_id`	Gets the database_software_image_id of this CreateDataGuardAssociationDetails.
`db_system_defined_tags`	Gets the db_system_defined_tags of this CreateDataGuardAssociationWithNewDbSystemDetails.
`db_system_freeform_tags`	Gets the db_system_freeform_tags of this CreateDataGuardAssociationWithNewDbSystemDetails.
`display_name`	Gets the display_name of this CreateDataGuardAssociationWithNewDbSystemDetails.
`fault_domains`	Gets the fault_domains of this CreateDataGuardAssociationWithNewDbSystemDetails.
`hostname`	Gets the hostname of this CreateDataGuardAssociationWithNewDbSystemDetails.
`is_active_data_guard_enabled`	Gets the is_active_data_guard_enabled of this CreateDataGuardAssociationDetails.
`license_model`	Gets the license_model of this CreateDataGuardAssociationWithNewDbSystemDetails.
`node_count`	Gets the node_count of this CreateDataGuardAssociationWithNewDbSystemDetails.
`nsg_ids`	Gets the nsg_ids of this CreateDataGuardAssociationWithNewDbSystemDetails.
`peer_db_unique_name`	Gets the peer_db_unique_name of this CreateDataGuardAssociationDetails.
`peer_sid_prefix`	Gets the peer_sid_prefix of this CreateDataGuardAssociationDetails.
`private_ip`	Gets the private_ip of this CreateDataGuardAssociationWithNewDbSystemDetails.
`protection_mode`	[Required] Gets the protection_mode of this CreateDataGuardAssociationDetails.
`shape`	Gets the shape of this CreateDataGuardAssociationWithNewDbSystemDetails.
`storage_volume_performance_mode`	Gets the storage_volume_performance_mode of this CreateDataGuardAssociationWithNewDbSystemDetails.
`subnet_id`	Gets the subnet_id of this CreateDataGuardAssociationWithNewDbSystemDetails.
`time_zone`	Gets the time_zone of this CreateDataGuardAssociationWithNewDbSystemDetails.
`transport_type`	[Required] Gets the transport_type of this CreateDataGuardAssociationDetails.

Methods

`__init__`(**kwargs)	Initializes a new CreateDataGuardAssociationWithNewDbSystemDetails 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.

LICENSE_MODEL_BRING_YOUR_OWN_LICENSE = 'BRING_YOUR_OWN_LICENSE'¶: A constant which can be used with the license_model property of a CreateDataGuardAssociationWithNewDbSystemDetails. This constant has a value of “BRING_YOUR_OWN_LICENSE”

LICENSE_MODEL_LICENSE_INCLUDED = 'LICENSE_INCLUDED'¶: A constant which can be used with the license_model property of a CreateDataGuardAssociationWithNewDbSystemDetails. This constant has a value of “LICENSE_INCLUDED”

PROTECTION_MODE_MAXIMUM_AVAILABILITY = 'MAXIMUM_AVAILABILITY'¶

PROTECTION_MODE_MAXIMUM_PERFORMANCE = 'MAXIMUM_PERFORMANCE'¶

PROTECTION_MODE_MAXIMUM_PROTECTION = 'MAXIMUM_PROTECTION'¶

STORAGE_VOLUME_PERFORMANCE_MODE_BALANCED = 'BALANCED'¶: A constant which can be used with the storage_volume_performance_mode property of a CreateDataGuardAssociationWithNewDbSystemDetails. This constant has a value of “BALANCED”

STORAGE_VOLUME_PERFORMANCE_MODE_HIGH_PERFORMANCE = 'HIGH_PERFORMANCE'¶: A constant which can be used with the storage_volume_performance_mode property of a CreateDataGuardAssociationWithNewDbSystemDetails. This constant has a value of “HIGH_PERFORMANCE”

TRANSPORT_TYPE_ASYNC = 'ASYNC'¶

TRANSPORT_TYPE_FASTSYNC = 'FASTSYNC'¶

TRANSPORT_TYPE_SYNC = 'SYNC'¶

__init__(**kwargs)¶

Initializes a new CreateDataGuardAssociationWithNewDbSystemDetails object with values from keyword arguments. The default value of the creation_type attribute of this class is NewDbSystem and 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 CreateDataGuardAssociationWithNewDbSystemDetails.
database_admin_password (str) – The value to assign to the database_admin_password property of this CreateDataGuardAssociationWithNewDbSystemDetails.
protection_mode (str) – The value to assign to the protection_mode property of this CreateDataGuardAssociationWithNewDbSystemDetails. 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 CreateDataGuardAssociationWithNewDbSystemDetails. Allowed values for this property are: “SYNC”, “ASYNC”, “FASTSYNC”
creation_type (str) – The value to assign to the creation_type property of this CreateDataGuardAssociationWithNewDbSystemDetails.
is_active_data_guard_enabled (bool) – The value to assign to the is_active_data_guard_enabled property of this CreateDataGuardAssociationWithNewDbSystemDetails.
peer_db_unique_name (str) – The value to assign to the peer_db_unique_name property of this CreateDataGuardAssociationWithNewDbSystemDetails.
peer_sid_prefix (str) – The value to assign to the peer_sid_prefix property of this CreateDataGuardAssociationWithNewDbSystemDetails.
display_name (str) – The value to assign to the display_name property of this CreateDataGuardAssociationWithNewDbSystemDetails.
availability_domain (str) – The value to assign to the availability_domain property of this CreateDataGuardAssociationWithNewDbSystemDetails.
shape (str) – The value to assign to the shape property of this CreateDataGuardAssociationWithNewDbSystemDetails.
cpu_core_count (int) – The value to assign to the cpu_core_count property of this CreateDataGuardAssociationWithNewDbSystemDetails.
storage_volume_performance_mode (str) – The value to assign to the storage_volume_performance_mode property of this CreateDataGuardAssociationWithNewDbSystemDetails. Allowed values for this property are: “BALANCED”, “HIGH_PERFORMANCE”
node_count (int) – The value to assign to the node_count property of this CreateDataGuardAssociationWithNewDbSystemDetails.
subnet_id (str) – The value to assign to the subnet_id property of this CreateDataGuardAssociationWithNewDbSystemDetails.
nsg_ids (list[str]) – The value to assign to the nsg_ids property of this CreateDataGuardAssociationWithNewDbSystemDetails.
backup_network_nsg_ids (list[str]) – The value to assign to the backup_network_nsg_ids property of this CreateDataGuardAssociationWithNewDbSystemDetails.
hostname (str) – The value to assign to the hostname property of this CreateDataGuardAssociationWithNewDbSystemDetails.
time_zone (str) – The value to assign to the time_zone property of this CreateDataGuardAssociationWithNewDbSystemDetails.
fault_domains (list[str]) – The value to assign to the fault_domains property of this CreateDataGuardAssociationWithNewDbSystemDetails.
private_ip (str) – The value to assign to the private_ip property of this CreateDataGuardAssociationWithNewDbSystemDetails.
license_model (str) – The value to assign to the license_model property of this CreateDataGuardAssociationWithNewDbSystemDetails. Allowed values for this property are: “LICENSE_INCLUDED”, “BRING_YOUR_OWN_LICENSE”
db_system_freeform_tags (dict(str, str)) – The value to assign to the db_system_freeform_tags property of this CreateDataGuardAssociationWithNewDbSystemDetails.
db_system_defined_tags (dict(str, dict(str, object))) – The value to assign to the db_system_defined_tags property of this CreateDataGuardAssociationWithNewDbSystemDetails.
database_freeform_tags (dict(str, str)) – The value to assign to the database_freeform_tags property of this CreateDataGuardAssociationWithNewDbSystemDetails.
database_defined_tags (dict(str, dict(str, object))) – The value to assign to the database_defined_tags property of this CreateDataGuardAssociationWithNewDbSystemDetails.
data_collection_options (oci.database.models.DataCollectionOptions) – The value to assign to the data_collection_options property of this CreateDataGuardAssociationWithNewDbSystemDetails.

availability_domain¶

Gets the availability_domain of this CreateDataGuardAssociationWithNewDbSystemDetails. The name of the availability domain that the standby database DB system will be located in. For example- “Uocm:PHX-AD-1”.

Returns:	The availability_domain of this CreateDataGuardAssociationWithNewDbSystemDetails.
Return type:	str

backup_network_nsg_ids¶

Gets the backup_network_nsg_ids of this CreateDataGuardAssociationWithNewDbSystemDetails. A list of the OCIDs of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see Security Rules. Applicable only to Exadata systems.

Returns:	The backup_network_nsg_ids of this CreateDataGuardAssociationWithNewDbSystemDetails.
Return type:	list[str]

cpu_core_count¶

Gets the cpu_core_count of this CreateDataGuardAssociationWithNewDbSystemDetails. The number of CPU cores available for AMD-based virtual machine DB systems.

Returns:	The cpu_core_count of this CreateDataGuardAssociationWithNewDbSystemDetails.
Return type:	int

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

data_collection_options¶

Gets the data_collection_options of this CreateDataGuardAssociationWithNewDbSystemDetails.

Returns:	The data_collection_options of this CreateDataGuardAssociationWithNewDbSystemDetails.
Return type:	oci.database.models.DataCollectionOptions

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

database_defined_tags¶

Gets the database_defined_tags of this CreateDataGuardAssociationWithNewDbSystemDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Returns:	The database_defined_tags of this CreateDataGuardAssociationWithNewDbSystemDetails.
Return type:	dict(str, dict(str, object))

database_freeform_tags¶

Gets the database_freeform_tags of this CreateDataGuardAssociationWithNewDbSystemDetails. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {“Department”: “Finance”}

Returns:	The database_freeform_tags of this CreateDataGuardAssociationWithNewDbSystemDetails.
Return type:	dict(str, str)

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

db_system_defined_tags¶

Gets the db_system_defined_tags of this CreateDataGuardAssociationWithNewDbSystemDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Returns:	The db_system_defined_tags of this CreateDataGuardAssociationWithNewDbSystemDetails.
Return type:	dict(str, dict(str, object))

db_system_freeform_tags¶

Gets the db_system_freeform_tags of this CreateDataGuardAssociationWithNewDbSystemDetails. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {“Department”: “Finance”}

Returns:	The db_system_freeform_tags of this CreateDataGuardAssociationWithNewDbSystemDetails.
Return type:	dict(str, str)

display_name¶

Gets the display_name of this CreateDataGuardAssociationWithNewDbSystemDetails. The user-friendly name of the DB system that will contain the the standby database. The display name does not have to be unique.

Returns:	The display_name of this CreateDataGuardAssociationWithNewDbSystemDetails.
Return type:	str

fault_domains¶

Gets the fault_domains of this CreateDataGuardAssociationWithNewDbSystemDetails. A Fault Domain is a grouping of hardware and infrastructure within an availability domain. Fault Domains let you distribute your instances so that they are not on the same physical hardware within a single availability domain. A hardware failure or maintenance that affects one Fault Domain does not affect DB systems in other Fault Domains.

If you do not specify the Fault Domain, the system selects one for you. To change the Fault Domain for a DB system, terminate it and launch a new DB system in the preferred Fault Domain.

If the node count is greater than 1, you can specify which Fault Domains these nodes will be distributed into. The system assigns your nodes automatically to the Fault Domains you specify so that no Fault Domain contains more than one node.

To get a list of Fault Domains, use the list_fault_domains() operation in the Identity and Access Management Service API.

Example: FAULT-DOMAIN-1

Returns:	The fault_domains of this CreateDataGuardAssociationWithNewDbSystemDetails.
Return type:	list[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.

hostname¶

Gets the hostname of this CreateDataGuardAssociationWithNewDbSystemDetails. The hostname for the DB node.

Returns:	The hostname of this CreateDataGuardAssociationWithNewDbSystemDetails.
Return type:	str

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

license_model¶

Gets the license_model of this CreateDataGuardAssociationWithNewDbSystemDetails. The Oracle license model that applies to all the databases on the dataguard standby DB system. The default is LICENSE_INCLUDED. Bring your own license (BYOL) allows you to select the DB edition using the optional parameter, for Autonomous Database Serverless.

Allowed values for this property are: “LICENSE_INCLUDED”, “BRING_YOUR_OWN_LICENSE”

Returns:	The license_model of this CreateDataGuardAssociationWithNewDbSystemDetails.
Return type:	str

node_count¶

Gets the node_count of this CreateDataGuardAssociationWithNewDbSystemDetails. The number of nodes to launch for the DB system of the standby in the Data Guard association. For a 2-node RAC virtual machine DB system, specify either 1 or 2. If you do not supply this parameter, the default is the node count of the primary DB system.

Returns:	The node_count of this CreateDataGuardAssociationWithNewDbSystemDetails.
Return type:	int

nsg_ids¶

Gets the nsg_ids of this CreateDataGuardAssociationWithNewDbSystemDetails. The list of OCIDs for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see Security Rules. NsgIds restrictions: - A network security group (NSG) is optional for Autonomous Databases with private access. The nsgIds list can be empty.

Returns:	The nsg_ids of this CreateDataGuardAssociationWithNewDbSystemDetails.
Return type:	list[str]

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

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

private_ip¶

Gets the private_ip of this CreateDataGuardAssociationWithNewDbSystemDetails. The IPv4 address from the provided OCI subnet which needs to be assigned to the VNIC. If not provided, it will be auto-assigned with an available IPv4 address from the subnet.

Returns:	The private_ip of this CreateDataGuardAssociationWithNewDbSystemDetails.
Return type:	str

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

shape¶

Gets the shape of this CreateDataGuardAssociationWithNewDbSystemDetails. The virtual machine DB system shape to launch for the standby database in the Data Guard association. The shape determines the number of CPU cores and the amount of memory available for the DB system. Only virtual machine shapes are valid options. If you do not supply this parameter, the default shape is the shape of the primary DB system.

To get a list of all shapes, use the list_db_system_shapes() operation.

Returns:	The shape of this CreateDataGuardAssociationWithNewDbSystemDetails.
Return type:	str

storage_volume_performance_mode¶

Gets the storage_volume_performance_mode of this CreateDataGuardAssociationWithNewDbSystemDetails. The block storage volume performance level. Valid values are BALANCED and HIGH_PERFORMANCE. See Block Volume Performance for more information.

Allowed values for this property are: “BALANCED”, “HIGH_PERFORMANCE”

Returns:	The storage_volume_performance_mode of this CreateDataGuardAssociationWithNewDbSystemDetails.
Return type:	str

subnet_id¶

Gets the subnet_id of this CreateDataGuardAssociationWithNewDbSystemDetails. The OCID of the subnet the DB system is associated with. Subnet Restrictions: - For 1- and 2-node RAC DB systems, do not use a subnet that overlaps with 192.168.16.16/28

These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and backup subnet.

Returns:	The subnet_id of this CreateDataGuardAssociationWithNewDbSystemDetails.
Return type:	str

time_zone¶

Gets the time_zone of this CreateDataGuardAssociationWithNewDbSystemDetails. The time zone of the dataguard standby DB system. For details, see DB System Time Zones.

Returns:	The time_zone of this CreateDataGuardAssociationWithNewDbSystemDetails.
Return type:	str

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