Package software.amazon.awscdk.services.arcregionswitch

Class CfnPlan

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.arcregionswitch.CfnPlan

All Implemented Interfaces:

IInspectable, IPlanRef, IEnvironmentAware, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-17T14:40:45.601Z")
@Stability(Stable)
public class CfnPlan
extends CfnResource
implements IInspectable, IPlanRef, ITaggableV2

Represents a Region switch plan.

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.arcregionswitch.*;
 StepProperty stepProperty_;
 CfnPlan cfnPlan = CfnPlan.Builder.create(this, "MyCfnPlan")
         .executionRole("executionRole")
         .name("name")
         .recoveryApproach("recoveryApproach")
         .regions(List.of("regions"))
         .workflows(List.of(WorkflowProperty.builder()
                 .workflowTargetAction("workflowTargetAction")
                 // the properties below are optional
                 .steps(List.of(StepProperty.builder()
                         .executionBlockConfiguration(ExecutionBlockConfigurationProperty.builder()
                                 .arcRoutingControlConfig(ArcRoutingControlConfigurationProperty.builder()
                                         .regionAndRoutingControls(Map.of(
                                                 "regionAndRoutingControlsKey", List.of(ArcRoutingControlStateProperty.builder()
                                                         .routingControlArn("routingControlArn")
                                                         .state("state")
                                                         .build())))
                                         // the properties below are optional
                                         .crossAccountRole("crossAccountRole")
                                         .externalId("externalId")
                                         .timeoutMinutes(123)
                                         .build())
                                 .customActionLambdaConfig(CustomActionLambdaConfigurationProperty.builder()
                                         .lambdas(List.of(LambdasProperty.builder()
                                                 .arn("arn")
                                                 .crossAccountRole("crossAccountRole")
                                                 .externalId("externalId")
                                                 .build()))
                                         .regionToRun("regionToRun")
                                         .retryIntervalMinutes(123)
                                         // the properties below are optional
                                         .timeoutMinutes(123)
                                         .ungraceful(LambdaUngracefulProperty.builder()
                                                 .behavior("behavior")
                                                 .build())
                                         .build())
                                 .ec2AsgCapacityIncreaseConfig(Ec2AsgCapacityIncreaseConfigurationProperty.builder()
                                         .asgs(List.of(AsgProperty.builder()
                                                 .arn("arn")
                                                 .crossAccountRole("crossAccountRole")
                                                 .externalId("externalId")
                                                 .build()))
                                         // the properties below are optional
                                         .capacityMonitoringApproach("capacityMonitoringApproach")
                                         .targetPercent(123)
                                         .timeoutMinutes(123)
                                         .ungraceful(Ec2UngracefulProperty.builder()
                                                 .minimumSuccessPercentage(123)
                                                 .build())
                                         .build())
                                 .ecsCapacityIncreaseConfig(EcsCapacityIncreaseConfigurationProperty.builder()
                                         .services(List.of(ServiceProperty.builder()
                                                 .clusterArn("clusterArn")
                                                 .crossAccountRole("crossAccountRole")
                                                 .externalId("externalId")
                                                 .serviceArn("serviceArn")
                                                 .build()))
                                         // the properties below are optional
                                         .capacityMonitoringApproach("capacityMonitoringApproach")
                                         .targetPercent(123)
                                         .timeoutMinutes(123)
                                         .ungraceful(EcsUngracefulProperty.builder()
                                                 .minimumSuccessPercentage(123)
                                                 .build())
                                         .build())
                                 .eksResourceScalingConfig(EksResourceScalingConfigurationProperty.builder()
                                         .kubernetesResourceType(KubernetesResourceTypeProperty.builder()
                                                 .apiVersion("apiVersion")
                                                 .kind("kind")
                                                 .build())
                                         // the properties below are optional
                                         .capacityMonitoringApproach("capacityMonitoringApproach")
                                         .eksClusters(List.of(EksClusterProperty.builder()
                                                 .clusterArn("clusterArn")
                                                 // the properties below are optional
                                                 .crossAccountRole("crossAccountRole")
                                                 .externalId("externalId")
                                                 .build()))
                                         .scalingResources(List.of(Map.of(
                                                 "scalingResourcesKey", Map.of(
                                                         "scalingResourcesKey", KubernetesScalingResourceProperty.builder()
                                                                 .name("name")
                                                                 .namespace("namespace")
                                                                 // the properties below are optional
                                                                 .hpaName("hpaName")
                                                                 .build()))))
                                         .targetPercent(123)
                                         .timeoutMinutes(123)
                                         .ungraceful(EksResourceScalingUngracefulProperty.builder()
                                                 .minimumSuccessPercentage(123)
                                                 .build())
                                         .build())
                                 .executionApprovalConfig(ExecutionApprovalConfigurationProperty.builder()
                                         .approvalRole("approvalRole")
                                         // the properties below are optional
                                         .timeoutMinutes(123)
                                         .build())
                                 .globalAuroraConfig(GlobalAuroraConfigurationProperty.builder()
                                         .behavior("behavior")
                                         .databaseClusterArns(List.of("databaseClusterArns"))
                                         .globalClusterIdentifier("globalClusterIdentifier")
                                         // the properties below are optional
                                         .crossAccountRole("crossAccountRole")
                                         .externalId("externalId")
                                         .timeoutMinutes(123)
                                         .ungraceful(GlobalAuroraUngracefulProperty.builder()
                                                 .ungraceful("ungraceful")
                                                 .build())
                                         .build())
                                 .parallelConfig(ParallelExecutionBlockConfigurationProperty.builder()
                                         .steps(List.of(stepProperty_))
                                         .build())
                                 .regionSwitchPlanConfig(RegionSwitchPlanConfigurationProperty.builder()
                                         .arn("arn")
                                         // the properties below are optional
                                         .crossAccountRole("crossAccountRole")
                                         .externalId("externalId")
                                         .build())
                                 .route53HealthCheckConfig(Route53HealthCheckConfigurationProperty.builder()
                                         .hostedZoneId("hostedZoneId")
                                         .recordName("recordName")
                                         // the properties below are optional
                                         .crossAccountRole("crossAccountRole")
                                         .externalId("externalId")
                                         .recordSets(List.of(Route53ResourceRecordSetProperty.builder()
                                                 .recordSetIdentifier("recordSetIdentifier")
                                                 .region("region")
                                                 .build()))
                                         .timeoutMinutes(123)
                                         .build())
                                 .build())
                         .executionBlockType("executionBlockType")
                         .name("name")
                         // the properties below are optional
                         .description("description")
                         .build()))
                 .workflowDescription("workflowDescription")
                 .workflowTargetRegion("workflowTargetRegion")
                 .build()))
         // the properties below are optional
         .associatedAlarms(Map.of(
                 "associatedAlarmsKey", AssociatedAlarmProperty.builder()
                         .alarmType("alarmType")
                         .resourceIdentifier("resourceIdentifier")
                         // the properties below are optional
                         .crossAccountRole("crossAccountRole")
                         .externalId("externalId")
                         .build()))
         .description("description")
         .primaryRegion("primaryRegion")
         .recoveryTimeObjectiveMinutes(123)
         .tags(Map.of(
                 "tagsKey", "tags"))
         .triggers(List.of(TriggerProperty.builder()
                 .action("action")
                 .conditions(List.of(TriggerConditionProperty.builder()
                         .associatedAlarmName("associatedAlarmName")
                         .condition("condition")
                         .build()))
                 .minDelayMinutesBetweenExecutions(123)
                 .targetRegion("targetRegion")
                 // the properties below are optional
                 .description("description")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-arcregionswitch-plan.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnPlan.ArcRoutingControlConfigurationProperty	Configuration for ARC routing controls used in a Region switch plan.
static interface	CfnPlan.ArcRoutingControlStateProperty	Example:
static interface	CfnPlan.AsgProperty	Configuration for an Amazon EC2 Auto Scaling group used in a Region switch plan.
static interface	CfnPlan.AssociatedAlarmProperty	An Amazon CloudWatch alarm associated with a Region switch plan.
static final class	CfnPlan.Builder	A fluent builder for CfnPlan.
static interface	CfnPlan.CustomActionLambdaConfigurationProperty	Configuration for AWS Lambda functions that perform custom actions during a Region switch.
static interface	CfnPlan.Ec2AsgCapacityIncreaseConfigurationProperty	Configuration for increasing the capacity of Amazon EC2 Auto Scaling groups during a Region switch.
static interface	CfnPlan.Ec2UngracefulProperty	Configuration for handling failures when performing operations on EC2 resources.
static interface	CfnPlan.EcsCapacityIncreaseConfigurationProperty	The configuration for an AWS ECS capacity increase.
static interface	CfnPlan.EcsUngracefulProperty	The settings for ungraceful execution.
static interface	CfnPlan.EksClusterProperty	The AWS EKS cluster execution block configuration.
static interface	CfnPlan.EksResourceScalingConfigurationProperty	The AWS EKS resource scaling configuration.
static interface	CfnPlan.EksResourceScalingUngracefulProperty	The ungraceful settings for AWS EKS resource scaling.
static interface	CfnPlan.ExecutionApprovalConfigurationProperty	Configuration for approval steps in a Region switch plan execution.
static interface	CfnPlan.ExecutionBlockConfigurationProperty	Execution block configurations for a workflow in a Region switch plan.
static interface	CfnPlan.GlobalAuroraConfigurationProperty	Configuration for Amazon Aurora global databases used in a Region switch plan.
static interface	CfnPlan.GlobalAuroraUngracefulProperty	Configuration for handling failures when performing operations on Aurora global databases.
static interface	CfnPlan.HealthCheckStateProperty	Example:
static interface	CfnPlan.KubernetesResourceTypeProperty	Defines the type of Kubernetes resource to scale in an Amazon EKS cluster.
static interface	CfnPlan.KubernetesScalingResourceProperty	Defines a Kubernetes resource to scale in an Amazon EKS cluster.
static interface	CfnPlan.LambdasProperty	Configuration for AWS Lambda functions used in a Region switch plan.
static interface	CfnPlan.LambdaUngracefulProperty	Configuration for handling failures when invoking Lambda functions.
static interface	CfnPlan.ParallelExecutionBlockConfigurationProperty	Configuration for steps that should be executed in parallel during a Region switch.
static interface	CfnPlan.RegionSwitchPlanConfigurationProperty	Configuration for nested Region switch plans.
static interface	CfnPlan.Route53HealthCheckConfigurationProperty	The Amazon Route 53 health check configuration.
static interface	CfnPlan.Route53HealthChecksProperty	Example:
static interface	CfnPlan.Route53ResourceRecordSetProperty	The Amazon Route 53 record set.
static interface	CfnPlan.ServiceProperty	The service for a cross account role.
static interface	CfnPlan.StepProperty	Represents a step in a Region switch plan workflow.
static interface	CfnPlan.TriggerConditionProperty	Defines a condition that must be met for a trigger to fire.
static interface	CfnPlan.TriggerProperty	Defines a condition that can automatically trigger the execution of a Region switch plan.
static interface	CfnPlan.WorkflowProperty	Represents a workflow in a Region switch plan.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.arcregionswitch.IPlanRef

IPlanRef.Jsii$Default, IPlanRef.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggableV2

ITaggableV2.Jsii$Default, ITaggableV2.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnPlan(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnPlan(software.amazon.jsii.JsiiObjectRef objRef)
	CfnPlan(software.constructs.Construct scope, String id, CfnPlanProps props)	Create a new AWS::ARCRegionSwitch::Plan.

Method Summary

Modifier and Type	Method	Description
Object	getAssociatedAlarms()	The associated application health alarms for a plan.
String	getAttrArn()	The Amazon Resource Name (ARN) of the plan.
IResolvable	getAttrHealthChecksForPlan()
String	getAttrOwner()	The owner of a plan.
List<String>	getAttrPlanHealthChecks()
IResolvable	getAttrRoute53HealthChecks()
String	getAttrVersion()	The version for the plan.
TagManager	getCdkTagManager()	Tag Manager which manages the tags for this resource.
protected Map<String,Object>	getCfnProperties()
String	getDescription()	The description for a plan.
String	getExecutionRole()	The execution role for a plan.
String	getName()	The name for a plan.
PlanReference	getPlanRef()	A reference to a Plan resource.
String	getPrimaryRegion()	The primary Region for a plan.
String	getRecoveryApproach()	The recovery approach for a Region switch plan, which can be active/active (activeActive) or active/passive (activePassive).
Number	getRecoveryTimeObjectiveMinutes()	The recovery time objective for a plan.
List<String>	getRegions()	The AWS Regions for a plan.
Map<String,String>	getTags()
Object	getTriggers()	The triggers for a plan.
Object	getWorkflows()	The workflows for a plan.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAssociatedAlarms(Map<String,Object> value)	The associated application health alarms for a plan.
void	setAssociatedAlarms(IResolvable value)	The associated application health alarms for a plan.
void	setDescription(String value)	The description for a plan.
void	setExecutionRole(String value)	The execution role for a plan.
void	setName(String value)	The name for a plan.
void	setPrimaryRegion(String value)	The primary Region for a plan.
void	setRecoveryApproach(String value)	The recovery approach for a Region switch plan, which can be active/active (activeActive) or active/passive (activePassive).
void	setRecoveryTimeObjectiveMinutes(Number value)	The recovery time objective for a plan.
void	setRegions(List<String> value)	The AWS Regions for a plan.
void	setTags(Map<String,String> value)
void	setTriggers(List<Object> value)	The triggers for a plan.
void	setTriggers(IResolvable value)	The triggers for a plan.
void	setWorkflows(List<Object> value)	The workflows for a plan.
void	setWorkflows(IResolvable value)	The workflows for a plan.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnPlan

protected CfnPlan(software.amazon.jsii.JsiiObjectRef objRef)

CfnPlan

protected CfnPlan(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnPlan

@Stability(Stable)
public CfnPlan(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnPlanProps props)

Create a new AWS::ARCRegionSwitch::Plan.

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(Stable)
@NotNull
public String getAttrArn()

The Amazon Resource Name (ARN) of the plan.

getAttrHealthChecksForPlan

@Stability(Stable)
@NotNull
public IResolvable getAttrHealthChecksForPlan()

getAttrOwner

@Stability(Stable)
@NotNull
public String getAttrOwner()

The owner of a plan.

getAttrPlanHealthChecks

@Stability(Stable)
@NotNull
public List<String> getAttrPlanHealthChecks()

getAttrRoute53HealthChecks

@Stability(Stable)
@NotNull
public IResolvable getAttrRoute53HealthChecks()

getAttrVersion

@Stability(Stable)
@NotNull
public String getAttrVersion()

The version for the plan.

getCdkTagManager

@Stability(Stable)
@NotNull
public TagManager getCdkTagManager()

Tag Manager which manages the tags for this resource.

Specified by:

getCdkTagManager in interface ITaggableV2

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getPlanRef

@Stability(Stable)
@NotNull
public PlanReference getPlanRef()

A reference to a Plan resource.

Specified by:

getPlanRef in interface IPlanRef

getExecutionRole

@Stability(Stable)
@NotNull
public String getExecutionRole()

The execution role for a plan.

setExecutionRole

@Stability(Stable)
public void setExecutionRole(@NotNull
 String value)

The execution role for a plan.

getName

@Stability(Stable)
@NotNull
public String getName()

The name for a plan.

setName

@Stability(Stable)
public void setName(@NotNull
 String value)

The name for a plan.

getRecoveryApproach

@Stability(Stable)
@NotNull
public String getRecoveryApproach()

The recovery approach for a Region switch plan, which can be active/active (activeActive) or active/passive (activePassive).

setRecoveryApproach

@Stability(Stable)
public void setRecoveryApproach(@NotNull
 String value)

The recovery approach for a Region switch plan, which can be active/active (activeActive) or active/passive (activePassive).

getRegions

@Stability(Stable)
@NotNull
public List<String> getRegions()

The AWS Regions for a plan.

setRegions

@Stability(Stable)
public void setRegions(@NotNull
 List<String> value)

The AWS Regions for a plan.

getWorkflows

@Stability(Stable)
@NotNull
public Object getWorkflows()

The workflows for a plan.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnPlan.WorkflowProperty>

setWorkflows

@Stability(Stable)
public void setWorkflows(@NotNull
 IResolvable value)

The workflows for a plan.

setWorkflows

@Stability(Stable)
public void setWorkflows(@NotNull
 List<Object> value)

The workflows for a plan.

getAssociatedAlarms

@Stability(Stable)
@Nullable
public Object getAssociatedAlarms()

The associated application health alarms for a plan.

Returns union: either IResolvable or Mapinvalid input: '<'String, either IResolvable or CfnPlan.AssociatedAlarmProperty>

setAssociatedAlarms

@Stability(Stable)
public void setAssociatedAlarms(@Nullable
 IResolvable value)

The associated application health alarms for a plan.

setAssociatedAlarms

@Stability(Stable)
public void setAssociatedAlarms(@Nullable
 Map<String,Object> value)

The associated application health alarms for a plan.

getDescription

@Stability(Stable)
@Nullable
public String getDescription()

The description for a plan.

setDescription

@Stability(Stable)
public void setDescription(@Nullable
 String value)

The description for a plan.

getPrimaryRegion

@Stability(Stable)
@Nullable
public String getPrimaryRegion()

The primary Region for a plan.

setPrimaryRegion

@Stability(Stable)
public void setPrimaryRegion(@Nullable
 String value)

The primary Region for a plan.

getRecoveryTimeObjectiveMinutes

@Stability(Stable)
@Nullable
public Number getRecoveryTimeObjectiveMinutes()

The recovery time objective for a plan.

setRecoveryTimeObjectiveMinutes

@Stability(Stable)
public void setRecoveryTimeObjectiveMinutes(@Nullable
 Number value)

The recovery time objective for a plan.

getTags

@Stability(Stable)
@Nullable
public Map<String,String> getTags()

setTags

@Stability(Stable)
public void setTags(@Nullable
 Map<String,String> value)

getTriggers

@Stability(Stable)
@Nullable
public Object getTriggers()

The triggers for a plan.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnPlan.TriggerProperty>

setTriggers

@Stability(Stable)
public void setTriggers(@Nullable
 IResolvable value)

The triggers for a plan.

setTriggers

@Stability(Stable)
public void setTriggers(@Nullable
 List<Object> value)

The triggers for a plan.