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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::ARCRegionSwitch::Plan
<a name="aws-resource-arcregionswitch-plan"></a>

Represents a Region switch plan. A plan defines the steps required to shift traffic from one AWS Region to another.

## Syntax
<a name="aws-resource-arcregionswitch-plan-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-arcregionswitch-plan-syntax.json"></a>

```
{
  "Type" : "AWS::ARCRegionSwitch::Plan",
  "Properties" : {
      "[AssociatedAlarms](#cfn-arcregionswitch-plan-associatedalarms)" : {Key: Value, ...},
      "[Description](#cfn-arcregionswitch-plan-description)" : String,
      "[ExecutionRole](#cfn-arcregionswitch-plan-executionrole)" : String,
      "[Name](#cfn-arcregionswitch-plan-name)" : String,
      "[PrimaryRegion](#cfn-arcregionswitch-plan-primaryregion)" : String,
      "[RecoveryApproach](#cfn-arcregionswitch-plan-recoveryapproach)" : String,
      "[RecoveryTimeObjectiveMinutes](#cfn-arcregionswitch-plan-recoverytimeobjectiveminutes)" : Number,
      "[Regions](#cfn-arcregionswitch-plan-regions)" : [ String, ... ],
      "[ReportConfiguration](#cfn-arcregionswitch-plan-reportconfiguration)" : ReportConfiguration,
      "[Tags](#cfn-arcregionswitch-plan-tags)" : {Key: Value, ...},
      "[Triggers](#cfn-arcregionswitch-plan-triggers)" : [ Trigger, ... ],
      "[Workflows](#cfn-arcregionswitch-plan-workflows)" : [ Workflow, ... ]
    }
}
```

### YAML
<a name="aws-resource-arcregionswitch-plan-syntax.yaml"></a>

```
Type: AWS::ARCRegionSwitch::Plan
Properties:
  [AssociatedAlarms](#cfn-arcregionswitch-plan-associatedalarms): 
    Key: Value
  [Description](#cfn-arcregionswitch-plan-description): String
  [ExecutionRole](#cfn-arcregionswitch-plan-executionrole): String
  [Name](#cfn-arcregionswitch-plan-name): String
  [PrimaryRegion](#cfn-arcregionswitch-plan-primaryregion): String
  [RecoveryApproach](#cfn-arcregionswitch-plan-recoveryapproach): String
  [RecoveryTimeObjectiveMinutes](#cfn-arcregionswitch-plan-recoverytimeobjectiveminutes): Number
  [Regions](#cfn-arcregionswitch-plan-regions): 
    - String
  [ReportConfiguration](#cfn-arcregionswitch-plan-reportconfiguration): 
    ReportConfiguration
  [Tags](#cfn-arcregionswitch-plan-tags): 
    Key: Value
  [Triggers](#cfn-arcregionswitch-plan-triggers): 
    - Trigger
  [Workflows](#cfn-arcregionswitch-plan-workflows): 
    - Workflow
```

## Properties
<a name="aws-resource-arcregionswitch-plan-properties"></a>

