Package software.amazon.awscdk.services.arczonalshift

Class CfnZonalAutoshiftConfiguration

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.arczonalshift.CfnZonalAutoshiftConfiguration
All Implemented Interfaces:
IInspectable, IZonalAutoshiftConfigurationRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-29T11:15:32.819Z") @Stability(Stable) public class CfnZonalAutoshiftConfiguration extends CfnResource implements IInspectable, IZonalAutoshiftConfigurationRef
The zonal autoshift configuration for a resource includes the practice run configuration and the status for running autoshifts, zonal autoshift status.

When a resource has a practice run configuation, ARC starts weekly zonal shifts for the resource, to shift traffic away from an Availability Zone. Weekly practice runs help you to make sure that your application can continue to operate normally with the loss of one Availability Zone.

You can update the zonal autoshift autoshift status to enable or disable zonal autoshift. When zonal autoshift is ENABLED , you authorize AWS to shift away resource traffic for an application from an Availability Zone during events, on your behalf, to help reduce time to recovery. Traffic is also shifted away for the required weekly practice runs.

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.arczonalshift.*;
 CfnZonalAutoshiftConfiguration cfnZonalAutoshiftConfiguration = CfnZonalAutoshiftConfiguration.Builder.create(this, "MyCfnZonalAutoshiftConfiguration")
         .resourceIdentifier("resourceIdentifier")
         // the properties below are optional
         .practiceRunConfiguration(PracticeRunConfigurationProperty.builder()
                 .outcomeAlarms(List.of(ControlConditionProperty.builder()
                         .alarmIdentifier("alarmIdentifier")
                         .type("type")
                         .build()))
                 // the properties below are optional
                 .blockedDates(List.of("blockedDates"))
                 .blockedWindows(List.of("blockedWindows"))
                 .blockingAlarms(List.of(ControlConditionProperty.builder()
                         .alarmIdentifier("alarmIdentifier")
                         .type("type")
                         .build()))
                 .build())
         .zonalAutoshiftStatus("zonalAutoshiftStatus")
         .build();

See Also:

  • 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

    • CfnZonalAutoshiftConfiguration

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

    • CfnZonalAutoshiftConfiguration

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

    • CfnZonalAutoshiftConfiguration

      @Stability(Stable) public CfnZonalAutoshiftConfiguration(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnZonalAutoshiftConfigurationProps props)
      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.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getZonalAutoshiftConfigurationRef

      @Stability(Stable) @NotNull public ZonalAutoshiftConfigurationReference getZonalAutoshiftConfigurationRef()
      A reference to a ZonalAutoshiftConfiguration resource.
      Specified by:
      getZonalAutoshiftConfigurationRef in interface IZonalAutoshiftConfigurationRef

    • getResourceIdentifier

      @Stability(Stable) @NotNull public String getResourceIdentifier()
      The identifier for the resource that AWS shifts traffic for.

    • setResourceIdentifier

      @Stability(Stable) public void setResourceIdentifier(@NotNull String value)
      The identifier for the resource that AWS shifts traffic for.

    • getPracticeRunConfiguration

      @Stability(Stable) @Nullable public Object getPracticeRunConfiguration()
      A practice run configuration for a resource includes the Amazon CloudWatch alarms that you've specified for a practice run, as well as any blocked dates or blocked windows for the practice run.

      Returns union: either IResolvable or CfnZonalAutoshiftConfiguration.PracticeRunConfigurationProperty

    • setPracticeRunConfiguration

      @Stability(Stable) public void setPracticeRunConfiguration(@Nullable IResolvable value)
      A practice run configuration for a resource includes the Amazon CloudWatch alarms that you've specified for a practice run, as well as any blocked dates or blocked windows for the practice run.

    • setPracticeRunConfiguration

      @Stability(Stable) public void setPracticeRunConfiguration(@Nullable CfnZonalAutoshiftConfiguration.PracticeRunConfigurationProperty value)
      A practice run configuration for a resource includes the Amazon CloudWatch alarms that you've specified for a practice run, as well as any blocked dates or blocked windows for the practice run.

    • getZonalAutoshiftStatus

      @Stability(Stable) @Nullable public String getZonalAutoshiftStatus()
      When zonal autoshift is ENABLED , you authorize AWS to shift away resource traffic for an application from an Availability Zone during events, on your behalf, to help reduce time to recovery.

    • setZonalAutoshiftStatus

      @Stability(Stable) public void setZonalAutoshiftStatus(@Nullable String value)
      When zonal autoshift is ENABLED , you authorize AWS to shift away resource traffic for an application from an Availability Zone during events, on your behalf, to help reduce time to recovery.