interface WarmUpConfigurationProperty
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.CfnPropertyMixins.AWS.CloudWatch.CfnAlarmPropsMixin.WarmUpConfigurationProperty |
 Go | github.com/aws/aws-cdk-go/awscdkcfnpropertymixins/v2/awscloudwatch#CfnAlarmPropsMixin_WarmUpConfigurationProperty |
 Java | software.amazon.awscdk.cfnpropertymixins.services.cloudwatch.CfnAlarmPropsMixin.WarmUpConfigurationProperty |
 Python | aws_cdk.cfn_property_mixins.aws_cloudwatch.CfnAlarmPropsMixin.WarmUpConfigurationProperty |
 TypeScript | @aws-cdk/cfn-property-mixins » aws_cloudwatch » CfnAlarmPropsMixin » WarmUpConfigurationProperty |
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cloudwatch as cloudwatch } from '@aws-cdk/cfn-property-mixins';
const warmUpConfigurationProperty: cloudwatch.CfnAlarmPropsMixin.WarmUpConfigurationProperty = {
onlyStartEvaluatingAfterWarmUpPeriodEnds: false,
warmUpPeriodDurationInMinutes: 123,
};
Properties
| Name | Type | Description |
|---|---|---|
| only | boolean | IResolvable | Specifies whether the alarm waits for the full warm-up period before it starts evaluating. |
| warm | number | The length of the warm-up period, in minutes. |
onlyStartEvaluatingAfterWarmUpPeriodEnds?
Type:
boolean | IResolvable
(optional)
Specifies whether the alarm waits for the full warm-up period before it starts evaluating.
If true, the alarm waits the entire WarmUpPeriodDurationInMinutes before it starts evaluating, even if metric data arrives earlier. If false, the alarm ends the warm-up period early and starts evaluating as soon as it has enough metric data to fill its evaluation window. This is the default behavior.
warmUpPeriodDurationInMinutes?
Type:
number
(optional)
The length of the warm-up period, in minutes.
For this duration after you create or update the alarm, the alarm stays in INSUFFICIENT_DATA and doesn't perform alarm actions. Valid values range from 1 to 2880 minutes (2 days). You can change this value while the alarm is still in its warm-up period. Changes have no effect after the warm-up period ends.