AbbreviatedPlan
A summarized representation of a Region switch plan. This structure contains key information about a plan without all the detailed workflow and step data.
Contents
- arn
-
The Amazon Resource Name (ARN) of the Region switch 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
- name
-
The name of a Region switch plan.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 32.
Pattern:
[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,30}[a-zA-Z0-9])?Required: Yes
- owner
-
The owner of a Region switch plan.
Type: String
Pattern:
\d{12}Required: Yes
- recoveryApproach
-
The recovery approach for a Region switch plan, which can be active/active (activeActive) or active/passive (activePassive).
Type: String
Valid Values:
activeActive | activePassiveRequired: Yes
- regions
-
The Amazon Web Services Region specified for a Region switch plan.
Type: Array of strings
Array Members: Fixed number of 2 items.
Pattern:
[a-z]{2}-[a-z-]+-\d+Required: Yes
- activePlanExecution
-
Specifies if this is the active plan execution at this time.
Type: String
Required: No
- description
-
The description of a Region switch plan.
Type: String
Required: No
- executionRole
-
The execution role is a way to categorize a Region switch plan.
Type: String
Required: No
- primaryRegion
-
The primary Region for a plan.
Type: String
Pattern:
[a-z]{2}-[a-z-]+-\d+Required: No
- recoveryTimeObjectiveMinutes
-
The recovery time objective that you've specified.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 10080.
Required: No
- updatedAt
-
The timestamp when the plan execution was last updated.
Type: Timestamp
Required: No
- version
-
The version for the plan.
Type: String
Required: No
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: