View Source AWS.ARCRegionswitch (aws-elixir v1.0.9)
Amazon Application Recovery Controller (ARC) Region switch helps you to quickly and reliably shift traffic away from an impaired Amazon Web Services Region to a healthy Region.
With Region switch, you can create plans that define the steps to shift traffic for your application from one Amazon Web Services Region to another. You can test your plans in practice mode before using them in a real recovery scenario.
Region switch provides a structured approach to multi-Region failover, helping you to meet your recovery time objectives (RTOs) and maintain business continuity during regional disruptions.
For more information, see Region switch in ARC in the Amazon Application Recovery Controller User Guide.
Link to this section Summary
Functions
Approves a step in a plan execution that requires manual approval.
Cancels an in-progress plan execution.
Creates a new Region switch plan.
Deletes a Region switch plan.
Retrieves detailed information about a Region switch plan.
Retrieves the evaluation status of a Region switch plan.
Retrieves detailed information about a specific plan execution.
Retrieves information about a Region switch plan in a specific Amazon Web Services Region.
Lists the events that occurred during a plan execution.
Lists the executions of a Region switch plan.
Lists all Region switch plans in your Amazon Web Services account.
Lists all Region switch plans in your Amazon Web Services account that are available in the current Amazon Web Services Region.
List the Amazon Route 53 health checks.
Lists the tags attached to a Region switch resource.
Starts the execution of a Region switch plan.
Adds or updates tags for a Region switch resource.
Removes tags from a Region switch resource.
Updates an existing Region switch plan.
Updates an in-progress plan execution.
Updates a specific step in an in-progress plan execution.
Link to this section Functions
Approves a step in a plan execution that requires manual approval.
When you create a plan, you can include approval steps that require manual intervention before the execution can proceed. This operation allows you to provide that approval.
You must specify the plan ARN, execution ID, step name, and approval status. You can also provide an optional comment explaining the approval decision.
Cancels an in-progress plan execution.
This operation stops the execution of the plan and prevents any further steps from being processed.
You must specify the plan ARN and execution ID. You can also provide an optional comment explaining why the execution was canceled.
Creates a new Region switch plan.
A plan defines the steps required to shift traffic from one Amazon Web Services Region to another.
You must specify a name for the plan, the primary Region, and at least one additional Region. You can also provide a description, execution role, recovery time objective, associated alarms, triggers, and workflows that define the steps to execute during a Region switch.
Deletes a Region switch plan.
You must specify the ARN of the plan to delete.
You cannot delete a plan that has an active execution in progress.
Retrieves detailed information about a Region switch plan.
You must specify the ARN of the plan.
Retrieves the evaluation status of a Region switch plan.
The evaluation status provides information about the last time the plan was evaluated and any warnings or issues detected.
Retrieves detailed information about a specific plan execution.
You must specify the plan ARN and execution ID.
Retrieves information about a Region switch plan in a specific Amazon Web Services Region.
This operation is useful for getting Region-specific information about a plan.
Lists the events that occurred during a plan execution.
These events provide a detailed timeline of the execution process.
Lists the executions of a Region switch plan.
This operation returns information about both current and historical executions.
Lists all Region switch plans in your Amazon Web Services account.
Lists all Region switch plans in your Amazon Web Services account that are available in the current Amazon Web Services Region.
List the Amazon Route 53 health checks.
Lists the tags attached to a Region switch resource.
Starts the execution of a Region switch plan.
You can execute a plan in either PRACTICE or RECOVERY mode.
In PRACTICE mode, the execution simulates the steps without making actual changes to your application's traffic routing. In RECOVERY mode, the execution performs actual changes to shift traffic between Regions.
Adds or updates tags for a Region switch resource.
You can assign metadata to your resources in the form of tags, which are key-value pairs.
Removes tags from a Region switch resource.
Updates an existing Region switch plan.
You can modify the plan's description, workflows, execution role, recovery time objective, associated alarms, and triggers.
Updates an in-progress plan execution.
This operation allows you to modify certain aspects of the execution, such as adding a comment or changing the action.
Updates a specific step in an in-progress plan execution.
This operation allows you to modify the step's comment or action.