Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. cloudwatch
  6. getInsightRule

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.74.1
published on Monday, Aug 3, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

aws-native.cloudwatch.getInsightRule

aws-native logo

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.74.1
published on Monday, Aug 3, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

    Resource Type definition for AWS::CloudWatch::InsightRule. Creates a Contributor Insights rule that analyzes log data to identify top contributors and usage patterns.

    Using getInsightRule

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getInsightRule(args: GetInsightRuleArgs, opts?: InvokeOptions): Promise<GetInsightRuleResult>
function getInsightRuleOutput(args: GetInsightRuleOutputArgs, opts?: InvokeOptions): Output<GetInsightRuleResult>
    def get_insight_rule(arn: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetInsightRuleResult
def get_insight_rule_output(arn: pulumi.Input[Optional[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetInsightRuleResult]
    func LookupInsightRule(ctx *Context, args *LookupInsightRuleArgs, opts ...InvokeOption) (*LookupInsightRuleResult, error)
func LookupInsightRuleOutput(ctx *Context, args *LookupInsightRuleOutputArgs, opts ...InvokeOption) LookupInsightRuleResultOutput

    > Note: This function is named LookupInsightRule in the Go SDK.

    public static class GetInsightRule 
{
    public static Task<GetInsightRuleResult> InvokeAsync(GetInsightRuleArgs args, InvokeOptions? opts = null)
    public static Output<GetInsightRuleResult> Invoke(GetInsightRuleInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetInsightRuleResult> getInsightRule(GetInsightRuleArgs args, InvokeOptions options)
public static Output<GetInsightRuleResult> getInsightRule(GetInsightRuleArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:cloudwatch:getInsightRule
  arguments:
    # arguments dictionary
    data "aws-native_cloudwatch_get_insight_rule" "name" {
    # arguments
}

    The following arguments are supported:

    Arn string
    The ARN of the Contributor Insights rule, such as arn:aws:cloudwatch:us-west-2:123456789012:insight-rule/MyInsightRuleName .
    Arn string
    The ARN of the Contributor Insights rule, such as arn:aws:cloudwatch:us-west-2:123456789012:insight-rule/MyInsightRuleName .
    arn string
    The ARN of the Contributor Insights rule, such as arn:aws:cloudwatch:us-west-2:123456789012:insight-rule/MyInsightRuleName .
    arn String
    The ARN of the Contributor Insights rule, such as arn:aws:cloudwatch:us-west-2:123456789012:insight-rule/MyInsightRuleName .
    arn string
    The ARN of the Contributor Insights rule, such as arn:aws:cloudwatch:us-west-2:123456789012:insight-rule/MyInsightRuleName .
    arn str
    The ARN of the Contributor Insights rule, such as arn:aws:cloudwatch:us-west-2:123456789012:insight-rule/MyInsightRuleName .
    arn String
    The ARN of the Contributor Insights rule, such as arn:aws:cloudwatch:us-west-2:123456789012:insight-rule/MyInsightRuleName .

    getInsightRule Result

    The following output properties are available:

    ApplyOnTransformedLogs bool
    Determines whether the rules is evaluated on transformed versions of logs. Valid values are TRUE and FALSE .
    Arn string
    The ARN of the Contributor Insights rule, such as arn:aws:cloudwatch:us-west-2:123456789012:insight-rule/MyInsightRuleName .
    RuleBody string
    The definition of the rule, as a JSON object. For details about the syntax, see Contributor Insights Rule Syntax in the Amazon CloudWatch User Guide .
    RuleState Pulumi.AwsNative.CloudWatch.InsightRuleRuleState
    The current state of the rule. Valid values are ENABLED and DISABLED .
    Tags List<Pulumi.AwsNative.Outputs.Tag>

    A list of key-value pairs to associate with the Contributor Insights rule. You can associate as many as 50 tags with a rule.

    Tags can help you organize and categorize your resources. For more information, see Tagging Your Amazon CloudWatch Resources .

    To be able to associate tags with a rule, you must have the cloudwatch:TagResource permission in addition to the cloudwatch:PutInsightRule permission.

    ApplyOnTransformedLogs bool
    Determines whether the rules is evaluated on transformed versions of logs. Valid values are TRUE and FALSE .
    Arn string
    The ARN of the Contributor Insights rule, such as arn:aws:cloudwatch:us-west-2:123456789012:insight-rule/MyInsightRuleName .
    RuleBody string
    The definition of the rule, as a JSON object. For details about the syntax, see Contributor Insights Rule Syntax in the Amazon CloudWatch User Guide .
    RuleState InsightRuleRuleState
    The current state of the rule. Valid values are ENABLED and DISABLED .
    Tags Tag

    A list of key-value pairs to associate with the Contributor Insights rule. You can associate as many as 50 tags with a rule.

    Tags can help you organize and categorize your resources. For more information, see Tagging Your Amazon CloudWatch Resources .

    To be able to associate tags with a rule, you must have the cloudwatch:TagResource permission in addition to the cloudwatch:PutInsightRule permission.

    apply_on_transformed_logs bool
    Determines whether the rules is evaluated on transformed versions of logs. Valid values are TRUE and FALSE .
    arn string
    The ARN of the Contributor Insights rule, such as arn:aws:cloudwatch:us-west-2:123456789012:insight-rule/MyInsightRuleName .
    rule_body string
    The definition of the rule, as a JSON object. For details about the syntax, see Contributor Insights Rule Syntax in the Amazon CloudWatch User Guide .
    rule_state "ENABLED" | "DISABLED"
    The current state of the rule. Valid values are ENABLED and DISABLED .
    tags list(object)

    A list of key-value pairs to associate with the Contributor Insights rule. You can associate as many as 50 tags with a rule.

    Tags can help you organize and categorize your resources. For more information, see Tagging Your Amazon CloudWatch Resources .

    To be able to associate tags with a rule, you must have the cloudwatch:TagResource permission in addition to the cloudwatch:PutInsightRule permission.

    applyOnTransformedLogs Boolean
    Determines whether the rules is evaluated on transformed versions of logs. Valid values are TRUE and FALSE .
    arn String
    The ARN of the Contributor Insights rule, such as arn:aws:cloudwatch:us-west-2:123456789012:insight-rule/MyInsightRuleName .
    ruleBody String
    The definition of the rule, as a JSON object. For details about the syntax, see Contributor Insights Rule Syntax in the Amazon CloudWatch User Guide .
    ruleState InsightRuleRuleState
    The current state of the rule. Valid values are ENABLED and DISABLED .
    tags List<Tag>

    A list of key-value pairs to associate with the Contributor Insights rule. You can associate as many as 50 tags with a rule.

    Tags can help you organize and categorize your resources. For more information, see Tagging Your Amazon CloudWatch Resources .

    To be able to associate tags with a rule, you must have the cloudwatch:TagResource permission in addition to the cloudwatch:PutInsightRule permission.

    applyOnTransformedLogs boolean
    Determines whether the rules is evaluated on transformed versions of logs. Valid values are TRUE and FALSE .
    arn string
    The ARN of the Contributor Insights rule, such as arn:aws:cloudwatch:us-west-2:123456789012:insight-rule/MyInsightRuleName .
    ruleBody string
    The definition of the rule, as a JSON object. For details about the syntax, see Contributor Insights Rule Syntax in the Amazon CloudWatch User Guide .
    ruleState InsightRuleRuleState
    The current state of the rule. Valid values are ENABLED and DISABLED .
    tags Tag[]

    A list of key-value pairs to associate with the Contributor Insights rule. You can associate as many as 50 tags with a rule.

    Tags can help you organize and categorize your resources. For more information, see Tagging Your Amazon CloudWatch Resources .

    To be able to associate tags with a rule, you must have the cloudwatch:TagResource permission in addition to the cloudwatch:PutInsightRule permission.

    apply_on_transformed_logs bool
    Determines whether the rules is evaluated on transformed versions of logs. Valid values are TRUE and FALSE .
    arn str
    The ARN of the Contributor Insights rule, such as arn:aws:cloudwatch:us-west-2:123456789012:insight-rule/MyInsightRuleName .
    rule_body str
    The definition of the rule, as a JSON object. For details about the syntax, see Contributor Insights Rule Syntax in the Amazon CloudWatch User Guide .
    rule_state InsightRuleRuleState
    The current state of the rule. Valid values are ENABLED and DISABLED .
    tags Sequence[root_Tag]

    A list of key-value pairs to associate with the Contributor Insights rule. You can associate as many as 50 tags with a rule.

    Tags can help you organize and categorize your resources. For more information, see Tagging Your Amazon CloudWatch Resources .

    To be able to associate tags with a rule, you must have the cloudwatch:TagResource permission in addition to the cloudwatch:PutInsightRule permission.

    applyOnTransformedLogs Boolean
    Determines whether the rules is evaluated on transformed versions of logs. Valid values are TRUE and FALSE .
    arn String
    The ARN of the Contributor Insights rule, such as arn:aws:cloudwatch:us-west-2:123456789012:insight-rule/MyInsightRuleName .
    ruleBody String
    The definition of the rule, as a JSON object. For details about the syntax, see Contributor Insights Rule Syntax in the Amazon CloudWatch User Guide .
    ruleState "ENABLED" | "DISABLED"
    The current state of the rule. Valid values are ENABLED and DISABLED .
    tags List<Property Map>

    A list of key-value pairs to associate with the Contributor Insights rule. You can associate as many as 50 tags with a rule.

    Tags can help you organize and categorize your resources. For more information, see Tagging Your Amazon CloudWatch Resources .

    To be able to associate tags with a rule, you must have the cloudwatch:TagResource permission in addition to the cloudwatch:PutInsightRule permission.

    Supporting Types

    InsightRuleRuleState

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    Viewing docs for AWS Cloud Control v1.74.1
    published on Monday, Aug 3, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws-native

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial