Class CfnInsightRule
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.cloudwatch.CfnInsightRule
- All Implemented Interfaces:
IInspectable
,ITaggable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
date="2024-10-11T15:55:54.759Z")
@Stability(Stable)
public class CfnInsightRule
extends CfnResource
implements IInspectable, ITaggable
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();
- See Also:
-
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.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable
ITaggable.Jsii$Default, ITaggable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnInsightRule
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnInsightRule
(software.amazon.jsii.JsiiObjectRef objRef) CfnInsightRule
(software.constructs.Construct scope, String id, CfnInsightRuleProps props) -
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()
Tag Manager which manages the tags for this resource.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.void
setTagsRaw
(List<CfnTag> value) A list of key-value pairs to associate with the Contributor Insights rule.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.constructs.Construct
getNode, isConstruct
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 software.constructs.Construct scope, @NotNull String id, @NotNull CfnInsightRuleProps props) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.props
- Resource properties. This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- 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 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
. -
getAttrId
-
getAttrRuleName
The name of the Contributor Insights rule. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
Tag Manager which manages the tags for this resource. -
getRuleBody
The definition of the rule, as a JSON object. -
setRuleBody
The definition of the rule, as a JSON object. -
getRuleName
The name of the rule. -
setRuleName
The name of the rule. -
getRuleState
The current state of the rule. -
setRuleState
The current state of the rule. -
getTagsRaw
A list of key-value pairs to associate with the Contributor Insights rule. -
setTagsRaw
A list of key-value pairs to associate with the Contributor Insights rule.
-