/AWS1/CL_CWTINSIGHTRULE¶
This structure contains the definition for a Contributor Insights rule. For more information about this rule, see Using Constributor Insights to analyze high-cardinality data in the Amazon CloudWatch User Guide.
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_name TYPE /AWS1/CWTINSIGHTRULENAME /AWS1/CWTINSIGHTRULENAME¶
The name of the rule.
iv_state TYPE /AWS1/CWTINSIGHTRULESTATE /AWS1/CWTINSIGHTRULESTATE¶
Indicates whether the rule is enabled or disabled.
iv_schema TYPE /AWS1/CWTINSIGHTRULESCHEMA /AWS1/CWTINSIGHTRULESCHEMA¶
For rules that you create, this is always
{"Name": "CloudWatchLogRule", "Version": 1}. For managed rules, this is{"Name": "ServiceLogRule", "Version": 1}
iv_definition TYPE /AWS1/CWTINSIGHTRULEDEFINITION /AWS1/CWTINSIGHTRULEDEFINITION¶
The definition of the rule, as a JSON object. The definition contains the keywords used to define contributors, the value to aggregate on if this rule returns a sum instead of a count, and the filters. For details on the valid syntax, see Contributor Insights Rule Syntax.
Optional arguments:¶
iv_managedrule TYPE /AWS1/CWTINSIGHTRULEISMANAGED /AWS1/CWTINSIGHTRULEISMANAGED¶
An optional built-in rule that Amazon Web Services manages.
iv_applyontransformedlogs TYPE /AWS1/CWTINSIGHTRLONTRANSFOR00 /AWS1/CWTINSIGHTRLONTRANSFOR00¶
Displays whether the rule is evaluated on the transformed versions of logs, for log groups that have Log transformation enabled. If this is
false, log events are evaluated before they are transformed.
Queryable Attributes¶
Name¶
The name of the rule.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_NAME() |
Getter for NAME, with configurable default |
ASK_NAME() |
Getter for NAME w/ exceptions if field has no value |
HAS_NAME() |
Determine if NAME has a value |
State¶
Indicates whether the rule is enabled or disabled.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATE() |
Getter for STATE, with configurable default |
ASK_STATE() |
Getter for STATE w/ exceptions if field has no value |
HAS_STATE() |
Determine if STATE has a value |
Schema¶
For rules that you create, this is always
{"Name": "CloudWatchLogRule", "Version": 1}. For managed rules, this is{"Name": "ServiceLogRule", "Version": 1}
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SCHEMA() |
Getter for SCHEMA, with configurable default |
ASK_SCHEMA() |
Getter for SCHEMA w/ exceptions if field has no value |
HAS_SCHEMA() |
Determine if SCHEMA has a value |
Definition¶
The definition of the rule, as a JSON object. The definition contains the keywords used to define contributors, the value to aggregate on if this rule returns a sum instead of a count, and the filters. For details on the valid syntax, see Contributor Insights Rule Syntax.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DEFINITION() |
Getter for DEFINITION, with configurable default |
ASK_DEFINITION() |
Getter for DEFINITION w/ exceptions if field has no value |
HAS_DEFINITION() |
Determine if DEFINITION has a value |
ManagedRule¶
An optional built-in rule that Amazon Web Services manages.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_MANAGEDRULE() |
Getter for MANAGEDRULE, with configurable default |
ASK_MANAGEDRULE() |
Getter for MANAGEDRULE w/ exceptions if field has no value |
HAS_MANAGEDRULE() |
Determine if MANAGEDRULE has a value |
ApplyOnTransformedLogs¶
Displays whether the rule is evaluated on the transformed versions of logs, for log groups that have Log transformation enabled. If this is
false, log events are evaluated before they are transformed.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_APPLYONTRANSFORMEDLOGS() |
Getter for APPLYONTRANSFORMEDLOGS, with configurable default |
ASK_APPLYONTRANSFORMEDLOGS() |
Getter for APPLYONTRANSFORMEDLOGS w/ exceptions if field has |
HAS_APPLYONTRANSFORMEDLOGS() |
Determine if APPLYONTRANSFORMEDLOGS 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_INSIGHTRULES¶
TYPES TT_INSIGHTRULES TYPE STANDARD TABLE OF REF TO /AWS1/CL_CWTINSIGHTRULE WITH DEFAULT KEY
.