W3cubDocs

/Ansible 2.10

community.aws.ec2_scaling_policy – Create or delete AWS scaling policies for Autoscaling groups

Note

This plugin is part of the community.aws collection.

To install it use: ansible-galaxy collection install community.aws.

To use it in a playbook, specify: community.aws.ec2_scaling_policy.

New in version 1.0.0: of community.aws

Synopsis

  • Can create or delete scaling policies for autoscaling groups.
  • Referenced autoscaling groups must already exist.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.6
  • boto

Parameters

Parameter Choices/Defaults Comments
adjustment_type
string
    Choices:
  • ChangeInCapacity
  • ExactCapacity
  • PercentChangeInCapacity
The type of change in capacity of the autoscaling group.
Required if state is present.
asg_name
string
Name of the associated autoscaling group.
Required if state is present.
aws_access_key
string
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.
If profile is set this parameter is ignored.
Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aliases: ec2_access_key, access_key
aws_ca_bundle
path
The location of a CA Bundle to use when validating SSL certificates.
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
aws_config
dictionary
A dictionary to modify the botocore configuration.
Only the 'user_agent' key is used for boto modules. See http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto for more boto configuration.
aws_secret_key
string
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.
If profile is set this parameter is ignored.
Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aliases: ec2_secret_key, secret_key
cooldown
integer
The minimum period of time (in seconds) between which autoscaling actions can take place.
Only used when policy_type is SimpleScaling.
debug_botocore_endpoint_logs
boolean
    Choices:
  • no ←
  • yes
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.
ec2_url
string
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.

aliases: aws_endpoint_url, endpoint_url
estimated_instance_warmup
integer
The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.
metric_aggregation
string
    Choices:
  • Minimum
  • Maximum
  • Average ←
The aggregation type for the CloudWatch metrics.
Only used when policy_type is not SimpleScaling.
min_adjustment_step
integer
Minimum amount of adjustment when policy is triggered.
Only used when adjustment_type is PercentChangeInCapacity.
name
string / required
Unique name for the scaling policy.
policy_type
string
    Choices:
  • StepScaling
  • SimpleScaling ←
Auto scaling adjustment policy.
profile
string
Uses a boto profile. Only works with boto >= 2.24.0.
Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

aliases: aws_profile
region
string
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 http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region

aliases: aws_region, ec2_region
scaling_adjustment
integer
The amount by which the autoscaling group is adjusted by the policy.
A negative number has the effect of scaling down the ASG.
Units are numbers of instances for ExactCapacity or ChangeInCapacity or percent of existing instances for PercentChangeInCapacity.
Required when policy_type is SimpleScaling.
security_token
string
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
If profile is set this parameter is ignored.
Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aliases: aws_security_token, access_token
state
string
    Choices:
  • present ←
  • absent
Register or deregister the policy.
step_adjustments
list / elements=dictionary
list of dicts containing lower_bound, upper_bound and scaling_adjustment
Intervals must not overlap or have a gap between them.
At most, one item can have an undefined lower_bound. If any item has a negative lower_bound, then there must be a step adjustment with an undefined lower_bound.
At most, one item can have an undefined upper_bound. If any item has a positive upper_bound, then there must be a step adjustment with an undefined upper_bound.
The bounds are the amount over the alarm threshold at which the adjustment will trigger. This means that for an alarm threshold of 50, triggering at 75 requires a lower bound of 25. See http://docs.aws.amazon.com/AutoScaling/latest/APIReference/API_StepAdjustment.html.
lower_bound
integer
The lower bound for the difference between the alarm threshold and the CloudWatch metric.
scaling_adjustment
integer / required
The amount by which to scale.
upper_bound
integer
The upper bound for the difference between the alarm threshold and the CloudWatch metric.
validate_certs
boolean
    Choices:
  • no
  • yes ←
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.

Notes

Note

  • If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence AWS_URL or EC2_URL, AWS_PROFILE or AWS_DEFAULT_PROFILE, AWS_ACCESS_KEY_ID or AWS_ACCESS_KEY or EC2_ACCESS_KEY, AWS_SECRET_ACCESS_KEY or AWS_SECRET_KEY or EC2_SECRET_KEY, AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN, AWS_REGION or EC2_REGION, AWS_CA_BUNDLE
  • Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html
  • 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

Examples

- name: Simple Scale Down policy
  community.aws.ec2_scaling_policy:
    state: present
    region: US-XXX
    name: "scaledown-policy"
    adjustment_type: "ChangeInCapacity"
    asg_name: "application-asg"
    scaling_adjustment: -1
    min_adjustment_step: 1
    cooldown: 300

# For an alarm with a breach threshold of 20, the
# following creates a stepped policy:
# From 20-40 (0-20 above threshold), increase by 50% of existing capacity
# From 41-infinity, increase by 100% of existing capacity
- community.aws.ec2_scaling_policy:
    state: present
    region: US-XXX
    name: "step-scale-up-policy"
    policy_type: StepScaling
    metric_aggregation: Maximum
    step_adjustments:
      - upper_bound: 20
        scaling_adjustment: 50
      - lower_bound: 20
        scaling_adjustment: 100
    adjustment_type: "PercentChangeInCapacity"
    asg_name: "application-asg"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
adjustment_type
string
always
Scaling policy adjustment type

Sample:
PercentChangeInCapacity
alarms
complex
always
Cloudwatch alarms related to the policy
alarm_arn
string
always
ARN of the Cloudwatch alarm

Sample:
arn:aws:cloudwatch:us-east-2:1234567890:alarm:cpu-very-high
alarm_name
string
always
name of the Cloudwatch alarm

Sample:
cpu-very-high
arn
string
always
ARN of the scaling policy. Provided for backward compatibility, value is the same as policy_arn

Sample:
arn:aws:autoscaling:us-east-2:123456789012:scalingPolicy:59e37526-bd27-42cf-adca-5cd3d90bc3b9:autoScalingGroupName/app-asg:policyName/app-policy
as_name
string
always
Auto Scaling Group name. Provided for backward compatibility, value is the same as auto_scaling_group_name

Sample:
app-asg
auto_scaling_group_name
string
always
Name of Auto Scaling Group

Sample:
app-asg
metric_aggregation_type
string
when policy_type is StepScaling
Method used to aggregate metrics

Sample:
Maximum
name
string
always
Name of the scaling policy. Provided for backward compatibility, value is the same as policy_name

Sample:
app-policy
policy_arn
string
always
ARN of scaling policy.

Sample:
arn:aws:autoscaling:us-east-2:123456789012:scalingPolicy:59e37526-bd27-42cf-adca-5cd3d90bc3b9:autoScalingGroupName/app-asg:policyName/app-policy
policy_name
string
always
Name of scaling policy

Sample:
app-policy
policy_type
string
always
Type of auto scaling policy

Sample:
StepScaling
scaling_adjustment
integer
When policy_type is SimpleScaling
Adjustment to make when alarm is triggered

Sample:
1
step_adjustments
complex
always
List of step adjustments
metric_interval_lower_bound
float
if step has a lower bound
Lower bound for metric interval

Sample:
20.0
metric_interval_upper_bound
float
if step has an upper bound
Upper bound for metric interval

Sample:
40.0
scaling_adjustment
integer
always
Adjustment to make if this step is reached

Sample:
50


Authors

  • Zacharie Eakin (@zeekin)
  • Will Thames (@willthames)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/aws/ec2_scaling_policy_module.html