Package software.amazon.awscdk.services.cloudwatch

Interface CfnInsightRuleProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnInsightRuleProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-15T10:24:56.213Z")
@Stability(Stable)
public interface CfnInsightRuleProps
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.cloudwatch.*;
 CfnInsightRuleProps cfnInsightRuleProps = CfnInsightRuleProps.builder()
         .ruleBody("ruleBody")
         .ruleName("ruleName")
         .ruleState("ruleState")
         // the properties below are optional
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-insightrule.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnInsightRuleProps.Builder	A builder for CfnInsightRuleProps
static final class	CfnInsightRuleProps.Jsii$Proxy	An implementation for CfnInsightRuleProps

Method Summary

Modifier and Type	Method	Description
static CfnInsightRuleProps.Builder	builder()
String	getRuleBody()	The definition of the rule, as a JSON object.
String	getRuleName()	The name of the rule.
String	getRuleState()	The current state of the rule.
default List<CfnTag>	getTags()	A list of key-value pairs to associate with the Contributor Insights rule.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getRuleBody

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-insightrule.html#cfn-cloudwatch-insightrule-rulebody

getRuleName

@Stability(Stable)
@NotNull
String getRuleName()

The name of the rule.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-insightrule.html#cfn-cloudwatch-insightrule-rulename

getRuleState

@Stability(Stable)
@NotNull
String getRuleState()

The current state of the rule.

Valid values are ENABLED and DISABLED .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-insightrule.html#cfn-cloudwatch-insightrule-rulestate

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-insightrule.html#cfn-cloudwatch-insightrule-tags

builder

@Stability(Stable)
static CfnInsightRuleProps.Builder builder()

Returns:

a CfnInsightRuleProps.Builder of CfnInsightRuleProps