Class: Ansible::Ruby::Modules::Ec2_metric_alarm

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Ec2_metric_alarm

Defined in:

lib/ansible/ruby/modules/generated/cloud/amazon/ec2_metric_alarm.rb

Overview

Can create or delete AWS metric alarms. Metrics you wish to alarm on must already exist.

Instance Method Summary

• #alarm_actions ⇒ Array<String>, ...

  A list of the names action(s) taken when the alarm is in the ‘alarm’ status.

• #comparison ⇒ :<=, :<, :>, :>=^?

  Determines how the threshold value is compared.

• #description ⇒ String^?

  A longer description of the alarm.

• #dimensions ⇒ Hash^?

  Describes to what the alarm is applied.

• #evaluation_periods ⇒ Integer^?

  The number of times in which the metric is evaluated before final calculation.

• #insufficient_data_actions ⇒ Object^?

  A list of the names of action(s) to take when the alarm is in the ‘insufficient_data’ status.

• #metric ⇒ String^?

  Name of the monitored metric (e.g. CPUUtilization),Metric must already exist.

• #name ⇒ String

  Unique name for the alarm.

• #namespace ⇒ String^?

  Name of the appropriate namespace (‘AWS/EC2’, ‘System/Linux’, etc.), which determines the category it will appear under in cloudwatch.

• #ok_actions ⇒ Object^?

  A list of the names of action(s) to take when the alarm is in the ‘ok’ status.

• #period ⇒ Integer^?

  The time (in seconds) between metric evaluations.

• #state ⇒ :present, :absent

  Register or deregister the alarm.

• #statistic ⇒ :SampleCount, ...

  Operation applied to the metric,Works in conjunction with period and evaluation_periods to determine the comparison value.

• #threshold ⇒ Float^?

  Sets the min/max bound for triggering the alarm.

• #unit ⇒ :Seconds, ...

  The threshold’s unit of measurement.

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#alarm_actions ⇒ Array<String>, ...

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_metric_alarm.rb', line 61

attribute :alarm_actions

#comparison ⇒ :<=, :<, :>, :>=^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_metric_alarm.rb', line 33

attribute :comparison

#description ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_metric_alarm.rb', line 53

attribute :description

#dimensions ⇒ Hash^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_metric_alarm.rb', line 57

attribute :dimensions

#evaluation_periods ⇒ Integer^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_metric_alarm.rb', line 45

attribute :evaluation_periods

#insufficient_data_actions ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_metric_alarm.rb', line 65

attribute :insufficient_data_actions

#metric ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_metric_alarm.rb', line 21

attribute :metric

#name ⇒ String

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_metric_alarm.rb', line 17

attribute :name

#namespace ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_metric_alarm.rb', line 25

attribute :namespace

#ok_actions ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_metric_alarm.rb', line 68

attribute :ok_actions

#period ⇒ Integer^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_metric_alarm.rb', line 41

attribute :period

#state ⇒ :present, :absent

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_metric_alarm.rb', line 13

attribute :state

#statistic ⇒ :SampleCount, ...

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_metric_alarm.rb', line 29

attribute :statistic

#threshold ⇒ Float^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_metric_alarm.rb', line 37

attribute :threshold

#unit ⇒ :Seconds, ...

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_metric_alarm.rb', line 49

attribute :unit