interface PracticeRunConfigurationProperty
Language | Type name |
---|---|
.NET | Amazon.CDK.aws_arczonalshift.CfnZonalAutoshiftConfiguration.PracticeRunConfigurationProperty |
Go | github.com/aws/aws-cdk-go/awscdk/v2/awsarczonalshift#CfnZonalAutoshiftConfiguration_PracticeRunConfigurationProperty |
Java | software.amazon.awscdk.services.arczonalshift.CfnZonalAutoshiftConfiguration.PracticeRunConfigurationProperty |
Python | aws_cdk.aws_arczonalshift.CfnZonalAutoshiftConfiguration.PracticeRunConfigurationProperty |
TypeScript | aws-cdk-lib » aws_arczonalshift » CfnZonalAutoshiftConfiguration » PracticeRunConfigurationProperty |
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 { aws_arczonalshift as arczonalshift } from 'aws-cdk-lib';
const practiceRunConfigurationProperty: arczonalshift.CfnZonalAutoshiftConfiguration.PracticeRunConfigurationProperty = {
outcomeAlarms: [{
alarmIdentifier: 'alarmIdentifier',
type: 'type',
}],
// the properties below are optional
blockedDates: ['blockedDates'],
blockedWindows: ['blockedWindows'],
blockingAlarms: [{
alarmIdentifier: 'alarmIdentifier',
type: 'type',
}],
};
Properties
Name | Type | Description |
---|---|---|
outcome | IResolvable | IResolvable | Control [] | The alarm that you specify to monitor the health of your application during practice runs. |
blocked | string[] | An array of one or more dates that you can specify when AWS does not start practice runs for a resource. |
blocked | string[] | 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. |
blocking | IResolvable | IResolvable | Control [] | An optional alarm that you can specify that blocks practice runs when the alarm is in an ALARM state. |
outcomeAlarms
Type:
IResolvable
|
IResolvable
|
Control
[]
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
.
blockedDates?
Type:
string[]
(optional)
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.
blockedWindows?
Type:
string[]
(optional)
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
.
blockingAlarms?
Type:
IResolvable
|
IResolvable
|
Control
[]
(optional)
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.