DrPlanSummary

class oci.disaster_recovery.models.DrPlanSummary(**kwargs)

Bases: object

The summary of a DR plan.

Attributes:

LIFECYCLE_STATE_ACTIVE

A constant which can be used with the lifecycle_state property of a DrPlanSummary.

LIFECYCLE_STATE_CREATING

A constant which can be used with the lifecycle_state property of a DrPlanSummary.

LIFECYCLE_STATE_DELETED

A constant which can be used with the lifecycle_state property of a DrPlanSummary.

LIFECYCLE_STATE_DELETING

A constant which can be used with the lifecycle_state property of a DrPlanSummary.

LIFECYCLE_STATE_FAILED

A constant which can be used with the lifecycle_state property of a DrPlanSummary.

LIFECYCLE_STATE_INACTIVE

A constant which can be used with the lifecycle_state property of a DrPlanSummary.

LIFECYCLE_STATE_NEEDS_ATTENTION

A constant which can be used with the lifecycle_state property of a DrPlanSummary.

LIFECYCLE_STATE_UPDATING

A constant which can be used with the lifecycle_state property of a DrPlanSummary.

LIFECYCLE_SUB_STATE_NEEDS_REFRESH

A constant which can be used with the lifecycle_sub_state property of a DrPlanSummary.

LIFECYCLE_SUB_STATE_NEEDS_VERIFICATION

A constant which can be used with the lifecycle_sub_state property of a DrPlanSummary.

LIFECYCLE_SUB_STATE_REFRESHING

A constant which can be used with the lifecycle_sub_state property of a DrPlanSummary.

LIFECYCLE_SUB_STATE_VERIFYING

A constant which can be used with the lifecycle_sub_state property of a DrPlanSummary.

TYPE_FAILOVER

A constant which can be used with the type property of a DrPlanSummary.

TYPE_START_DRILL

A constant which can be used with the type property of a DrPlanSummary.

TYPE_STOP_DRILL

A constant which can be used with the type property of a DrPlanSummary.

TYPE_SWITCHOVER

A constant which can be used with the type property of a DrPlanSummary.

compartment_id

[Required] Gets the compartment_id of this DrPlanSummary.

defined_tags

Gets the defined_tags of this DrPlanSummary.

display_name

[Required] Gets the display_name of this DrPlanSummary.

dr_protection_group_id

[Required] Gets the dr_protection_group_id of this DrPlanSummary.

freeform_tags

Gets the freeform_tags of this DrPlanSummary.

id

[Required] Gets the id of this DrPlanSummary.

life_cycle_details

Gets the life_cycle_details of this DrPlanSummary.

lifecycle_state

[Required] Gets the lifecycle_state of this DrPlanSummary.

lifecycle_sub_state

Gets the lifecycle_sub_state of this DrPlanSummary.

peer_dr_protection_group_id

[Required] Gets the peer_dr_protection_group_id of this DrPlanSummary.

peer_region

[Required] Gets the peer_region of this DrPlanSummary.

system_tags

Gets the system_tags of this DrPlanSummary.

time_created

[Required] Gets the time_created of this DrPlanSummary.

time_updated

[Required] Gets the time_updated of this DrPlanSummary.

type

[Required] Gets the type of this DrPlanSummary.

Methods:

__init__(**kwargs)

Initializes a new DrPlanSummary object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a DrPlanSummary. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'

A constant which can be used with the lifecycle_state property of a DrPlanSummary. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a DrPlanSummary. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'

A constant which can be used with the lifecycle_state property of a DrPlanSummary. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a DrPlanSummary. This constant has a value of “FAILED”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

A constant which can be used with the lifecycle_state property of a DrPlanSummary. This constant has a value of “INACTIVE”

LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'

A constant which can be used with the lifecycle_state property of a DrPlanSummary. This constant has a value of “NEEDS_ATTENTION”

LIFECYCLE_STATE_UPDATING = 'UPDATING'

A constant which can be used with the lifecycle_state property of a DrPlanSummary. This constant has a value of “UPDATING”

LIFECYCLE_SUB_STATE_NEEDS_REFRESH = 'NEEDS_REFRESH'

A constant which can be used with the lifecycle_sub_state property of a DrPlanSummary. This constant has a value of “NEEDS_REFRESH”

LIFECYCLE_SUB_STATE_NEEDS_VERIFICATION = 'NEEDS_VERIFICATION'

A constant which can be used with the lifecycle_sub_state property of a DrPlanSummary. This constant has a value of “NEEDS_VERIFICATION”

LIFECYCLE_SUB_STATE_REFRESHING = 'REFRESHING'

A constant which can be used with the lifecycle_sub_state property of a DrPlanSummary. This constant has a value of “REFRESHING”

LIFECYCLE_SUB_STATE_VERIFYING = 'VERIFYING'

A constant which can be used with the lifecycle_sub_state property of a DrPlanSummary. This constant has a value of “VERIFYING”

TYPE_FAILOVER = 'FAILOVER'

A constant which can be used with the type property of a DrPlanSummary. This constant has a value of “FAILOVER”

TYPE_START_DRILL = 'START_DRILL'

A constant which can be used with the type property of a DrPlanSummary. This constant has a value of “START_DRILL”

TYPE_STOP_DRILL = 'STOP_DRILL'

A constant which can be used with the type property of a DrPlanSummary. This constant has a value of “STOP_DRILL”

TYPE_SWITCHOVER = 'SWITCHOVER'

