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

Inherits:

Struct

• Object
• Struct
• Aws::CloudWatch::Types::PutInsightRuleInput

Defined in:

gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #apply_on_transformed_logs ⇒ Boolean

  Specify true to have this rule evaluate log events after they have been transformed by [Log transformation][1].

• #rule_definition ⇒ String

  The definition of the rule, as a JSON object.

• #rule_name ⇒ String

  A unique name for the rule.

• #rule_state ⇒ String

  The state of the rule.

• #tags ⇒ Array<Types::Tag>

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

Instance Attribute Details

#apply_on_transformed_logs ⇒ Boolean

Specify true to have this rule evaluate log events after they have been transformed by Log transformation. If you specify true, then the log events in log groups that have transformers will be evaluated by Contributor Insights after being transformed. Log groups that don't have transformers will still have their original log events evaluated by Contributor Insights.

The default is false

If a log group has a transformer, and transformation fails for some log events, those log events won't be evaluated by Contributor Insights. For information about investigating log transformation failures, see Transformation metrics and errors.

Returns:

• (Boolean)

# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 4145

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

#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)

# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 4145

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

#rule_name ⇒ String

A unique name for the rule.

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 4145

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

#rule_state ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 4145

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

#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>)

# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 4145

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