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

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

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`

<note markdown=“1”> 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].

</note>

[1]: docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation.html [2]: docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Transformation-Errors-Metrics.html

Returns:

  • (Boolean) 


3798
3799
3800
3801
3802
3803
3804
3805
3806
 
# File 'lib/aws-sdk-cloudwatch/types.rb', line 3798

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].

[1]: docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights-RuleSyntax.html

Returns:

  • (String) 


3798
3799
3800
3801
3802
3803
3804
3805
3806
 
# File 'lib/aws-sdk-cloudwatch/types.rb', line 3798

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) 


3798
3799
3800
3801
3802
3803
3804
3805
3806
 
# File 'lib/aws-sdk-cloudwatch/types.rb', line 3798

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) 


3798
3799
3800
3801
3802
3803
3804
3805
3806
 
# File 'lib/aws-sdk-cloudwatch/types.rb', line 3798

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].

[1]: docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_TagResource.html

Returns:



3798
3799
3800
3801
3802
3803
3804
3805
3806
 
# File 'lib/aws-sdk-cloudwatch/types.rb', line 3798

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