A constant which can be used with the type property of a DrPlanSummary. This constant has a value of “SWITCHOVER”

__init__(**kwargs)

Initializes a new DrPlanSummary 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 DrPlanSummary.

  • compartment_id (str) – The value to assign to the compartment_id property of this DrPlanSummary.

  • display_name (str) – The value to assign to the display_name property of this DrPlanSummary.

  • type (str) – The value to assign to the type property of this DrPlanSummary. Allowed values for this property are: “SWITCHOVER”, “FAILOVER”, “START_DRILL”, “STOP_DRILL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • dr_protection_group_id (str) – The value to assign to the dr_protection_group_id property of this DrPlanSummary.

  • peer_dr_protection_group_id (str) – The value to assign to the peer_dr_protection_group_id property of this DrPlanSummary.

  • peer_region (str) – The value to assign to the peer_region property of this DrPlanSummary.

  • time_created (datetime) – The value to assign to the time_created property of this DrPlanSummary.

  • time_updated (datetime) – The value to assign to the time_updated property of this DrPlanSummary.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this DrPlanSummary. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “FAILED”, “NEEDS_ATTENTION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • lifecycle_sub_state (str) – The value to assign to the lifecycle_sub_state property of this DrPlanSummary. Allowed values for this property are: “NEEDS_REFRESH”, “NEEDS_VERIFICATION”, “REFRESHING”, “VERIFYING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • life_cycle_details (str) – The value to assign to the life_cycle_details property of this DrPlanSummary.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this DrPlanSummary.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this DrPlanSummary.

  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this DrPlanSummary.

property compartment_id

[Required] Gets the compartment_id of this DrPlanSummary. The OCID of the compartment containing the DR plan.

Example: ocid1.compartment.oc1..uniqueID

Returns

The compartment_id of this DrPlanSummary.

Return type

str

property defined_tags

Gets the defined_tags of this DrPlanSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace.

Example: {“Operations”: {“CostCenter”: “42”}}

Returns

The defined_tags of this DrPlanSummary.

Return type

dict(str, dict(str, object))

property display_name

[Required] Gets the display_name of this DrPlanSummary. The display name of the DR plan.

Example: EBS Switchover PHX to IAD

Returns

The display_name of this DrPlanSummary.

Return type

str

property dr_protection_group_id

[Required] Gets the dr_protection_group_id of this DrPlanSummary. The OCID of the DR protection group to which this DR plan belongs.

Example: ocid1.drprotectiongroup.oc1..uniqueID

Returns

The dr_protection_group_id of this DrPlanSummary.

Return type

str

property freeform_tags

Gets the freeform_tags of this DrPlanSummary. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.

Example: {“Department”: “Finance”}

Returns

The freeform_tags of this DrPlanSummary.

Return type

dict(str, str)

property id

[Required] Gets the id of this DrPlanSummary. The OCID of the DR plan.

Example: ocid1.drplan.oc1..uniqueID

Returns

The id of this DrPlanSummary.

Return type

str

property life_cycle_details

Gets the life_cycle_details of this DrPlanSummary. A message describing the DR plan’s current state in more detail.

Returns

The life_cycle_details of this DrPlanSummary.

Return type

str

property lifecycle_state

[Required] Gets the lifecycle_state of this DrPlanSummary. The current state of the DR plan.

Example: ACTIVE

Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “FAILED”, “NEEDS_ATTENTION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The lifecycle_state of this DrPlanSummary.

Return type

str

property lifecycle_sub_state

Gets the lifecycle_sub_state of this DrPlanSummary. The current sub state of the DR plan.

Example: NEEDS_REFRESH

Allowed values for this property are: “NEEDS_REFRESH”, “NEEDS_VERIFICATION”, “REFRESHING”, “VERIFYING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The lifecycle_sub_state of this DrPlanSummary.

Return type

str

property peer_dr_protection_group_id

[Required] Gets the peer_dr_protection_group_id of this DrPlanSummary. The OCID of the peer DR protection group associated with this plan’s DR protection group.

Example: ocid1.drprotectiongroup.oc1..uniqueID

Returns

The peer_dr_protection_group_id of this DrPlanSummary.

Return type

str

property peer_region

[Required] Gets the peer_region of this DrPlanSummary. The region of the peer DR protection group associated with this plan’s DR protection group.

Example: us-ashburn-1

Returns

The peer_region of this DrPlanSummary.

Return type

str

property system_tags

Gets the system_tags of this DrPlanSummary. Usage of system tag keys. These predefined keys are scoped to namespaces.

Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns

The system_tags of this DrPlanSummary.

Return type

dict(str, dict(str, object))

property time_created

[Required] Gets the time_created of this DrPlanSummary. The date and time the DR plan was created. An RFC3339 formatted datetime string.

Example: 2019-03-29T09:36:42Z

Returns

The time_created of this DrPlanSummary.

Return type

datetime

property time_updated

[Required] Gets the time_updated of this DrPlanSummary. The date and time the DR plan was updated. An RFC3339 formatted datetime string.

Example: 2019-03-29T09:36:42Z

Returns

The time_updated of this DrPlanSummary.

Return type

datetime

property type

[Required] Gets the type of this DrPlanSummary. The type of the DR plan.

Example: SWITCHOVER

Allowed values for this property are: “SWITCHOVER”, “FAILOVER”, “START_DRILL”, “STOP_DRILL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The type of this DrPlanSummary.

Return type

str