/AWS1/CL_CWTSCHEDULEDQUERYCONF¶
The configuration of the CloudWatch Logs scheduled query that backs a log alarm.
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_querystring TYPE /AWS1/CWTQUERYSTRING /AWS1/CWTQUERYSTRING¶
The CloudWatch Logs query to execute on each scheduled run. Length constraints: maximum of 10,000 characters.
iv_scheduledqueryrolearn TYPE /AWS1/CWTAMAZONRESOURCENAME /AWS1/CWTAMAZONRESOURCENAME¶
The Amazon Resource Name (ARN) of the IAM role that CloudWatch assumes when executing the scheduled query against the configured log groups.
io_scheduleconfiguration TYPE REF TO /AWS1/CL_CWTSCHEDULECONF /AWS1/CL_CWTSCHEDULECONF¶
The schedule and time-range offset configuration for the underlying scheduled query.
iv_aggregationexpression TYPE /AWS1/CWTAGGREGATIONEXPRESSION /AWS1/CWTAGGREGATIONEXPRESSION¶
The expression that defines how to aggregate query results into one or more scalar values for alarm evaluation. For example,
count(*)oravg(latency) by host | sort desc. Length constraints: minimum 1 character, maximum 2048 characters.
Optional arguments:¶
it_loggroupidentifiers TYPE /AWS1/CL_CWTLOGGROUPIDNTFRS_W=>TT_LOGGROUPIDENTIFIERS TT_LOGGROUPIDENTIFIERS¶
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.
iv_queryarn TYPE /AWS1/CWTAMAZONRESOURCENAME /AWS1/CWTAMAZONRESOURCENAME¶
The Amazon Resource Name (ARN) of the CloudWatch Logs scheduled query that the alarm uses. This field is populated in
DescribeAlarmsresponses.
it_tags TYPE /AWS1/CL_CWTTAG=>TT_TAGLIST TT_TAGLIST¶
A list of key-value pairs to associate with the underlying scheduled query resource.
Queryable Attributes¶
QueryString¶
The CloudWatch Logs query to execute on each scheduled run. Length constraints: maximum of 10,000 characters.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_QUERYSTRING() |
Getter for QUERYSTRING, with configurable default |
ASK_QUERYSTRING() |
Getter for QUERYSTRING w/ exceptions if field has no value |
HAS_QUERYSTRING() |
Determine if QUERYSTRING has a value |
LogGroupIdentifiers¶
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LOGGROUPIDENTIFIERS() |
Getter for LOGGROUPIDENTIFIERS, with configurable default |
ASK_LOGGROUPIDENTIFIERS() |
Getter for LOGGROUPIDENTIFIERS w/ exceptions if field has no |
HAS_LOGGROUPIDENTIFIERS() |
Determine if LOGGROUPIDENTIFIERS has a value |
QueryARN¶
The Amazon Resource Name (ARN) of the CloudWatch Logs scheduled query that the alarm uses. This field is populated in
DescribeAlarmsresponses.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_QUERYARN() |
Getter for QUERYARN, with configurable default |
ASK_QUERYARN() |
Getter for QUERYARN w/ exceptions if field has no value |
HAS_QUERYARN() |
Determine if QUERYARN has a value |
ScheduledQueryRoleARN¶
The Amazon Resource Name (ARN) of the IAM role that CloudWatch assumes when executing the scheduled query against the configured log groups.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SCHEDULEDQUERYROLEARN() |
Getter for SCHEDULEDQUERYROLEARN, with configurable default |
ASK_SCHEDULEDQUERYROLEARN() |
Getter for SCHEDULEDQUERYROLEARN w/ exceptions if field has |
HAS_SCHEDULEDQUERYROLEARN() |
Determine if SCHEDULEDQUERYROLEARN has a value |
ScheduleConfiguration¶
The schedule and time-range offset configuration for the underlying scheduled query.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SCHEDULECONFIGURATION() |
Getter for SCHEDULECONFIGURATION |
AggregationExpression¶
The expression that defines how to aggregate query results into one or more scalar values for alarm evaluation. For example,
count(*)oravg(latency) by host | sort desc. Length constraints: minimum 1 character, maximum 2048 characters.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_AGGREGATIONEXPRESSION() |
Getter for AGGREGATIONEXPRESSION, with configurable default |
ASK_AGGREGATIONEXPRESSION() |
Getter for AGGREGATIONEXPRESSION w/ exceptions if field has |
HAS_AGGREGATIONEXPRESSION() |
Determine if AGGREGATIONEXPRESSION has a value |
Tags¶
A list of key-value pairs to associate with the underlying scheduled query resource.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TAGS() |
Getter for TAGS, with configurable default |
ASK_TAGS() |
Getter for TAGS w/ exceptions if field has no value |
HAS_TAGS() |
Determine if TAGS has a value |