UpdatePlan
Updates an existing Region switch plan. You can modify the plan's description, workflows, execution role, recovery time objective, associated alarms, and triggers.
Request Parameters
- arn
-
The Amazon Resource Name (ARN) of the plan.
Type: String
Pattern:
arn:aws[a-zA-Z-]*:arc-region-switch::[0-9]{12}:plan/([a-zA-Z0-9](?:[a-zA-Z0-9-]{0,30}[a-zA-Z0-9])?):([a-z0-9]{6})Required: Yes
- associatedAlarms
-
The updated CloudWatch alarms associated with the plan.
Type: String to AssociatedAlarm object map
Required: No
- description
-
The updated description for the Region switch plan.
Type: String
Required: No
- executionRole
-
The updated IAM role ARN that grants Region switch the permissions needed to execute the plan steps.
Type: String
Pattern:
arn:aws[a-zA-Z0-9-]*:iam::[0-9]{12}:role/.+Required: Yes
- recoveryTimeObjectiveMinutes
-
The updated target recovery time objective (RTO) in minutes for the plan.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 10080.
Required: No
- triggers
-
The updated conditions that can automatically trigger the execution of the plan.
Type: Array of Trigger objects
Required: No
- workflows
-
The updated workflows for the Region switch plan.
Type: Array of Workflow objects
Required: Yes
Response Elements
The following element is returned by the service.
- plan
-
The details of the updated Region switch plan.
Type: Plan object
Errors
For information about the errors that are common to all actions, see Common Errors.
- ResourceNotFoundException
-
The specified resource was not found.
HTTP Status Code: 404
HTTP Status Code: 404
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
