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

Interface CfnLogAlarmPropsMixin.ScheduledQueryConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnLogAlarmPropsMixin.ScheduledQueryConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnLogAlarmPropsMixin

@Stability(Stable)
public static interface CfnLogAlarmPropsMixin.ScheduledQueryConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

The scheduled query configuration for the log alarm.

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.*;
 ScheduledQueryConfigurationProperty scheduledQueryConfigurationProperty = ScheduledQueryConfigurationProperty.builder()
         .aggregationExpression("aggregationExpression")
         .logGroupIdentifiers(List.of("logGroupIdentifiers"))
         .queryString("queryString")
         .scheduleConfiguration(ScheduleConfigurationProperty.builder()
                 .endTimeOffset(123)
                 .scheduleExpression("scheduleExpression")
                 .startTimeOffset(123)
                 .build())
         .scheduledQueryRoleArn("scheduledQueryRoleArn")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnLogAlarmPropsMixin.ScheduledQueryConfigurationProperty.Builder	builder()
default String	getAggregationExpression()	The aggregation expression for the scheduled query, e.g.
default List<String>	getLogGroupIdentifiers()	The log groups to query.
default String	getQueryString()	The query string to execute against the specified log groups.
default Object	getScheduleConfiguration()	The schedule configuration for the scheduled query.
default String	getScheduledQueryRoleArn()	The ARN of the IAM role that grants permissions to execute the scheduled query.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAggregationExpression

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

The aggregation expression for the scheduled query, e.g. count(*) or avg(latency) by host.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-logalarm-scheduledqueryconfiguration.html#cfn-cloudwatch-logalarm-scheduledqueryconfiguration-aggregationexpression

getLogGroupIdentifiers

@Stability(Stable)
@Nullable
default List<String> getLogGroupIdentifiers()

The log groups to query.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-logalarm-scheduledqueryconfiguration.html#cfn-cloudwatch-logalarm-scheduledqueryconfiguration-loggroupidentifiers

getQueryString

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

The query string to execute against the specified log groups.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-logalarm-scheduledqueryconfiguration.html#cfn-cloudwatch-logalarm-scheduledqueryconfiguration-querystring

getScheduleConfiguration

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

The schedule configuration for the scheduled query.

Returns union: either IResolvable or CfnLogAlarmPropsMixin.ScheduleConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-logalarm-scheduledqueryconfiguration.html#cfn-cloudwatch-logalarm-scheduledqueryconfiguration-scheduleconfiguration

getScheduledQueryRoleArn

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

The ARN of the IAM role that grants permissions to execute the scheduled query.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-logalarm-scheduledqueryconfiguration.html#cfn-cloudwatch-logalarm-scheduledqueryconfiguration-scheduledqueryrolearn

builder

@Stability(Stable)
static CfnLogAlarmPropsMixin.ScheduledQueryConfigurationProperty.Builder builder()

Returns:

a CfnLogAlarmPropsMixin.ScheduledQueryConfigurationProperty.Builder of CfnLogAlarmPropsMixin.ScheduledQueryConfigurationProperty