/AWS1/CL_CWTLOGALARM

The details about a log alarm.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_alarmname TYPE /AWS1/CWTALARMNAME /AWS1/CWTALARMNAME

The name of the alarm.

iv_alarmarn TYPE /AWS1/CWTALARMARN /AWS1/CWTALARMARN

The Amazon Resource Name (ARN) of the alarm.

iv_alarmdescription TYPE /AWS1/CWTALARMDESCRIPTION /AWS1/CWTALARMDESCRIPTION

The description of the alarm.

iv_alarmconfupdatedtimestamp TYPE /AWS1/CWTTIMESTAMP /AWS1/CWTTIMESTAMP

The time stamp of the last update to the alarm configuration.

iv_actionsenabled TYPE /AWS1/CWTACTIONSENABLED /AWS1/CWTACTIONSENABLED

Indicates whether actions should be executed during any changes to the alarm state.

it_okactions TYPE /AWS1/CL_CWTRESOURCELIST_W=>TT_RESOURCELIST TT_RESOURCELIST

The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).

it_alarmactions TYPE /AWS1/CL_CWTRESOURCELIST_W=>TT_RESOURCELIST TT_RESOURCELIST

The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).

it_insufficientdataactions TYPE /AWS1/CL_CWTRESOURCELIST_W=>TT_RESOURCELIST TT_RESOURCELIST

The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).

iv_statevalue TYPE /AWS1/CWTSTATEVALUE /AWS1/CWTSTATEVALUE

The state value for the alarm.

iv_statereason TYPE /AWS1/CWTSTATEREASON /AWS1/CWTSTATEREASON

An explanation for the alarm state, in text format.

iv_statereasondata TYPE /AWS1/CWTSTATEREASONDATA /AWS1/CWTSTATEREASONDATA

An explanation for the alarm state, in JSON format.

iv_stateupdatedtimestamp TYPE /AWS1/CWTTIMESTAMP /AWS1/CWTTIMESTAMP

The time stamp of the last update to the value of either the StateValue or EvaluationState parameters.

io_scheduledqueryconf TYPE REF TO /AWS1/CL_CWTSCHEDULEDQUERYCONF /AWS1/CL_CWTSCHEDULEDQUERYCONF

The configuration of the underlying CloudWatch Logs scheduled query, including the query string, log groups, schedule, aggregation expression, and the ARN of the managed scheduled query.

iv_queryresultstoevaluate TYPE /AWS1/CWTQUERYRESULTSTOEVAL /AWS1/CWTQUERYRESULTSTOEVAL

The number of most recent scheduled query results that the alarm evaluates against the threshold (the N in M-of-N evaluation).

iv_queryresultstoalarm TYPE /AWS1/CWTQUERYRESULTSTOALARM /AWS1/CWTQUERYRESULTSTOALARM

The number of query results, out of the most recent QueryResultsToEvaluate results, that must breach the threshold to trigger the alarm to transition to ALARM (the M in M-of-N evaluation).

iv_threshold TYPE /AWS1/RT_DOUBLE_AS_STRING /AWS1/RT_DOUBLE_AS_STRING

The value to compare with the aggregated query result.

iv_comparisonoperator TYPE /AWS1/CWTCOMPARISONOPERATOR /AWS1/CWTCOMPARISONOPERATOR

The arithmetic operation to use when comparing the aggregated query result and the threshold. The aggregated query result is used as the first operand.

iv_treatmissingdata TYPE /AWS1/CWTTREATMISSINGDATA /AWS1/CWTTREATMISSINGDATA

How this alarm handles missing data points. Valid values are breaching, notBreaching, ignore, and missing.

iv_statetransedtimestamp TYPE /AWS1/CWTTIMESTAMP /AWS1/CWTTIMESTAMP

The date and time that the alarm's StateValue most recently changed.

iv_evaluationstate TYPE /AWS1/CWTEVALUATIONSTATE /AWS1/CWTEVALUATIONSTATE

If the value of this field is EVALUATION_ERROR, it indicates configuration errors in the alarm setup that require review and correction. Refer to the StateReason field of the alarm for more details.

If the value of this field is EVALUATION_FAILURE, it indicates temporary CloudWatch issues. We recommend manual monitoring until the issue is resolved.

If the value of this field is PARTIAL_DATA, it indicates that the query returned the maximum 500 contributor groups but more matched. The alarm evaluates the available contributors, but results might be incomplete.

iv_actionloglinecount TYPE /AWS1/CWTACTIONLOGLINECOUNT /AWS1/CWTACTIONLOGLINECOUNT

The number of log lines from the most recent scheduled query execution that are included in alarm action notifications. Valid range is 0 through 50. A value of 0 means no log lines are included.

iv_actionloglinerolearn TYPE /AWS1/CWTACTIONLOGLINEROLEARN /AWS1/CWTACTIONLOGLINEROLEARN

The Amazon Resource Name (ARN) of the IAM role that CloudWatch assumes to retrieve log events for inclusion in alarm action notifications. Set when ActionLogLineCount is greater than 0.

---

Queryable Attributes

AlarmName

