cloudwatch/aws.sdk.kotlin.services.cloudwatch.model/ScheduledQueryConfiguration

ScheduledQueryConfiguration

class ScheduledQueryConfiguration

The configuration of the CloudWatch Logs scheduled query that backs a log alarm.

Types

Builder

class Builder

Companion

object Companion

Properties

aggregationExpression

val aggregationExpression: String?

The expression that defines how to aggregate query results into one or more scalar values for alarm evaluation. For example, count(*) or avg(latency) by host | sort desc. Length constraints: minimum 1 character, maximum 2048 characters.

logGroupIdentifiers

val logGroupIdentifiers: List<String>?

The log groups to query. Each entry can be a log group name or ARN. Use the ARN form when querying log groups in a different account (for example, when running cross-account queries from a monitoring account). The list must contain between 1 and 50 entries.

queryArn

val queryArn: String?

The Amazon Resource Name (ARN) of the CloudWatch Logs scheduled query that the alarm uses. This field is populated in DescribeAlarms responses.

queryString

val queryString: String?

The CloudWatch Logs query to execute on each scheduled run. Length constraints: maximum of 10,000 characters.

scheduleConfiguration

val scheduleConfiguration: ScheduleConfiguration?

The schedule and time-range offset configuration for the underlying scheduled query.

scheduledQueryRoleArn

val scheduledQueryRoleArn: String?

The Amazon Resource Name (ARN) of the IAM role that CloudWatch assumes when executing the scheduled query against the configured log groups.

Functions

copy

inline fun copy(block: ScheduledQueryConfiguration.Builder.() -> Unit = {}): ScheduledQueryConfiguration

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String