Package software.amazon.awscdk.cfnpropertymixins.services.arcregionswitch

Class CfnPlanPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.arcregionswitch.CfnPlanPropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-19T12:55:16.976Z")
@Stability(Stable)
public class CfnPlanPropsMixin
extends Mixin
implements software.constructs.IMixin

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.cfnpropertymixins.services.arcregionswitch.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 StepProperty stepProperty_;
 CfnPlanPropsMixin cfnPlanPropsMixin = CfnPlanPropsMixin.Builder.create(CfnPlanMixinProps.builder()
         .associatedAlarms(Map.of(
                 "associatedAlarmsKey", AssociatedAlarmProperty.builder()
                         .alarmType("alarmType")
                         .crossAccountRole("crossAccountRole")
                         .externalId("externalId")
                         .resourceIdentifier("resourceIdentifier")
                         .build()))
         .description("description")
         .executionRole("executionRole")
         .name("name")
         .primaryRegion("primaryRegion")
         .recoveryApproach("recoveryApproach")
         .recoveryTimeObjectiveMinutes(123)
         .regions(List.of("regions"))
         .reportConfiguration(ReportConfigurationProperty.builder()
                 .reportOutput(List.of(ReportOutputConfigurationProperty.builder()
                         .s3Configuration(S3ReportOutputConfigurationProperty.builder()
                                 .bucketOwner("bucketOwner")
                                 .bucketPath("bucketPath")
                                 .build())
                         .build()))
                 .build())
         .tags(Map.of(
                 "tagsKey", "tags"))
         .triggers(List.of(TriggerProperty.builder()
                 .action("action")
                 .conditions(List.of(TriggerConditionProperty.builder()
                         .associatedAlarmName("associatedAlarmName")
                         .condition("condition")
                         .build()))
                 .description("description")
                 .minDelayMinutesBetweenExecutions(123)
                 .targetRegion("targetRegion")
                 .build()))
         .workflows(List.of(WorkflowProperty.builder()
                 .steps(List.of(StepProperty.builder()
                         .description("description")
                         .executionBlockConfiguration(ExecutionBlockConfigurationProperty.builder()
                                 .arcRoutingControlConfig(ArcRoutingControlConfigurationProperty.builder()
                                         .crossAccountRole("crossAccountRole")
                                         .externalId("externalId")
                                         .regionAndRoutingControls(Map.of(
                                                 "regionAndRoutingControlsKey", List.of(ArcRoutingControlStateProperty.builder()
                                                         .routingControlArn("routingControlArn")
                                                         .state("state")
                                                         .build())))
                                         .timeoutMinutes(123)
                                         .build())
                                 .customActionLambdaConfig(CustomActionLambdaConfigurationProperty.builder()
                                         .lambdas(List.of(LambdasProperty.builder()
                                                 .arn("arn")
                                                 .crossAccountRole("crossAccountRole")
                                                 .externalId("externalId")
                                                 .build()))
                                         .regionToRun("regionToRun")
                                         .retryIntervalMinutes(123)
                                         .timeoutMinutes(123)
                                         .ungraceful(LambdaUngracefulProperty.builder()
                                                 .behavior("behavior")
                                                 .build())
                                         .build())
                                 .documentDbConfig(DocumentDbConfigurationProperty.builder()
                                         .behavior("behavior")
                                         .crossAccountRole("crossAccountRole")
                                         .databaseClusterArns(List.of("databaseClusterArns"))
                                         .externalId("externalId")
                                         .globalClusterIdentifier("globalClusterIdentifier")
                                         .timeoutMinutes(123)
                                         .ungraceful(DocumentDbUngracefulProperty.builder()
                                                 .ungraceful("ungraceful")
                                                 .build())
                                         .build())
                                 .ec2AsgCapacityIncreaseConfig(Ec2AsgCapacityIncreaseConfigurationProperty.builder()
                                         .asgs(List.of(AsgProperty.builder()
                                                 .arn("arn")
                                                 .crossAccountRole("crossAccountRole")
                                                 .externalId("externalId")
                                                 .build()))
                                         .capacityMonitoringApproach("capacityMonitoringApproach")
                                         .targetPercent(123)
                                         .timeoutMinutes(123)
                                         .ungraceful(Ec2UngracefulProperty.builder()
                                                 .minimumSuccessPercentage(123)
                                                 .build())
                                         .build())
                                 .ecsCapacityIncreaseConfig(EcsCapacityIncreaseConfigurationProperty.builder()
                                         .capacityMonitoringApproach("capacityMonitoringApproach")
                                         .services(List.of(ServiceProperty.builder()
                                                 .clusterArn("clusterArn")
                                                 .crossAccountRole("crossAccountRole")
                                                 .externalId("externalId")
                                                 .serviceArn("serviceArn")
                                                 .build()))
                                         .targetPercent(123)
                                         .timeoutMinutes(123)
                                         .ungraceful(EcsUngracefulProperty.builder()
                                                 .minimumSuccessPercentage(123)
                                                 .build())
                                         .build())
                                 .eksResourceScalingConfig(EksResourceScalingConfigurationProperty.builder()
                                         .capacityMonitoringApproach("capacityMonitoringApproach")
                                         .eksClusters(List.of(EksClusterProperty.builder()
                                                 .clusterArn("clusterArn")
                                                 .crossAccountRole("crossAccountRole")
                                                 .externalId("externalId")
                                                 .build()))
                                         .kubernetesResourceType(KubernetesResourceTypeProperty.builder()
                                                 .apiVersion("apiVersion")
                                                 .kind("kind")
                                                 .build())
                                         .scalingResources(List.of(Map.of(
                                                 "scalingResourcesKey", Map.of(
                                                         "scalingResourcesKey", KubernetesScalingResourceProperty.builder()
                                                                 .hpaName("hpaName")
                                                                 .name("name")
                                                                 .namespace("namespace")
                                                                 .build()))))
                                         .targetPercent(123)
                                         .timeoutMinutes(123)
                                         .ungraceful(EksResourceScalingUngracefulProperty.builder()
                                                 .minimumSuccessPercentage(123)
                                                 .build())
                                         .build())
                                 .executionApprovalConfig(ExecutionApprovalConfigurationProperty.builder()
                                         .approvalRole("approvalRole")
                                         .timeoutMinutes(123)
                                         .build())
                                 .globalAuroraConfig(GlobalAuroraConfigurationProperty.builder()
                                         .behavior("behavior")
                                         .crossAccountRole("crossAccountRole")
                                         .databaseClusterArns(List.of("databaseClusterArns"))
                                         .externalId("externalId")
                                         .globalClusterIdentifier("globalClusterIdentifier")
                                         .timeoutMinutes(123)
                                         .ungraceful(GlobalAuroraUngracefulProperty.builder()
                                                 .ungraceful("ungraceful")
                                                 .build())
                                         .build())
                                 .parallelConfig(ParallelExecutionBlockConfigurationProperty.builder()
                                         .steps(List.of(stepProperty_))
                                         .build())
                                 .rdsCreateCrossRegionReadReplicaConfig(RdsCreateCrossRegionReplicaConfigurationProperty.builder()
                                         .crossAccountRole("crossAccountRole")
                                         .dbInstanceArnMap(Map.of(
                                                 "dbInstanceArnMapKey", "dbInstanceArnMap"))
                                         .externalId("externalId")
                                         .timeoutMinutes(123)
                                         .build())
                                 .rdsPromoteReadReplicaConfig(RdsPromoteReadReplicaConfigurationProperty.builder()
                                         .crossAccountRole("crossAccountRole")
                                         .dbInstanceArnMap(Map.of(
                                                 "dbInstanceArnMapKey", "dbInstanceArnMap"))
                                         .externalId("externalId")
                                         .timeoutMinutes(123)
                                         .build())
                                 .regionSwitchPlanConfig(RegionSwitchPlanConfigurationProperty.builder()
                                         .arn("arn")
                                         .crossAccountRole("crossAccountRole")
                                         .externalId("externalId")
                                         .build())
                                 .route53HealthCheckConfig(Route53HealthCheckConfigurationProperty.builder()
                                         .crossAccountRole("crossAccountRole")
                                         .externalId("externalId")
                                         .hostedZoneId("hostedZoneId")
                                         .recordName("recordName")
                                         .recordSets(List.of(Route53ResourceRecordSetProperty.builder()
                                                 .recordSetIdentifier("recordSetIdentifier")
                                                 .region("region")
                                                 .build()))
                                         .timeoutMinutes(123)
                                         .build())
                                 .build())
                         .executionBlockType("executionBlockType")
                         .name("name")
                         .build()))
                 .workflowDescription("workflowDescription")
                 .workflowTargetAction("workflowTargetAction")
                 .workflowTargetRegion("workflowTargetRegion")
                 .build()))
         .build())
 .strategy(mergeStrategy)
 .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	CfnPlanPropsMixin.ArcRoutingControlConfigurationProperty	Configuration for ARC routing controls used in a Region switch plan.
