All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:: CfnPlanProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-11-13T16:09:59.122Z") @Stability(Stable) public interface CfnPlanProps extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnPlan.

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_;
 CfnPlanProps cfnPlanProps = CfnPlanProps.builder()
         .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:

Nested Class Summary

Nested Classes

Modifier and Type

Interface

Description

static final class

CfnPlanProps.Builder

A builder for CfnPlanProps

static final class

CfnPlanProps.Jsii$Proxy

An implementation for CfnPlanProps
Method Summary

Modifier and Type

Method

Description

static CfnPlanProps.Builder

builder()

default Object

getAssociatedAlarms()

The associated application health alarms for a plan.

default String

getDescription()

The description for a plan.

String

getExecutionRole()

The execution role for a plan.

String

getName()

The name for a plan.

default 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).

default Number

getRecoveryTimeObjectiveMinutes()

The recovery time objective for a plan.

List<String>

getRegions()

The AWS Regions for a plan.

default Map<String,String>

getTags()

default Object

getTriggers()

The triggers for a plan.

Object

getWorkflows()

The workflows for a plan.

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

Method Details
- getExecutionRole
  
  @Stability(Stable) @NotNull String getExecutionRole()
  
  The execution role for a plan.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-arcregionswitch-plan.html#cfn-arcregionswitch-plan-executionrole
- getName
  
  @Stability(Stable) @NotNull String getName()
  
  The name for a plan.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-arcregionswitch-plan.html#cfn-arcregionswitch-plan-name
- getRecoveryApproach
  
  @Stability(Stable) @NotNull String getRecoveryApproach()
  
  The recovery approach for a Region switch plan, which can be active/active (activeActive) or active/passive (activePassive).
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-arcregionswitch-plan.html#cfn-arcregionswitch-plan-recoveryapproach
- getRegions
  
  @Stability(Stable) @NotNull List<String> getRegions()
  
  The AWS Regions for a plan.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-arcregionswitch-plan.html#cfn-arcregionswitch-plan-regions
- getWorkflows
  
  @Stability(Stable) @NotNull Object getWorkflows()
  
  The workflows for a plan.
  Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnPlan.WorkflowProperty>
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-arcregionswitch-plan.html#cfn-arcregionswitch-plan-workflows
- getAssociatedAlarms
  
  @Stability(Stable) @Nullable default Object getAssociatedAlarms()
  
  The associated application health alarms for a plan.
  Returns union: either IResolvable or Mapinvalid input: '<'String, either IResolvable or CfnPlan.AssociatedAlarmProperty>
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-arcregionswitch-plan.html#cfn-arcregionswitch-plan-associatedalarms
- getDescription
  
  @Stability(Stable) @Nullable default String getDescription()
  
  The description for a plan.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-arcregionswitch-plan.html#cfn-arcregionswitch-plan-description
- getPrimaryRegion
  
  @Stability(Stable) @Nullable default String getPrimaryRegion()
  
  The primary Region for a plan.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-arcregionswitch-plan.html#cfn-arcregionswitch-plan-primaryregion
- getRecoveryTimeObjectiveMinutes
  
  @Stability(Stable) @Nullable default Number getRecoveryTimeObjectiveMinutes()
  
  The recovery time objective for a plan.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-arcregionswitch-plan.html#cfn-arcregionswitch-plan-recoverytimeobjectiveminutes
- getTags
  
  @Stability(Stable) @Nullable default Map<String,String> getTags()
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-arcregionswitch-plan.html#cfn-arcregionswitch-plan-tags
- getTriggers
  
  @Stability(Stable) @Nullable default Object getTriggers()
  
  The triggers for a plan.
  Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnPlan.TriggerProperty>
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-arcregionswitch-plan.html#cfn-arcregionswitch-plan-triggers
- builder
  
  @Stability(Stable) static CfnPlanProps.Builder builder()
  
  Returns:
  
  a CfnPlanProps.Builder of CfnPlanProps

Interface CfnPlanProps

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Details

getExecutionRole

getName

getRecoveryApproach

getRegions

getWorkflows

getAssociatedAlarms

getDescription

getPrimaryRegion

getRecoveryTimeObjectiveMinutes

getTags

getTriggers

builder