/AWS1/CL_CWTCOMPOSITEALARM¶
The details about a composite alarm.
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_actionsenabled TYPE /AWS1/CWTACTIONSENABLED /AWS1/CWTACTIONSENABLED¶
Indicates whether actions should be executed during any changes to the alarm state.
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).
iv_alarmarn TYPE /AWS1/CWTALARMARN /AWS1/CWTALARMARN¶
The Amazon Resource Name (ARN) of the alarm.
iv_alarmconfupdatedtimestamp TYPE /AWS1/CWTTIMESTAMP /AWS1/CWTTIMESTAMP¶
The time stamp of the last update to the alarm configuration.
iv_alarmdescription TYPE /AWS1/CWTALARMDESCRIPTION /AWS1/CWTALARMDESCRIPTION¶
The description of the alarm.
iv_alarmname TYPE /AWS1/CWTALARMNAME /AWS1/CWTALARMNAME¶
The name of the alarm.
iv_alarmrule TYPE /AWS1/CWTALARMRULE /AWS1/CWTALARMRULE¶
The rule that this alarm uses to evaluate its alarm state.
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).
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).
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¶
Tracks the timestamp of any state update, even if
StateValuedoesn't change.
iv_statevalue TYPE /AWS1/CWTSTATEVALUE /AWS1/CWTSTATEVALUE¶
The state value for the alarm.
iv_statetransedtimestamp TYPE /AWS1/CWTTIMESTAMP /AWS1/CWTTIMESTAMP¶
The timestamp of the last change to the alarm's
StateValue.
iv_actionssuppressedby TYPE /AWS1/CWTACTIONSSUPPRESSEDBY /AWS1/CWTACTIONSSUPPRESSEDBY¶
When the value is
ALARM, it means that the actions are suppressed because the suppressor alarm is inALARMWhen the value isWaitPeriod, it means that the actions are suppressed because the composite alarm is waiting for the suppressor alarm to go into into theALARMstate. The maximum waiting time is as specified inActionsSuppressorWaitPeriod. After this time, the composite alarm performs its actions. When the value isExtensionPeriod, it means that the actions are suppressed because the composite alarm is waiting after the suppressor alarm went out of theALARMstate. The maximum waiting time is as specified inActionsSuppressorExtensionPeriod. After this time, the composite alarm performs its actions.
iv_actionssuppressedreason TYPE /AWS1/CWTACTIONSSUPEDREASON /AWS1/CWTACTIONSSUPEDREASON¶
Captures the reason for action suppression.
iv_actionssuppressor TYPE /AWS1/CWTALARMARN /AWS1/CWTALARMARN¶
Actions will be suppressed if the suppressor alarm is in the
ALARMstate.ActionsSuppressorcan be an AlarmName or an Amazon Resource Name (ARN) from an existing alarm.
iv_actionssuporwaitperiod TYPE /AWS1/CWTSUPPRESSORPERIOD /AWS1/CWTSUPPRESSORPERIOD¶
The maximum time in seconds that the composite alarm waits for the suppressor alarm to go into the
ALARMstate. After this time, the composite alarm performs its actions.
WaitPeriodis required only whenActionsSuppressoris specified.
iv_actssuporextensionperiod TYPE /AWS1/CWTSUPPRESSORPERIOD /AWS1/CWTSUPPRESSORPERIOD¶
The maximum time in seconds that the composite alarm waits after suppressor alarm goes out of the
ALARMstate. After this time, the composite alarm performs its actions.
ExtensionPeriodis required only whenActionsSuppressoris specified.
Queryable Attributes¶
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 |
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 |
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 |
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 |
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 |
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 |
AlarmRule¶
The rule that this alarm uses to evaluate its alarm state.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ALARMRULE() |
Getter for ALARMRULE, with configurable default |
ASK_ALARMRULE() |
Getter for ALARMRULE w/ exceptions if field has no value |
HAS_ALARMRULE() |
Determine if ALARMRULE 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 |
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 |
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¶
Tracks the timestamp of any state update, even if
StateValuedoesn't change.
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 |
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 |
StateTransitionedTimestamp¶
The timestamp of the last change to the alarm's
StateValue.
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 |
ActionsSuppressedBy¶
When the value is
ALARM, it means that the actions are suppressed because the suppressor alarm is inALARMWhen the value isWaitPeriod, it means that the actions are suppressed because the composite alarm is waiting for the suppressor alarm to go into into theALARMstate. The maximum waiting time is as specified inActionsSuppressorWaitPeriod. After this time, the composite alarm performs its actions. When the value isExtensionPeriod, it means that the actions are suppressed because the composite alarm is waiting after the suppressor alarm went out of theALARMstate. The maximum waiting time is as specified inActionsSuppressorExtensionPeriod. After this time, the composite alarm performs its actions.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ACTIONSSUPPRESSEDBY() |
Getter for ACTIONSSUPPRESSEDBY, with configurable default |
ASK_ACTIONSSUPPRESSEDBY() |
Getter for ACTIONSSUPPRESSEDBY w/ exceptions if field has no |
HAS_ACTIONSSUPPRESSEDBY() |
Determine if ACTIONSSUPPRESSEDBY has a value |
ActionsSuppressedReason¶
Captures the reason for action suppression.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ACTIONSSUPPRESSEDREASON() |
Getter for ACTIONSSUPPRESSEDREASON, with configurable defaul |
ASK_ACTIONSSUPPRESSEDREASON() |
Getter for ACTIONSSUPPRESSEDREASON w/ exceptions if field ha |
HAS_ACTIONSSUPPRESSEDREASON() |
Determine if ACTIONSSUPPRESSEDREASON has a value |
ActionsSuppressor¶
Actions will be suppressed if the suppressor alarm is in the
ALARMstate.ActionsSuppressorcan be an AlarmName or an Amazon Resource Name (ARN) from an existing alarm.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ACTIONSSUPPRESSOR() |
Getter for ACTIONSSUPPRESSOR, with configurable default |
ASK_ACTIONSSUPPRESSOR() |
Getter for ACTIONSSUPPRESSOR w/ exceptions if field has no v |
HAS_ACTIONSSUPPRESSOR() |
Determine if ACTIONSSUPPRESSOR has a value |
ActionsSuppressorWaitPeriod¶
The maximum time in seconds that the composite alarm waits for the suppressor alarm to go into the
ALARMstate. After this time, the composite alarm performs its actions.
WaitPeriodis required only whenActionsSuppressoris specified.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ACTIONSSUPORWAITPERIOD() |
Getter for ACTIONSSUPPRESSORWAITPERIOD, with configurable de |
ASK_ACTIONSSUPORWAITPERIOD() |
Getter for ACTIONSSUPPRESSORWAITPERIOD w/ exceptions if fiel |
HAS_ACTIONSSUPORWAITPERIOD() |
Determine if ACTIONSSUPPRESSORWAITPERIOD has a value |
ActionsSuppressorExtensionPeriod¶
The maximum time in seconds that the composite alarm waits after suppressor alarm goes out of the
ALARMstate. After this time, the composite alarm performs its actions.
ExtensionPeriodis required only whenActionsSuppressoris specified.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ACTSSUPOREXTENSIONPERIOD() |
Getter for ACTIONSSUPOREXTENSIONPERIOD, with configurable de |
ASK_ACTSSUPOREXTENSIONPERIOD() |
Getter for ACTIONSSUPOREXTENSIONPERIOD w/ exceptions if fiel |
HAS_ACTSSUPOREXTENSIONPERIOD() |
Determine if ACTIONSSUPOREXTENSIONPERIOD 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_COMPOSITEALARMS¶
TYPES TT_COMPOSITEALARMS TYPE STANDARD TABLE OF REF TO /AWS1/CL_CWTCOMPOSITEALARM WITH DEFAULT KEY
.