InsightRule
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.
Contents
- 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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 8192.
Pattern:
[\x00-\x7F]+Required: Yes
- Name
-
The name of the rule.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[\x20-\x7E]+Required: Yes
- Schema
-
For rules that you create, this is always
{"Name": "CloudWatchLogRule", "Version": 1}. For managed rules, this is{"Name": "ServiceLogRule", "Version": 1}Type: String
Required: Yes
- State
-
Indicates whether the rule is enabled or disabled.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 32.
Pattern:
[\x20-\x7E]+Required: Yes
- ManagedRule
-
An optional built-in rule that AWS manages.
Type: Boolean
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
