Class CfnInsightRule

A CloudFormation AWS::CloudWatch::InsightRule.

Inheritance
System.Object
Construct
CfnElement
CfnRefElement
CfnResource
CfnInsightRule
Implements
Constructs.IConstruct
Inherited Members
Namespace: Amazon.CDK.AWS.CloudWatch
Assembly: Amazon.CDK.AWS.CloudWatch.dll
Syntax (csharp)
public class CfnInsightRule : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnInsightRule
    Inherits CfnResource
    Implements IConstruct, IDependable, IInspectable
Remarks

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 .

CloudformationResource: AWS::CloudWatch::InsightRule

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

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.CloudWatch;

var cfnInsightRule = new CfnInsightRule(this, "MyCfnInsightRule", new CfnInsightRuleProps {
    RuleBody = "ruleBody",
    RuleName = "ruleName",
    RuleState = "ruleState",

    // the properties below are optional
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } }
});

Synopsis

Constructors

CfnInsightRule(Construct, String, ICfnInsightRuleProps)

Create a new AWS::CloudWatch::InsightRule.
CfnInsightRule(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnInsightRule(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

Properties

AttrArn

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

The name of the Contributor Insights rule.
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CfnProperties
RuleBody

The definition of the rule, as a JSON object.
RuleName

The name of the rule.
RuleState

The current state of the rule.
Tags

A list of key-value pairs to associate with the Contributor Insights rule.

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

CfnInsightRule(Construct, String, ICfnInsightRuleProps)

Create a new AWS::CloudWatch::InsightRule.

public CfnInsightRule(Construct scope, string id, ICfnInsightRuleProps props)
Parameters
scope Construct
  • scope in which this resource is defined.
id System.String
  • scoped id of the resource.
props ICfnInsightRuleProps
  • resource properties.

CfnInsightRule(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnInsightRule(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

CfnInsightRule(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnInsightRule(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

Properties

AttrArn

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

public virtual string AttrArn { get; }
Property Value

System.String

Remarks

CloudformationAttribute: Arn

AttrRuleName

The name of the Contributor Insights rule.

public virtual string AttrRuleName { get; }
Property Value

System.String

Remarks

CloudformationAttribute: RuleName

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

System.String

CfnProperties

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

RuleBody

The definition of the rule, as a JSON object.

public virtual string RuleBody { get; set; }
Property Value

System.String

Remarks

For details about the syntax, see Contributor Insights Rule Syntax in the Amazon CloudWatch User Guide .

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

RuleName

The name of the rule.

public virtual string RuleName { get; set; }
Property Value

System.String

Remarks

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

RuleState

The current state of the rule.

public virtual string RuleState { get; set; }
Property Value

System.String

Remarks

Valid values are ENABLED and DISABLED .

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

Tags

A list of key-value pairs to associate with the Contributor Insights rule.

public virtual TagManager Tags { get; }
Property Value

TagManager

Remarks

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.

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

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)
Parameters
inspector TreeInspector
  • tree inspector to collect and process attributes.

RenderProperties(IDictionary<String, Object>)

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

Implements

Constructs.IConstruct