AWS::CloudWatch::InsightRule - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

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.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::CloudWatch::InsightRule",
  "Properties" : {
      "ApplyOnTransformedLogs" : Boolean,
      "RuleBody" : String,
      "RuleName" : String,
      "RuleState" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::CloudWatch::InsightRule
Properties:
  ApplyOnTransformedLogs: Boolean
  RuleBody: String
  RuleName: String
  RuleState: String
  Tags: 
    - Tag

Properties

ApplyOnTransformedLogs

Determines whether the rules is evaluated on transformed versions of logs. Valid values are TRUE and FALSE.

Required: No

Type: Boolean

Update requires: No interruption

RuleBody

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.

Required: Yes

Type: String

Update requires: No interruption

RuleName

The name of the rule.

Required: Yes

Type: String

Update requires: Replacement

RuleState

The current state of the rule. Valid values are ENABLED and DISABLED.

Required: Yes

Type: String

Update requires: No interruption

Tags

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.

Required: No

Type: Array of Tag

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ARN of the rule.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

Arn

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

RuleName

The name of the Contributor Insights rule.