You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::CloudWatch::Types::PutInsightRuleInput

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing PutInsightRuleInput as input to an Aws::Client method, you can use a vanilla Hash:

{
  rule_name: "InsightRuleName", # required
  rule_state: "InsightRuleState",
  rule_definition: "InsightRuleDefinition", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#rule_definition ⇒ String

The definition of the rule, as a JSON object. For details on the valid syntax, see Contributor Insights Rule Syntax.

Returns:

  • (String) —

    The definition of the rule, as a JSON object.

#rule_name ⇒ String

A unique name for the rule.

Returns:

  • (String) —

    A unique name for the rule.

#rule_state ⇒ String

The state of the rule. Valid values are ENABLED and DISABLED.

Returns:

  • (String) —

    The state of the rule.

#tags ⇒ Array<Types::Tag>

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. You can also use them to scope user permissions, by granting a user permission to access or change only the resources that have certain tag values.

To be able to associate tags with a rule, you must have the cloudwatch:TagResource permission in addition to the cloudwatch:PutInsightRule permission.

If you are using this operation to update an existing Contributor Insights rule, any tags you specify in this parameter are ignored. To change the tags of an existing rule, use TagResource.

Returns:

  • (Array<Types::Tag>) —

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