DisasterRecoveryClientCompositeOperations

class oci.disaster_recovery.DisasterRecoveryClientCompositeOperations(client, **kwargs)

This class provides a wrapper around DisasterRecoveryClient and offers convenience methods for operations that would otherwise need to be chained together. For example, instead of performing an action on a resource (e.g. launching an instance, creating a load balancer) and then using a waiter to wait for the resource to enter a given state, you can call a single method in this class to accomplish the same functionality

Methods

__init__(client, **kwargs)	Creates a new DisasterRecoveryClientCompositeOperations object
associate_dr_protection_group_and_wait_for_state(…)	Calls associate_dr_protection_group() and waits for the WorkRequest to enter the given state(s).
cancel_dr_plan_execution_and_wait_for_state(…)	Calls cancel_dr_plan_execution() and waits for the WorkRequest to enter the given state(s).
change_dr_protection_group_compartment_and_wait_for_state(…)	Calls change_dr_protection_group_compartment() and waits for the WorkRequest to enter the given state(s).
create_dr_plan_and_wait_for_state(…[, …])	Calls create_dr_plan() and waits for the WorkRequest to enter the given state(s).
create_dr_plan_execution_and_wait_for_state(…)	Calls create_dr_plan_execution() and waits for the WorkRequest to enter the given state(s).
create_dr_protection_group_and_wait_for_state(…)	Calls create_dr_protection_group() and waits for the WorkRequest to enter the given state(s).
delete_dr_plan_and_wait_for_state(dr_plan_id)	Calls delete_dr_plan() and waits for the DrPlan acted upon to enter the given state(s).
delete_dr_plan_execution_and_wait_for_state(…)	Calls delete_dr_plan_execution() and waits for the WorkRequest to enter the given state(s).
delete_dr_protection_group_and_wait_for_state(…)	Calls delete_dr_protection_group() and waits for the WorkRequest to enter the given state(s).
disassociate_dr_protection_group_and_wait_for_state(…)	Calls disassociate_dr_protection_group() and waits for the WorkRequest to enter the given state(s).
ignore_dr_plan_execution_and_wait_for_state(…)	Calls ignore_dr_plan_execution() and waits for the WorkRequest to enter the given state(s).
pause_dr_plan_execution_and_wait_for_state(…)	Calls pause_dr_plan_execution() and waits for the WorkRequest to enter the given state(s).
resume_dr_plan_execution_and_wait_for_state(…)	Calls resume_dr_plan_execution() and waits for the WorkRequest to enter the given state(s).
retry_dr_plan_execution_and_wait_for_state(…)	Calls retry_dr_plan_execution() and waits for the WorkRequest to enter the given state(s).
update_dr_plan_and_wait_for_state(…[, …])	Calls update_dr_plan() and waits for the WorkRequest to enter the given state(s).
update_dr_plan_execution_and_wait_for_state(…)	Calls update_dr_plan_execution() and waits for the WorkRequest to enter the given state(s).
update_dr_protection_group_and_wait_for_state(…)	Calls update_dr_protection_group() and waits for the WorkRequest to enter the given state(s).
update_dr_protection_group_role_and_wait_for_state(…)	Calls update_dr_protection_group_role() and waits for the WorkRequest to enter the given state(s).

__init__(client, **kwargs)

Creates a new DisasterRecoveryClientCompositeOperations object

Parameters:client (DisasterRecoveryClient) – The service client which will be wrapped by this object

