DataGuardAssociationSummary¶

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

Bases: object

The properties that define a Data Guard association.

To use any of the API operations, you must be authorized in an IAM policy. If you’re not authorized, talk to an administrator. If you’re an administrator who needs to write policies to give users access, see Getting Started with Policies.

For information about endpoints and signing API requests, see About the API. For information about available SDKs and tools, see SDKS and Other Tools.

Attributes

`LIFECYCLE_STATE_AVAILABLE`	A constant which can be used with the lifecycle_state property of a DataGuardAssociationSummary.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a DataGuardAssociationSummary.
`LIFECYCLE_STATE_PROVISIONING`	A constant which can be used with the lifecycle_state property of a DataGuardAssociationSummary.
`LIFECYCLE_STATE_TERMINATED`	A constant which can be used with the lifecycle_state property of a DataGuardAssociationSummary.
`LIFECYCLE_STATE_TERMINATING`	A constant which can be used with the lifecycle_state property of a DataGuardAssociationSummary.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a DataGuardAssociationSummary.
`LIFECYCLE_STATE_UPGRADING`	A constant which can be used with the lifecycle_state property of a DataGuardAssociationSummary.
`PEER_ROLE_DISABLED_STANDBY`	A constant which can be used with the peer_role property of a DataGuardAssociationSummary.
`PEER_ROLE_PRIMARY`	A constant which can be used with the peer_role property of a DataGuardAssociationSummary.
`PEER_ROLE_STANDBY`	A constant which can be used with the peer_role property of a DataGuardAssociationSummary.
`PROTECTION_MODE_MAXIMUM_AVAILABILITY`	A constant which can be used with the protection_mode property of a DataGuardAssociationSummary.
`PROTECTION_MODE_MAXIMUM_PERFORMANCE`	A constant which can be used with the protection_mode property of a DataGuardAssociationSummary.
`PROTECTION_MODE_MAXIMUM_PROTECTION`	A constant which can be used with the protection_mode property of a DataGuardAssociationSummary.
`ROLE_DISABLED_STANDBY`	A constant which can be used with the role property of a DataGuardAssociationSummary.
`ROLE_PRIMARY`	A constant which can be used with the role property of a DataGuardAssociationSummary.
`ROLE_STANDBY`	A constant which can be used with the role property of a DataGuardAssociationSummary.
`TRANSPORT_TYPE_ASYNC`	A constant which can be used with the transport_type property of a DataGuardAssociationSummary.
`TRANSPORT_TYPE_FASTSYNC`	A constant which can be used with the transport_type property of a DataGuardAssociationSummary.
`TRANSPORT_TYPE_SYNC`	A constant which can be used with the transport_type property of a DataGuardAssociationSummary.
`apply_lag`	Gets the apply_lag of this DataGuardAssociationSummary.
`apply_rate`	Gets the apply_rate of this DataGuardAssociationSummary.
`database_id`	[Required] Gets the database_id of this DataGuardAssociationSummary.
`id`	[Required] Gets the id of this DataGuardAssociationSummary.
`is_active_data_guard_enabled`	Gets the is_active_data_guard_enabled of this DataGuardAssociationSummary.
`lifecycle_details`	Gets the lifecycle_details of this DataGuardAssociationSummary.
`lifecycle_state`	[Required] Gets the lifecycle_state of this DataGuardAssociationSummary.
`peer_data_guard_association_id`	Gets the peer_data_guard_association_id of this DataGuardAssociationSummary.
`peer_database_id`	Gets the peer_database_id of this DataGuardAssociationSummary.
`peer_db_home_id`	Gets the peer_db_home_id of this DataGuardAssociationSummary.
`peer_db_system_id`	[Required] Gets the peer_db_system_id of this DataGuardAssociationSummary.
`peer_role`	[Required] Gets the peer_role of this DataGuardAssociationSummary.
`protection_mode`	[Required] Gets the protection_mode of this DataGuardAssociationSummary.
`role`	[Required] Gets the role of this DataGuardAssociationSummary.
`time_created`	Gets the time_created of this DataGuardAssociationSummary.
`transport_type`	Gets the transport_type of this DataGuardAssociationSummary.

Methods

__init__(**kwargs) Initializes a new DataGuardAssociationSummary object with values from keyword arguments.

