community.aws.autoscaling_policy module – Create or delete AWS scaling policies for Autoscaling groups
Note
This module is part of the community.aws collection (version 5.5.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 community.aws.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.aws.autoscaling_policy.
New in community.aws 1.0.0
Synopsis
Can create or delete scaling policies for autoscaling groups.
Referenced autoscaling groups must already exist.
Prior to release 5.0.0 this module was called
community.aws.ec2_scaling_policy. The usage did not change.
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.6
boto3 >= 1.18.0
botocore >= 1.21.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 |
|
The type of change in capacity of the autoscaling group. Required if state is Choices:
|
|
Name of the associated autoscaling group. Required if state is |
|
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. |
|
The minimum period of time (in seconds) between which autoscaling actions can take place. Only used when policy_type is |
|
Use a The Choices:
|
|
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 |
|
The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. |
|
The aggregation type for the CloudWatch metrics. Only used when policy_type is not Choices:
|
|
Minimum amount of adjustment when policy is triggered. Only used when adjustment_type is |
|
Unique name for the scaling policy. |
|
Auto scaling adjustment policy. Choices:
|
|
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 |
|
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 Required when policy_type is |
|
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 policy. Choices:
|
|
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. |
|
The lower bound for the difference between the alarm threshold and the CloudWatch metric. |
|
The amount by which to scale. |
|
The upper bound for the difference between the alarm threshold and the CloudWatch metric. |
|
Allows you to specify a target_tracking_config for autoscaling policies in AWS. target_tracking_config can accept nested dicts for customized_metric_spec or predefined_metric_spec. Each specification aligns with their boto3 equivalent. Required when TargetTrackingScaling policy is specified. |
|
Specify a dict will be passed in as a call for |
|
The dimensions of the metric. The element of the list should be a dict. |
|
The name of the metric. |
|
The namespace of the metric. |
|
The statistic of the metric. Choices:
|
|
The unit of the metric. Reference AmazonCloudWatch API for valid Units. |
|
Indicate whether scaling in by the target tracking scaling policy is disabled. Choices:
|
|
Specify a dict will be passed in as a call for TargetTrackingConfiguration. |
|
Required if Choices:
|
|
Uniquely identifies a specific ALB target group from which to determine the average request count served by your Auto Scaling group. You can’t specify a resource label unless the target group is attached to the Auto Scaling group. |
|
Specify a float number for target utilization. Required when target_tracking_config is specified. |
|
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: Simple Scale Down policy
community.aws.autoscaling_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.autoscaling_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"
- name: create TargetTracking predefined policy
ec2_scaling_policy:
name: "predefined-policy-1"
policy_type: TargetTrackingScaling
target_tracking_config:
predefined_metric_spec:
predefined_metric_type: ASGAverageCPUUtilization
target_value: 98.0
asg_name: "asg-test-1"
register: result
- name: create TargetTracking predefined policy with resource_label
ec2_scaling_policy:
name: "predefined-policy-1"
policy_type: TargetTrackingScaling
target_tracking_config:
predefined_metric_spec:
predefined_metric_type: ALBRequestCountPerTarget
resource_label: app/my-alb/778d41231d141a0f/targetgroup/my-alb-target-group/942f017f100becff
target_value: 98.0
asg_name: "asg-test-1"
register: result
- name: create TargetTrackingScaling custom policy
ec2_scaling_policy:
name: "custom-policy-1"
policy_type: TargetTrackingScaling
target_tracking_config:
customized_metric_spec:
metric_name: metric_1
namespace: namespace_1
statistic: Minimum
unit: Gigabits
dimensions: [{'Name': 'dimension1', 'Value': 'value1'}]
disable_scalein: true
target_value: 98.0
asg_name: asg-test-1
register: result
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Scaling policy adjustment type. Returned: always Sample: |
|
Cloudwatch alarms related to the policy. Returned: always |
|
ARN of the Cloudwatch alarm. Returned: always Sample: |
|
Name of the Cloudwatch alarm. Returned: always Sample: |
|
ARN of the scaling policy. Provided for backward compatibility, value is the same as policy_arn. Returned: always Sample: |
|
Auto Scaling Group name. Provided for backward compatibility, value is the same as auto_scaling_group_name. Returned: always Sample: |
|
Name of Auto Scaling Group. Returned: always Sample: |
|
Method used to aggregate metrics. Returned: when policy_type is Sample: |
|
Name of the scaling policy. Provided for backward compatibility, value is the same as policy_name. Returned: always Sample: |
|
ARN of scaling policy. Returned: always Sample: |
|
Name of scaling policy. Returned: always Sample: |
|
Type of auto scaling policy. Returned: always Sample: |
|
Adjustment to make when alarm is triggered. Returned: When policy_type is Sample: |
|
List of step adjustments. Returned: always |
|
Lower bound for metric interval. Returned: if step has a lower bound Sample: |
|
Upper bound for metric interval. Returned: if step has an upper bound Sample: |
|
Adjustment to make if this step is reached. Returned: always Sample: |