# AWS::ARCRegionSwitch Construct Library

---

![cfn-resources: Stable](https://img.shields.io/badge/cfn--resources-stable-success.svg?style=for-the-badge)

> All classes with the `Cfn` prefix in this module ([CFN Resources]) are always stable and safe to use.
>
> [CFN Resources]: https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_lib

---

This module is part of the [AWS Cloud Development Kit](https://github.com/aws/aws-cdk) project.

```ts
import * as arcregionswitch from 'aws-cdk-lib/aws-arcregionswitch';
```

There are no official hand-written ([L2](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_lib)) constructs for this service yet. Here are some suggestions on how to proceed:

- Search [Construct Hub for ARCRegionSwitch construct libraries](https://constructs.dev/search?q=arcregionswitch)
- Use the automatically generated [L1](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_l1_using) constructs, in the same way you would use [the CloudFormation AWS::ARCRegionSwitch resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/AWS_ARCRegionSwitch.html) directly.

There are no hand-written ([L2](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_lib)) constructs for this service yet.
However, you can still use the automatically generated [L1](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_l1_using) constructs, and use this service exactly as you would using CloudFormation directly.

For more information on the resources and properties available for this service, see the [CloudFormation documentation for AWS::ARCRegionSwitch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/AWS_ARCRegionSwitch.html).

(Read the [CDK Contributing Guide](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and submit an RFC if you are interested in contributing to this construct library.)

## Types

| Name | Kind | Summary |
| --- | --- | --- |
| [`CfnPlan`](/v2/docs/aws-cdk-lib.aws_arcregionswitch.CfnPlan) | Construct (L1) | Represents a Region switch plan. |
| [`CfnPlan.ArcRoutingControlConfigurationProperty`](/v2/docs/aws-cdk-lib.aws_arcregionswitch.CfnPlan.ArcRoutingControlConfigurationProperty) | Struct | Configuration for ARC routing controls used in a Region switch plan. |
| [`CfnPlan.ArcRoutingControlStateProperty`](/v2/docs/aws-cdk-lib.aws_arcregionswitch.CfnPlan.ArcRoutingControlStateProperty) | Struct |  |
| [`CfnPlan.AsgProperty`](/v2/docs/aws-cdk-lib.aws_arcregionswitch.CfnPlan.AsgProperty) | Struct | Configuration for an Amazon EC2 Auto Scaling group used in a Region switch plan. |
| [`CfnPlan.AssociatedAlarmProperty`](/v2/docs/aws-cdk-lib.aws_arcregionswitch.CfnPlan.AssociatedAlarmProperty) | Struct | An Amazon CloudWatch alarm associated with a Region switch plan. |
| [`CfnPlan.AuroraProvisionedScalingConfigurationProperty`](/v2/docs/aws-cdk-lib.aws_arcregionswitch.CfnPlan.AuroraProvisionedScalingConfigurationProperty) | Struct |  |
| [`CfnPlan.AuroraServerlessScalingConfigurationProperty`](/v2/docs/aws-cdk-lib.aws_arcregionswitch.CfnPlan.AuroraServerlessScalingConfigurationProperty) | Struct |  |
| [`CfnPlan.CustomActionLambdaConfigurationProperty`](/v2/docs/aws-cdk-lib.aws_arcregionswitch.CfnPlan.CustomActionLambdaConfigurationProperty) | Struct | Configuration for AWS Lambda functions that perform custom actions during a Region switch. |
| [`CfnPlan.DocumentDbConfigurationProperty`](/v2/docs/aws-cdk-lib.aws_arcregionswitch.CfnPlan.DocumentDbConfigurationProperty) | Struct | Configuration for Amazon DocumentDB global clusters used in a Region switch plan. |
| [`CfnPlan.DocumentDbUngracefulProperty`](/v2/docs/aws-cdk-lib.aws_arcregionswitch.CfnPlan.DocumentDbUngracefulProperty) | Struct | Configuration for handling failures when performing operations on DocumentDB global clusters. |
| [`CfnPlan.Ec2AsgCapacityIncreaseConfigurationProperty`](/v2/docs/aws-cdk-lib.aws_arcregionswitch.CfnPlan.Ec2AsgCapacityIncreaseConfigurationProperty) | Struct | Configuration for increasing the capacity of Amazon EC2 Auto Scaling groups during a Region switch. |
| [`CfnPlan.Ec2UngracefulProperty`](/v2/docs/aws-cdk-lib.aws_arcregionswitch.CfnPlan.Ec2UngracefulProperty) | Struct | Configuration for handling failures when performing operations on EC2 resources. |
| [`CfnPlan.EcsCapacityIncreaseConfigurationProperty`](/v2/docs/aws-cdk-lib.aws_arcregionswitch.CfnPlan.EcsCapacityIncreaseConfigurationProperty) | Struct | The configuration for an AWS ECS capacity increase. |
| [`CfnPlan.EcsUngracefulProperty`](/v2/docs/aws-cdk-lib.aws_arcregionswitch.CfnPlan.EcsUngracefulProperty) | Struct | The settings for ungraceful execution. |
| [`CfnPlan.EksClusterProperty`](/v2/docs/aws-cdk-lib.aws_arcregionswitch.CfnPlan.EksClusterProperty) | Struct | The AWS EKS cluster execution block configuration. |
| [`CfnPlan.EksResourceScalingConfigurationProperty`](/v2/docs/aws-cdk-lib.aws_arcregionswitch.CfnPlan.EksResourceScalingConfigurationProperty) | Struct | The AWS EKS resource scaling configuration. |
| [`CfnPlan.EksResourceScalingUngracefulProperty`](/v2/docs/aws-cdk-lib.aws_arcregionswitch.CfnPlan.EksResourceScalingUngracefulProperty) | Struct | The ungraceful settings for AWS EKS resource scaling. |
| [`CfnPlan.EventSourceMappingProperty`](/v2/docs/aws-cdk-lib.aws_arcregionswitch.CfnPlan.EventSourceMappingProperty) | Struct |  |
| [`CfnPlan.ExecutionApprovalConfigurationProperty`](/v2/docs/aws-cdk-lib.aws_arcregionswitch.CfnPlan.ExecutionApprovalConfigurationProperty) | Struct | Configuration for approval steps in a Region switch plan execution. |
| [`CfnPlan.ExecutionBlockConfigurationProperty`](/v2/docs/aws-cdk-lib.aws_arcregionswitch.CfnPlan.ExecutionBlockConfigurationProperty) | Struct | Execution block configurations for a workflow in a Region switch plan. |
| [`CfnPlan.GlobalAuroraConfigurationProperty`](/v2/docs/aws-cdk-lib.aws_arcregionswitch.CfnPlan.GlobalAuroraConfigurationProperty) | Struct | Configuration for Amazon Aurora global databases used in a Region switch plan. |
| [`CfnPlan.GlobalAuroraUngracefulProperty`](/v2/docs/aws-cdk-lib.aws_arcregionswitch.CfnPlan.GlobalAuroraUngracefulProperty) | Struct | Configuration for handling failures when performing operations on Aurora global databases. |
| [`CfnPlan.HealthCheckStateProperty`](/v2/docs/aws-cdk-lib.aws_arcregionswitch.CfnPlan.HealthCheckStateProperty) | Struct |  |
| [`CfnPlan.KubernetesResourceTypeProperty`](/v2/docs/aws-cdk-lib.aws_arcregionswitch.CfnPlan.KubernetesResourceTypeProperty) | Struct | Defines the type of Kubernetes resource to scale in an Amazon EKS cluster. |
| [`CfnPlan.KubernetesScalingResourceProperty`](/v2/docs/aws-cdk-lib.aws_arcregionswitch.CfnPlan.KubernetesScalingResourceProperty) | Struct | Defines a Kubernetes resource to scale in an Amazon EKS cluster. |
| [`CfnPlan.LambdaEventSourceMappingConfigurationProperty`](/v2/docs/aws-cdk-lib.aws_arcregionswitch.CfnPlan.LambdaEventSourceMappingConfigurationProperty) | Struct |  |
| [`CfnPlan.LambdaEventSourceMappingUngracefulProperty`](/v2/docs/aws-cdk-lib.aws_arcregionswitch.CfnPlan.LambdaEventSourceMappingUngracefulProperty) | Struct |  |
| [`CfnPlan.LambdasProperty`](/v2/docs/aws-cdk-lib.aws_arcregionswitch.CfnPlan.LambdasProperty) | Struct | Configuration for AWS Lambda functions used in a Region switch plan. |
| [`CfnPlan.LambdaUngracefulProperty`](/v2/docs/aws-cdk-lib.aws_arcregionswitch.CfnPlan.LambdaUngracefulProperty) | Struct | Configuration for handling failures when invoking Lambda functions. |
| [`CfnPlan.NeptuneGlobalDatabaseConfigurationProperty`](/v2/docs/aws-cdk-lib.aws_arcregionswitch.CfnPlan.NeptuneGlobalDatabaseConfigurationProperty) | Struct |  |
| [`CfnPlan.NeptuneUngracefulProperty`](/v2/docs/aws-cdk-lib.aws_arcregionswitch.CfnPlan.NeptuneUngracefulProperty) | Struct |  |
| [`CfnPlan.ParallelExecutionBlockConfigurationProperty`](/v2/docs/aws-cdk-lib.aws_arcregionswitch.CfnPlan.ParallelExecutionBlockConfigurationProperty) | Struct | Configuration for steps that should be executed in parallel during a Region switch. |
| [`CfnPlan.RdsCreateCrossRegionReplicaConfigurationProperty`](/v2/docs/aws-cdk-lib.aws_arcregionswitch.CfnPlan.RdsCreateCrossRegionReplicaConfigurationProperty) | Struct |  |
| [`CfnPlan.RdsPromoteReadReplicaConfigurationProperty`](/v2/docs/aws-cdk-lib.aws_arcregionswitch.CfnPlan.RdsPromoteReadReplicaConfigurationProperty) | Struct |  |
| [`CfnPlan.RdsSwitchoverReadReplicaConfigurationProperty`](/v2/docs/aws-cdk-lib.aws_arcregionswitch.CfnPlan.RdsSwitchoverReadReplicaConfigurationProperty) | Struct |  |
| [`CfnPlan.RdsUngracefulProperty`](/v2/docs/aws-cdk-lib.aws_arcregionswitch.CfnPlan.RdsUngracefulProperty) | Struct |  |
| [`CfnPlan.RegionSwitchPlanConfigurationProperty`](/v2/docs/aws-cdk-lib.aws_arcregionswitch.CfnPlan.RegionSwitchPlanConfigurationProperty) | Struct | Configuration for nested Region switch plans. |
| [`CfnPlan.ReportConfigurationProperty`](/v2/docs/aws-cdk-lib.aws_arcregionswitch.CfnPlan.ReportConfigurationProperty) | Struct | Configuration for automatic report generation for plan executions. |
| [`CfnPlan.ReportOutputConfigurationProperty`](/v2/docs/aws-cdk-lib.aws_arcregionswitch.CfnPlan.ReportOutputConfigurationProperty) | Struct | Configuration for report output destinations used in a Region switch plan. |
| [`CfnPlan.Route53HealthCheckConfigurationProperty`](/v2/docs/aws-cdk-lib.aws_arcregionswitch.CfnPlan.Route53HealthCheckConfigurationProperty) | Struct | The Amazon Route 53 health check configuration. |
| [`CfnPlan.Route53HealthChecksProperty`](/v2/docs/aws-cdk-lib.aws_arcregionswitch.CfnPlan.Route53HealthChecksProperty) | Struct |  |
| [`CfnPlan.Route53ResourceRecordSetProperty`](/v2/docs/aws-cdk-lib.aws_arcregionswitch.CfnPlan.Route53ResourceRecordSetProperty) | Struct | The Amazon Route 53 record set. |
| [`CfnPlan.S3ReportOutputConfigurationProperty`](/v2/docs/aws-cdk-lib.aws_arcregionswitch.CfnPlan.S3ReportOutputConfigurationProperty) | Struct | Configuration for delivering generated reports to an Amazon S3 bucket. |
| [`CfnPlan.ServiceProperty`](/v2/docs/aws-cdk-lib.aws_arcregionswitch.CfnPlan.ServiceProperty) | Struct | The service for a cross account role. |
| [`CfnPlan.SsmDocumentConfigProperty`](/v2/docs/aws-cdk-lib.aws_arcregionswitch.CfnPlan.SsmDocumentConfigProperty) | Struct |  |
| [`CfnPlan.SsmSendCommandConfigurationProperty`](/v2/docs/aws-cdk-lib.aws_arcregionswitch.CfnPlan.SsmSendCommandConfigurationProperty) | Struct |  |
| [`CfnPlan.SsmSendCommandUngracefulProperty`](/v2/docs/aws-cdk-lib.aws_arcregionswitch.CfnPlan.SsmSendCommandUngracefulProperty) | Struct |  |
| [`CfnPlan.SsmTargetProperty`](/v2/docs/aws-cdk-lib.aws_arcregionswitch.CfnPlan.SsmTargetProperty) | Struct |  |
| [`CfnPlan.StepProperty`](/v2/docs/aws-cdk-lib.aws_arcregionswitch.CfnPlan.StepProperty) | Struct | Represents a step in a Region switch plan workflow. |
| [`CfnPlan.TriggerConditionProperty`](/v2/docs/aws-cdk-lib.aws_arcregionswitch.CfnPlan.TriggerConditionProperty) | Struct | Defines a condition that must be met for a trigger to fire. |
| [`CfnPlan.TriggerProperty`](/v2/docs/aws-cdk-lib.aws_arcregionswitch.CfnPlan.TriggerProperty) | Struct | Defines a condition that can automatically trigger the execution of a Region switch plan. |
| [`CfnPlan.WorkflowProperty`](/v2/docs/aws-cdk-lib.aws_arcregionswitch.CfnPlan.WorkflowProperty) | Struct | Represents a workflow in a Region switch plan. |
| [`CfnPlanProps`](/v2/docs/aws-cdk-lib.aws_arcregionswitch.CfnPlanProps) | Struct | Properties for defining a `CfnPlan`. |
