W3cubDocs

/Ansible

ec2_metric_alarm - Create/update or delete AWS Cloudwatch ‘metric alarms’

New in version 1.6.

Synopsis

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

Requirements (on host that executes module)

  • python >= 2.6
  • boto

Options

parameter required default choices comments
alarm_actions
 no
A list of the names action(s) taken when the alarm is in the 'alarm' status
aws_access_key
 no
AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
aliases: ec2_access_key, access_key
aws_secret_key
 no
AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
aliases: ec2_secret_key, secret_key
comparison
 no
Determines how the threshold value is compared
description
 no
A longer description of the alarm
dimensions
 no
Describes to what the alarm is applied
ec2_url
 no
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
evaluation_periods
 no
The number of times in which the metric is evaluated before final calculation
insufficient_data_actions
 no
A list of the names of action(s) to take when the alarm is in the 'insufficient_data' status
metric
 no
Name of the monitored metric (e.g. CPUUtilization)
Metric must already exist
name
 yes
Unique name for the alarm
namespace
 no
Name of the appropriate namespace ('AWS/EC2', 'System/Linux', etc.), which determines the category it will appear under in cloudwatch
ok_actions
 no
A list of the names of action(s) to take when the alarm is in the 'ok' status
period
 no
The time (in seconds) between metric evaluations
profile
(added in 1.6)
 no
Uses a boto profile. Only works with boto >= 2.24.0.
region
 no
The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
aliases: aws_region, ec2_region
security_token
(added in 1.6)
 no
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
aliases: access_token
state
 yes
  • present
  • absent
register or deregister the alarm
statistic
 no
Operation applied to the metric
Works in conjunction with period and evaluation_periods to determine the comparison value
threshold
 no
Sets the min/max bound for triggering the alarm
unit
 no
The threshold's unit of measurement
validate_certs
(added in 1.5)
 no yes
  • yes
  • no
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.

Examples

- name: create alarm
  ec2_metric_alarm:
    state: present
    region: ap-southeast-2
    name: "cpu-low"
    metric: "CPUUtilization"
    namespace: "AWS/EC2"
    statistic: Average
    comparison: "<="
    threshold: 5.0
    period: 300
    evaluation_periods: 3
    unit: "Percent"
    description: "This will alarm when a bamboo slave's cpu usage average is lower than 5% for 15 minutes "
    dimensions: {'InstanceId':'i-XXX'}
    alarm_actions: ["action1","action2"]

Notes

Note

If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence AWS_URL or EC2_URL, AWS_ACCESS_KEY_ID or AWS_ACCESS_KEY or EC2_ACCESS_KEY, AWS_SECRET_ACCESS_KEY or AWS_SECRET_KEY or EC2_SECRET_KEY, AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN, AWS_REGION or EC2_REGION

Note

Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See http://boto.readthedocs.org/en/latest/boto_config_tut.html

Note

AWS_REGION or EC2_REGION can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file

This is a Core Module

For more information on what this means please read Core Modules

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, developing_test_pr and Developing Modules.

© 2012–2016 Michael DeHaan
© 2016 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/ec2_metric_alarm_module.html