community / community.aws / 3.4.0 / module / ec2_metric_alarm Create/update or delete AWS Cloudwatch 'metric alarms' | "added in version" 1.0.0 of community.aws" Authors: Zacharie Eakin (@Zeekin)community.aws.ec2_metric_alarm (3.4.0) — module
Install with ansible-galaxy collection install community.aws:==3.4.0
collections: - name: community.aws version: 3.4.0
Can create or delete AWS metric alarms.
Metrics you wish to alarm on must already exist.
- name: create alarm community.aws.ec2_metric_alarm: state: present region: ap-southeast-2 name: "cpu-low" metric: "CPUUtilization" namespace: "AWS/EC2" statistic: Average comparison: "LessThanOrEqualToThreshold" threshold: 5.0 period: 300 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 an alarm to recover a failed instance community.aws.ec2_metric_alarm: state: present region: us-west-1 name: "recover-instance" metric: "StatusCheckFailed_System" namespace: "AWS/EC2" statistic: "Minimum" comparison: ">=" 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"]
name: description: - Unique name for the alarm. required: true type: str 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 description: - The threshold's unit of measurement. required: false type: str state: choices: - present - absent default: present description: - Register or deregister the alarm. type: str metric: description: - Name of the monitored metric (e.g. C(CPUUtilization)). - Metric must already exist. required: false type: str period: description: - The time (in seconds) between metric evaluations. required: false type: int region: aliases: - aws_region - ec2_region description: - 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 U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region) type: str ec2_url: aliases: - aws_endpoint_url - endpoint_url description: - 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. type: str profile: aliases: - aws_profile description: - Using I(profile) will override I(aws_access_key), I(aws_secret_key) and I(security_token) and support for passing them at the same time as I(profile) has been deprecated. - I(aws_access_key), I(aws_secret_key) and I(security_token) will be made mutually exclusive with I(profile) after 2022-06-01. type: str namespace: description: - Name of the appropriate namespace (C(AWS/EC2), C(System/Linux), etc.), which determines the category it will appear under in cloudwatch. required: false type: str statistic: choices: - SampleCount - Average - Sum - Minimum - Maximum description: - Operation applied to the metric. - Works in conjunction with I(period) and I(evaluation_periods) to determine the comparison value. required: false type: str threshold: description: - Sets the min/max bound for triggering the alarm. required: false type: float aws_config: description: - A dictionary to modify the botocore configuration. - Parameters can be found at U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config). - Only the 'user_agent' key is used for boto modules. See U(http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto) for more boto configuration. type: dict comparison: choices: - GreaterThanOrEqualToThreshold - GreaterThanThreshold - LessThanThreshold - LessThanOrEqualToThreshold - <= - < - '>=' - '>' description: - Determines how the threshold value is compared - Symbolic comparison operators have been deprecated, and will be removed after 2022-06-22. required: false type: str dimensions: description: - A dictionary describing which metric the alarm is applied to. - 'For more information see the AWS documentation:' - U(https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Dimension) required: false type: dict ok_actions: description: - A list of the names of action(s) to take when the alarm is in the C(ok) status, denoted as Amazon Resource Name(s). elements: str required: false type: list description: description: - A longer description of the alarm. required: false type: str alarm_actions: description: - A list of the names action(s) taken when the alarm is in the C(alarm) status, denoted as Amazon Resource Name(s). elements: str required: false type: list aws_ca_bundle: description: - The location of a CA Bundle to use when validating SSL certificates. - Not used by boto 2 based modules. - 'Note: The CA Bundle is read ''module'' side and may need to be explicitly copied from the controller if not run locally.' type: path aws_access_key: aliases: - ec2_access_key - access_key description: - C(AWS access key). If not set then the value of the C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY) or C(EC2_ACCESS_KEY) environment variable is used. - If I(profile) is set this parameter is ignored. - Passing the I(aws_access_key) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. type: str aws_secret_key: aliases: - ec2_secret_key - secret_key description: - C(AWS secret key). If not set then the value of the C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY), or C(EC2_SECRET_KEY) environment variable is used. - If I(profile) is set this parameter is ignored. - Passing the I(aws_secret_key) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. type: str security_token: aliases: - aws_security_token - access_token description: - C(AWS STS security token). If not set then the value of the C(AWS_SECURITY_TOKEN) or C(EC2_SECURITY_TOKEN) environment variable is used. - If I(profile) is set this parameter is ignored. - Passing the I(security_token) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. type: str validate_certs: default: true description: - When set to "no", SSL certificates will not be validated for communication with the AWS APIs. type: bool evaluation_periods: description: - The number of times in which the metric is evaluated before final calculation. required: false type: int treat_missing_data: choices: - breaching - notBreaching - ignore - missing default: missing description: - Sets how the alarm handles missing data points. required: false type: str insufficient_data_actions: description: - A list of the names of action(s) to take when the alarm is in the C(insufficient_data) status. elements: str required: false type: list debug_botocore_endpoint_logs: default: 'no' description: - Use a botocore.endpoint logger to parse the unique (rather than total) "resource:action" API calls made during a task, outputing the set to the resource_actions key in the task results. Use the aws_resource_action callback to output to total list made during a playbook. The ANSIBLE_DEBUG_BOTOCORE_LOGS environment variable may also be used. type: bool