The name of the alarm.

Accessible with the following methods

Method	Description
GET_ALARMNAME()	Getter for ALARMNAME, with configurable default
ASK_ALARMNAME()	Getter for ALARMNAME w/ exceptions if field has no value
HAS_ALARMNAME()	Determine if ALARMNAME has a value

AlarmArn

The Amazon Resource Name (ARN) of the alarm.

Accessible with the following methods

Method	Description
GET_ALARMARN()	Getter for ALARMARN, with configurable default
ASK_ALARMARN()	Getter for ALARMARN w/ exceptions if field has no value
HAS_ALARMARN()	Determine if ALARMARN has a value

AlarmDescription

The description of the alarm.

Accessible with the following methods

Method	Description
GET_ALARMDESCRIPTION()	Getter for ALARMDESCRIPTION, with configurable default
ASK_ALARMDESCRIPTION()	Getter for ALARMDESCRIPTION w/ exceptions if field has no va
HAS_ALARMDESCRIPTION()	Determine if ALARMDESCRIPTION has a value

AlarmConfigurationUpdatedTimestamp

The time stamp of the last update to the alarm configuration.

Accessible with the following methods

Method	Description
GET_ALARMCONFUPDATEDTSMP()	Getter for ALARMCONFUPDATEDTIMESTAMP, with configurable defa
ASK_ALARMCONFUPDATEDTSMP()	Getter for ALARMCONFUPDATEDTIMESTAMP w/ exceptions if field
HAS_ALARMCONFUPDATEDTSMP()	Determine if ALARMCONFUPDATEDTIMESTAMP has a value

ActionsEnabled

Indicates whether actions should be executed during any changes to the alarm state.

Accessible with the following methods

Method	Description
GET_ACTIONSENABLED()	Getter for ACTIONSENABLED, with configurable default
ASK_ACTIONSENABLED()	Getter for ACTIONSENABLED w/ exceptions if field has no valu
HAS_ACTIONSENABLED()	Determine if ACTIONSENABLED has a value

OKActions

The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).

Accessible with the following methods

Method	Description
GET_OKACTIONS()	Getter for OKACTIONS, with configurable default
ASK_OKACTIONS()	Getter for OKACTIONS w/ exceptions if field has no value
HAS_OKACTIONS()	Determine if OKACTIONS has a value

AlarmActions

The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).

Accessible with the following methods

Method	Description
GET_ALARMACTIONS()	Getter for ALARMACTIONS, with configurable default
ASK_ALARMACTIONS()	Getter for ALARMACTIONS w/ exceptions if field has no value
HAS_ALARMACTIONS()	Determine if ALARMACTIONS has a value

InsufficientDataActions

The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).

Accessible with the following methods

Method	Description
GET_INSUFFICIENTDATAACTIONS()	Getter for INSUFFICIENTDATAACTIONS, with configurable defaul
ASK_INSUFFICIENTDATAACTIONS()	Getter for INSUFFICIENTDATAACTIONS w/ exceptions if field ha
HAS_INSUFFICIENTDATAACTIONS()	Determine if INSUFFICIENTDATAACTIONS has a value

StateValue

The state value for the alarm.

Accessible with the following methods

Method	Description
GET_STATEVALUE()	Getter for STATEVALUE, with configurable default
ASK_STATEVALUE()	Getter for STATEVALUE w/ exceptions if field has no value
HAS_STATEVALUE()	Determine if STATEVALUE has a value

StateReason

An explanation for the alarm state, in text format.

Accessible with the following methods

Method	Description
GET_STATEREASON()	Getter for STATEREASON, with configurable default
ASK_STATEREASON()	Getter for STATEREASON w/ exceptions if field has no value
HAS_STATEREASON()	Determine if STATEREASON has a value

StateReasonData

An explanation for the alarm state, in JSON format.

Accessible with the following methods

Method	Description
GET_STATEREASONDATA()	Getter for STATEREASONDATA, with configurable default
ASK_STATEREASONDATA()	Getter for STATEREASONDATA w/ exceptions if field has no val
HAS_STATEREASONDATA()	Determine if STATEREASONDATA has a value

StateUpdatedTimestamp

The time stamp of the last update to the value of either the StateValue or EvaluationState parameters.

Accessible with the following methods

Method	Description
GET_STATEUPDATEDTIMESTAMP()	Getter for STATEUPDATEDTIMESTAMP, with configurable default
ASK_STATEUPDATEDTIMESTAMP()	Getter for STATEUPDATEDTIMESTAMP w/ exceptions if field has
HAS_STATEUPDATEDTIMESTAMP()	Determine if STATEUPDATEDTIMESTAMP has a value

ScheduledQueryConfiguration

The configuration of the underlying CloudWatch Logs scheduled query, including the query string, log groups, schedule, aggregation expression, and the ARN of the managed scheduled query.

Accessible with the following methods

Method	Description
GET_SCHEDULEDQUERYCONF()	Getter for SCHEDULEDQUERYCONFIGURATION

QueryResultsToEvaluate

The number of most recent scheduled query results that the alarm evaluates against the threshold (the N in M-of-N evaluation).