static interface	CfnPlanPropsMixin.ArcRoutingControlStateProperty	Example:
static interface	CfnPlanPropsMixin.AsgProperty	Configuration for an Amazon EC2 Auto Scaling group used in a Region switch plan.
static interface	CfnPlanPropsMixin.AssociatedAlarmProperty	An Amazon CloudWatch alarm associated with a Region switch plan.
static final class	CfnPlanPropsMixin.Builder	A fluent builder for CfnPlanPropsMixin.
static interface	CfnPlanPropsMixin.CustomActionLambdaConfigurationProperty	Configuration for AWS Lambda functions that perform custom actions during a Region switch.
static interface	CfnPlanPropsMixin.DocumentDbConfigurationProperty	Configuration for Amazon DocumentDB global clusters used in a Region switch plan.
static interface	CfnPlanPropsMixin.DocumentDbUngracefulProperty	Configuration for handling failures when performing operations on DocumentDB global clusters.
static interface	CfnPlanPropsMixin.Ec2AsgCapacityIncreaseConfigurationProperty	Configuration for increasing the capacity of Amazon EC2 Auto Scaling groups during a Region switch.
static interface	CfnPlanPropsMixin.Ec2UngracefulProperty	Configuration for handling failures when performing operations on EC2 resources.
static interface	CfnPlanPropsMixin.EcsCapacityIncreaseConfigurationProperty	The configuration for an AWS ECS capacity increase.
static interface	CfnPlanPropsMixin.EcsUngracefulProperty	The settings for ungraceful execution.
static interface	CfnPlanPropsMixin.EksClusterProperty	The AWS EKS cluster execution block configuration.
static interface	CfnPlanPropsMixin.EksResourceScalingConfigurationProperty	The AWS EKS resource scaling configuration.
static interface	CfnPlanPropsMixin.EksResourceScalingUngracefulProperty	The ungraceful settings for AWS EKS resource scaling.
static interface	CfnPlanPropsMixin.ExecutionApprovalConfigurationProperty	Configuration for approval steps in a Region switch plan execution.
static interface	CfnPlanPropsMixin.ExecutionBlockConfigurationProperty	Execution block configurations for a workflow in a Region switch plan.
static interface	CfnPlanPropsMixin.GlobalAuroraConfigurationProperty	Configuration for Amazon Aurora global databases used in a Region switch plan.
static interface	CfnPlanPropsMixin.GlobalAuroraUngracefulProperty	Configuration for handling failures when performing operations on Aurora global databases.
static interface	CfnPlanPropsMixin.HealthCheckStateProperty	Example:
static interface	CfnPlanPropsMixin.KubernetesResourceTypeProperty	Defines the type of Kubernetes resource to scale in an Amazon EKS cluster.
static interface	CfnPlanPropsMixin.KubernetesScalingResourceProperty	Defines a Kubernetes resource to scale in an Amazon EKS cluster.
static interface	CfnPlanPropsMixin.LambdasProperty	Configuration for AWS Lambda functions used in a Region switch plan.
static interface	CfnPlanPropsMixin.LambdaUngracefulProperty	Configuration for handling failures when invoking Lambda functions.
static interface	CfnPlanPropsMixin.ParallelExecutionBlockConfigurationProperty	Configuration for steps that should be executed in parallel during a Region switch.
static interface	CfnPlanPropsMixin.RdsCreateCrossRegionReplicaConfigurationProperty	Example:
static interface	CfnPlanPropsMixin.RdsPromoteReadReplicaConfigurationProperty	Example:
static interface	CfnPlanPropsMixin.RegionSwitchPlanConfigurationProperty	Configuration for nested Region switch plans.
static interface	CfnPlanPropsMixin.ReportConfigurationProperty	Configuration for automatic report generation for plan executions.
static interface	CfnPlanPropsMixin.ReportOutputConfigurationProperty	Configuration for report output destinations used in a Region switch plan.
static interface	CfnPlanPropsMixin.Route53HealthCheckConfigurationProperty	The Amazon Route 53 health check configuration.
static interface	CfnPlanPropsMixin.Route53HealthChecksProperty	Example:
static interface	CfnPlanPropsMixin.Route53ResourceRecordSetProperty	The Amazon Route 53 record set.
static interface	CfnPlanPropsMixin.S3ReportOutputConfigurationProperty	Configuration for delivering generated reports to an Amazon S3 bucket.
static interface	CfnPlanPropsMixin.ServiceProperty	The service for a cross account role.
static interface	CfnPlanPropsMixin.StepProperty	Represents a step in a Region switch plan workflow.
static interface	CfnPlanPropsMixin.TriggerConditionProperty	Defines a condition that must be met for a trigger to fire.
static interface	CfnPlanPropsMixin.TriggerProperty	Defines a condition that can automatically trigger the execution of a Region switch plan.
static interface	CfnPlanPropsMixin.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.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnPlanPropsMixin(CfnPlanMixinProps props)	Create a mixin to apply properties to AWS::ARCRegionSwitch::Plan.
	CfnPlanPropsMixin(CfnPlanMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::ARCRegionSwitch::Plan.
protected	CfnPlanPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnPlanPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnPlanMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

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, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnPlanPropsMixin

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

CfnPlanPropsMixin

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

CfnPlanPropsMixin

@Stability(Stable)
public CfnPlanPropsMixin(@NotNull
 CfnPlanMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::ARCRegionSwitch::Plan.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnPlanPropsMixin

@Stability(Stable)
public CfnPlanPropsMixin(@NotNull
 CfnPlanMixinProps props)

Create a mixin to apply properties to AWS::ARCRegionSwitch::Plan.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnPlanMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()