`AssociatedAlarms`  <a name="cfn-arcregionswitch-plan-associatedalarms"></a>
The associated application health alarms for a plan.  
*Required*: No  
*Type*: Object of [AssociatedAlarm](aws-properties-arcregionswitch-plan-associatedalarm.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Description`  <a name="cfn-arcregionswitch-plan-description"></a>
The description for a plan.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ExecutionRole`  <a name="cfn-arcregionswitch-plan-executionrole"></a>
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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-arcregionswitch-plan-name"></a>
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*: `1`  
*Maximum*: `32`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`PrimaryRegion`  <a name="cfn-arcregionswitch-plan-primaryregion"></a>
The primary Region for a plan.  
*Required*: No  
*Type*: String  
*Pattern*: `^[a-z]{2}-[a-z-]+-\d+$`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`RecoveryApproach`  <a name="cfn-arcregionswitch-plan-recoveryapproach"></a>
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 | activePassive`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`RecoveryTimeObjectiveMinutes`  <a name="cfn-arcregionswitch-plan-recoverytimeobjectiveminutes"></a>
The recovery time objective for a plan.  
*Required*: No  
*Type*: Number  
*Minimum*: `1`  
*Maximum*: `10080`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Regions`  <a name="cfn-arcregionswitch-plan-regions"></a>
The AWS Regions for a plan.  
*Required*: Yes  
*Type*: Array of String  
*Minimum*: `2`  
*Maximum*: `2`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`ReportConfiguration`  <a name="cfn-arcregionswitch-plan-reportconfiguration"></a>
The report configuration for a plan.  
*Required*: No  
*Type*: [ReportConfiguration](aws-properties-arcregionswitch-plan-reportconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Tags`  <a name="cfn-arcregionswitch-plan-tags"></a>
Property description not available.  
*Required*: No  
*Type*: Object of String  
*Pattern*: `.+`  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Triggers`  <a name="cfn-arcregionswitch-plan-triggers"></a>
The triggers for a plan.  
*Required*: No  
*Type*: Array of [Trigger](aws-properties-arcregionswitch-plan-trigger.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Workflows`  <a name="cfn-arcregionswitch-plan-workflows"></a>
The workflows for a plan.  
*Required*: Yes  
*Type*: Array of [Workflow](aws-properties-arcregionswitch-plan-workflow.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-arcregionswitch-plan-return-values"></a>

### Ref
<a name="aws-resource-arcregionswitch-plan-return-values-ref"></a>

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
<a name="aws-resource-arcregionswitch-plan-return-values-fn--getatt"></a>

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 [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-arcregionswitch-plan-return-values-fn--getatt-fn--getatt"></a>

`Arn`  <a name="Arn-fn::getatt"></a>
The Amazon Resource Name (ARN) of the plan.

`Owner`  <a name="Owner-fn::getatt"></a>
The owner of a plan.

`PlanHealthChecks`  <a name="PlanHealthChecks-fn::getatt"></a>
Property description not available.

`Version`  <a name="Version-fn::getatt"></a>
The version for the plan.

# AWS::ARCRegionSwitch::Plan ArcRoutingControlConfiguration
<a name="aws-properties-arcregionswitch-plan-arcroutingcontrolconfiguration"></a>

Configuration for ARC routing controls used in a Region switch plan. Routing controls are simple on/off switches that you can use to shift traffic away from an impaired Region.

## Syntax
<a name="aws-properties-arcregionswitch-plan-arcroutingcontrolconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-arcregionswitch-plan-arcroutingcontrolconfiguration-syntax.json"></a>

```
{
  "[CrossAccountRole](#cfn-arcregionswitch-plan-arcroutingcontrolconfiguration-crossaccountrole)" : String,
  "[ExternalId](#cfn-arcregionswitch-plan-arcroutingcontrolconfiguration-externalid)" : String,
  "[RegionAndRoutingControls](#cfn-arcregionswitch-plan-arcroutingcontrolconfiguration-regionandroutingcontrols)" : {Key: Value, ...},
  "[TimeoutMinutes](#cfn-arcregionswitch-plan-arcroutingcontrolconfiguration-timeoutminutes)" : Number
}
```

### YAML
<a name="aws-properties-arcregionswitch-plan-arcroutingcontrolconfiguration-syntax.yaml"></a>

```
  [CrossAccountRole](#cfn-arcregionswitch-plan-arcroutingcontrolconfiguration-crossaccountrole): String
  [ExternalId](#cfn-arcregionswitch-plan-arcroutingcontrolconfiguration-externalid): String
  [RegionAndRoutingControls](#cfn-arcregionswitch-plan-arcroutingcontrolconfiguration-regionandroutingcontrols): 
    Key: Value
  [TimeoutMinutes](#cfn-arcregionswitch-plan-arcroutingcontrolconfiguration-timeoutminutes): Number
```

## Properties
<a name="aws-properties-arcregionswitch-plan-arcroutingcontrolconfiguration-properties"></a>

`CrossAccountRole`  <a name="cfn-arcregionswitch-plan-arcroutingcontrolconfiguration-crossaccountrole"></a>
The cross account role for the configuration.  
*Required*: No  
*Type*: String  
*Pattern*: `^arn:aws[a-zA-Z0-9-]*:iam::[0-9]{12}:role/.+$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ExternalId`  <a name="cfn-arcregionswitch-plan-arcroutingcontrolconfiguration-externalid"></a>
The external ID (secret key) for the configuration.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RegionAndRoutingControls`  <a name="cfn-arcregionswitch-plan-arcroutingcontrolconfiguration-regionandroutingcontrols"></a>
The Region and ARC routing controls for the configuration.  
*Required*: Yes  
*Type*: Object of Array  
*Pattern*: `.+`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TimeoutMinutes`  <a name="cfn-arcregionswitch-plan-arcroutingcontrolconfiguration-timeoutminutes"></a>
The timeout value specified for the configuration.  
*Required*: No  
*Type*: Number  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::ARCRegionSwitch::Plan Asg
<a name="aws-properties-arcregionswitch-plan-asg"></a>

Configuration for an Amazon EC2 Auto Scaling group used in a Region switch plan.

## Syntax
<a name="aws-properties-arcregionswitch-plan-asg-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-arcregionswitch-plan-asg-syntax.json"></a>

```
{
  "[Arn](#cfn-arcregionswitch-plan-asg-arn)" : String,
  "[CrossAccountRole](#cfn-arcregionswitch-plan-asg-crossaccountrole)" : String,
  "[ExternalId](#cfn-arcregionswitch-plan-asg-externalid)" : String
}
```

### YAML
<a name="aws-properties-arcregionswitch-plan-asg-syntax.yaml"></a>

```
  [Arn](#cfn-arcregionswitch-plan-asg-arn): String
  [CrossAccountRole](#cfn-arcregionswitch-plan-asg-crossaccountrole): String
  [ExternalId](#cfn-arcregionswitch-plan-asg-externalid): String
```

## Properties
<a name="aws-properties-arcregionswitch-plan-asg-properties"></a>

`Arn`  <a name="cfn-arcregionswitch-plan-asg-arn"></a>
The Amazon Resource Name (ARN) of the EC2 Auto Scaling group.  
*Required*: No  
*Type*: String  
*Pattern*: `^arn:aws[a-zA-Z-]*:autoscaling:[a-z0-9-]+:\d{12}:autoScalingGroup:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}:autoScalingGroupName/[\S\s]{1,255}$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CrossAccountRole`  <a name="cfn-arcregionswitch-plan-asg-crossaccountrole"></a>
The cross account role for the configuration.  
*Required*: No  
*Type*: String  
*Pattern*: `^arn:aws[a-zA-Z0-9-]*:iam::[0-9]{12}:role/.+$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ExternalId`  <a name="cfn-arcregionswitch-plan-asg-externalid"></a>
The external ID (secret key) for the configuration.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::ARCRegionSwitch::Plan AssociatedAlarm
<a name="aws-properties-arcregionswitch-plan-associatedalarm"></a>

An Amazon CloudWatch alarm associated with a Region switch plan. These alarms can be used to trigger automatic execution of the plan.

## Syntax
<a name="aws-properties-arcregionswitch-plan-associatedalarm-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-arcregionswitch-plan-associatedalarm-syntax.json"></a>

```
{
  "[AlarmType](#cfn-arcregionswitch-plan-associatedalarm-alarmtype)" : String,
  "[CrossAccountRole](#cfn-arcregionswitch-plan-associatedalarm-crossaccountrole)" : String,
  "[ExternalId](#cfn-arcregionswitch-plan-associatedalarm-externalid)" : String,
  "[ResourceIdentifier](#cfn-arcregionswitch-plan-associatedalarm-resourceidentifier)" : String
}
```

### YAML
<a name="aws-properties-arcregionswitch-plan-associatedalarm-syntax.yaml"></a>

```
  [AlarmType](#cfn-arcregionswitch-plan-associatedalarm-alarmtype): String
  [CrossAccountRole](#cfn-arcregionswitch-plan-associatedalarm-crossaccountrole): String
  [ExternalId](#cfn-arcregionswitch-plan-associatedalarm-externalid): String
  [ResourceIdentifier](#cfn-arcregionswitch-plan-associatedalarm-resourceidentifier): String
```

## Properties
<a name="aws-properties-arcregionswitch-plan-associatedalarm-properties"></a>

`AlarmType`  <a name="cfn-arcregionswitch-plan-associatedalarm-alarmtype"></a>
The alarm type for an associated alarm. An associated CloudWatch alarm can be an application health alarm or a trigger alarm.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `applicationHealth | trigger`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CrossAccountRole`  <a name="cfn-arcregionswitch-plan-associatedalarm-crossaccountrole"></a>
The cross account role for the configuration.  
*Required*: No  
*Type*: String  
*Pattern*: `^arn:aws[a-zA-Z0-9-]*:iam::[0-9]{12}:role/.+$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ExternalId`  <a name="cfn-arcregionswitch-plan-associatedalarm-externalid"></a>
The external ID (secret key) for the configuration.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ResourceIdentifier`  <a name="cfn-arcregionswitch-plan-associatedalarm-resourceidentifier"></a>
The resource identifier for alarms that you associate with a plan.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::ARCRegionSwitch::Plan CustomActionLambdaConfiguration
<a name="aws-properties-arcregionswitch-plan-customactionlambdaconfiguration"></a>

Configuration for AWS Lambda functions that perform custom actions during a Region switch.

## Syntax
<a name="aws-properties-arcregionswitch-plan-customactionlambdaconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-arcregionswitch-plan-customactionlambdaconfiguration-syntax.json"></a>

```
{
  "[Lambdas](#cfn-arcregionswitch-plan-customactionlambdaconfiguration-lambdas)" : [ Lambdas, ... ],
  "[RegionToRun](#cfn-arcregionswitch-plan-customactionlambdaconfiguration-regiontorun)" : String,
  "[RetryIntervalMinutes](#cfn-arcregionswitch-plan-customactionlambdaconfiguration-retryintervalminutes)" : Number,
  "[TimeoutMinutes](#cfn-arcregionswitch-plan-customactionlambdaconfiguration-timeoutminutes)" : Number,
  "[Ungraceful](#cfn-arcregionswitch-plan-customactionlambdaconfiguration-ungraceful)" : LambdaUngraceful
}
```

### YAML
<a name="aws-properties-arcregionswitch-plan-customactionlambdaconfiguration-syntax.yaml"></a>

```
  [Lambdas](#cfn-arcregionswitch-plan-customactionlambdaconfiguration-lambdas): 
    - Lambdas
  [RegionToRun](#cfn-arcregionswitch-plan-customactionlambdaconfiguration-regiontorun): String
  [RetryIntervalMinutes](#cfn-arcregionswitch-plan-customactionlambdaconfiguration-retryintervalminutes): Number
  [TimeoutMinutes](#cfn-arcregionswitch-plan-customactionlambdaconfiguration-timeoutminutes): Number
  [Ungraceful](#cfn-arcregionswitch-plan-customactionlambdaconfiguration-ungraceful): 
    LambdaUngraceful
```

## Properties
<a name="aws-properties-arcregionswitch-plan-customactionlambdaconfiguration-properties"></a>

`Lambdas`  <a name="cfn-arcregionswitch-plan-customactionlambdaconfiguration-lambdas"></a>
The AWS Lambda functions for the execution block.  
*Required*: Yes  
*Type*: [Array](aws-properties-arcregionswitch-plan-lambdas.md) of [Lambdas](aws-properties-arcregionswitch-plan-lambdas.md)  
*Minimum*: `1`  
*Maximum*: `2`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RegionToRun`  <a name="cfn-arcregionswitch-plan-customactionlambdaconfiguration-regiontorun"></a>
The AWS Region for the function to run in. For recovery workflows use `activatingRegion` or `deactivatingRegion`. For post-recovery workflows, use `activeRegion` (the Region with customer traffic) or `inactiveRegion` (the Region with no customer traffic).  
*Required*: Yes  
*Type*: String  
*Allowed values*: `activatingRegion | deactivatingRegion | activeRegion | inactiveRegion`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RetryIntervalMinutes`  <a name="cfn-arcregionswitch-plan-customactionlambdaconfiguration-retryintervalminutes"></a>
The retry interval specified.  
*Required*: Yes  
*Type*: Number  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TimeoutMinutes`  <a name="cfn-arcregionswitch-plan-customactionlambdaconfiguration-timeoutminutes"></a>
The timeout value specified for the configuration.  
*Required*: No  
*Type*: Number  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Ungraceful`  <a name="cfn-arcregionswitch-plan-customactionlambdaconfiguration-ungraceful"></a>
The settings for ungraceful execution.  
*Required*: No  
*Type*: [LambdaUngraceful](aws-properties-arcregionswitch-plan-lambdaungraceful.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::ARCRegionSwitch::Plan DocumentDbConfiguration
<a name="aws-properties-arcregionswitch-plan-documentdbconfiguration"></a>

Configuration for Amazon DocumentDB global clusters used in a Region switch plan.

## Syntax
<a name="aws-properties-arcregionswitch-plan-documentdbconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-arcregionswitch-plan-documentdbconfiguration-syntax.json"></a>

```
{
  "[Behavior](#cfn-arcregionswitch-plan-documentdbconfiguration-behavior)" : ,
  "[CrossAccountRole](#cfn-arcregionswitch-plan-documentdbconfiguration-crossaccountrole)" : String,
  "[DatabaseClusterArns](#cfn-arcregionswitch-plan-documentdbconfiguration-databaseclusterarns)" : [ String, ... ],
  "[ExternalId](#cfn-arcregionswitch-plan-documentdbconfiguration-externalid)" : String,
  "[GlobalClusterIdentifier](#cfn-arcregionswitch-plan-documentdbconfiguration-globalclusteridentifier)" : String,
  "[TimeoutMinutes](#cfn-arcregionswitch-plan-documentdbconfiguration-timeoutminutes)" : Number,
  "[Ungraceful](#cfn-arcregionswitch-plan-documentdbconfiguration-ungraceful)" : DocumentDbUngraceful
}
```

### YAML
<a name="aws-properties-arcregionswitch-plan-documentdbconfiguration-syntax.yaml"></a>

```
  [Behavior](#cfn-arcregionswitch-plan-documentdbconfiguration-behavior): 
    
  [CrossAccountRole](#cfn-arcregionswitch-plan-documentdbconfiguration-crossaccountrole): String
  [DatabaseClusterArns](#cfn-arcregionswitch-plan-documentdbconfiguration-databaseclusterarns): 
    - String
  [ExternalId](#cfn-arcregionswitch-plan-documentdbconfiguration-externalid): String
  [GlobalClusterIdentifier](#cfn-arcregionswitch-plan-documentdbconfiguration-globalclusteridentifier): String
  [TimeoutMinutes](#cfn-arcregionswitch-plan-documentdbconfiguration-timeoutminutes): Number
  [Ungraceful](#cfn-arcregionswitch-plan-documentdbconfiguration-ungraceful): 
    DocumentDbUngraceful
```

## Properties
<a name="aws-properties-arcregionswitch-plan-documentdbconfiguration-properties"></a>

`Behavior`  <a name="cfn-arcregionswitch-plan-documentdbconfiguration-behavior"></a>
The behavior for a global cluster, that is, only allow switchover or also allow failover.  
*Required*: Yes  
*Type*:   
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CrossAccountRole`  <a name="cfn-arcregionswitch-plan-documentdbconfiguration-crossaccountrole"></a>
The cross account role for the configuration.  
*Required*: No  
*Type*: String  
*Pattern*: `^arn:aws[a-zA-Z0-9-]*:iam::[0-9]{12}:role/.+$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DatabaseClusterArns`  <a name="cfn-arcregionswitch-plan-documentdbconfiguration-databaseclusterarns"></a>
The database cluster Amazon Resource Names (ARNs) for a DocumentDB global cluster.  
*Required*: Yes  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ExternalId`  <a name="cfn-arcregionswitch-plan-documentdbconfiguration-externalid"></a>
The external ID (secret key) for the configuration.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`GlobalClusterIdentifier`  <a name="cfn-arcregionswitch-plan-documentdbconfiguration-globalclusteridentifier"></a>
The global cluster identifier for a DocumentDB global cluster.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[A-Za-z][0-9A-Za-z-:._]*$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TimeoutMinutes`  <a name="cfn-arcregionswitch-plan-documentdbconfiguration-timeoutminutes"></a>
The timeout value specified for the configuration.  
*Required*: No  
*Type*: Number  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Ungraceful`  <a name="cfn-arcregionswitch-plan-documentdbconfiguration-ungraceful"></a>
The settings for ungraceful execution.  
*Required*: No  
*Type*: [DocumentDbUngraceful](aws-properties-arcregionswitch-plan-documentdbungraceful.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::ARCRegionSwitch::Plan DocumentDbUngraceful
<a name="aws-properties-arcregionswitch-plan-documentdbungraceful"></a>

Configuration for handling failures when performing operations on DocumentDB global clusters.

## Syntax
<a name="aws-properties-arcregionswitch-plan-documentdbungraceful-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-arcregionswitch-plan-documentdbungraceful-syntax.json"></a>

```
{
  "[Ungraceful](#cfn-arcregionswitch-plan-documentdbungraceful-ungraceful)" : String
}
```

### YAML
<a name="aws-properties-arcregionswitch-plan-documentdbungraceful-syntax.yaml"></a>

```
  [Ungraceful](#cfn-arcregionswitch-plan-documentdbungraceful-ungraceful): String
```

## Properties
<a name="aws-properties-arcregionswitch-plan-documentdbungraceful-properties"></a>

`Ungraceful`  <a name="cfn-arcregionswitch-plan-documentdbungraceful-ungraceful"></a>
The settings for ungraceful execution.  
*Required*: No  
*Type*: String  
*Allowed values*: `failover`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::ARCRegionSwitch::Plan Ec2AsgCapacityIncreaseConfiguration
<a name="aws-properties-arcregionswitch-plan-ec2asgcapacityincreaseconfiguration"></a>

Configuration for increasing the capacity of Amazon EC2 Auto Scaling groups during a Region switch.

## Syntax
<a name="aws-properties-arcregionswitch-plan-ec2asgcapacityincreaseconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-arcregionswitch-plan-ec2asgcapacityincreaseconfiguration-syntax.json"></a>

```
{
  "[Asgs](#cfn-arcregionswitch-plan-ec2asgcapacityincreaseconfiguration-asgs)" : [ Asg, ... ],
  "[CapacityMonitoringApproach](#cfn-arcregionswitch-plan-ec2asgcapacityincreaseconfiguration-capacitymonitoringapproach)" : ,
  "[TargetPercent](#cfn-arcregionswitch-plan-ec2asgcapacityincreaseconfiguration-targetpercent)" : Number,
  "[TimeoutMinutes](#cfn-arcregionswitch-plan-ec2asgcapacityincreaseconfiguration-timeoutminutes)" : Number,
  "[Ungraceful](#cfn-arcregionswitch-plan-ec2asgcapacityincreaseconfiguration-ungraceful)" : Ec2Ungraceful
}
```

### YAML
<a name="aws-properties-arcregionswitch-plan-ec2asgcapacityincreaseconfiguration-syntax.yaml"></a>

```
  [Asgs](#cfn-arcregionswitch-plan-ec2asgcapacityincreaseconfiguration-asgs): 
    - Asg
  [CapacityMonitoringApproach](#cfn-arcregionswitch-plan-ec2asgcapacityincreaseconfiguration-capacitymonitoringapproach): 
    
  [TargetPercent](#cfn-arcregionswitch-plan-ec2asgcapacityincreaseconfiguration-targetpercent): Number
  [TimeoutMinutes](#cfn-arcregionswitch-plan-ec2asgcapacityincreaseconfiguration-timeoutminutes): Number
  [Ungraceful](#cfn-arcregionswitch-plan-ec2asgcapacityincreaseconfiguration-ungraceful): 
    Ec2Ungraceful
```

## Properties
<a name="aws-properties-arcregionswitch-plan-ec2asgcapacityincreaseconfiguration-properties"></a>

`Asgs`  <a name="cfn-arcregionswitch-plan-ec2asgcapacityincreaseconfiguration-asgs"></a>
The EC2 Auto Scaling groups for the configuration.  
*Required*: Yes  
*Type*: Array of [Asg](aws-properties-arcregionswitch-plan-asg.md)  
*Minimum*: `2`  
*Maximum*: `2`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CapacityMonitoringApproach`  <a name="cfn-arcregionswitch-plan-ec2asgcapacityincreaseconfiguration-capacitymonitoringapproach"></a>
The monitoring approach that you specify EC2 Auto Scaling groups for the configuration.  
*Required*: No  
*Type*:   
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TargetPercent`  <a name="cfn-arcregionswitch-plan-ec2asgcapacityincreaseconfiguration-targetpercent"></a>
The target percentage that you specify for EC2 Auto Scaling groups. The default is 100.  
*Required*: No  
*Type*: Number  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TimeoutMinutes`  <a name="cfn-arcregionswitch-plan-ec2asgcapacityincreaseconfiguration-timeoutminutes"></a>
The timeout value specified for the configuration.  
*Required*: No  
*Type*: Number  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Ungraceful`  <a name="cfn-arcregionswitch-plan-ec2asgcapacityincreaseconfiguration-ungraceful"></a>
The settings for ungraceful execution.  
*Required*: No  
*Type*: [Ec2Ungraceful](aws-properties-arcregionswitch-plan-ec2ungraceful.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::ARCRegionSwitch::Plan Ec2Ungraceful
<a name="aws-properties-arcregionswitch-plan-ec2ungraceful"></a>

Configuration for handling failures when performing operations on EC2 resources.

## Syntax
<a name="aws-properties-arcregionswitch-plan-ec2ungraceful-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-arcregionswitch-plan-ec2ungraceful-syntax.json"></a>

```
{
  "[MinimumSuccessPercentage](#cfn-arcregionswitch-plan-ec2ungraceful-minimumsuccesspercentage)" : Number
}
```

### YAML
<a name="aws-properties-arcregionswitch-plan-ec2ungraceful-syntax.yaml"></a>

```
  [MinimumSuccessPercentage](#cfn-arcregionswitch-plan-ec2ungraceful-minimumsuccesspercentage): Number
```

## Properties
<a name="aws-properties-arcregionswitch-plan-ec2ungraceful-properties"></a>

`MinimumSuccessPercentage`  <a name="cfn-arcregionswitch-plan-ec2ungraceful-minimumsuccesspercentage"></a>
The minimum success percentage that you specify for EC2 Auto Scaling groups.  
*Required*: Yes  
*Type*: Number  
*Minimum*: `0`  
*Maximum*: `99`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::ARCRegionSwitch::Plan EcsCapacityIncreaseConfiguration
<a name="aws-properties-arcregionswitch-plan-ecscapacityincreaseconfiguration"></a>

The configuration for an AWS ECS capacity increase.

## Syntax
<a name="aws-properties-arcregionswitch-plan-ecscapacityincreaseconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-arcregionswitch-plan-ecscapacityincreaseconfiguration-syntax.json"></a>

```
{
  "[CapacityMonitoringApproach](#cfn-arcregionswitch-plan-ecscapacityincreaseconfiguration-capacitymonitoringapproach)" : ,
  "[Services](#cfn-arcregionswitch-plan-ecscapacityincreaseconfiguration-services)" : [ Service, ... ],
  "[TargetPercent](#cfn-arcregionswitch-plan-ecscapacityincreaseconfiguration-targetpercent)" : Number,
  "[TimeoutMinutes](#cfn-arcregionswitch-plan-ecscapacityincreaseconfiguration-timeoutminutes)" : Number,
  "[Ungraceful](#cfn-arcregionswitch-plan-ecscapacityincreaseconfiguration-ungraceful)" : EcsUngraceful
}
```

### YAML
<a name="aws-properties-arcregionswitch-plan-ecscapacityincreaseconfiguration-syntax.yaml"></a>

```
  [CapacityMonitoringApproach](#cfn-arcregionswitch-plan-ecscapacityincreaseconfiguration-capacitymonitoringapproach): 
    
  [Services](#cfn-arcregionswitch-plan-ecscapacityincreaseconfiguration-services): 
    - Service
  [TargetPercent](#cfn-arcregionswitch-plan-ecscapacityincreaseconfiguration-targetpercent): Number
  [TimeoutMinutes](#cfn-arcregionswitch-plan-ecscapacityincreaseconfiguration-timeoutminutes): Number
  [Ungraceful](#cfn-arcregionswitch-plan-ecscapacityincreaseconfiguration-ungraceful): 
    EcsUngraceful
```

## Properties
<a name="aws-properties-arcregionswitch-plan-ecscapacityincreaseconfiguration-properties"></a>

`CapacityMonitoringApproach`  <a name="cfn-arcregionswitch-plan-ecscapacityincreaseconfiguration-capacitymonitoringapproach"></a>
The monitoring approach specified for the configuration, for example, `Most_Recent`.  
*Required*: No  
*Type*:   
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Services`  <a name="cfn-arcregionswitch-plan-ecscapacityincreaseconfiguration-services"></a>
The services specified for the configuration.  
*Required*: Yes  
*Type*: Array of [Service](aws-properties-arcregionswitch-plan-service.md)  
*Minimum*: `2`  
*Maximum*: `2`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TargetPercent`  <a name="cfn-arcregionswitch-plan-ecscapacityincreaseconfiguration-targetpercent"></a>
The target percentage specified for the configuration. The default is 100.  
*Required*: No  
*Type*: Number  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TimeoutMinutes`  <a name="cfn-arcregionswitch-plan-ecscapacityincreaseconfiguration-timeoutminutes"></a>
The timeout value specified for the configuration.  
*Required*: No  
*Type*: Number  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Ungraceful`  <a name="cfn-arcregionswitch-plan-ecscapacityincreaseconfiguration-ungraceful"></a>
The settings for ungraceful execution.  
*Required*: No  
*Type*: [EcsUngraceful](aws-properties-arcregionswitch-plan-ecsungraceful.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::ARCRegionSwitch::Plan EcsUngraceful
<a name="aws-properties-arcregionswitch-plan-ecsungraceful"></a>

The settings for ungraceful execution.

## Syntax
<a name="aws-properties-arcregionswitch-plan-ecsungraceful-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-arcregionswitch-plan-ecsungraceful-syntax.json"></a>

```
{
  "[MinimumSuccessPercentage](#cfn-arcregionswitch-plan-ecsungraceful-minimumsuccesspercentage)" : Number
}
```

### YAML
<a name="aws-properties-arcregionswitch-plan-ecsungraceful-syntax.yaml"></a>

```
  [MinimumSuccessPercentage](#cfn-arcregionswitch-plan-ecsungraceful-minimumsuccesspercentage): Number
```

## Properties
<a name="aws-properties-arcregionswitch-plan-ecsungraceful-properties"></a>

`MinimumSuccessPercentage`  <a name="cfn-arcregionswitch-plan-ecsungraceful-minimumsuccesspercentage"></a>
The minimum success percentage specified for the configuration.  
*Required*: Yes  
*Type*: Number  
*Minimum*: `0`  
*Maximum*: `99`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::ARCRegionSwitch::Plan EksCluster
<a name="aws-properties-arcregionswitch-plan-ekscluster"></a>

The AWS EKS cluster execution block configuration.

## Syntax
<a name="aws-properties-arcregionswitch-plan-ekscluster-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-arcregionswitch-plan-ekscluster-syntax.json"></a>

```
{
  "[ClusterArn](#cfn-arcregionswitch-plan-ekscluster-clusterarn)" : String,
  "[CrossAccountRole](#cfn-arcregionswitch-plan-ekscluster-crossaccountrole)" : String,
  "[ExternalId](#cfn-arcregionswitch-plan-ekscluster-externalid)" : String
}
```

### YAML
<a name="aws-properties-arcregionswitch-plan-ekscluster-syntax.yaml"></a>

```
  [ClusterArn](#cfn-arcregionswitch-plan-ekscluster-clusterarn): String
  [CrossAccountRole](#cfn-arcregionswitch-plan-ekscluster-crossaccountrole): String
  [ExternalId](#cfn-arcregionswitch-plan-ekscluster-externalid): String
```

## Properties
<a name="aws-properties-arcregionswitch-plan-ekscluster-properties"></a>

`ClusterArn`  <a name="cfn-arcregionswitch-plan-ekscluster-clusterarn"></a>
The Amazon Resource Name (ARN) of an AWS EKS cluster.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^arn:aws[a-zA-Z-]*:eks:[a-z0-9-]+:\d{12}:cluster/[a-zA-Z0-9][a-zA-Z0-9-_]{0,99}$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CrossAccountRole`  <a name="cfn-arcregionswitch-plan-ekscluster-crossaccountrole"></a>
The cross account role for the configuration.  
*Required*: No  
*Type*: String  
*Pattern*: `^arn:aws[a-zA-Z0-9-]*:iam::[0-9]{12}:role/.+$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ExternalId`  <a name="cfn-arcregionswitch-plan-ekscluster-externalid"></a>
The external ID (secret key) for the configuration.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::ARCRegionSwitch::Plan EksResourceScalingConfiguration
<a name="aws-properties-arcregionswitch-plan-eksresourcescalingconfiguration"></a>

The AWS EKS resource scaling configuration.

## Syntax
<a name="aws-properties-arcregionswitch-plan-eksresourcescalingconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-arcregionswitch-plan-eksresourcescalingconfiguration-syntax.json"></a>

```
{
  "[CapacityMonitoringApproach](#cfn-arcregionswitch-plan-eksresourcescalingconfiguration-capacitymonitoringapproach)" : ,
  "[EksClusters](#cfn-arcregionswitch-plan-eksresourcescalingconfiguration-eksclusters)" : [ EksCluster, ... ],
  "[KubernetesResourceType](#cfn-arcregionswitch-plan-eksresourcescalingconfiguration-kubernetesresourcetype)" : KubernetesResourceType,
  "[ScalingResources](#cfn-arcregionswitch-plan-eksresourcescalingconfiguration-scalingresources)" : [ {Key: Value, ...}, ... ],
  "[TargetPercent](#cfn-arcregionswitch-plan-eksresourcescalingconfiguration-targetpercent)" : Number,
  "[TimeoutMinutes](#cfn-arcregionswitch-plan-eksresourcescalingconfiguration-timeoutminutes)" : Number,
  "[Ungraceful](#cfn-arcregionswitch-plan-eksresourcescalingconfiguration-ungraceful)" : EksResourceScalingUngraceful
}
```

### YAML
<a name="aws-properties-arcregionswitch-plan-eksresourcescalingconfiguration-syntax.yaml"></a>

```
  [CapacityMonitoringApproach](#cfn-arcregionswitch-plan-eksresourcescalingconfiguration-capacitymonitoringapproach): 
    
  [EksClusters](#cfn-arcregionswitch-plan-eksresourcescalingconfiguration-eksclusters): 
    - EksCluster
  [KubernetesResourceType](#cfn-arcregionswitch-plan-eksresourcescalingconfiguration-kubernetesresourcetype): 
    KubernetesResourceType
  [ScalingResources](#cfn-arcregionswitch-plan-eksresourcescalingconfiguration-scalingresources): 
    - 
    Key: Value
  [TargetPercent](#cfn-arcregionswitch-plan-eksresourcescalingconfiguration-targetpercent): Number
  [TimeoutMinutes](#cfn-arcregionswitch-plan-eksresourcescalingconfiguration-timeoutminutes): Number
  [Ungraceful](#cfn-arcregionswitch-plan-eksresourcescalingconfiguration-ungraceful): 
    EksResourceScalingUngraceful
```

## Properties
<a name="aws-properties-arcregionswitch-plan-eksresourcescalingconfiguration-properties"></a>

`CapacityMonitoringApproach`  <a name="cfn-arcregionswitch-plan-eksresourcescalingconfiguration-capacitymonitoringapproach"></a>
The monitoring approach for the configuration, that is, whether it was sampled in the last 24 hours or autoscaled in the last 24 hours.  
*Required*: No  
*Type*:   
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`EksClusters`  <a name="cfn-arcregionswitch-plan-eksresourcescalingconfiguration-eksclusters"></a>
The clusters for the configuration.  
*Required*: No  
*Type*: Array of [EksCluster](aws-properties-arcregionswitch-plan-ekscluster.md)  
*Minimum*: `2`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`KubernetesResourceType`  <a name="cfn-arcregionswitch-plan-eksresourcescalingconfiguration-kubernetesresourcetype"></a>
The Kubernetes resource type for the configuration.  
*Required*: Yes  
*Type*: [KubernetesResourceType](aws-properties-arcregionswitch-plan-kubernetesresourcetype.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ScalingResources`  <a name="cfn-arcregionswitch-plan-eksresourcescalingconfiguration-scalingresources"></a>
The scaling resources for the configuration.  
*Required*: No  
*Type*: Array of Object  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TargetPercent`  <a name="cfn-arcregionswitch-plan-eksresourcescalingconfiguration-targetpercent"></a>
The target percentage for the configuration. The default is 100.  
*Required*: No  
*Type*: Number  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TimeoutMinutes`  <a name="cfn-arcregionswitch-plan-eksresourcescalingconfiguration-timeoutminutes"></a>
The timeout value specified for the configuration.  
*Required*: No  
*Type*: Number  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Ungraceful`  <a name="cfn-arcregionswitch-plan-eksresourcescalingconfiguration-ungraceful"></a>
The settings for ungraceful execution.  
*Required*: No  
*Type*: [EksResourceScalingUngraceful](aws-properties-arcregionswitch-plan-eksresourcescalingungraceful.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::ARCRegionSwitch::Plan EksResourceScalingUngraceful
<a name="aws-properties-arcregionswitch-plan-eksresourcescalingungraceful"></a>

The ungraceful settings for AWS EKS resource scaling.

## Syntax
<a name="aws-properties-arcregionswitch-plan-eksresourcescalingungraceful-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-arcregionswitch-plan-eksresourcescalingungraceful-syntax.json"></a>

```
{
  "[MinimumSuccessPercentage](#cfn-arcregionswitch-plan-eksresourcescalingungraceful-minimumsuccesspercentage)" : Number
}
```

### YAML
<a name="aws-properties-arcregionswitch-plan-eksresourcescalingungraceful-syntax.yaml"></a>

```
  [MinimumSuccessPercentage](#cfn-arcregionswitch-plan-eksresourcescalingungraceful-minimumsuccesspercentage): Number
```

## Properties
<a name="aws-properties-arcregionswitch-plan-eksresourcescalingungraceful-properties"></a>

`MinimumSuccessPercentage`  <a name="cfn-arcregionswitch-plan-eksresourcescalingungraceful-minimumsuccesspercentage"></a>
The minimum success percentage for the configuration.  
*Required*: Yes  
*Type*: Number  
*Minimum*: `0`  
*Maximum*: `99`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::ARCRegionSwitch::Plan ExecutionApprovalConfiguration
<a name="aws-properties-arcregionswitch-plan-executionapprovalconfiguration"></a>

Configuration for approval steps in a Region switch plan execution. Approval steps require manual intervention before the execution can proceed.

## Syntax
<a name="aws-properties-arcregionswitch-plan-executionapprovalconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-arcregionswitch-plan-executionapprovalconfiguration-syntax.json"></a>

```
{
  "[ApprovalRole](#cfn-arcregionswitch-plan-executionapprovalconfiguration-approvalrole)" : String,
  "[TimeoutMinutes](#cfn-arcregionswitch-plan-executionapprovalconfiguration-timeoutminutes)" : Number
}
```

### YAML
<a name="aws-properties-arcregionswitch-plan-executionapprovalconfiguration-syntax.yaml"></a>

```
  [ApprovalRole](#cfn-arcregionswitch-plan-executionapprovalconfiguration-approvalrole): String
  [TimeoutMinutes](#cfn-arcregionswitch-plan-executionapprovalconfiguration-timeoutminutes): Number
```

## Properties
<a name="aws-properties-arcregionswitch-plan-executionapprovalconfiguration-properties"></a>

`ApprovalRole`  <a name="cfn-arcregionswitch-plan-executionapprovalconfiguration-approvalrole"></a>
The IAM approval role for the configuration.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TimeoutMinutes`  <a name="cfn-arcregionswitch-plan-executionapprovalconfiguration-timeoutminutes"></a>
The timeout value specified for the configuration.  
*Required*: No  
*Type*: Number  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::ARCRegionSwitch::Plan ExecutionBlockConfiguration
<a name="aws-properties-arcregionswitch-plan-executionblockconfiguration"></a>

Execution block configurations for a workflow in a Region switch plan. An execution block represents a specific type of action to perform during a Region switch.

## Syntax
<a name="aws-properties-arcregionswitch-plan-executionblockconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-arcregionswitch-plan-executionblockconfiguration-syntax.json"></a>

```
{
  "[ArcRoutingControlConfig](#cfn-arcregionswitch-plan-executionblockconfiguration-arcroutingcontrolconfig)" : ArcRoutingControlConfiguration,
  "[CustomActionLambdaConfig](#cfn-arcregionswitch-plan-executionblockconfiguration-customactionlambdaconfig)" : CustomActionLambdaConfiguration,
  "[DocumentDbConfig](#cfn-arcregionswitch-plan-executionblockconfiguration-documentdbconfig)" : DocumentDbConfiguration,
  "[Ec2AsgCapacityIncreaseConfig](#cfn-arcregionswitch-plan-executionblockconfiguration-ec2asgcapacityincreaseconfig)" : Ec2AsgCapacityIncreaseConfiguration,
  "[EcsCapacityIncreaseConfig](#cfn-arcregionswitch-plan-executionblockconfiguration-ecscapacityincreaseconfig)" : EcsCapacityIncreaseConfiguration,
  "[EksResourceScalingConfig](#cfn-arcregionswitch-plan-executionblockconfiguration-eksresourcescalingconfig)" : EksResourceScalingConfiguration,
  "[ExecutionApprovalConfig](#cfn-arcregionswitch-plan-executionblockconfiguration-executionapprovalconfig)" : ExecutionApprovalConfiguration,
  "[GlobalAuroraConfig](#cfn-arcregionswitch-plan-executionblockconfiguration-globalauroraconfig)" : GlobalAuroraConfiguration,
  "[ParallelConfig](#cfn-arcregionswitch-plan-executionblockconfiguration-parallelconfig)" : ParallelExecutionBlockConfiguration,
  "[RdsCreateCrossRegionReadReplicaConfig](#cfn-arcregionswitch-plan-executionblockconfiguration-rdscreatecrossregionreadreplicaconfig)" : RdsCreateCrossRegionReplicaConfiguration,
  "[RdsPromoteReadReplicaConfig](#cfn-arcregionswitch-plan-executionblockconfiguration-rdspromotereadreplicaconfig)" : RdsPromoteReadReplicaConfiguration,
  "[RegionSwitchPlanConfig](#cfn-arcregionswitch-plan-executionblockconfiguration-regionswitchplanconfig)" : RegionSwitchPlanConfiguration,
  "[Route53HealthCheckConfig](#cfn-arcregionswitch-plan-executionblockconfiguration-route53healthcheckconfig)" : Route53HealthCheckConfiguration
}
```

### YAML
<a name="aws-properties-arcregionswitch-plan-executionblockconfiguration-syntax.yaml"></a>

```
  [ArcRoutingControlConfig](#cfn-arcregionswitch-plan-executionblockconfiguration-arcroutingcontrolconfig): 
    ArcRoutingControlConfiguration
  [CustomActionLambdaConfig](#cfn-arcregionswitch-plan-executionblockconfiguration-customactionlambdaconfig): 
    CustomActionLambdaConfiguration
  [DocumentDbConfig](#cfn-arcregionswitch-plan-executionblockconfiguration-documentdbconfig): 
    DocumentDbConfiguration
  [Ec2AsgCapacityIncreaseConfig](#cfn-arcregionswitch-plan-executionblockconfiguration-ec2asgcapacityincreaseconfig): 
    Ec2AsgCapacityIncreaseConfiguration
  [EcsCapacityIncreaseConfig](#cfn-arcregionswitch-plan-executionblockconfiguration-ecscapacityincreaseconfig): 
    EcsCapacityIncreaseConfiguration
  [EksResourceScalingConfig](#cfn-arcregionswitch-plan-executionblockconfiguration-eksresourcescalingconfig): 
    EksResourceScalingConfiguration
  [ExecutionApprovalConfig](#cfn-arcregionswitch-plan-executionblockconfiguration-executionapprovalconfig): 
    ExecutionApprovalConfiguration
  [GlobalAuroraConfig](#cfn-arcregionswitch-plan-executionblockconfiguration-globalauroraconfig): 
    GlobalAuroraConfiguration
  [ParallelConfig](#cfn-arcregionswitch-plan-executionblockconfiguration-parallelconfig): 
    ParallelExecutionBlockConfiguration
  [RdsCreateCrossRegionReadReplicaConfig](#cfn-arcregionswitch-plan-executionblockconfiguration-rdscreatecrossregionreadreplicaconfig): 
    RdsCreateCrossRegionReplicaConfiguration
  [RdsPromoteReadReplicaConfig](#cfn-arcregionswitch-plan-executionblockconfiguration-rdspromotereadreplicaconfig): 
    RdsPromoteReadReplicaConfiguration
  [RegionSwitchPlanConfig](#cfn-arcregionswitch-plan-executionblockconfiguration-regionswitchplanconfig): 
    RegionSwitchPlanConfiguration
  [Route53HealthCheckConfig](#cfn-arcregionswitch-plan-executionblockconfiguration-route53healthcheckconfig): 
    Route53HealthCheckConfiguration
```

## Properties
<a name="aws-properties-arcregionswitch-plan-executionblockconfiguration-properties"></a>

`ArcRoutingControlConfig`  <a name="cfn-arcregionswitch-plan-executionblockconfiguration-arcroutingcontrolconfig"></a>
An ARC routing control execution block.  
*Required*: No  
*Type*: [ArcRoutingControlConfiguration](aws-properties-arcregionswitch-plan-arcroutingcontrolconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CustomActionLambdaConfig`  <a name="cfn-arcregionswitch-plan-executionblockconfiguration-customactionlambdaconfig"></a>
An AWS Lambda execution block.  
*Required*: No  
*Type*: [CustomActionLambdaConfiguration](aws-properties-arcregionswitch-plan-customactionlambdaconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DocumentDbConfig`  <a name="cfn-arcregionswitch-plan-executionblockconfiguration-documentdbconfig"></a>
Property description not available.  
*Required*: No  
*Type*: [DocumentDbConfiguration](aws-properties-arcregionswitch-plan-documentdbconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Ec2AsgCapacityIncreaseConfig`  <a name="cfn-arcregionswitch-plan-executionblockconfiguration-ec2asgcapacityincreaseconfig"></a>
An EC2 Auto Scaling group execution block.  
*Required*: No  
*Type*: [Ec2AsgCapacityIncreaseConfiguration](aws-properties-arcregionswitch-plan-ec2asgcapacityincreaseconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`EcsCapacityIncreaseConfig`  <a name="cfn-arcregionswitch-plan-executionblockconfiguration-ecscapacityincreaseconfig"></a>
The capacity increase specified for the configuration.  
*Required*: No  
*Type*: [EcsCapacityIncreaseConfiguration](aws-properties-arcregionswitch-plan-ecscapacityincreaseconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`EksResourceScalingConfig`  <a name="cfn-arcregionswitch-plan-executionblockconfiguration-eksresourcescalingconfig"></a>
An AWS EKS resource scaling execution block.  
*Required*: No  
*Type*: [EksResourceScalingConfiguration](aws-properties-arcregionswitch-plan-eksresourcescalingconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ExecutionApprovalConfig`  <a name="cfn-arcregionswitch-plan-executionblockconfiguration-executionapprovalconfig"></a>
A manual approval execution block.  
*Required*: No  
*Type*: [ExecutionApprovalConfiguration](aws-properties-arcregionswitch-plan-executionapprovalconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`GlobalAuroraConfig`  <a name="cfn-arcregionswitch-plan-executionblockconfiguration-globalauroraconfig"></a>
An Aurora Global Database execution block.  
*Required*: No  
*Type*: [GlobalAuroraConfiguration](aws-properties-arcregionswitch-plan-globalauroraconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ParallelConfig`  <a name="cfn-arcregionswitch-plan-executionblockconfiguration-parallelconfig"></a>
A parallel configuration execution block.  
*Required*: No  
*Type*: [ParallelExecutionBlockConfiguration](aws-properties-arcregionswitch-plan-parallelexecutionblockconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RdsCreateCrossRegionReadReplicaConfig`  <a name="cfn-arcregionswitch-plan-executionblockconfiguration-rdscreatecrossregionreadreplicaconfig"></a>
An Amazon RDS create cross-Region replica execution block.  
*Required*: No  
*Type*: [RdsCreateCrossRegionReplicaConfiguration](aws-properties-arcregionswitch-plan-rdscreatecrossregionreplicaconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RdsPromoteReadReplicaConfig`  <a name="cfn-arcregionswitch-plan-executionblockconfiguration-rdspromotereadreplicaconfig"></a>
An Amazon RDS promote read replica execution block.  
*Required*: No  
*Type*: [RdsPromoteReadReplicaConfiguration](aws-properties-arcregionswitch-plan-rdspromotereadreplicaconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RegionSwitchPlanConfig`  <a name="cfn-arcregionswitch-plan-executionblockconfiguration-regionswitchplanconfig"></a>
A Region switch plan execution block.  
*Required*: No  
*Type*: [RegionSwitchPlanConfiguration](aws-properties-arcregionswitch-plan-regionswitchplanconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Route53HealthCheckConfig`  <a name="cfn-arcregionswitch-plan-executionblockconfiguration-route53healthcheckconfig"></a>
The Amazon Route 53 health check configuration.  
*Required*: No  
*Type*: [Route53HealthCheckConfiguration](aws-properties-arcregionswitch-plan-route53healthcheckconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::ARCRegionSwitch::Plan GlobalAuroraConfiguration
<a name="aws-properties-arcregionswitch-plan-globalauroraconfiguration"></a>

Configuration for Amazon Aurora global databases used in a Region switch plan.

## Syntax
<a name="aws-properties-arcregionswitch-plan-globalauroraconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-arcregionswitch-plan-globalauroraconfiguration-syntax.json"></a>

```
{
  "[Behavior](#cfn-arcregionswitch-plan-globalauroraconfiguration-behavior)" : ,
  "[CrossAccountRole](#cfn-arcregionswitch-plan-globalauroraconfiguration-crossaccountrole)" : String,
  "[DatabaseClusterArns](#cfn-arcregionswitch-plan-globalauroraconfiguration-databaseclusterarns)" : [ String, ... ],
  "[ExternalId](#cfn-arcregionswitch-plan-globalauroraconfiguration-externalid)" : String,
  "[GlobalClusterIdentifier](#cfn-arcregionswitch-plan-globalauroraconfiguration-globalclusteridentifier)" : String,
  "[TimeoutMinutes](#cfn-arcregionswitch-plan-globalauroraconfiguration-timeoutminutes)" : Number,
  "[Ungraceful](#cfn-arcregionswitch-plan-globalauroraconfiguration-ungraceful)" : GlobalAuroraUngraceful
}
```

### YAML
<a name="aws-properties-arcregionswitch-plan-globalauroraconfiguration-syntax.yaml"></a>

```
  [Behavior](#cfn-arcregionswitch-plan-globalauroraconfiguration-behavior): 
    
  [CrossAccountRole](#cfn-arcregionswitch-plan-globalauroraconfiguration-crossaccountrole): String
  [DatabaseClusterArns](#cfn-arcregionswitch-plan-globalauroraconfiguration-databaseclusterarns): 
    - String
  [ExternalId](#cfn-arcregionswitch-plan-globalauroraconfiguration-externalid): String
  [GlobalClusterIdentifier](#cfn-arcregionswitch-plan-globalauroraconfiguration-globalclusteridentifier): String
  [TimeoutMinutes](#cfn-arcregionswitch-plan-globalauroraconfiguration-timeoutminutes): Number
  [Ungraceful](#cfn-arcregionswitch-plan-globalauroraconfiguration-ungraceful): 
    GlobalAuroraUngraceful
```

## Properties
<a name="aws-properties-arcregionswitch-plan-globalauroraconfiguration-properties"></a>

`Behavior`  <a name="cfn-arcregionswitch-plan-globalauroraconfiguration-behavior"></a>
The behavior for a global database, that is, only allow switchover or also allow failover.  
*Required*: Yes  
*Type*:   
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CrossAccountRole`  <a name="cfn-arcregionswitch-plan-globalauroraconfiguration-crossaccountrole"></a>
The cross account role for the configuration.  
*Required*: No  
*Type*: String  
*Pattern*: `^arn:aws[a-zA-Z0-9-]*:iam::[0-9]{12}:role/.+$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DatabaseClusterArns`  <a name="cfn-arcregionswitch-plan-globalauroraconfiguration-databaseclusterarns"></a>
The database cluster Amazon Resource Names (ARNs) for a global database.  
*Required*: Yes  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ExternalId`  <a name="cfn-arcregionswitch-plan-globalauroraconfiguration-externalid"></a>
The external ID (secret key) for the configuration.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`GlobalClusterIdentifier`  <a name="cfn-arcregionswitch-plan-globalauroraconfiguration-globalclusteridentifier"></a>
The global cluster identifier for a global database.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TimeoutMinutes`  <a name="cfn-arcregionswitch-plan-globalauroraconfiguration-timeoutminutes"></a>
The timeout value specified for the configuration.  
*Required*: No  
*Type*: Number  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Ungraceful`  <a name="cfn-arcregionswitch-plan-globalauroraconfiguration-ungraceful"></a>
The settings for ungraceful execution.  
*Required*: No  
*Type*: [GlobalAuroraUngraceful](aws-properties-arcregionswitch-plan-globalauroraungraceful.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::ARCRegionSwitch::Plan GlobalAuroraUngraceful
<a name="aws-properties-arcregionswitch-plan-globalauroraungraceful"></a>

Configuration for handling failures when performing operations on Aurora global databases.

## Syntax
<a name="aws-properties-arcregionswitch-plan-globalauroraungraceful-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-arcregionswitch-plan-globalauroraungraceful-syntax.json"></a>

```
{
  "[Ungraceful](#cfn-arcregionswitch-plan-globalauroraungraceful-ungraceful)" : String
}
```

### YAML
<a name="aws-properties-arcregionswitch-plan-globalauroraungraceful-syntax.yaml"></a>

```
  [Ungraceful](#cfn-arcregionswitch-plan-globalauroraungraceful-ungraceful): String
```

## Properties
<a name="aws-properties-arcregionswitch-plan-globalauroraungraceful-properties"></a>

`Ungraceful`  <a name="cfn-arcregionswitch-plan-globalauroraungraceful-ungraceful"></a>
The settings for ungraceful execution.  
*Required*: No  
*Type*: String  
*Allowed values*: `failover`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::ARCRegionSwitch::Plan KubernetesResourceType
<a name="aws-properties-arcregionswitch-plan-kubernetesresourcetype"></a>

Defines the type of Kubernetes resource to scale in an Amazon EKS cluster.

## Syntax
<a name="aws-properties-arcregionswitch-plan-kubernetesresourcetype-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-arcregionswitch-plan-kubernetesresourcetype-syntax.json"></a>

```
{
  "[ApiVersion](#cfn-arcregionswitch-plan-kubernetesresourcetype-apiversion)" : String,
  "[Kind](#cfn-arcregionswitch-plan-kubernetesresourcetype-kind)" : String
}
```

### YAML
<a name="aws-properties-arcregionswitch-plan-kubernetesresourcetype-syntax.yaml"></a>

```
  [ApiVersion](#cfn-arcregionswitch-plan-kubernetesresourcetype-apiversion): String
  [Kind](#cfn-arcregionswitch-plan-kubernetesresourcetype-kind): String
```

## Properties
<a name="aws-properties-arcregionswitch-plan-kubernetesresourcetype-properties"></a>

`ApiVersion`  <a name="cfn-arcregionswitch-plan-kubernetesresourcetype-apiversion"></a>
The API version type for the Kubernetes resource.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Kind`  <a name="cfn-arcregionswitch-plan-kubernetesresourcetype-kind"></a>
The kind for the Kubernetes resource.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::ARCRegionSwitch::Plan KubernetesScalingResource
<a name="aws-properties-arcregionswitch-plan-kubernetesscalingresource"></a>

Defines a Kubernetes resource to scale in an Amazon EKS cluster.

## Syntax
<a name="aws-properties-arcregionswitch-plan-kubernetesscalingresource-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-arcregionswitch-plan-kubernetesscalingresource-syntax.json"></a>

```
{
  "[HpaName](#cfn-arcregionswitch-plan-kubernetesscalingresource-hpaname)" : String,
  "[Name](#cfn-arcregionswitch-plan-kubernetesscalingresource-name)" : String,
  "[Namespace](#cfn-arcregionswitch-plan-kubernetesscalingresource-namespace)" : String
}
```

### YAML
<a name="aws-properties-arcregionswitch-plan-kubernetesscalingresource-syntax.yaml"></a>

```
  [HpaName](#cfn-arcregionswitch-plan-kubernetesscalingresource-hpaname): String
  [Name](#cfn-arcregionswitch-plan-kubernetesscalingresource-name): String
  [Namespace](#cfn-arcregionswitch-plan-kubernetesscalingresource-namespace): String
```

## Properties
<a name="aws-properties-arcregionswitch-plan-kubernetesscalingresource-properties"></a>

`HpaName`  <a name="cfn-arcregionswitch-plan-kubernetesscalingresource-hpaname"></a>
The hpaname for the Kubernetes resource.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-arcregionswitch-plan-kubernetesscalingresource-name"></a>
The name for the Kubernetes resource.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Namespace`  <a name="cfn-arcregionswitch-plan-kubernetesscalingresource-namespace"></a>
The namespace for the Kubernetes resource.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[a-z0-9][a-z0-9-]{0,61}[a-z0-9]$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::ARCRegionSwitch::Plan Lambdas
<a name="aws-properties-arcregionswitch-plan-lambdas"></a>

Configuration for AWS Lambda functions used in a Region switch plan.

## Syntax
<a name="aws-properties-arcregionswitch-plan-lambdas-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-arcregionswitch-plan-lambdas-syntax.json"></a>

```
{
  "[Arn](#cfn-arcregionswitch-plan-lambdas-arn)" : String,
  "[CrossAccountRole](#cfn-arcregionswitch-plan-lambdas-crossaccountrole)" : String,
  "[ExternalId](#cfn-arcregionswitch-plan-lambdas-externalid)" : String
}
```

### YAML
<a name="aws-properties-arcregionswitch-plan-lambdas-syntax.yaml"></a>

```
  [Arn](#cfn-arcregionswitch-plan-lambdas-arn): String
  [CrossAccountRole](#cfn-arcregionswitch-plan-lambdas-crossaccountrole): String
  [ExternalId](#cfn-arcregionswitch-plan-lambdas-externalid): String
```

## Properties
<a name="aws-properties-arcregionswitch-plan-lambdas-properties"></a>

`Arn`  <a name="cfn-arcregionswitch-plan-lambdas-arn"></a>
The Amazon Resource Name (ARN) of the Lambda function.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CrossAccountRole`  <a name="cfn-arcregionswitch-plan-lambdas-crossaccountrole"></a>
The cross account role for the configuration.  
*Required*: No  
*Type*: String  
*Pattern*: `^arn:aws[a-zA-Z0-9-]*:iam::[0-9]{12}:role/.+$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ExternalId`  <a name="cfn-arcregionswitch-plan-lambdas-externalid"></a>
The external ID (secret key) for the configuration.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::ARCRegionSwitch::Plan LambdaUngraceful
<a name="aws-properties-arcregionswitch-plan-lambdaungraceful"></a>

Configuration for handling failures when invoking Lambda functions.

## Syntax
<a name="aws-properties-arcregionswitch-plan-lambdaungraceful-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-arcregionswitch-plan-lambdaungraceful-syntax.json"></a>

```
{
  "[Behavior](#cfn-arcregionswitch-plan-lambdaungraceful-behavior)" : 
}
```

### YAML
<a name="aws-properties-arcregionswitch-plan-lambdaungraceful-syntax.yaml"></a>

```
  [Behavior](#cfn-arcregionswitch-plan-lambdaungraceful-behavior): 
```

## Properties
<a name="aws-properties-arcregionswitch-plan-lambdaungraceful-properties"></a>

`Behavior`  <a name="cfn-arcregionswitch-plan-lambdaungraceful-behavior"></a>
The ungraceful behavior for a Lambda function, which must be set to `skip`.  
*Required*: No  
*Type*:   
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::ARCRegionSwitch::Plan ParallelExecutionBlockConfiguration
<a name="aws-properties-arcregionswitch-plan-parallelexecutionblockconfiguration"></a>

Configuration for steps that should be executed in parallel during a Region switch.

## Syntax
<a name="aws-properties-arcregionswitch-plan-parallelexecutionblockconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-arcregionswitch-plan-parallelexecutionblockconfiguration-syntax.json"></a>

```
{
  "[Steps](#cfn-arcregionswitch-plan-parallelexecutionblockconfiguration-steps)" : [ Step, ... ]
}
```

### YAML
<a name="aws-properties-arcregionswitch-plan-parallelexecutionblockconfiguration-syntax.yaml"></a>

```
  [Steps](#cfn-arcregionswitch-plan-parallelexecutionblockconfiguration-steps): 
    - Step
```

## Properties
<a name="aws-properties-arcregionswitch-plan-parallelexecutionblockconfiguration-properties"></a>

`Steps`  <a name="cfn-arcregionswitch-plan-parallelexecutionblockconfiguration-steps"></a>
The steps for a parallel execution block.  
*Required*: Yes  
*Type*: Array of [Step](aws-properties-arcregionswitch-plan-step.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::ARCRegionSwitch::Plan RdsCreateCrossRegionReplicaConfiguration
<a name="aws-properties-arcregionswitch-plan-rdscreatecrossregionreplicaconfiguration"></a>

Configuration for creating an Amazon RDS cross-Region read replica during post-recovery in a Region switch.

## Syntax
<a name="aws-properties-arcregionswitch-plan-rdscreatecrossregionreplicaconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-arcregionswitch-plan-rdscreatecrossregionreplicaconfiguration-syntax.json"></a>

```
{
  "[CrossAccountRole](#cfn-arcregionswitch-plan-rdscreatecrossregionreplicaconfiguration-crossaccountrole)" : String,
  "[DbInstanceArnMap](#cfn-arcregionswitch-plan-rdscreatecrossregionreplicaconfiguration-dbinstancearnmap)" : {Key: Value, ...},
  "[ExternalId](#cfn-arcregionswitch-plan-rdscreatecrossregionreplicaconfiguration-externalid)" : String,
  "[TimeoutMinutes](#cfn-arcregionswitch-plan-rdscreatecrossregionreplicaconfiguration-timeoutminutes)" : Number
}
```

### YAML
<a name="aws-properties-arcregionswitch-plan-rdscreatecrossregionreplicaconfiguration-syntax.yaml"></a>

```
  [CrossAccountRole](#cfn-arcregionswitch-plan-rdscreatecrossregionreplicaconfiguration-crossaccountrole): String
  [DbInstanceArnMap](#cfn-arcregionswitch-plan-rdscreatecrossregionreplicaconfiguration-dbinstancearnmap): 
    Key: Value
  [ExternalId](#cfn-arcregionswitch-plan-rdscreatecrossregionreplicaconfiguration-externalid): String
  [TimeoutMinutes](#cfn-arcregionswitch-plan-rdscreatecrossregionreplicaconfiguration-timeoutminutes): Number
```

## Properties
<a name="aws-properties-arcregionswitch-plan-rdscreatecrossregionreplicaconfiguration-properties"></a>

`CrossAccountRole`  <a name="cfn-arcregionswitch-plan-rdscreatecrossregionreplicaconfiguration-crossaccountrole"></a>
The cross-account role for the configuration.  
*Required*: No  
*Type*: String  
*Pattern*: `^arn:aws[a-zA-Z0-9-]*:iam::[0-9]{12}:role/.+$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DbInstanceArnMap`  <a name="cfn-arcregionswitch-plan-rdscreatecrossregionreplicaconfiguration-dbinstancearnmap"></a>
A map of database instance ARNs for each Region in the plan.  
*Required*: Yes  
*Type*: Object of String  
*Pattern*: `^[a-z]{2}-[a-z-]+-\d+$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ExternalId`  <a name="cfn-arcregionswitch-plan-rdscreatecrossregionreplicaconfiguration-externalid"></a>
The external ID (secret key) for the configuration.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TimeoutMinutes`  <a name="cfn-arcregionswitch-plan-rdscreatecrossregionreplicaconfiguration-timeoutminutes"></a>
The timeout value specified for the configuration.  
*Required*: No  
*Type*: Number  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::ARCRegionSwitch::Plan RdsPromoteReadReplicaConfiguration
<a name="aws-properties-arcregionswitch-plan-rdspromotereadreplicaconfiguration"></a>

Configuration for promoting an Amazon RDS read replica to a standalone database instance during a Region switch.

## Syntax
<a name="aws-properties-arcregionswitch-plan-rdspromotereadreplicaconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-arcregionswitch-plan-rdspromotereadreplicaconfiguration-syntax.json"></a>

```
{
  "[CrossAccountRole](#cfn-arcregionswitch-plan-rdspromotereadreplicaconfiguration-crossaccountrole)" : String,
  "[DbInstanceArnMap](#cfn-arcregionswitch-plan-rdspromotereadreplicaconfiguration-dbinstancearnmap)" : {Key: Value, ...},
  "[ExternalId](#cfn-arcregionswitch-plan-rdspromotereadreplicaconfiguration-externalid)" : String,
  "[TimeoutMinutes](#cfn-arcregionswitch-plan-rdspromotereadreplicaconfiguration-timeoutminutes)" : Number
}
```

### YAML
<a name="aws-properties-arcregionswitch-plan-rdspromotereadreplicaconfiguration-syntax.yaml"></a>

```
  [CrossAccountRole](#cfn-arcregionswitch-plan-rdspromotereadreplicaconfiguration-crossaccountrole): String
  [DbInstanceArnMap](#cfn-arcregionswitch-plan-rdspromotereadreplicaconfiguration-dbinstancearnmap): 
    Key: Value
  [ExternalId](#cfn-arcregionswitch-plan-rdspromotereadreplicaconfiguration-externalid): String
  [TimeoutMinutes](#cfn-arcregionswitch-plan-rdspromotereadreplicaconfiguration-timeoutminutes): Number
```

## Properties
<a name="aws-properties-arcregionswitch-plan-rdspromotereadreplicaconfiguration-properties"></a>

`CrossAccountRole`  <a name="cfn-arcregionswitch-plan-rdspromotereadreplicaconfiguration-crossaccountrole"></a>
The cross-account role for the configuration.  
*Required*: No  
*Type*: String  
*Pattern*: `^arn:aws[a-zA-Z0-9-]*:iam::[0-9]{12}:role/.+$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DbInstanceArnMap`  <a name="cfn-arcregionswitch-plan-rdspromotereadreplicaconfiguration-dbinstancearnmap"></a>
A map of database instance ARNs for each Region in the plan.  
*Required*: Yes  
*Type*: Object of String  
*Pattern*: `^[a-z]{2}-[a-z-]+-\d+$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ExternalId`  <a name="cfn-arcregionswitch-plan-rdspromotereadreplicaconfiguration-externalid"></a>
The external ID (secret key) for the configuration.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TimeoutMinutes`  <a name="cfn-arcregionswitch-plan-rdspromotereadreplicaconfiguration-timeoutminutes"></a>
The timeout value specified for the configuration.  
*Required*: No  
*Type*: Number  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::ARCRegionSwitch::Plan RegionSwitchPlanConfiguration
<a name="aws-properties-arcregionswitch-plan-regionswitchplanconfiguration"></a>

Configuration for nested Region switch plans. This allows one Region switch plan to trigger another plan as part of its execution.

## Syntax
<a name="aws-properties-arcregionswitch-plan-regionswitchplanconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-arcregionswitch-plan-regionswitchplanconfiguration-syntax.json"></a>

```
{
  "[Arn](#cfn-arcregionswitch-plan-regionswitchplanconfiguration-arn)" : String,
  "[CrossAccountRole](#cfn-arcregionswitch-plan-regionswitchplanconfiguration-crossaccountrole)" : String,
  "[ExternalId](#cfn-arcregionswitch-plan-regionswitchplanconfiguration-externalid)" : String
}
```

### YAML
<a name="aws-properties-arcregionswitch-plan-regionswitchplanconfiguration-syntax.yaml"></a>

```
  [Arn](#cfn-arcregionswitch-plan-regionswitchplanconfiguration-arn): String
  [CrossAccountRole](#cfn-arcregionswitch-plan-regionswitchplanconfiguration-crossaccountrole): String
  [ExternalId](#cfn-arcregionswitch-plan-regionswitchplanconfiguration-externalid): String
```

## Properties
<a name="aws-properties-arcregionswitch-plan-regionswitchplanconfiguration-properties"></a>

`Arn`  <a name="cfn-arcregionswitch-plan-regionswitchplanconfiguration-arn"></a>
The Amazon Resource Name (ARN) of the plan configuration.  
*Required*: Yes  
*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})$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CrossAccountRole`  <a name="cfn-arcregionswitch-plan-regionswitchplanconfiguration-crossaccountrole"></a>
The cross account role for the configuration.  
*Required*: No  
*Type*: String  
*Pattern*: `^arn:aws[a-zA-Z0-9-]*:iam::[0-9]{12}:role/.+$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ExternalId`  <a name="cfn-arcregionswitch-plan-regionswitchplanconfiguration-externalid"></a>
The external ID (secret key) for the configuration.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::ARCRegionSwitch::Plan ReportConfiguration
<a name="aws-properties-arcregionswitch-plan-reportconfiguration"></a>

Configuration for automatic report generation for plan executions. When configured, Region switch automatically generates a report after each plan execution that includes execution events, plan configuration, and CloudWatch alarm states.

## Syntax
<a name="aws-properties-arcregionswitch-plan-reportconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-arcregionswitch-plan-reportconfiguration-syntax.json"></a>

```
{
  "[ReportOutput](#cfn-arcregionswitch-plan-reportconfiguration-reportoutput)" : [ ReportOutputConfiguration, ... ]
}
```

### YAML
<a name="aws-properties-arcregionswitch-plan-reportconfiguration-syntax.yaml"></a>

```
  [ReportOutput](#cfn-arcregionswitch-plan-reportconfiguration-reportoutput): 
    - ReportOutputConfiguration
```

## Properties
<a name="aws-properties-arcregionswitch-plan-reportconfiguration-properties"></a>

`ReportOutput`  <a name="cfn-arcregionswitch-plan-reportconfiguration-reportoutput"></a>
The output configuration for the report.  
*Required*: No  
*Type*: Array of [ReportOutputConfiguration](aws-properties-arcregionswitch-plan-reportoutputconfiguration.md)  
*Minimum*: `1`  
*Maximum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::ARCRegionSwitch::Plan ReportOutputConfiguration
<a name="aws-properties-arcregionswitch-plan-reportoutputconfiguration"></a>

Configuration for report output destinations used in a Region switch plan.

## Syntax
<a name="aws-properties-arcregionswitch-plan-reportoutputconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-arcregionswitch-plan-reportoutputconfiguration-syntax.json"></a>

```
{
  "[S3Configuration](#cfn-arcregionswitch-plan-reportoutputconfiguration-s3configuration)" : S3ReportOutputConfiguration
}
```

### YAML
<a name="aws-properties-arcregionswitch-plan-reportoutputconfiguration-syntax.yaml"></a>

```
  [S3Configuration](#cfn-arcregionswitch-plan-reportoutputconfiguration-s3configuration): 
    S3ReportOutputConfiguration
```

## Properties
<a name="aws-properties-arcregionswitch-plan-reportoutputconfiguration-properties"></a>

`S3Configuration`  <a name="cfn-arcregionswitch-plan-reportoutputconfiguration-s3configuration"></a>
Configuration for delivering reports to an Amazon S3 bucket.  
*Required*: Yes  
*Type*: [S3ReportOutputConfiguration](aws-properties-arcregionswitch-plan-s3reportoutputconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::ARCRegionSwitch::Plan Route53HealthCheckConfiguration
<a name="aws-properties-arcregionswitch-plan-route53healthcheckconfiguration"></a>

The Amazon Route 53 health check configuration.

## Syntax
<a name="aws-properties-arcregionswitch-plan-route53healthcheckconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-arcregionswitch-plan-route53healthcheckconfiguration-syntax.json"></a>

```
{
  "[CrossAccountRole](#cfn-arcregionswitch-plan-route53healthcheckconfiguration-crossaccountrole)" : String,
  "[ExternalId](#cfn-arcregionswitch-plan-route53healthcheckconfiguration-externalid)" : String,
  "[HostedZoneId](#cfn-arcregionswitch-plan-route53healthcheckconfiguration-hostedzoneid)" : String,
  "[RecordName](#cfn-arcregionswitch-plan-route53healthcheckconfiguration-recordname)" : String,
  "[RecordSets](#cfn-arcregionswitch-plan-route53healthcheckconfiguration-recordsets)" : [ Route53ResourceRecordSet, ... ],
  "[TimeoutMinutes](#cfn-arcregionswitch-plan-route53healthcheckconfiguration-timeoutminutes)" : Number
}
```

### YAML
<a name="aws-properties-arcregionswitch-plan-route53healthcheckconfiguration-syntax.yaml"></a>

```
  [CrossAccountRole](#cfn-arcregionswitch-plan-route53healthcheckconfiguration-crossaccountrole): String
  [ExternalId](#cfn-arcregionswitch-plan-route53healthcheckconfiguration-externalid): String
  [HostedZoneId](#cfn-arcregionswitch-plan-route53healthcheckconfiguration-hostedzoneid): String
  [RecordName](#cfn-arcregionswitch-plan-route53healthcheckconfiguration-recordname): String
  [RecordSets](#cfn-arcregionswitch-plan-route53healthcheckconfiguration-recordsets): 
    - Route53ResourceRecordSet
  [TimeoutMinutes](#cfn-arcregionswitch-plan-route53healthcheckconfiguration-timeoutminutes): Number
```

## Properties
<a name="aws-properties-arcregionswitch-plan-route53healthcheckconfiguration-properties"></a>

`CrossAccountRole`  <a name="cfn-arcregionswitch-plan-route53healthcheckconfiguration-crossaccountrole"></a>
The cross account role for the configuration.  
*Required*: No  
*Type*: String  
*Pattern*: `^arn:aws[a-zA-Z0-9-]*:iam::[0-9]{12}:role/.+$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ExternalId`  <a name="cfn-arcregionswitch-plan-route53healthcheckconfiguration-externalid"></a>
The external ID (secret key) for the configuration.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`HostedZoneId`  <a name="cfn-arcregionswitch-plan-route53healthcheckconfiguration-hostedzoneid"></a>
The Amazon Route 53 health check configuration hosted zone ID.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `32`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RecordName`  <a name="cfn-arcregionswitch-plan-route53healthcheckconfiguration-recordname"></a>
The Amazon Route 53 health check configuration record name.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `1024`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RecordSets`  <a name="cfn-arcregionswitch-plan-route53healthcheckconfiguration-recordsets"></a>
The Amazon Route 53 health check configuration record sets.  
*Required*: No  
*Type*: Array of [Route53ResourceRecordSet](aws-properties-arcregionswitch-plan-route53resourcerecordset.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TimeoutMinutes`  <a name="cfn-arcregionswitch-plan-route53healthcheckconfiguration-timeoutminutes"></a>
The Amazon Route 53 health check configuration time out (in minutes).  
*Required*: No  
*Type*: Number  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::ARCRegionSwitch::Plan Route53ResourceRecordSet
<a name="aws-properties-arcregionswitch-plan-route53resourcerecordset"></a>

The Amazon Route 53 record set.

## Syntax
<a name="aws-properties-arcregionswitch-plan-route53resourcerecordset-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-arcregionswitch-plan-route53resourcerecordset-syntax.json"></a>

```
{
  "[RecordSetIdentifier](#cfn-arcregionswitch-plan-route53resourcerecordset-recordsetidentifier)" : String,
  "[Region](#cfn-arcregionswitch-plan-route53resourcerecordset-region)" : String
}
```

### YAML
<a name="aws-properties-arcregionswitch-plan-route53resourcerecordset-syntax.yaml"></a>

```
  [RecordSetIdentifier](#cfn-arcregionswitch-plan-route53resourcerecordset-recordsetidentifier): String
  [Region](#cfn-arcregionswitch-plan-route53resourcerecordset-region): String
```

## Properties
<a name="aws-properties-arcregionswitch-plan-route53resourcerecordset-properties"></a>

`RecordSetIdentifier`  <a name="cfn-arcregionswitch-plan-route53resourcerecordset-recordsetidentifier"></a>
The Amazon Route 53 record set identifier.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `1024`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Region`  <a name="cfn-arcregionswitch-plan-route53resourcerecordset-region"></a>
The Amazon Route 53 record set Region.  
*Required*: No  
*Type*: String  
*Pattern*: `^[a-z]{2}-[a-z-]+-\d+$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::ARCRegionSwitch::Plan S3ReportOutputConfiguration
<a name="aws-properties-arcregionswitch-plan-s3reportoutputconfiguration"></a>

Configuration for delivering generated reports to an Amazon S3 bucket.

## Syntax
<a name="aws-properties-arcregionswitch-plan-s3reportoutputconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-arcregionswitch-plan-s3reportoutputconfiguration-syntax.json"></a>

```
{
  "[BucketOwner](#cfn-arcregionswitch-plan-s3reportoutputconfiguration-bucketowner)" : String,
  "[BucketPath](#cfn-arcregionswitch-plan-s3reportoutputconfiguration-bucketpath)" : String
}
```

### YAML
<a name="aws-properties-arcregionswitch-plan-s3reportoutputconfiguration-syntax.yaml"></a>

```
  [BucketOwner](#cfn-arcregionswitch-plan-s3reportoutputconfiguration-bucketowner): String
  [BucketPath](#cfn-arcregionswitch-plan-s3reportoutputconfiguration-bucketpath): String
```

## Properties
<a name="aws-properties-arcregionswitch-plan-s3reportoutputconfiguration-properties"></a>

`BucketOwner`  <a name="cfn-arcregionswitch-plan-s3reportoutputconfiguration-bucketowner"></a>
The AWS account ID that owns the S3 bucket. Required to ensure the bucket is still owned by the same expected owner at generation time.  
*Required*: No  
*Type*: String  
*Pattern*: `^\d{12}$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`BucketPath`  <a name="cfn-arcregionswitch-plan-s3reportoutputconfiguration-bucketpath"></a>
The S3 bucket name and optional prefix where reports are stored. Format: bucket-name or bucket-name/prefix.  
*Required*: No  
*Type*: String  
*Pattern*: `^(?:s3://)?[a-z0-9][a-z0-9-]{1,61}[a-z0-9](?:/[^/ ][^/]*)*/?$`  
*Minimum*: `3`  
*Maximum*: `512`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::ARCRegionSwitch::Plan Service
<a name="aws-properties-arcregionswitch-plan-service"></a>

The service for a cross account role.

## Syntax
<a name="aws-properties-arcregionswitch-plan-service-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-arcregionswitch-plan-service-syntax.json"></a>

```
{
  "[ClusterArn](#cfn-arcregionswitch-plan-service-clusterarn)" : String,
  "[CrossAccountRole](#cfn-arcregionswitch-plan-service-crossaccountrole)" : String,
  "[ExternalId](#cfn-arcregionswitch-plan-service-externalid)" : String,
  "[ServiceArn](#cfn-arcregionswitch-plan-service-servicearn)" : String
}
```

### YAML
<a name="aws-properties-arcregionswitch-plan-service-syntax.yaml"></a>

```
  [ClusterArn](#cfn-arcregionswitch-plan-service-clusterarn): String
  [CrossAccountRole](#cfn-arcregionswitch-plan-service-crossaccountrole): String
  [ExternalId](#cfn-arcregionswitch-plan-service-externalid): String
  [ServiceArn](#cfn-arcregionswitch-plan-service-servicearn): String
```

## Properties
<a name="aws-properties-arcregionswitch-plan-service-properties"></a>

`ClusterArn`  <a name="cfn-arcregionswitch-plan-service-clusterarn"></a>
The cluster Amazon Resource Name (ARN) for a service.  
*Required*: No  
*Type*: String  
*Pattern*: `^arn:aws[a-zA-Z-]*:ecs:[a-z0-9-]+:\d{12}:cluster/[a-zA-Z0-9_-]{1,255}$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CrossAccountRole`  <a name="cfn-arcregionswitch-plan-service-crossaccountrole"></a>
The cross account role for a service.  
*Required*: No  
*Type*: String  
*Pattern*: `^arn:aws[a-zA-Z0-9-]*:iam::[0-9]{12}:role/.+$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ExternalId`  <a name="cfn-arcregionswitch-plan-service-externalid"></a>
The external ID (secret key) for the service.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ServiceArn`  <a name="cfn-arcregionswitch-plan-service-servicearn"></a>
The Amazon Resource Name (ARN) for a service.  
*Required*: No  
*Type*: String  
*Pattern*: `^arn:aws[a-zA-Z-]*:ecs:[a-z0-9-]+:\d{12}:service/[a-zA-Z0-9_-]+/[a-zA-Z0-9_-]{1,255}$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::ARCRegionSwitch::Plan Step
<a name="aws-properties-arcregionswitch-plan-step"></a>

Represents a step in a Region switch plan workflow. Each step performs a specific action during the Region switch process.

## Syntax
<a name="aws-properties-arcregionswitch-plan-step-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-arcregionswitch-plan-step-syntax.json"></a>

```
{
  "[Description](#cfn-arcregionswitch-plan-step-description)" : String,
  "[ExecutionBlockConfiguration](#cfn-arcregionswitch-plan-step-executionblockconfiguration)" : ExecutionBlockConfiguration,
  "[ExecutionBlockType](#cfn-arcregionswitch-plan-step-executionblocktype)" : String,
  "[Name](#cfn-arcregionswitch-plan-step-name)" : String
}
```

### YAML
<a name="aws-properties-arcregionswitch-plan-step-syntax.yaml"></a>

```
  [Description](#cfn-arcregionswitch-plan-step-description): String
  [ExecutionBlockConfiguration](#cfn-arcregionswitch-plan-step-executionblockconfiguration): 
    ExecutionBlockConfiguration
  [ExecutionBlockType](#cfn-arcregionswitch-plan-step-executionblocktype): String
  [Name](#cfn-arcregionswitch-plan-step-name): String
```

## Properties
<a name="aws-properties-arcregionswitch-plan-step-properties"></a>

`Description`  <a name="cfn-arcregionswitch-plan-step-description"></a>
The description of a step in a workflow.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ExecutionBlockConfiguration`  <a name="cfn-arcregionswitch-plan-step-executionblockconfiguration"></a>
The configuration for an execution block in a workflow.  
*Required*: Yes  
*Type*: [ExecutionBlockConfiguration](aws-properties-arcregionswitch-plan-executionblockconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ExecutionBlockType`  <a name="cfn-arcregionswitch-plan-step-executionblocktype"></a>
The type of an execution block in a workflow.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `CustomActionLambda | ManualApproval | AuroraGlobalDatabase | EC2AutoScaling | ARCRoutingControl | ARCRegionSwitchPlan | Parallel | ECSServiceScaling | EKSResourceScaling | Route53HealthCheck | DocumentDb | RdsPromoteReadReplica | RdsCreateCrossRegionReplica`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-arcregionswitch-plan-step-name"></a>
The name of a step in a workflow.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::ARCRegionSwitch::Plan Trigger
<a name="aws-properties-arcregionswitch-plan-trigger"></a>

Defines a condition that can automatically trigger the execution of a Region switch plan.

## Syntax
<a name="aws-properties-arcregionswitch-plan-trigger-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-arcregionswitch-plan-trigger-syntax.json"></a>

```
{
  "[Action](#cfn-arcregionswitch-plan-trigger-action)" : String,
  "[Conditions](#cfn-arcregionswitch-plan-trigger-conditions)" : [ TriggerCondition, ... ],
  "[Description](#cfn-arcregionswitch-plan-trigger-description)" : String,
  "[MinDelayMinutesBetweenExecutions](#cfn-arcregionswitch-plan-trigger-mindelayminutesbetweenexecutions)" : Number,
  "[TargetRegion](#cfn-arcregionswitch-plan-trigger-targetregion)" : String
}
```

### YAML
<a name="aws-properties-arcregionswitch-plan-trigger-syntax.yaml"></a>

```
  [Action](#cfn-arcregionswitch-plan-trigger-action): String
  [Conditions](#cfn-arcregionswitch-plan-trigger-conditions): 
    - TriggerCondition
  [Description](#cfn-arcregionswitch-plan-trigger-description): String
  [MinDelayMinutesBetweenExecutions](#cfn-arcregionswitch-plan-trigger-mindelayminutesbetweenexecutions): Number
  [TargetRegion](#cfn-arcregionswitch-plan-trigger-targetregion): String
```

## Properties
<a name="aws-properties-arcregionswitch-plan-trigger-properties"></a>

`Action`  <a name="cfn-arcregionswitch-plan-trigger-action"></a>
The action to perform when the trigger fires. Valid values include `activate` and `deactivate`.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `activate | deactivate | postRecovery`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Conditions`  <a name="cfn-arcregionswitch-plan-trigger-conditions"></a>
The conditions that must be met for the trigger to fire.  
*Required*: Yes  
*Type*: Array of [TriggerCondition](aws-properties-arcregionswitch-plan-triggercondition.md)  
*Minimum*: `1`  
*Maximum*: `10`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Description`  <a name="cfn-arcregionswitch-plan-trigger-description"></a>
The description for a trigger.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MinDelayMinutesBetweenExecutions`  <a name="cfn-arcregionswitch-plan-trigger-mindelayminutesbetweenexecutions"></a>
The minimum time, in minutes, that must elapse between automatic executions of the plan.  
*Required*: Yes  
*Type*: Number  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TargetRegion`  <a name="cfn-arcregionswitch-plan-trigger-targetregion"></a>
The AWS Region for a trigger.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[a-z]{2}-[a-z-]+-\d+$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::ARCRegionSwitch::Plan TriggerCondition
<a name="aws-properties-arcregionswitch-plan-triggercondition"></a>

Defines a condition that must be met for a trigger to fire.

## Syntax
<a name="aws-properties-arcregionswitch-plan-triggercondition-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-arcregionswitch-plan-triggercondition-syntax.json"></a>

```
{
  "[AssociatedAlarmName](#cfn-arcregionswitch-plan-triggercondition-associatedalarmname)" : String,
  "[Condition](#cfn-arcregionswitch-plan-triggercondition-condition)" : String
}
```

### YAML
<a name="aws-properties-arcregionswitch-plan-triggercondition-syntax.yaml"></a>

```
  [AssociatedAlarmName](#cfn-arcregionswitch-plan-triggercondition-associatedalarmname): String
  [Condition](#cfn-arcregionswitch-plan-triggercondition-condition): String
```

## Properties
<a name="aws-properties-arcregionswitch-plan-triggercondition-properties"></a>

`AssociatedAlarmName`  <a name="cfn-arcregionswitch-plan-triggercondition-associatedalarmname"></a>
The name of the CloudWatch alarm associated with the condition.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Condition`  <a name="cfn-arcregionswitch-plan-triggercondition-condition"></a>
The condition that must be met. Valid values include `green` and `red`.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `red | green`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::ARCRegionSwitch::Plan Workflow
<a name="aws-properties-arcregionswitch-plan-workflow"></a>

Represents a workflow in a Region switch plan. A workflow defines a sequence of steps to execute during a Region switch.

## Syntax
<a name="aws-properties-arcregionswitch-plan-workflow-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-arcregionswitch-plan-workflow-syntax.json"></a>

```
{
  "[Steps](#cfn-arcregionswitch-plan-workflow-steps)" : [ Step, ... ],
  "[WorkflowDescription](#cfn-arcregionswitch-plan-workflow-workflowdescription)" : String,
  "[WorkflowTargetAction](#cfn-arcregionswitch-plan-workflow-workflowtargetaction)" : String,
  "[WorkflowTargetRegion](#cfn-arcregionswitch-plan-workflow-workflowtargetregion)" : String
}
```

### YAML
<a name="aws-properties-arcregionswitch-plan-workflow-syntax.yaml"></a>

```
  [Steps](#cfn-arcregionswitch-plan-workflow-steps): 
    - Step
  [WorkflowDescription](#cfn-arcregionswitch-plan-workflow-workflowdescription): String
  [WorkflowTargetAction](#cfn-arcregionswitch-plan-workflow-workflowtargetaction): String
  [WorkflowTargetRegion](#cfn-arcregionswitch-plan-workflow-workflowtargetregion): String
```

## Properties
<a name="aws-properties-arcregionswitch-plan-workflow-properties"></a>

`Steps`  <a name="cfn-arcregionswitch-plan-workflow-steps"></a>
The steps that make up the workflow.  
*Required*: No  
*Type*: Array of [Step](aws-properties-arcregionswitch-plan-step.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`WorkflowDescription`  <a name="cfn-arcregionswitch-plan-workflow-workflowdescription"></a>
The description of the workflow.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`WorkflowTargetAction`  <a name="cfn-arcregionswitch-plan-workflow-workflowtargetaction"></a>
The action that the workflow performs. Valid values include `activate` and `deactivate`.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `activate | deactivate | postRecovery`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`WorkflowTargetRegion`  <a name="cfn-arcregionswitch-plan-workflow-workflowtargetregion"></a>
The AWS Region that the workflow targets.  
*Required*: No  
*Type*: String  
*Pattern*: `^[a-z]{2}-[a-z-]+-\d+$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)