Package software.amazon.awscdk.services.arczonalshift

Interface CfnZonalAutoshiftConfiguration.PracticeRunConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnZonalAutoshiftConfiguration.PracticeRunConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnZonalAutoshiftConfiguration

@Stability(Stable)
public static interface CfnZonalAutoshiftConfiguration.PracticeRunConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

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 configuation, Route 53 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 or delete a practice run configuration. When you delete a practice run configuration, zonal autoshift is disabled for the resource. A practice run configuration is required when zonal autoshift is enabled.

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.*;
 PracticeRunConfigurationProperty practiceRunConfigurationProperty = 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();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnZonalAutoshiftConfiguration.PracticeRunConfigurationProperty.Builder	builder()
default List<String>	getBlockedDates()	An array of one or more dates that you can specify when AWS does not start practice runs for a resource.
default List<String>	getBlockedWindows()	An array of one or more days and times that you can specify when Route 53 ARC does not start practice runs for a resource.
default Object	getBlockingAlarms()	An optional alarm that you can specify that blocks practice runs when the alarm is in an ALARM state.
Object	getOutcomeAlarms()	The alarm that you specify to monitor the health of your application during practice runs.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getOutcomeAlarms

@Stability(Stable)
@NotNull
Object getOutcomeAlarms()

The alarm that you specify to monitor the health of your application during practice runs.

When the outcome alarm goes into an ALARM state, the practice run is ended and the outcome is set to FAILED .

See Also:

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

getBlockedDates

@Stability(Stable)
@Nullable
default List<String> getBlockedDates()

An array of one or more dates that you can specify when AWS does not start practice runs for a resource.

Dates are in UTC.

Specify blocked dates in the format YYYY-MM-DD , separated by spaces.

See Also:

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

getBlockedWindows

@Stability(Stable)
@Nullable
default List<String> getBlockedWindows()

An array of one or more days and times that you can specify when Route 53 ARC does not start practice runs for a resource.

Days and times are in UTC.

Specify blocked windows in the format DAY:HH:MM-DAY:HH:MM , separated by spaces. For example, MON:18:30-MON:19:30 TUE:18:30-TUE:19:30 .

See Also:

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

getBlockingAlarms

@Stability(Stable)
@Nullable
default Object getBlockingAlarms()

An optional alarm that you can specify that blocks practice runs when the alarm is in an ALARM state.

When a blocking alarm goes into an ALARM state, it prevents practice runs from being started, and ends practice runs that are in progress.

See Also:

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

builder

@Stability(Stable)
static CfnZonalAutoshiftConfiguration.PracticeRunConfigurationProperty.Builder builder()

Returns:

a CfnZonalAutoshiftConfiguration.PracticeRunConfigurationProperty.Builder of CfnZonalAutoshiftConfiguration.PracticeRunConfigurationProperty