Class: Aws::CloudWatch::Types::PutLogAlarmInput

Inherits:

Struct

Object
Struct
Aws::CloudWatch::Types::PutLogAlarmInput

show all

Defined in:: gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb

Overview

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#action_log_line_count ⇒ Integer
The number of log lines from the most recent scheduled query execution to include in alarm action notifications.
#action_log_line_role_arn ⇒ String
The Amazon Resource Name (ARN) of an IAM role that CloudWatch assumes to retrieve log events for inclusion in alarm action notifications.
#actions_enabled ⇒ Boolean
Indicates whether actions should be executed during any changes to the alarm state.
#alarm_actions ⇒ Array<String>
The actions to execute when this alarm transitions to the ALARM state from any other state.
#alarm_description ⇒ String
The description for the alarm.
#alarm_name ⇒ String
The name for the alarm.
#comparison_operator ⇒ String
The arithmetic operation to use when comparing the aggregated query result and the threshold.
#insufficient_data_actions ⇒ Array<String>
The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state.
#ok_actions ⇒ Array<String>
The actions to execute when this alarm transitions to the OK state from any other state.
#query_results_to_alarm ⇒ Integer
The number of query results, out of the most recent QueryResultsToEvaluate results, that must breach the threshold to trigger the alarm to transition to ALARM (the M in M-of-N evaluation).
#query_results_to_evaluate ⇒ Integer
The number of most recent scheduled query results to evaluate against the threshold (the N in M-of-N evaluation).
#scheduled_query_configuration ⇒ Types::ScheduledQueryConfiguration
The configuration of the underlying CloudWatch Logs scheduled query that this alarm evaluates, including the query string, log groups, schedule, and aggregation expression.
#tags ⇒ Array<Types::Tag>
A list of key-value pairs to associate with the alarm.
#threshold ⇒ Float
The value to compare with the aggregated query result.
#treat_missing_data ⇒ String
Sets how this alarm is to handle missing data points.

Instance Attribute Details

#action_log_line_count ⇒ `Integer`

The number of log lines from the most recent scheduled query execution to include in alarm action notifications. Valid range is 0 through 50. The default is 0, which means no log lines are included.

Returns:

(Integer)

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

