amazon.aws.cloudwatch_metric_alarm module – Create/update or delete AWS CloudWatch ‘metric alarms’
Note
This module is part of the amazon.aws collection (version 9.0.0).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install amazon.aws.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: amazon.aws.cloudwatch_metric_alarm.
New in amazon.aws 5.0.0
Synopsis
Can create or delete AWS CloudWatch metric alarms.
Metrics you wish to alarm on must already exist.
Prior to release 5.0.0 this module was called community.aws.ec2_metric_alarm. The usage did not change.
This module was originally added to
community.awsin release 1.0.0.
Aliases: ec2_metric_alarm
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.6
boto3 >= 1.28.0
botocore >= 1.31.0
Parameters
Parameter |
Comments |
|---|---|
AWS access key ID. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The The aws_access_key and profile options are mutually exclusive. The aws_access_key_id alias was added in release 5.1.0 for consistency with the AWS botocore SDK. The ec2_access_key alias has been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
A list of the names action(s) taken when the alarm is in the Default: |
|
The location of a CA Bundle to use when validating SSL certificates. The |
|
A dictionary to modify the botocore configuration. Parameters can be found in the AWS documentation https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. |
|
Determines how the threshold value is compared Choices:
|
|
The number of data points that must be breaching to trigger the alarm. |
|
Use a The Choices:
|
|
A longer description of the alarm. |
|
A dictionary describing which metric the alarm is applied to. For more information see the AWS documentation: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Dimension |
|
URL to connect to instead of the default AWS endpoints. While this can be used to connection to other AWS-compatible services the amazon.aws and community.aws collections are only tested against AWS. The The ec2_url and s3_url aliases have been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
Used only for alarms based on percentiles. If you specify If you specify Choices:
|
|
The number of times in which the metric is evaluated before final calculation. |
|
The percentile statistic for the metric specified in the metric name. |
|
A list of the names of action(s) to take when the alarm is in the Default: |
|
Name of the monitored metric (e.g. Metric must already exist. |
|
An array of MetricDataQuery structures that enable you to create an alarm based on the result of a metric math expression. Default: |
|
The ID of the account where the metrics are located, if this is a cross-account alarm. |
|
This field can contain either a Metrics Insights query, or a metric math expression to be performed on the returned data. |
|
A short name used to tie this object to the results in the response. |
|
A human-readable label for this metric or expression. |
|
The metric to be returned, along with statistics, period, and units. |
|
The metric to return, including the metric name, namespace, and dimensions. |
|
A name/value pair that is part of the identity of a metric. |
|
The name of the dimension. |
|
The value of the dimension. |
|
The name of the metric. |
|
The namespace of the metric. |
|
The granularity, in seconds, of the returned data points. |
|
The statistic to return. It can include any CloudWatch statistic or extended statistic. |
|
Unit to use when storing the metric. |
|
The granularity, in seconds, of the returned data points. |
|
This option indicates whether to return the timestamps and raw data values of this metric. Choices:
|
|
Unique name for the alarm. |
|
Name of the appropriate namespace ( |
|
A list of the names of action(s) to take when the alarm is in the Default: |
|
The time (in seconds) between metric evaluations. |
|
A named AWS profile to use for authentication. See the AWS documentation for more information about named profiles https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. The The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options. |
|
The AWS region to use. For global services such as IAM, Route53 and CloudFront, region is ignored. The See the Amazon AWS documentation for more information http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. The Support for the |
|
AWS secret access key. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The The secret_key and profile options are mutually exclusive. The aws_secret_access_key alias was added in release 5.1.0 for consistency with the AWS botocore SDK. The ec2_secret_key alias has been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
AWS STS session token for use with temporary credentials. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The The security_token and profile options are mutually exclusive. Aliases aws_session_token and session_token were added in release 3.2.0, with the parameter being renamed from security_token to session_token in release 6.0.0. The security_token, aws_security_token, and access_token aliases have been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
Register or deregister the alarm. Choices:
|
|
Operation applied to the metric. Works in conjunction with Choices:
|
|
Sets the min/max bound for triggering the alarm. |
|
Sets how the alarm handles missing data points. Choices:
|
|
The threshold’s unit of measurement. Choices:
|
|
When set to Setting validate_certs=false is strongly discouraged, as an alternative, consider setting aws_ca_bundle instead. Choices:
|
Notes
Note
Caution: For modules, environment variables and configuration files are read from the Ansible ‘host’ context and not the ‘controller’ context. As such, files may need to be explicitly copied to the ‘host’. For lookup and connection plugins, environment variables and configuration files are read from the Ansible ‘controller’ context and not the ‘host’ context.
The AWS SDK (boto3) that Ansible uses may also read defaults for credentials and other settings, such as the region, from its configuration files in the Ansible ‘host’ context (typically
~/.aws/credentials). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
Examples
- name: create alarm
amazon.aws.cloudwatch_metric_alarm:
state: present
region: ap-southeast-2
name: "cpu-low"
metric_name: "CPUUtilization"
namespace: "AWS/EC2"
statistic: Average
comparison: "LessThanOrEqualToThreshold"
threshold: 5.0
period: 300
evaluate_low_sample_count_percentile: "ignore"
evaluation_periods: 3
unit: "Percent"
description: "This will alarm when a instance's CPU usage average is lower than 5% for 15 minutes"
dimensions: {'InstanceId': 'i-XXX'}
alarm_actions: ["action1", "action2"]
- name: create alarm with metrics
amazon.aws.cloudwatch_metric_alarm:
state: present
region: ap-southeast-2
name: "cpu-low"
metrics:
- id: 'CPU'
metric_stat:
metric:
dimensions:
name: "InstanceId"
value: "i-xx"
metric_name: "CPUUtilization"
namespace: "AWS/EC2"
period: "300"
stat: "Average"
unit: "Percent"
return_data: false
alarm_actions: ["action1", "action2"]
- name: Create an alarm to recover a failed instance
amazon.aws.cloudwatch_metric_alarm:
state: present
region: us-west-1
name: "recover-instance"
metric: "StatusCheckFailed_System"
namespace: "AWS/EC2"
statistic: "Minimum"
comparison: "GreaterThanOrEqualToThreshold"
threshold: 1.0
period: 60
evaluation_periods: 2
unit: "Count"
description: "This will recover an instance when it fails"
dimensions: {"InstanceId":'i-XXX'}
alarm_actions: ["arn:aws:automate:us-west-1:ec2:recover"]
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Indicates whether actions should be executed during any changes to the alarm state. Returned: always |
|
The actions to execute when this alarm transitions to an ALARM state from any other state. Returned: always |
|
The Amazon Resource Name (ARN) of the alarm. Returned: always |
|
The arithmetic operation to use when comparing the specified statistic and threshold. Returned: always |
|
The description of the alarm. Returned: always |
|
The dimensions for the metric. Returned: always |
|
The name of the dimension. Returned: always |
|
The value of the dimension. Returned: always |
|
Used only for alarms based on percentiles. If ignore, the alarm state does not change during periods with too few data points to be statistically significant. If evaluate or this parameter is not used, the alarm is always evaluated and possibly changes state. Returned: always |
|
The number of periods over which data is compared to the specified threshold. Returned: always |
|
The percentile statistic for the metric associated with the alarm. Returned: always |
|
The actions to execute when this alarm transitions to an INSUFFICIENT_DATA state from any other state. Returned: always |
|
The time stamp of the last update to the alarm configuration. Returned: always |
|
Name of the monitored metric (e.g. Returned: always |
|
Name of the monitored metric (e.g. Returned: always |
|
An array of MetricDataQuery structures, used in an alarm based on a metric math expression. Returned: always |
|
Unique name for the alarm. Returned: always |
|
Name of the appropriate namespace ( Determines the category it will appear under in CloudWatch. Returned: always |
|
The actions to execute when this alarm transitions to an OK state from any other state. Returned: always |
|
The length, in seconds, used each time the metric specified in MetricName is evaluated. Valid values are 10, 30, and any multiple of 60. Returned: always |
|
An explanation for the alarm state, in text format. Returned: always |
|
The state value for the alarm. Returned: always |
|
The statistic for the metric associated with the alarm, other than percentile. Returned: always |
|
The value to compare with the specified statistic. Returned: always |
|
Sets how alarm is to handle missing data points. Returned: always |
|
Unit used when storing the metric Returned: always |