Package software.amazon.awscdk.services.cloudwatch

Interface CfnLogAlarm.ScheduledQueryConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnLogAlarm.ScheduledQueryConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnLogAlarm

@Stability(Stable)
public static interface CfnLogAlarm.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.services.cloudwatch.*;
 ScheduledQueryConfigurationProperty scheduledQueryConfigurationProperty = ScheduledQueryConfigurationProperty.builder()
         .aggregationExpression("aggregationExpression")
         .logGroupIdentifiers(List.of("logGroupIdentifiers"))
         .queryLanguage("queryLanguage")
         .queryString("queryString")
         .scheduleConfiguration(ScheduleConfigurationProperty.builder()
                 .scheduleExpression("scheduleExpression")
                 // the properties below are optional
                 .endTimeOffset(123)
                 .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	CfnLogAlarm.ScheduledQueryConfigurationProperty.Builder	A builder for CfnLogAlarm.ScheduledQueryConfigurationProperty
static final class	CfnLogAlarm.ScheduledQueryConfigurationProperty.Jsii$Proxy	An implementation for CfnLogAlarm.ScheduledQueryConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnLogAlarm.ScheduledQueryConfigurationProperty.Builder	builder()
String	getAggregationExpression()	The aggregation expression for the scheduled query, e.g.
List<String>	getLogGroupIdentifiers()	The log groups to query.
String	getQueryLanguage()	The query language to use for the scheduled query (CWLI or SQL).
String	getQueryString()	The query string to execute against the specified log groups.
Object	getScheduleConfiguration()	The schedule configuration for the scheduled query.
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)
@NotNull
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)
@NotNull
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

getQueryLanguage

@Stability(Stable)
@NotNull
String getQueryLanguage()

The query language to use for the scheduled query (CWLI or SQL).

See Also:

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

getQueryString

@Stability(Stable)
@NotNull
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)
@NotNull
Object getScheduleConfiguration()

The schedule configuration for the scheduled query.

Returns union: either IResolvable or CfnLogAlarm.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)
@NotNull
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 CfnLogAlarm.ScheduledQueryConfigurationProperty.Builder builder()

Returns:

a CfnLogAlarm.ScheduledQueryConfigurationProperty.Builder of CfnLogAlarm.ScheduledQueryConfigurationProperty