interface ScheduledQueryConfigurationProperty

Language	Type name
.NET	Amazon.CDK.AWS.CloudWatch.CfnLogAlarm.ScheduledQueryConfigurationProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awscloudwatch#CfnLogAlarm_ScheduledQueryConfigurationProperty
Java	software.amazon.awscdk.services.cloudwatch.CfnLogAlarm.ScheduledQueryConfigurationProperty
Python	aws_cdk.aws_cloudwatch.CfnLogAlarm.ScheduledQueryConfigurationProperty
TypeScript	aws-cdk-lib » aws_cloudwatch » CfnLogAlarm » ScheduledQueryConfigurationProperty

The scheduled query configuration for the log alarm.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cloudwatch as cloudwatch } from 'aws-cdk-lib';
const scheduledQueryConfigurationProperty: cloudwatch.CfnLogAlarm.ScheduledQueryConfigurationProperty = {
  aggregationExpression: 'aggregationExpression',
  logGroupIdentifiers: ['logGroupIdentifiers'],
  queryLanguage: 'queryLanguage',
  queryString: 'queryString',
  scheduleConfiguration: {
    scheduleExpression: 'scheduleExpression',

    // the properties below are optional
    endTimeOffset: 123,
    startTimeOffset: 123,
  },
  scheduledQueryRoleArn: 'scheduledQueryRoleArn',
};

Properties

Name	Type	Description
aggregationExpression	string	The aggregation expression for the scheduled query, e.g. count(*) or avg(latency) by host.
logGroupIdentifiers	string[]	The log groups to query.
queryLanguage	string	The query language to use for the scheduled query (CWLI or SQL).
queryString	string	The query string to execute against the specified log groups.
scheduleConfiguration	IResolvable | ScheduleConfigurationProperty	The schedule configuration for the scheduled query.
scheduledQueryRoleArn	string	The ARN of the IAM role that grants permissions to execute the scheduled query.

---

aggregationExpression

Type: string

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

---

logGroupIdentifiers

Type: string[]

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

---

queryLanguage

Type: string

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

---

queryString

Type: string

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

---

scheduleConfiguration

Type: IResolvable | ScheduleConfigurationProperty

The schedule configuration for the scheduled query.

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

---

scheduledQueryRoleArn

Type: string

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