ansible.builtin.ec2_metric_alarm (v2.7.18) — module

Install Ansible via pip

Install with pip install ansible==2.7.18

Description

Can create or delete AWS metric alarms.

Metrics you wish to alarm on must already exist.

Requirements

• python >= 2.6
• boto

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

  - 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"]

Inputs

    
name:
    description:
    - Unique name for the alarm
    required: true

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

state:
    choices:
    - present
    - absent
    description:
    - register or deregister the alarm
    required: true

metric:
    description:
    - Name of the monitored metric (e.g. CPUUtilization)
    - Metric must already exist
    required: false

period:
    description:
    - The time (in seconds) between metric evaluations
    required: false

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:
    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:
    description:
    - Uses a boto profile. Only works with boto >= 2.24.0.
    type: str

namespace:
    description:
    - Name of the appropriate namespace ('AWS/EC2', 'System/Linux', etc.), which determines
      the category it will appear under in cloudwatch
    required: false

statistic:
    choices:
    - SampleCount
    - Average
    - Sum
    - Minimum
    - Maximum
    description:
    - Operation applied to the metric
    - Works in conjunction with period and evaluation_periods to determine the comparison
      value
    required: false

threshold:
    description:
    - Sets the min/max bound for triggering the alarm
    required: false

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:
    - <=
    - <
    - '>'
    - '>='
    description:
    - Determines how the threshold value is compared
    required: false

dimensions:
    description:
    - Describes to what the alarm is applied
    required: false

ok_actions:
    description:
    - A list of the names of action(s) to take when the alarm is in the 'ok' status
    required: false

description:
    description:
    - A longer description of the alarm
    required: false

alarm_actions:
    description:
    - A list of the names action(s) taken when the alarm is in the 'alarm' status
    required: false

aws_access_key:
    aliases:
    - ec2_access_key
    - access_key
    description:
    - 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.
    type: str

aws_secret_key:
    aliases:
    - ec2_secret_key
    - secret_key
    description:
    - 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.
    type: str

security_token:
    aliases:
    - access_token
    description:
    - AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN
      environment variable is used.
    type: str

validate_certs:
    default: true
    description:
    - When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
    type: bool

evaluation_periods:
    description:
    - The number of times in which the metric is evaluated before final calculation
    required: false

insufficient_data_actions:
    description:
    - A list of the names of action(s) to take when the alarm is in the 'insufficient_data'
      status
    required: false

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