AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb

Overview

Note:

When making an API call, you may pass PutInsightRuleInput data as a hash:

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#rule_definitionString

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

Returns:

  • (String)


3397
3398
3399
3400
3401
3402
3403
3404
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 3397

class PutInsightRuleInput < Struct.new(
  :rule_name,
  :rule_state,
  :rule_definition,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#rule_nameString

A unique name for the rule.

Returns:

  • (String)


3397
3398
3399
3400
3401
3402
3403
3404
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 3397

class PutInsightRuleInput < Struct.new(
  :rule_name,
  :rule_state,
  :rule_definition,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#rule_stateString

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

Returns:

  • (String)


3397
3398
3399
3400
3401
3402
3403
3404
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 3397

class PutInsightRuleInput < Struct.new(
  :rule_name,
  :rule_state,
  :rule_definition,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<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:



3397
3398
3399
3400
3401
3402
3403
3404
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 3397

class PutInsightRuleInput < Struct.new(
  :rule_name,
  :rule_state,
  :rule_definition,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end