Class CfnInsightRuleProps

Properties for defining a CfnInsightRule.

Inheritance

object

CfnInsightRuleProps

Implements

ICfnInsightRuleProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.CloudWatch

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnInsightRuleProps : ICfnInsightRuleProps

Syntax (vb)

Public Class CfnInsightRuleProps Implements ICfnInsightRuleProps

Remarks

See: 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 cfnInsightRuleProps = new CfnInsightRuleProps {
                 RuleBody = "ruleBody",
                 RuleName = "ruleName",
                 RuleState = "ruleState",

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

Synopsis

Constructors

CfnInsightRuleProps()

Properties for defining a CfnInsightRule.

Properties

ApplyOnTransformedLogs	Determines whether the rules is evaluated on transformed versions of logs.
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.

Constructors

CfnInsightRuleProps()

Properties for defining a CfnInsightRule.

public CfnInsightRuleProps()

Remarks

See: 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 cfnInsightRuleProps = new CfnInsightRuleProps {
                 RuleBody = "ruleBody",
                 RuleName = "ruleName",
                 RuleState = "ruleState",

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

Properties

ApplyOnTransformedLogs

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

public object? ApplyOnTransformedLogs { get; set; }

Property Value

object

Remarks

Valid values are TRUE and FALSE .

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

RuleBody

The definition of the rule, as a JSON object.

public string RuleBody { get; set; }

Property Value

string

Remarks

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

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

RuleName

The name of the rule.

public string RuleName { get; set; }

Property Value

string

Remarks

See: 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 string RuleState { get; set; }

Property Value

string

Remarks

Valid values are ENABLED and DISABLED .

See: 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 ICfnTag[]? Tags { get; set; }

Property Value

ICfnTag[]

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.

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

Implements

ICfnInsightRuleProps