All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:: CfnLogAlarmMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.133.0 (build 0f43e37)", date="2026-07-02T13:32:52.936Z") @Stability(Stable) public interface CfnLogAlarmMixinProps extends software.amazon.jsii.JsiiSerializable

Properties for CfnLogAlarmPropsMixin.

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.*;
 CfnLogAlarmMixinProps cfnLogAlarmMixinProps = CfnLogAlarmMixinProps.builder()
         .actionLogLineCount(123)
         .actionLogLineRoleArn("actionLogLineRoleArn")
         .actionsEnabled(false)
         .alarmActions(List.of("alarmActions"))
         .alarmDescription("alarmDescription")
         .alarmName("alarmName")
         .comparisonOperator("comparisonOperator")
         .insufficientDataActions(List.of("insufficientDataActions"))
         .okActions(List.of("okActions"))
         .queryResultsToAlarm(123)
         .queryResultsToEvaluate(123)
         .scheduledQueryConfiguration(ScheduledQueryConfigurationProperty.builder()
                 .aggregationExpression("aggregationExpression")
                 .logGroupIdentifiers(List.of("logGroupIdentifiers"))
                 .queryString("queryString")
                 .scheduleConfiguration(ScheduleConfigurationProperty.builder()
                         .endTimeOffset(123)
                         .scheduleExpression("scheduleExpression")
                         .startTimeOffset(123)
                         .build())
                 .scheduledQueryRoleArn("scheduledQueryRoleArn")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .threshold(123)
         .treatMissingData("treatMissingData")
         .build();

See Also:

Nested Class Summary

Nested Classes

Modifier and Type

Interface

Description

static final class

CfnLogAlarmMixinProps.Builder

A builder for CfnLogAlarmMixinProps

static final class

CfnLogAlarmMixinProps.Jsii$Proxy

An implementation for CfnLogAlarmMixinProps
Method Summary

Modifier and Type

Method

Description

static CfnLogAlarmMixinProps.Builder

builder()

default Number

getActionLogLineCount()

The number of log lines to include in alarm notifications.

default String

getActionLogLineRoleArn()

The ARN of the IAM role that grants CloudWatch permissions to fetch log lines for alarm notifications.

default Object

getActionsEnabled()

Indicates whether actions should be executed during any changes to the alarm state.

default List<String>

getAlarmActions()

The list of actions to execute when this alarm transitions into an ALARM state from any other state.

default String

getAlarmDescription()

The description of the log alarm.

default String

getAlarmName()

The name of the log alarm.

default String

getComparisonOperator()

The arithmetic operation to use when comparing the specified threshold and the query results.

default List<String>

getInsufficientDataActions()

The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state.

default List<String>

getOkActions()

The actions to execute when this alarm transitions to the OK state from any other state.

default Number

getQueryResultsToAlarm()

The number of query results that must be breaching to trigger the alarm.

default Number

getQueryResultsToEvaluate()

The number of query results over which data is compared to the specified threshold.

default Object

getScheduledQueryConfiguration()

The scheduled query configuration for the log alarm.

default List<CfnTag>

getTags()

A list of key-value pairs to associate with the log alarm.

default Number

getThreshold()

The value to compare against the results of the scheduled query evaluation.

default String

getTreatMissingData()

Sets how this alarm is to handle missing data points.

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

Method Details
- getActionLogLineCount
  
  @Stability(Stable) @Nullable default Number getActionLogLineCount()
  
  The number of log lines to include in alarm notifications.
  Valid values are 0 to 50.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-logalarm.html#cfn-cloudwatch-logalarm-actionloglinecount
- getActionLogLineRoleArn
  
  @Stability(Stable) @Nullable default String getActionLogLineRoleArn()
  
  The ARN of the IAM role that grants CloudWatch permissions to fetch log lines for alarm notifications.
  Required when ActionLogLineCount is greater than 0.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-logalarm.html#cfn-cloudwatch-logalarm-actionloglinerolearn
- getActionsEnabled
  
  @Stability(Stable) @Nullable default Object getActionsEnabled()
  
  Indicates whether actions should be executed during any changes to the alarm state.
  The default is TRUE.
  Returns union: either Boolean or IResolvable
  Default: - true
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-logalarm.html#cfn-cloudwatch-logalarm-actionsenabled
- getAlarmActions
  
  @Stability(Stable) @Nullable default List<String> getAlarmActions()
  
  The list of actions to execute when this alarm transitions into an ALARM state from any other state.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-logalarm.html#cfn-cloudwatch-logalarm-alarmactions
- getAlarmDescription
  
  @Stability(Stable) @Nullable default String getAlarmDescription()
  
  The description of the log alarm.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-logalarm.html#cfn-cloudwatch-logalarm-alarmdescription
- getAlarmName
  
  @Stability(Stable) @Nullable default String getAlarmName()
  
  The name of the log alarm.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-logalarm.html#cfn-cloudwatch-logalarm-alarmname
- getComparisonOperator
  
  @Stability(Stable) @Nullable default String getComparisonOperator()
  
  The arithmetic operation to use when comparing the specified threshold and the query results.
  Valid values are GreaterThanOrEqualToThreshold, GreaterThanThreshold, LessThanThreshold, and LessThanOrEqualToThreshold.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-logalarm.html#cfn-cloudwatch-logalarm-comparisonoperator
- getInsufficientDataActions
  
  @Stability(Stable) @Nullable default List<String> getInsufficientDataActions()
  
  The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-logalarm.html#cfn-cloudwatch-logalarm-insufficientdataactions
- getOkActions
  
  @Stability(Stable) @Nullable default List<String> getOkActions()
  
  The actions to execute when this alarm transitions to the OK state from any other state.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-logalarm.html#cfn-cloudwatch-logalarm-okactions
- getQueryResultsToAlarm
  
  @Stability(Stable) @Nullable default Number getQueryResultsToAlarm()
  
  The number of query results that must be breaching to trigger the alarm.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-logalarm.html#cfn-cloudwatch-logalarm-queryresultstoalarm
- getQueryResultsToEvaluate
  
  @Stability(Stable) @Nullable default Number getQueryResultsToEvaluate()
  
  The number of query results over which data is compared to the specified threshold.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-logalarm.html#cfn-cloudwatch-logalarm-queryresultstoevaluate
- getScheduledQueryConfiguration
  
  @Stability(Stable) @Nullable default Object getScheduledQueryConfiguration()
  
  The scheduled query configuration for the log alarm.
  Returns union: either IResolvable or CfnLogAlarmPropsMixin.ScheduledQueryConfigurationProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-logalarm.html#cfn-cloudwatch-logalarm-scheduledqueryconfiguration
- getTags
  
  @Stability(Stable) @Nullable default List<CfnTag> getTags()
  
  A list of key-value pairs to associate with the log alarm.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-logalarm.html#cfn-cloudwatch-logalarm-tags
- getThreshold
  
  @Stability(Stable) @Nullable default Number getThreshold()
  
  The value to compare against the results of the scheduled query evaluation.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-logalarm.html#cfn-cloudwatch-logalarm-threshold
- getTreatMissingData
  
  @Stability(Stable) @Nullable default String getTreatMissingData()
  
  Sets how this alarm is to handle missing data points.
  Valid values are breaching, notBreaching, ignore, and missing.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-logalarm.html#cfn-cloudwatch-logalarm-treatmissingdata
- builder
  
  @Stability(Stable) static CfnLogAlarmMixinProps.Builder builder()
  
  Returns:
  
  a CfnLogAlarmMixinProps.Builder of CfnLogAlarmMixinProps

Interface CfnLogAlarmMixinProps

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Details

getActionLogLineCount

getActionLogLineRoleArn

getActionsEnabled

getAlarmActions

getAlarmDescription

getAlarmName

getComparisonOperator

getInsufficientDataActions

getOkActions

getQueryResultsToAlarm

getQueryResultsToEvaluate

getScheduledQueryConfiguration

getTags

getThreshold

getTreatMissingData

builder