class Amazonite::CloudWatch::PutLogAlarmInput

Included Modules

Defined in:

cloudwatch/put_log_alarm_input.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(alarm_name : String, scheduled_query_configuration : ScheduledQueryConfiguration, query_results_to_evaluate : Int32, query_results_to_alarm : Int32, threshold : Float64, comparison_operator : ComparisonOperator, alarm_description : String | Nil = nil, action_log_line_count : Int32 | Nil = nil, action_log_line_role_arn : String | Nil = nil, actions_enabled : Bool | Nil = nil, ok_actions : Array(String) | Nil = nil, alarm_actions : Array(String) | Nil = nil, insufficient_data_actions : Array(String) | Nil = nil, treat_missing_data : String | Nil = nil, tags : Array(Tag) | Nil = nil, warm_up_configuration : WarmUpConfiguration | Nil = nil) #

[View source]
def self.new(pull : JSON::PullParser) #

[View source]

Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def action_log_line_count : Int32 | Nil #

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.


[View source]
def action_log_line_count=(action_log_line_count : Int32 | Nil) #

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.


[View source]
def action_log_line_role_arn : String | Nil #

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.


[View source]
def action_log_line_role_arn=(action_log_line_role_arn : String | Nil) #

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.


[View source]
def actions_enabled : Bool | Nil #

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


[View source]
def actions_enabled=(actions_enabled : Bool | Nil) #

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


[View source]
def alarm_actions : Array(String) | Nil #

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*


[View source]
def alarm_actions=(alarm_actions : Array(String) | Nil) #

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*


[View source]
def alarm_description : String | Nil #

The description for the alarm.


[View source]
def alarm_description=(alarm_description : String | Nil) #

The description for the alarm.


[View source]
def alarm_name : String #

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


[View source]
def alarm_name=(alarm_name : String) #

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


[View source]
def comparison_operator : ComparisonOperator #

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.


[View source]
def comparison_operator=(comparison_operator : ComparisonOperator) #

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.


[View source]
def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def insufficient_data_actions : Array(String) | Nil #

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*


[View source]
def insufficient_data_actions=(insufficient_data_actions : Array(String) | Nil) #

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*


[View source]
def ok_actions : Array(String) | Nil #

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*


[View source]
def ok_actions=(ok_actions : Array(String) | Nil) #

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*


[View source]
def query_results_to_alarm : Int32 #

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.


[View source]
def query_results_to_alarm=(query_results_to_alarm : Int32) #

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.


[View source]
def query_results_to_evaluate : Int32 #

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.


[View source]
def query_results_to_evaluate=(query_results_to_evaluate : Int32) #

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.


[View source]
def scheduled_query_configuration : ScheduledQueryConfiguration #

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


[View source]
def scheduled_query_configuration=(scheduled_query_configuration : ScheduledQueryConfiguration) #

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


[View source]
def tags : Array(Tag) | Nil #

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


[View source]
def tags=(tags : Array(Tag) | Nil) #

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


[View source]
def threshold : Float64 #

The value to compare with the aggregated query result.


[View source]
def threshold=(threshold : Float64) #

The value to compare with the aggregated query result.


[View source]
def treat_missing_data : String | Nil #

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.


[View source]
def treat_missing_data=(treat_missing_data : String | Nil) #

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.


[View source]
def validate! : Nil #

[View source]
def warm_up_configuration : WarmUpConfiguration | Nil #

The warm-up configuration for the alarm. A warm-up period delays alarm evaluation after you create or update the alarm. The warm-up period reduces alarm noise from missing data while a new resource or service starts publishing data.

For more information, see Alarm warm-up periods in the Amazon CloudWatch User Guide.


[View source]
def warm_up_configuration=(warm_up_configuration : WarmUpConfiguration | Nil) #

The warm-up configuration for the alarm. A warm-up period delays alarm evaluation after you create or update the alarm. The warm-up period reduces alarm noise from missing data while a new resource or service starts publishing data.

For more information, see Alarm warm-up periods in the Amazon CloudWatch User Guide.


[View source]