Plan
Represents a Region switch plan. A plan defines the steps required to shift traffic from one AWS Region to another.
Contents
- 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
- executionRole
-
The execution role for a plan.
Type: String
Pattern:
arn:aws[a-zA-Z0-9-]*:iam::[0-9]{12}:role/.+Required: Yes
- name
-
The name for a 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 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 AWS Regions for a plan.
Type: Array of strings
Array Members: Fixed number of 2 items.
Pattern:
[a-z]{2}-[a-z-]+-\d+Required: Yes
- workflows
-
The workflows for a plan.
Type: Array of Workflow objects
Required: Yes
- associatedAlarms
-
The associated application health alarms for a plan.
Type: String to AssociatedAlarm object map
Required: No
- description
-
The description for a 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 for a plan.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 10080.
Required: No
- reportConfiguration
-
The report configuration for a plan.
Type: ReportConfiguration object
Required: No
- serviceQuotaChecksEnabled
-
Indicates whether service quota checks are enabled for the Region switch plan. When enabled, Region switch compares the applied service quota values across the plan's AWS Regions and creates a warning when a quota in one Region is lower than the value required for the matching resource in another Region. Service quota checks are advisory and don't prevent you from creating, evaluating, or executing a plan.
Type: Boolean
Required: No
- triggers
-
The triggers for a plan.
Type: Array of Trigger objects
Required: No
- updatedAt
-
The timestamp when the plan 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 AWS SDKs, see the following:
