Author: | Zacharie Eakin |
---|
New in version 1.6.
Can create or delete AWS metric alarms Metrics you wish to alarm on must already exist
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 environment variable is used. | ||
aws_secret_key | no | AWS secret key. If not set then the value of the AWS_SECRET_KEY environment variable is used. | ||
comparison | no | Determines how the threshold value is compared | ||
description | no | A longer desciption 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). Must be specified 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 | |||
namespace | no | Name of the appropriate namespace, 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 | no | uses a boto profile. Only works with boto >= 2.24.0 (added in Ansible 1.6) | ||
security_token | no | security token to authenticate against AWS (added in Ansible 1.6) | ||
state | yes |
|
register or deregister the alarm | |
statistic | no | Operation applied to the metricWorks 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 | no | yes |
|
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0. (added in Ansible 1.5) |
Note
Requires boto
- 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"]
Note
The following environment variables can be used AWS_ACCESS_KEY or EC2_ACCESS_KEY or AWS_ACCESS_KEY_ID, AWS_SECRET_KEY or EC2_SECRET_KEY or AWS_SECRET_ACCESS_KEY, AWS_REGION or EC2_REGION, AWS_SECURITY_TOKEN
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