Package software.amazon.awscdk.cfnpropertymixins.services.cloudwatch

Interface CfnAlarmPropsMixin.AlarmPromQLCriteriaProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAlarmPropsMixin.AlarmPromQLCriteriaProperty.Jsii$Proxy

Enclosing class:

CfnAlarmPropsMixin

@Stability(Stable)
public static interface CfnAlarmPropsMixin.AlarmPromQLCriteriaProperty
extends software.amazon.jsii.JsiiSerializable

Contains the configuration that determines how a PromQL alarm evaluates its contributors, including the query to run and the durations that define when contributors transition between states.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.cloudwatch.*;
 AlarmPromQLCriteriaProperty alarmPromQLCriteriaProperty = AlarmPromQLCriteriaProperty.builder()
         .pendingPeriod(123)
         .query("query")
         .recoveryPeriod(123)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnAlarmPropsMixin.AlarmPromQLCriteriaProperty.Builder	builder()
default Number	getPendingPeriod()	The duration, in seconds, that a contributor must be continuously breaching before it transitions to the ALARM state.
default String	getQuery()	The PromQL query that the alarm evaluates.
default Number	getRecoveryPeriod()	The duration, in seconds, that a contributor must continuously not be breaching before it transitions back to the OK state.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getPendingPeriod

@Stability(Stable)
@Nullable
default Number getPendingPeriod()

The duration, in seconds, that a contributor must be continuously breaching before it transitions to the ALARM state.

See Also:

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

getQuery

@Stability(Stable)
@Nullable
default String getQuery()

The PromQL query that the alarm evaluates.

The query must return a result of vector type. Each entry in the vector result represents an alarm contributor.

See Also:

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

getRecoveryPeriod

@Stability(Stable)
@Nullable
default Number getRecoveryPeriod()

The duration, in seconds, that a contributor must continuously not be breaching before it transitions back to the OK state.

See Also:

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

builder

@Stability(Stable)
static CfnAlarmPropsMixin.AlarmPromQLCriteriaProperty.Builder builder()

Returns:

a CfnAlarmPropsMixin.AlarmPromQLCriteriaProperty.Builder of CfnAlarmPropsMixin.AlarmPromQLCriteriaProperty