LIFECYCLE_STATE_AVAILABLE = 'AVAILABLE'¶: A constant which can be used with the lifecycle_state property of a DataGuardAssociationSummary. This constant has a value of “AVAILABLE”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a DataGuardAssociationSummary. This constant has a value of “FAILED”

LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING'¶: A constant which can be used with the lifecycle_state property of a DataGuardAssociationSummary. This constant has a value of “PROVISIONING”

LIFECYCLE_STATE_TERMINATED = 'TERMINATED'¶: A constant which can be used with the lifecycle_state property of a DataGuardAssociationSummary. This constant has a value of “TERMINATED”

LIFECYCLE_STATE_TERMINATING = 'TERMINATING'¶: A constant which can be used with the lifecycle_state property of a DataGuardAssociationSummary. This constant has a value of “TERMINATING”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a DataGuardAssociationSummary. This constant has a value of “UPDATING”

LIFECYCLE_STATE_UPGRADING = 'UPGRADING'¶: A constant which can be used with the lifecycle_state property of a DataGuardAssociationSummary. This constant has a value of “UPGRADING”

PEER_ROLE_DISABLED_STANDBY = 'DISABLED_STANDBY'¶: A constant which can be used with the peer_role property of a DataGuardAssociationSummary. This constant has a value of “DISABLED_STANDBY”

PEER_ROLE_PRIMARY = 'PRIMARY'¶: A constant which can be used with the peer_role property of a DataGuardAssociationSummary. This constant has a value of “PRIMARY”

PEER_ROLE_STANDBY = 'STANDBY'¶: A constant which can be used with the peer_role property of a DataGuardAssociationSummary. This constant has a value of “STANDBY”

PROTECTION_MODE_MAXIMUM_AVAILABILITY = 'MAXIMUM_AVAILABILITY'¶: A constant which can be used with the protection_mode property of a DataGuardAssociationSummary. 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 DataGuardAssociationSummary. 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 DataGuardAssociationSummary. This constant has a value of “MAXIMUM_PROTECTION”

ROLE_DISABLED_STANDBY = 'DISABLED_STANDBY'¶: A constant which can be used with the role property of a DataGuardAssociationSummary. This constant has a value of “DISABLED_STANDBY”

ROLE_PRIMARY = 'PRIMARY'¶: A constant which can be used with the role property of a DataGuardAssociationSummary. This constant has a value of “PRIMARY”

ROLE_STANDBY = 'STANDBY'¶: A constant which can be used with the role property of a DataGuardAssociationSummary. This constant has a value of “STANDBY”

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

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

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

__init__(**kwargs)¶

Initializes a new DataGuardAssociationSummary object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

id (str) – The value to assign to the id property of this DataGuardAssociationSummary.
database_id (str) – The value to assign to the database_id property of this DataGuardAssociationSummary.
role (str) – The value to assign to the role property of this DataGuardAssociationSummary. Allowed values for this property are: “PRIMARY”, “STANDBY”, “DISABLED_STANDBY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this DataGuardAssociationSummary. Allowed values for this property are: “PROVISIONING”, “AVAILABLE”, “UPDATING”, “TERMINATING”, “TERMINATED”, “FAILED”, “UPGRADING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this DataGuardAssociationSummary.
peer_db_system_id (str) – The value to assign to the peer_db_system_id property of this DataGuardAssociationSummary.
peer_db_home_id (str) – The value to assign to the peer_db_home_id property of this DataGuardAssociationSummary.
peer_database_id (str) – The value to assign to the peer_database_id property of this DataGuardAssociationSummary.
peer_data_guard_association_id (str) – The value to assign to the peer_data_guard_association_id property of this DataGuardAssociationSummary.
peer_role (str) – The value to assign to the peer_role property of this DataGuardAssociationSummary. Allowed values for this property are: “PRIMARY”, “STANDBY”, “DISABLED_STANDBY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
apply_lag (str) – The value to assign to the apply_lag property of this DataGuardAssociationSummary.
apply_rate (str) – The value to assign to the apply_rate property of this DataGuardAssociationSummary.
protection_mode (str) – The value to assign to the protection_mode property of this DataGuardAssociationSummary. Allowed values for this property are: “MAXIMUM_AVAILABILITY”, “MAXIMUM_PERFORMANCE”, “MAXIMUM_PROTECTION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
transport_type (str) – The value to assign to the transport_type property of this DataGuardAssociationSummary. Allowed values for this property are: “SYNC”, “ASYNC”, “FASTSYNC”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
time_created (datetime) – The value to assign to the time_created property of this DataGuardAssociationSummary.
is_active_data_guard_enabled (bool) – The value to assign to the is_active_data_guard_enabled property of this DataGuardAssociationSummary.

