Package software.amazon.awscdk.services.cloudwatch

Interface CfnAlarm.EvaluationWindowProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAlarm.EvaluationWindowProperty.Jsii$Proxy

Enclosing class:

CfnAlarm

@Stability(Stable)
public static interface CfnAlarm.EvaluationWindowProperty
extends software.amazon.jsii.JsiiSerializable

The evaluation window that an alarm uses to select the range of metric data that it evaluates each time it runs.

This is a union type. Set exactly one of its members, SlidingWindow or WallClockWindow. If you don't set EvaluationWindow, the alarm uses a SlidingWindow by default. For more information, see Alarm evaluation windows in the CloudWatch User Guide.

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.cloudwatch.*;
 Object slidingWindow;
 EvaluationWindowProperty evaluationWindowProperty = EvaluationWindowProperty.builder()
         .slidingWindow(slidingWindow)
         .wallClockWindow(WallClockWindowProperty.builder()
                 .timezone("timezone")
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-evaluationwindow.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnAlarm.EvaluationWindowProperty.Builder	builder()
default Object	getSlidingWindow()	A sliding window, which advances each time the alarm is evaluated, forming a rolling time window.
default Object	getWallClockWindow()	An evaluation window that aligns the evaluated range to fixed clock boundaries that match the alarm's period, such as the top of the hour, midnight, or the start of the calendar week, optionally in a specific time zone.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getSlidingWindow

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

A sliding window, which advances each time the alarm is evaluated, forming a rolling time window.

This is the default evaluation window.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-evaluationwindow.html#cfn-cloudwatch-alarm-evaluationwindow-slidingwindow

getWallClockWindow

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

An evaluation window that aligns the evaluated range to fixed clock boundaries that match the alarm's period, such as the top of the hour, midnight, or the start of the calendar week, optionally in a specific time zone.

When you use a wall clock window, the alarm's period must be 1 minute (60 seconds), 5 minutes (300 seconds), 1 hour (3,600 seconds), 1 day (86,400 seconds), or 1 week (604,800 seconds). Other period values aren't supported with a wall clock window. Choose a wall clock window when your monitoring is tied to a business or calendar period, such as daily reports, batch jobs, or backups, or when you want alarm evaluations to match the periods shown on a metric dashboard.

Returns union: either IResolvable or CfnAlarm.WallClockWindowProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-evaluationwindow.html#cfn-cloudwatch-alarm-evaluationwindow-wallclockwindow

builder

@Stability(Stable)
static CfnAlarm.EvaluationWindowProperty.Builder builder()

Returns:

a CfnAlarm.EvaluationWindowProperty.Builder of CfnAlarm.EvaluationWindowProperty