associate_dr_protection_group_and_wait_for_state(associate_dr_protection_group_details, dr_protection_group_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls associate_dr_protection_group() and waits for the WorkRequest to enter the given state(s).

Parameters:

• associate_dr_protection_group_details (oci.disaster_recovery.models.AssociateDrProtectionGroupDetails) – (required) Details for creating an association between two DR protection groups.
• dr_protection_group_id (str) –

  (required) The OCID of the DR protection group.

  Example: ocid1.drprotectiongroup.oc1..uniqueID

• wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status
• operation_kwargs (dict) – A dictionary of keyword arguments to pass to associate_dr_protection_group()
• waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

cancel_dr_plan_execution_and_wait_for_state(cancel_dr_plan_execution_details, dr_plan_execution_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls cancel_dr_plan_execution() and waits for the WorkRequest to enter the given state(s).

Parameters:

• cancel_dr_plan_execution_details (oci.disaster_recovery.models.CancelDrPlanExecutionDetails) – (required) Details for canceling the DR plan execution.
• dr_plan_execution_id (str) –

  (required) The OCID of the DR plan execution.

  Example: ocid1.drplanexecution.oc1..uniqueID

• wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status
• operation_kwargs (dict) – A dictionary of keyword arguments to pass to cancel_dr_plan_execution()
• waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

change_dr_protection_group_compartment_and_wait_for_state(change_dr_protection_group_compartment_details, dr_protection_group_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls change_dr_protection_group_compartment() and waits for the WorkRequest to enter the given state(s).

Parameters:

• change_dr_protection_group_compartment_details (oci.disaster_recovery.models.ChangeDrProtectionGroupCompartmentDetails) – (required) Details for changing the DR protection group compartment.
• dr_protection_group_id (str) –

  (required) The OCID of the DR protection group.

  Example: ocid1.drprotectiongroup.oc1..uniqueID

• wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status
• operation_kwargs (dict) – A dictionary of keyword arguments to pass to change_dr_protection_group_compartment()
• waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

create_dr_plan_and_wait_for_state(create_dr_plan_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_dr_plan() and waits for the WorkRequest to enter the given state(s).

Parameters:

• create_dr_plan_details (oci.disaster_recovery.models.CreateDrPlanDetails) – (required) Details for creating the new DR plan.
• wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status
• operation_kwargs (dict) – A dictionary of keyword arguments to pass to create_dr_plan()
• waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

create_dr_plan_execution_and_wait_for_state(create_dr_plan_execution_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_dr_plan_execution() and waits for the WorkRequest to enter the given state(s).

Parameters:

• create_dr_plan_execution_details (oci.disaster_recovery.models.CreateDrPlanExecutionDetails) – (required) Details for creating the DR plan execution.
• wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status
• operation_kwargs (dict) – A dictionary of keyword arguments to pass to create_dr_plan_execution()
• waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

create_dr_protection_group_and_wait_for_state(create_dr_protection_group_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_dr_protection_group() and waits for the WorkRequest to enter the given state(s).

Parameters:

• create_dr_protection_group_details (oci.disaster_recovery.models.CreateDrProtectionGroupDetails) – (required) Details for creating the DR protection group.
• wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status
• operation_kwargs (dict) – A dictionary of keyword arguments to pass to create_dr_protection_group()
• waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

delete_dr_plan_and_wait_for_state(dr_plan_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls delete_dr_plan() and waits for the DrPlan acted upon to enter the given state(s).

Parameters:

• dr_plan_id (str) –

  (required) The OCID of the DR plan.

  Example: ocid1.drplan.oc1..uniqueID

• wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
• operation_kwargs (dict) – A dictionary of keyword arguments to pass to delete_dr_plan()
• waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

delete_dr_plan_execution_and_wait_for_state(dr_plan_execution_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls delete_dr_plan_execution() and waits for the WorkRequest to enter the given state(s).

Parameters:

• dr_plan_execution_id (str) –

  (required) The OCID of the DR plan execution.

  Example: ocid1.drplanexecution.oc1..uniqueID

• wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status
• operation_kwargs (dict) – A dictionary of keyword arguments to pass to delete_dr_plan_execution()
• waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

delete_dr_protection_group_and_wait_for_state(dr_protection_group_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls delete_dr_protection_group() and waits for the WorkRequest to enter the given state(s).

Parameters:

• dr_protection_group_id (str) –

  (required) The OCID of the DR protection group.

  Example: ocid1.drprotectiongroup.oc1..uniqueID

• wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status
• operation_kwargs (dict) – A dictionary of keyword arguments to pass to delete_dr_protection_group()
• waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

disassociate_dr_protection_group_and_wait_for_state(disassociate_dr_protection_group_details, dr_protection_group_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls disassociate_dr_protection_group() and waits for the WorkRequest to enter the given state(s).

Parameters:

• disassociate_dr_protection_group_details (oci.disaster_recovery.models.DisassociateDrProtectionGroupDetails) – (required) Details for deleting the association between two DR protection groups.
• dr_protection_group_id (str) –

  (required) The OCID of the DR protection group.

  Example: ocid1.drprotectiongroup.oc1..uniqueID

• wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status
• operation_kwargs (dict) – A dictionary of keyword arguments to pass to disassociate_dr_protection_group()
• waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

ignore_dr_plan_execution_and_wait_for_state(ignore_dr_plan_execution_details, dr_plan_execution_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls ignore_dr_plan_execution() and waits for the WorkRequest to enter the given state(s).

Parameters:

• ignore_dr_plan_execution_details (oci.disaster_recovery.models.IgnoreDrPlanExecutionDetails) – (required) Details for ignoring the failed group or step and resuming execution.
• dr_plan_execution_id (str) –

  (required) The OCID of the DR plan execution.

  Example: ocid1.drplanexecution.oc1..uniqueID

• wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status
• operation_kwargs (dict) – A dictionary of keyword arguments to pass to ignore_dr_plan_execution()
• waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

pause_dr_plan_execution_and_wait_for_state(pause_dr_plan_execution_details, dr_plan_execution_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls pause_dr_plan_execution() and waits for the WorkRequest to enter the given state(s).

Parameters:

• pause_dr_plan_execution_details (oci.disaster_recovery.models.PauseDrPlanExecutionDetails) – (required) Details for pausing the DR plan execution.
• dr_plan_execution_id (str) –

  (required) The OCID of the DR plan execution.

  Example: ocid1.drplanexecution.oc1..uniqueID

• wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status
• operation_kwargs (dict) – A dictionary of keyword arguments to pass to pause_dr_plan_execution()
• waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

resume_dr_plan_execution_and_wait_for_state(resume_dr_plan_execution_details, dr_plan_execution_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls resume_dr_plan_execution() and waits for the WorkRequest to enter the given state(s).

Parameters:

• resume_dr_plan_execution_details (oci.disaster_recovery.models.ResumeDrPlanExecutionDetails) – (required) Details for resuming the DR plan execution.
• dr_plan_execution_id (str) –

  (required) The OCID of the DR plan execution.

  Example: ocid1.drplanexecution.oc1..uniqueID

• wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status
• operation_kwargs (dict) – A dictionary of keyword arguments to pass to resume_dr_plan_execution()
• waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

retry_dr_plan_execution_and_wait_for_state(retry_dr_plan_execution_details, dr_plan_execution_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls retry_dr_plan_execution() and waits for the WorkRequest to enter the given state(s).

Parameters:

• retry_dr_plan_execution_details (oci.disaster_recovery.models.RetryDrPlanExecutionDetails) – (required) Details for retrying execution of the failed group or step.
• dr_plan_execution_id (str) –

  (required) The OCID of the DR plan execution.

  Example: ocid1.drplanexecution.oc1..uniqueID

• wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status
• operation_kwargs (dict) – A dictionary of keyword arguments to pass to retry_dr_plan_execution()
• waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

update_dr_plan_and_wait_for_state(update_dr_plan_details, dr_plan_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_dr_plan() and waits for the WorkRequest to enter the given state(s).

Parameters:

• update_dr_plan_details (oci.disaster_recovery.models.UpdateDrPlanDetails) – (required) Details for updating the DR plan.
• dr_plan_id (str) –

  (required) The OCID of the DR plan.

  Example: ocid1.drplan.oc1..uniqueID

• wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status
• operation_kwargs (dict) – A dictionary of keyword arguments to pass to update_dr_plan()
• waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

update_dr_plan_execution_and_wait_for_state(update_dr_plan_execution_details, dr_plan_execution_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_dr_plan_execution() and waits for the WorkRequest to enter the given state(s).

Parameters:

• update_dr_plan_execution_details (oci.disaster_recovery.models.UpdateDrPlanExecutionDetails) – (required) Details for updating the DR plan execution.
• dr_plan_execution_id (str) –

  (required) The OCID of the DR plan execution.

  Example: ocid1.drplanexecution.oc1..uniqueID

• wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status
• operation_kwargs (dict) – A dictionary of keyword arguments to pass to update_dr_plan_execution()
• waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

update_dr_protection_group_and_wait_for_state(update_dr_protection_group_details, dr_protection_group_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_dr_protection_group() and waits for the WorkRequest to enter the given state(s).

Parameters:

• update_dr_protection_group_details (oci.disaster_recovery.models.UpdateDrProtectionGroupDetails) – (required) Details for updating the the DR protection group.
• dr_protection_group_id (str) –

  (required) The OCID of the DR protection group.

  Example: ocid1.drprotectiongroup.oc1..uniqueID

• wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status
• operation_kwargs (dict) – A dictionary of keyword arguments to pass to update_dr_protection_group()
• waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

update_dr_protection_group_role_and_wait_for_state(update_dr_protection_group_role_details, dr_protection_group_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_dr_protection_group_role() and waits for the WorkRequest to enter the given state(s).

Parameters:

• update_dr_protection_group_role_details (oci.disaster_recovery.models.UpdateDrProtectionGroupRoleDetails) – (required) The role details for the DR protection group to be updated.
• dr_protection_group_id (str) –

  (required) The OCID of the DR protection group.

  Example: ocid1.drprotectiongroup.oc1..uniqueID

• wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status
• operation_kwargs (dict) – A dictionary of keyword arguments to pass to update_dr_protection_group_role()
• waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait