Class CfnInsightRule
- All Implemented Interfaces:
IConstruct
,IDependable
,IInspectable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
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();
-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionCfnInsightRule
(Construct scope, String id, CfnInsightRuleProps props) Create a newAWS::CloudWatch::InsightRule
.protected
CfnInsightRule
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnInsightRule
(software.amazon.jsii.JsiiObjectRef objRef) -
Method Summary
Modifier and TypeMethodDescriptionThe ARN of the Contributor Insights rule, such asarn:aws:cloudwatch:us-west-2:123456789012:insight-rule/MyInsightRuleName
.The name of the Contributor Insights rule.The definition of the rule, as a JSON object.The name of the rule.The current state of the rule.getTags()
A list of key-value pairs to associate with the Contributor Insights rule.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setRuleBody
(String value) The definition of the rule, as a JSON object.void
setRuleName
(String value) The name of the rule.void
setRuleState
(String value) The current state of the rule.Methods inherited from class software.amazon.awscdk.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
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 newAWS::CloudWatch::InsightRule
.- Parameters:
scope
-- scope in which this resource is defined.
id
-- scoped id of the resource.
props
-- resource properties.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
-- tree inspector to collect and process attributes.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrArn
The ARN of the Contributor Insights rule, such asarn:aws:cloudwatch:us-west-2:123456789012:insight-rule/MyInsightRuleName
. -
getAttrRuleName
The name of the Contributor Insights rule. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
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 thecloudwatch:PutInsightRule
permission. -
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
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
The name of the rule. -
setRuleName
The name of the rule. -
getRuleState
The current state of the rule.Valid values are
ENABLED
andDISABLED
. -
setRuleState
The current state of the rule.Valid values are
ENABLED
andDISABLED
.
-