This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.
AWS::ARCRegionSwitch::Plan
Represents a Region switch plan. A plan defines the steps required to shift traffic from one AWS Region to another.
Syntax
To declare this entity in your CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::ARCRegionSwitch::Plan", "Properties" : { "AssociatedAlarms" :{, "Description" :Key:Value, ...}String, "ExecutionRole" :String, "Name" :String, "PrimaryRegion" :String, "RecoveryApproach" :String, "RecoveryTimeObjectiveMinutes" :Number, "Regions" :[ String, ... ], "ReportConfiguration" :ReportConfiguration, "ServiceQuotaChecksEnabled" :Boolean, "Tags" :{, "Triggers" :Key:Value, ...}[ Trigger, ... ], "Workflows" :[ Workflow, ... ]} }
YAML
Type: AWS::ARCRegionSwitch::Plan Properties: AssociatedAlarms:Description:Key:ValueStringExecutionRole:StringName:StringPrimaryRegion:StringRecoveryApproach:StringRecoveryTimeObjectiveMinutes:NumberRegions:- StringReportConfiguration:ReportConfigurationServiceQuotaChecksEnabled:BooleanTags:Triggers:Key:Value- TriggerWorkflows:- Workflow
Properties
AssociatedAlarms-
The associated application health alarms for a plan.
Required: No
Type: Object of AssociatedAlarm
Update requires: No interruption
Description-
The description for a plan.
Required: No
Type: String
Update requires: No interruption
ExecutionRole-
The execution role for a plan.
Required: Yes
Type: String
Pattern:
^arn:aws[a-zA-Z0-9-]*:iam::[0-9]{12}:role/.+$Update requires: No interruption
Name-
The name for a plan.
Required: Yes
Type: String
Pattern:
^[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,30}[a-zA-Z0-9])?$Minimum:
1Maximum:
32Update requires: Replacement
PrimaryRegion-
The primary Region for a plan.
Required: No
Type: String
Pattern:
^[a-z]{2}-[a-z-]+-\d+$Update requires: Replacement
RecoveryApproach-
The recovery approach for a Region switch plan, which can be active/active (activeActive) or active/passive (activePassive).
Required: Yes
Type: String
Allowed values:
activeActive | activePassiveUpdate requires: Replacement
RecoveryTimeObjectiveMinutes-
The recovery time objective for a plan.
Required: No
Type: Number
Minimum:
1Maximum:
10080Update requires: No interruption
Regions-
The AWS Regions for a plan.
Required: Yes
Type: Array of String
Minimum:
2Maximum:
2Update requires: Replacement
ReportConfiguration-
The report configuration for a plan.
Required: No
Type: ReportConfiguration
Update requires: No interruption
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.
Required: No
Type: Boolean
Update requires: No interruption
Property description not available.
Required: No
Type: Object of String
Pattern:
.+Minimum:
0Maximum:
256Update requires: No interruption
Triggers-
The triggers for a plan.
Required: No
Type: Array of Trigger
Update requires: No interruption
Workflows-
The workflows for a plan.
Required: Yes
Type: Array of Workflow
Update requires: No interruption
Return values
Ref
When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the Amazon Resource Name (ARN) of the plan.
Fn::GetAtt
The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.
For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.
Arn-
The Amazon Resource Name (ARN) of the plan.
Owner-
The owner of a plan.
PlanHealthChecksProperty description not available.
Version-
The version for the plan.
