Parameter |
Choices/Defaults |
Comments |
alarm_actions
|
|
A list of the names action(s) taken when the alarm is in the 'alarm' status
|
aws_access_key
|
|
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
|
|
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
|
|
Determines how the threshold value is compared
|
description
|
|
A longer description of the alarm
|
dimensions
|
|
Describes to what the alarm is applied
|
ec2_url
|
|
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
|
|
The number of times in which the metric is evaluated before final calculation
|
insufficient_data_actions
|
|
A list of the names of action(s) to take when the alarm is in the 'insufficient_data' status
|
metric
|
|
Name of the monitored metric (e.g. CPUUtilization)
Metric must already exist
|
name
required |
|
Unique name for the alarm
|
namespace
|
|
Name of the appropriate namespace ('AWS/EC2', 'System/Linux', etc.), which determines the category it will appear under in cloudwatch
|
ok_actions
|
|
A list of the names of action(s) to take when the alarm is in the 'ok' status
|
period
|
|
The time (in seconds) between metric evaluations
|
profile
(added in 1.6) |
|
Uses a boto profile. Only works with boto >= 2.24.0.
|
region
|
|
aliases: aws_region, ec2_region
|
security_token
(added in 1.6) |
|
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
required |
|
register or deregister the alarm
|
statistic
|
Choices:
- SampleCount
- Average
- Sum
- Minimum
- Maximum
|
Operation applied to the metric
Works in conjunction with period and evaluation_periods to determine the comparison value
|
threshold
|
|
Sets the min/max bound for triggering the alarm
|
unit
|
Choices:
- Seconds
- Microseconds
- Milliseconds
- Bytes
- Kilobytes
- Megabytes
- Gigabytes
- Terabytes
- Bits
- Kilobits
- Megabits
- Gigabits
- Terabits
- Percent
- Count
- Bytes/Second
- Kilobytes/Second
- Megabytes/Second
- Gigabytes/Second
- Terabytes/Second
- Bits/Second
- Kilobits/Second
- Megabits/Second
- Gigabits/Second
- Terabits/Second
- Count/Second
- None
|
The threshold's unit of measurement
|
validate_certs
bool
(added in 1.5) |
|
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
|