interface CfnInsightRuleProps

Language	Type name
.NET	`Amazon.CDK.AWS.CloudWatch.CfnInsightRuleProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awscloudwatch#CfnInsightRuleProps`
Java	`software.amazon.awscdk.services.cloudwatch.CfnInsightRuleProps`
Python	`aws_cdk.aws_cloudwatch.CfnInsightRuleProps`
TypeScript	`aws-cdk-lib` » `aws_cloudwatch` » `CfnInsightRuleProps`

Properties for defining a CfnInsightRule.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cloudwatch as cloudwatch } from 'aws-cdk-lib';
const cfnInsightRuleProps: cloudwatch.CfnInsightRuleProps = {
  ruleBody: 'ruleBody',
  ruleName: 'ruleName',
  ruleState: 'ruleState',

  // the properties below are optional
  applyOnTransformedLogs: false,
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
ruleBody	`string`	The definition of the rule, as a JSON object.
ruleName	`string`	The name of the rule.
ruleState	`string`	The current state of the rule.
applyOnTransformedLogs?	`boolean \|` `IResolvable`	Determines whether the rules is evaluated on transformed versions of logs.
tags?	`CfnTag[]`	A list of key-value pairs to associate with the Contributor Insights rule.

ruleBody

Type: 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 .

ruleName

Type: string

The name of the rule.

ruleState

Type: string

The current state of the rule.

Valid values are ENABLED and DISABLED .

applyOnTransformedLogs?

Type: boolean | IResolvable (optional)

Determines whether the rules is evaluated on transformed versions of logs.

Valid values are TRUE and FALSE .

tags?

Type: CfnTag[] (optional)

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.