Accessible with the following methods

Method	Description
GET_QUERYRESULTSTOEVALUATE()	Getter for QUERYRESULTSTOEVALUATE, with configurable default
ASK_QUERYRESULTSTOEVALUATE()	Getter for QUERYRESULTSTOEVALUATE w/ exceptions if field has
HAS_QUERYRESULTSTOEVALUATE()	Determine if QUERYRESULTSTOEVALUATE has a value

QueryResultsToAlarm

The number of query results, out of the most recent QueryResultsToEvaluate results, that must breach the threshold to trigger the alarm to transition to ALARM (the M in M-of-N evaluation).

Accessible with the following methods

Method	Description
GET_QUERYRESULTSTOALARM()	Getter for QUERYRESULTSTOALARM, with configurable default
ASK_QUERYRESULTSTOALARM()	Getter for QUERYRESULTSTOALARM w/ exceptions if field has no
HAS_QUERYRESULTSTOALARM()	Determine if QUERYRESULTSTOALARM has a value

Threshold

The value to compare with the aggregated query result.

Accessible with the following methods

Method	Description
GET_THRESHOLD()	Getter for THRESHOLD, with configurable default
ASK_THRESHOLD()	Getter for THRESHOLD w/ exceptions if field has no value
STR_THRESHOLD()	String format for THRESHOLD, with configurable default
HAS_THRESHOLD()	Determine if THRESHOLD has a value

ComparisonOperator

The arithmetic operation to use when comparing the aggregated query result and the threshold. The aggregated query result is used as the first operand.

Accessible with the following methods

Method	Description
GET_COMPARISONOPERATOR()	Getter for COMPARISONOPERATOR, with configurable default
ASK_COMPARISONOPERATOR()	Getter for COMPARISONOPERATOR w/ exceptions if field has no
HAS_COMPARISONOPERATOR()	Determine if COMPARISONOPERATOR has a value

TreatMissingData

How this alarm handles missing data points. Valid values are breaching, notBreaching, ignore, and missing.

Accessible with the following methods

Method	Description
GET_TREATMISSINGDATA()	Getter for TREATMISSINGDATA, with configurable default
ASK_TREATMISSINGDATA()	Getter for TREATMISSINGDATA w/ exceptions if field has no va
HAS_TREATMISSINGDATA()	Determine if TREATMISSINGDATA has a value

StateTransitionedTimestamp

The date and time that the alarm's StateValue most recently changed.

Accessible with the following methods

Method	Description
GET_STATETRANSEDTIMESTAMP()	Getter for STATETRANSITIONEDTIMESTAMP, with configurable def
ASK_STATETRANSEDTIMESTAMP()	Getter for STATETRANSITIONEDTIMESTAMP w/ exceptions if field
HAS_STATETRANSEDTIMESTAMP()	Determine if STATETRANSITIONEDTIMESTAMP has a value

EvaluationState

If the value of this field is EVALUATION_ERROR, it indicates configuration errors in the alarm setup that require review and correction. Refer to the StateReason field of the alarm for more details.

If the value of this field is EVALUATION_FAILURE, it indicates temporary CloudWatch issues. We recommend manual monitoring until the issue is resolved.

If the value of this field is PARTIAL_DATA, it indicates that the query returned the maximum 500 contributor groups but more matched. The alarm evaluates the available contributors, but results might be incomplete.

Accessible with the following methods

Method	Description
GET_EVALUATIONSTATE()	Getter for EVALUATIONSTATE, with configurable default
ASK_EVALUATIONSTATE()	Getter for EVALUATIONSTATE w/ exceptions if field has no val
HAS_EVALUATIONSTATE()	Determine if EVALUATIONSTATE has a value

ActionLogLineCount

The number of log lines from the most recent scheduled query execution that are included in alarm action notifications. Valid range is 0 through 50. A value of 0 means no log lines are included.

Accessible with the following methods

Method	Description
GET_ACTIONLOGLINECOUNT()	Getter for ACTIONLOGLINECOUNT, with configurable default
ASK_ACTIONLOGLINECOUNT()	Getter for ACTIONLOGLINECOUNT w/ exceptions if field has no
HAS_ACTIONLOGLINECOUNT()	Determine if ACTIONLOGLINECOUNT has a value

ActionLogLineRoleArn

The Amazon Resource Name (ARN) of the IAM role that CloudWatch assumes to retrieve log events for inclusion in alarm action notifications. Set when ActionLogLineCount is greater than 0.

Accessible with the following methods

Method	Description
GET_ACTIONLOGLINEROLEARN()	Getter for ACTIONLOGLINEROLEARN, with configurable default
ASK_ACTIONLOGLINEROLEARN()	Getter for ACTIONLOGLINEROLEARN w/ exceptions if field has n
HAS_ACTIONLOGLINEROLEARN()	Determine if ACTIONLOGLINEROLEARN has a value

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT_LOGALARMS

TYPES TT_LOGALARMS TYPE STANDARD TABLE OF REF TO /AWS1/CL_CWTLOGALARM WITH DEFAULT KEY
.