Package software.amazon.awscdk.services.cloudwatch

Class CfnInsightRule

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.cloudwatch.CfnInsightRule
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:36.824Z") @Stability(Stable) public class CfnInsightRule extends CfnResource implements IInspectable
A CloudFormation AWS::CloudWatch::InsightRule.

Creates or updates a Contributor Insights rule. Rules evaluate log events in a CloudWatch Logs log group, enabling you to find contributor data for the log events in that log group. For more information, see Using Contributor Insights to Analyze High-Cardinality Data in the Amazon CloudWatch User Guide .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cloudwatch.*;
 CfnInsightRule cfnInsightRule = CfnInsightRule.Builder.create(this, "MyCfnInsightRule")
         .ruleBody("ruleBody")
         .ruleName("ruleName")
         .ruleState("ruleState")
         // the properties below are optional
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnInsightRule

      protected CfnInsightRule(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnInsightRule

      protected CfnInsightRule(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnInsightRule

      @Stability(Stable) public CfnInsightRule(@NotNull Construct scope, @NotNull String id, @NotNull CfnInsightRuleProps props)
      Create a new AWS::CloudWatch::InsightRule.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The ARN of the Contributor Insights rule, such as arn:aws:cloudwatch:us-west-2:123456789012:insight-rule/MyInsightRuleName .

    • getAttrRuleName

      @Stability(Stable) @NotNull public String getAttrRuleName()
      The name of the Contributor Insights rule.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      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.

    • getRuleBody

      @Stability(Stable) @NotNull public String getRuleBody()
      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 .

    • setRuleBody

      @Stability(Stable) public void setRuleBody(@NotNull String value)
      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 .

    • getRuleName

      @Stability(Stable) @NotNull public String getRuleName()
      The name of the rule.

    • setRuleName

      @Stability(Stable) public void setRuleName(@NotNull String value)
      The name of the rule.

    • getRuleState

      @Stability(Stable) @NotNull public String getRuleState()
      The current state of the rule.

      Valid values are ENABLED and DISABLED .

    • setRuleState

      @Stability(Stable) public void setRuleState(@NotNull String value)
      The current state of the rule.

      Valid values are ENABLED and DISABLED .