Package software.amazon.awscdk.services.arczonalshift

Interface CfnZonalAutoshiftConfigurationProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnZonalAutoshiftConfigurationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-23T05:56:11.505Z")
@Stability(Stable)
public interface CfnZonalAutoshiftConfigurationProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnZonalAutoshiftConfiguration.

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.*;
 CfnZonalAutoshiftConfigurationProps cfnZonalAutoshiftConfigurationProps = CfnZonalAutoshiftConfigurationProps.builder()
         .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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-arczonalshift-zonalautoshiftconfiguration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnZonalAutoshiftConfigurationProps.Builder	A builder for CfnZonalAutoshiftConfigurationProps
static final class	CfnZonalAutoshiftConfigurationProps.Jsii$Proxy	An implementation for CfnZonalAutoshiftConfigurationProps

Method Summary

Modifier and Type	Method	Description
static CfnZonalAutoshiftConfigurationProps.Builder	builder()
default 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.
String	getResourceIdentifier()	The identifier for the resource that AWS shifts traffic for.
default 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.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getResourceIdentifier

@Stability(Stable)
@NotNull
String getResourceIdentifier()

The identifier for the resource that AWS shifts traffic for.

The identifier is the Amazon Resource Name (ARN) for the resource.

At this time, supported resources are Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-arczonalshift-zonalautoshiftconfiguration.html#cfn-arczonalshift-zonalautoshiftconfiguration-resourceidentifier

getPracticeRunConfiguration

@Stability(Stable)
@Nullable
default 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.

When a resource has a practice run configuration, Route 53 ARC shifts traffic for the resource weekly for practice runs.

Practice runs are required for zonal autoshift. The zonal shifts that Route 53 ARC starts for practice runs help you to ensure that shifting away traffic from an Availability Zone during an autoshift is safe for your application.

You can update or delete a practice run configuration. Before you delete a practice run configuration, you must disable zonal autoshift for the resource. A practice run configuration is required when zonal autoshift is enabled.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-arczonalshift-zonalautoshiftconfiguration.html#cfn-arczonalshift-zonalautoshiftconfiguration-practicerunconfiguration

getZonalAutoshiftStatus

@Stability(Stable)
@Nullable
default 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.

Traffic is also shifted away for the required weekly practice runs.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-arczonalshift-zonalautoshiftconfiguration.html#cfn-arczonalshift-zonalautoshiftconfiguration-zonalautoshiftstatus

builder

@Stability(Stable)
static CfnZonalAutoshiftConfigurationProps.Builder builder()

Returns:

a CfnZonalAutoshiftConfigurationProps.Builder of CfnZonalAutoshiftConfigurationProps