Skip to content

InsightRule

Source code in docs_src/capo_cloudwatch/types/insight_rule.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
class InsightRule(TypedDict, closed=True):
    name: NotRequired["capo_cloudwatch.types.insight_rule_name.InsightRuleName"]
    """<p>The name of the rule.</p>"""
    state: NotRequired["capo_cloudwatch.types.insight_rule_state.InsightRuleState"]
    """<p>Indicates whether the rule is enabled or disabled.</p>"""
    schema: NotRequired["capo_cloudwatch.types.insight_rule_schema.InsightRuleSchema"]
    """<p>For rules that you create, this is always <code>{"Name": "CloudWatchLogRule", "Version": 1}</code>. For managed rules, this is <code>{"Name": "ServiceLogRule", "Version": 1}</code> </p>"""
    definition: NotRequired[
        "capo_cloudwatch.types.insight_rule_definition.InsightRuleDefinition"
    ]
    """<p>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 <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights-RuleSyntax.html">Contributor Insights Rule Syntax</a>.</p>"""
    managed_rule: NotRequired[
        "capo_cloudwatch.types.insight_rule_is_managed.InsightRuleIsManaged"
    ]
    """<p> An optional built-in rule that Amazon Web Services manages. </p>"""
    apply_on_transformed_logs: NotRequired[
        "capo_cloudwatch.types.insight_rule_on_transformed_logs.InsightRuleOnTransformedLogs"
    ]
    """<p>Displays whether the rule is evaluated on the transformed versions of logs, for log groups that have <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation.html">Log transformation</a> enabled. If this is <code>false</code>, log events are evaluated before they are transformed.</p>"""

apply_on_transformed_logs instance-attribute 

apply_on_transformed_logs: NotRequired[InsightRuleOnTransformedLogs]

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.

definition instance-attribute 

definition: NotRequired[InsightRuleDefinition]

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.

managed_rule instance-attribute 

managed_rule: NotRequired[InsightRuleIsManaged]

An optional built-in rule that Amazon Web Services manages.

name instance-attribute 

name: NotRequired[InsightRuleName]

The name of the rule.

schema instance-attribute 

schema: NotRequired[InsightRuleSchema]

For rules that you create, this is always {"Name": "CloudWatchLogRule", "Version": 1}. For managed rules, this is {"Name": "ServiceLogRule", "Version": 1}

state instance-attribute 

state: NotRequired[InsightRuleState]

Indicates whether the rule is enabled or disabled.