class PutLogAlarmInput < Struct.new(
  :alarm_name,
  :alarm_description,
  :scheduled_query_configuration,
  :action_log_line_count,
  :action_log_line_role_arn,
  :actions_enabled,
  :ok_actions,
  :alarm_actions,
  :insufficient_data_actions,
  :query_results_to_evaluate,
  :query_results_to_alarm,
  :threshold,
  :comparison_operator,
  :treat_missing_data,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#action_log_line_role_arn ⇒ `String`

The Amazon Resource Name (ARN) of an IAM role that CloudWatch assumes to retrieve log events for inclusion in alarm action notifications. Required when ActionLogLineCount is greater than 0.

Returns:

(String)

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

class PutLogAlarmInput < Struct.new(
  :alarm_name,
  :alarm_description,
  :scheduled_query_configuration,
  :action_log_line_count,
  :action_log_line_role_arn,
  :actions_enabled,
  :ok_actions,
  :alarm_actions,
  :insufficient_data_actions,
  :query_results_to_evaluate,
  :query_results_to_alarm,
  :threshold,
  :comparison_operator,
  :treat_missing_data,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#actions_enabled ⇒ `Boolean`

Indicates whether actions should be executed during any changes to the alarm state. The default is true.

Returns:

(Boolean)

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

class PutLogAlarmInput < Struct.new(
  :alarm_name,
  :alarm_description,
  :scheduled_query_configuration,
  :action_log_line_count,
  :action_log_line_role_arn,
  :actions_enabled,
  :ok_actions,
  :alarm_actions,
  :insufficient_data_actions,
  :query_results_to_evaluate,
  :query_results_to_alarm,
  :threshold,
  :comparison_operator,
  :treat_missing_data,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#alarm_actions ⇒ `Array<String>`

The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).

Valid Values:

Amazon SNS actions:

arn:aws:sns:region:account-id:sns-topic-name

Lambda actions:

Invoke the latest version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name
Invoke a specific version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name:version-number
Invoke a function by using an alias Lambda function: arn:aws:lambda:region:account-id:function:function-name:alias-name

Systems Manager actions:

arn:aws:ssm:region:account-id:opsitem:severity

Returns:

(Array<String>)

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

class PutLogAlarmInput < Struct.new(
  :alarm_name,
  :alarm_description,
  :scheduled_query_configuration,
  :action_log_line_count,
  :action_log_line_role_arn,
  :actions_enabled,
  :ok_actions,
  :alarm_actions,
  :insufficient_data_actions,
  :query_results_to_evaluate,
  :query_results_to_alarm,
  :threshold,
  :comparison_operator,
  :treat_missing_data,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#alarm_description ⇒ `String`

The description for the alarm.

Returns:

(String)

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

class PutLogAlarmInput < Struct.new(
  :alarm_name,
  :alarm_description,
  :scheduled_query_configuration,
  :action_log_line_count,
  :action_log_line_role_arn,
  :actions_enabled,
  :ok_actions,
  :alarm_actions,
  :insufficient_data_actions,
  :query_results_to_evaluate,
  :query_results_to_alarm,
  :threshold,
  :comparison_operator,
  :treat_missing_data,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#alarm_name ⇒ `String`

The name for the alarm. This name must be unique within the Amazon Web Services account and Region.

Returns:

(String)

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

class PutLogAlarmInput < Struct.new(
  :alarm_name,
  :alarm_description,
  :scheduled_query_configuration,
  :action_log_line_count,
  :action_log_line_role_arn,
  :actions_enabled,
  :ok_actions,
  :alarm_actions,
  :insufficient_data_actions,
  :query_results_to_evaluate,
  :query_results_to_alarm,
  :threshold,
  :comparison_operator,
  :treat_missing_data,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#comparison_operator ⇒ `String`

The arithmetic operation to use when comparing the aggregated query result and the threshold. The aggregated query result is used as the first operand. Valid values are GreaterThanThreshold, GreaterThanOrEqualToThreshold, LessThanThreshold, and LessThanOrEqualToThreshold.

Returns:

(String)

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

class PutLogAlarmInput < Struct.new(
  :alarm_name,
  :alarm_description,
  :scheduled_query_configuration,
  :action_log_line_count,
  :action_log_line_role_arn,
  :actions_enabled,
  :ok_actions,
  :alarm_actions,
  :insufficient_data_actions,
  :query_results_to_evaluate,
  :query_results_to_alarm,
  :threshold,
  :comparison_operator,
  :treat_missing_data,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#insufficient_data_actions ⇒ `Array<String>`

The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).

Valid Values:

Amazon SNS actions:

arn:aws:sns:region:account-id:sns-topic-name

Lambda actions:

Invoke the latest version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name
Invoke a specific version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name:version-number
Invoke a function by using an alias Lambda function: arn:aws:lambda:region:account-id:function:function-name:alias-name

Returns:

(Array<String>)

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

class PutLogAlarmInput < Struct.new(
  :alarm_name,
  :alarm_description,
  :scheduled_query_configuration,
  :action_log_line_count,
  :action_log_line_role_arn,
  :actions_enabled,
  :ok_actions,
  :alarm_actions,
  :insufficient_data_actions,
  :query_results_to_evaluate,
  :query_results_to_alarm,
  :threshold,
  :comparison_operator,
  :treat_missing_data,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#ok_actions ⇒ `Array<String>`

The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).

Valid Values:

Amazon SNS actions:

arn:aws:sns:region:account-id:sns-topic-name

Lambda actions:

Invoke the latest version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name
Invoke a specific version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name:version-number
Invoke a function by using an alias Lambda function: arn:aws:lambda:region:account-id:function:function-name:alias-name

Returns:

(Array<String>)

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

class PutLogAlarmInput < Struct.new(
  :alarm_name,
  :alarm_description,
  :scheduled_query_configuration,
  :action_log_line_count,
  :action_log_line_role_arn,
  :actions_enabled,
  :ok_actions,
  :alarm_actions,
  :insufficient_data_actions,
  :query_results_to_evaluate,
  :query_results_to_alarm,
  :threshold,
  :comparison_operator,
  :treat_missing_data,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#query_results_to_alarm ⇒ `Integer`

The number of query results, out of the most recent QueryResultsToEvaluate results, that must breach the threshold to trigger the alarm to transition to ALARM (the M in M-of-N evaluation). Must be less than or equal to QueryResultsToEvaluate.

Returns:

(Integer)

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

class PutLogAlarmInput < Struct.new(
  :alarm_name,
  :alarm_description,
  :scheduled_query_configuration,
  :action_log_line_count,
  :action_log_line_role_arn,
  :actions_enabled,
  :ok_actions,
  :alarm_actions,
  :insufficient_data_actions,
  :query_results_to_evaluate,
  :query_results_to_alarm,
  :threshold,
  :comparison_operator,
  :treat_missing_data,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#query_results_to_evaluate ⇒ `Integer`

The number of most recent scheduled query results to evaluate against the threshold (the N in M-of-N evaluation). Valid range is 1 through 100.

Returns:

(Integer)

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

class PutLogAlarmInput < Struct.new(
  :alarm_name,
  :alarm_description,
  :scheduled_query_configuration,
  :action_log_line_count,
  :action_log_line_role_arn,
  :actions_enabled,
  :ok_actions,
  :alarm_actions,
  :insufficient_data_actions,
  :query_results_to_evaluate,
  :query_results_to_alarm,
  :threshold,
  :comparison_operator,
  :treat_missing_data,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#scheduled_query_configuration ⇒ `Types::ScheduledQueryConfiguration`

The configuration of the underlying CloudWatch Logs scheduled query that this alarm evaluates, including the query string, log groups, schedule, and aggregation expression.

Returns:

(Types::ScheduledQueryConfiguration)

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

class PutLogAlarmInput < Struct.new(
  :alarm_name,
  :alarm_description,
  :scheduled_query_configuration,
  :action_log_line_count,
  :action_log_line_role_arn,
  :actions_enabled,
  :ok_actions,
  :alarm_actions,
  :insufficient_data_actions,
  :query_results_to_evaluate,
  :query_results_to_alarm,
  :threshold,
  :comparison_operator,
  :treat_missing_data,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ `Array<Types::Tag>`

A list of key-value pairs to associate with the alarm. You can use tags to categorize and manage your alarms.

Returns:

(Array<Types::Tag>)

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

class PutLogAlarmInput < Struct.new(
  :alarm_name,
  :alarm_description,
  :scheduled_query_configuration,
  :action_log_line_count,
  :action_log_line_role_arn,
  :actions_enabled,
  :ok_actions,
  :alarm_actions,
  :insufficient_data_actions,
  :query_results_to_evaluate,
  :query_results_to_alarm,
  :threshold,
  :comparison_operator,
  :treat_missing_data,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#threshold ⇒ `Float`

The value to compare with the aggregated query result.

Returns:

(Float)

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

class PutLogAlarmInput < Struct.new(
  :alarm_name,
  :alarm_description,
  :scheduled_query_configuration,
  :action_log_line_count,
  :action_log_line_role_arn,
  :actions_enabled,
  :ok_actions,
  :alarm_actions,
  :insufficient_data_actions,
  :query_results_to_evaluate,
  :query_results_to_alarm,
  :threshold,
  :comparison_operator,
  :treat_missing_data,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#treat_missing_data ⇒ `String`

Sets how this alarm is to handle missing data points. Valid values are breaching, notBreaching, ignore, and missing. If this parameter is omitted, the default behavior of missing is used.

Returns:

(String)

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

class PutLogAlarmInput < Struct.new(
  :alarm_name,
  :alarm_description,
  :scheduled_query_configuration,
  :action_log_line_count,
  :action_log_line_role_arn,
  :actions_enabled,
  :ok_actions,
  :alarm_actions,
  :insufficient_data_actions,
  :query_results_to_evaluate,
  :query_results_to_alarm,
  :threshold,
  :comparison_operator,
  :treat_missing_data,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::CloudWatch::Types::PutLogAlarmInput

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#action_log_line_count ⇒ Integer

#action_log_line_role_arn ⇒ String

#actions_enabled ⇒ Boolean

#alarm_actions ⇒ Array<String>

#alarm_description ⇒ String

#alarm_name ⇒ String

#comparison_operator ⇒ String

#insufficient_data_actions ⇒ Array<String>

#ok_actions ⇒ Array<String>

#query_results_to_alarm ⇒ Integer

#query_results_to_evaluate ⇒ Integer

#scheduled_query_configuration ⇒ Types::ScheduledQueryConfiguration

#tags ⇒ Array<Types::Tag>

#threshold ⇒ Float

#treat_missing_data ⇒ String

#action_log_line_count ⇒ `Integer`

#action_log_line_role_arn ⇒ `String`

#actions_enabled ⇒ `Boolean`

#alarm_actions ⇒ `Array<String>`

#alarm_description ⇒ `String`

#alarm_name ⇒ `String`

#comparison_operator ⇒ `String`

#insufficient_data_actions ⇒ `Array<String>`

#ok_actions ⇒ `Array<String>`

#query_results_to_alarm ⇒ `Integer`

#query_results_to_evaluate ⇒ `Integer`

#scheduled_query_configuration ⇒ `Types::ScheduledQueryConfiguration`

#tags ⇒ `Array<Types::Tag>`

#threshold ⇒ `Float`

#treat_missing_data ⇒ `String`