apply_lag¶

Gets the apply_lag of this DataGuardAssociationSummary. The lag time between updates to the primary database and application of the redo data on the standby database, as computed by the reporting database.

Example: 9 seconds

Returns:	The apply_lag of this DataGuardAssociationSummary.
Return type:	str

apply_rate¶

Gets the apply_rate of this DataGuardAssociationSummary. The rate at which redo logs are synced between the associated databases.

Example: 180 Mb per second

Returns:	The apply_rate of this DataGuardAssociationSummary.
Return type:	str

database_id¶

[Required] Gets the database_id of this DataGuardAssociationSummary. The OCID of the reporting database.

Returns:	The database_id of this DataGuardAssociationSummary.
Return type:	str

id¶

[Required] Gets the id of this DataGuardAssociationSummary. The OCID of the Data Guard association.

Returns:	The id of this DataGuardAssociationSummary.
Return type:	str

is_active_data_guard_enabled¶

Gets the is_active_data_guard_enabled of this DataGuardAssociationSummary. True if active Data Guard is enabled.

Returns:	The is_active_data_guard_enabled of this DataGuardAssociationSummary.
Return type:	bool

lifecycle_details¶

Gets the lifecycle_details of this DataGuardAssociationSummary. Additional information about the current lifecycleState, if available.

Returns:	The lifecycle_details of this DataGuardAssociationSummary.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this DataGuardAssociationSummary. The current state of the Data Guard association.

Allowed values for this property are: “PROVISIONING”, “AVAILABLE”, “UPDATING”, “TERMINATING”, “TERMINATED”, “FAILED”, “UPGRADING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_state of this DataGuardAssociationSummary.
Return type:	str

peer_data_guard_association_id¶

Gets the peer_data_guard_association_id of this DataGuardAssociationSummary. The OCID of the peer database’s Data Guard association.

Returns:	The peer_data_guard_association_id of this DataGuardAssociationSummary.
Return type:	str

peer_database_id¶

Gets the peer_database_id of this DataGuardAssociationSummary. The OCID of the associated peer database.

Returns:	The peer_database_id of this DataGuardAssociationSummary.
Return type:	str

peer_db_home_id¶

Gets the peer_db_home_id of this DataGuardAssociationSummary. The OCID of the Database Home containing the associated peer database.

Returns:	The peer_db_home_id of this DataGuardAssociationSummary.
Return type:	str

peer_db_system_id¶

[Required] Gets the peer_db_system_id of this DataGuardAssociationSummary. The OCID of the DB system containing the associated peer database.

Returns:	The peer_db_system_id of this DataGuardAssociationSummary.
Return type:	str

peer_role¶

[Required] Gets the peer_role of this DataGuardAssociationSummary. The role of the peer database in this Data Guard association.

Allowed values for this property are: “PRIMARY”, “STANDBY”, “DISABLED_STANDBY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The peer_role of this DataGuardAssociationSummary.
Return type:	str

protection_mode¶

[Required] Gets the protection_mode of this DataGuardAssociationSummary. The protection mode of this Data Guard association. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.

Allowed values for this property are: “MAXIMUM_AVAILABILITY”, “MAXIMUM_PERFORMANCE”, “MAXIMUM_PROTECTION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

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

role¶

[Required] Gets the role of this DataGuardAssociationSummary. The role of the reporting database in this Data Guard association.

Allowed values for this property are: “PRIMARY”, “STANDBY”, “DISABLED_STANDBY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The role of this DataGuardAssociationSummary.
Return type:	str

time_created¶

Gets the time_created of this DataGuardAssociationSummary. The date and time the Data Guard association was created.

Returns:	The time_created of this DataGuardAssociationSummary.
Return type:	datetime

transport_type¶

Gets the transport_type of this DataGuardAssociationSummary. The redo transport type used by this Data Guard association. For more information, see Redo Transport Services in the Oracle Data Guard documentation.

Allowed values for this property are: “SYNC”, “ASYNC”, “FASTSYNC”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

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