community.aws.application_autoscaling_policy module – Manage Application Auto Scaling Scaling Policies
Note
This module is part of the community.aws collection (version 7.2.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.application_autoscaling_policy.
New in community.aws 1.0.0
Synopsis
Creates, updates or removes a Scaling Policy.
Prior to release 5.0.0 this module was called
community.aws.aws_application_scaling_policy. The usage did not change.
Aliases: aws_application_scaling_policy
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.6
boto3 >= 1.26.0
botocore >= 1.29.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 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. |
|
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 maximum value to scale to in response to a scale out event. This parameter is required if you are creating a first new policy for the specified service. |
|
The minimum value to scale to in response to a scale in event. This parameter is required if you are creating a first new policy for the specified service. |
|
Whether or not to override values of minimum and/or maximum tasks if it’s already set. Defaults to Choices:
|
|
The name of the scaling policy. |
|
The policy type. 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 identifier of the resource associated with the scalable target. |
|
The scalable dimension associated with the scalable target. Choices:
|
|
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 |
|
The namespace of the AWS service. Choices:
|
|
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 |
|
Whether a policy should be Choices:
|
|
A step scaling policy. This parameter is required if you are creating a policy and policy_type=StepScaling. |
|
A target tracking policy. This parameter is required if you are creating a new policy and policy_type=TargetTrackingScaling. Full documentation of the suboptions can be found in the API documentation: |
|
The metric to use if using a customized metric. |
|
Whether scaling-in should be disabled. Choices:
|
|
The metric to use if using a predefined metric. |
|
The time (in seconds) to wait after scaling-in before another scaling action can occur. |
|
The time (in seconds) to wait after scaling-out before another scaling action can occur. |
|
The target value for the metric. |
|
When set to Setting validate_certs=false is strongly discouraged, as an alternative, consider setting aws_ca_bundle instead. Choices:
|
Notes
Note
For more details of the parameters and returns see http://boto3.readthedocs.io/en/latest/reference/services/application-autoscaling.html#ApplicationAutoScaling.Client.put_scaling_policy
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
# Note: These examples do not set authentication details, see the AWS Guide for details.
# Create step scaling policy for ECS Service
- name: scaling_policy
community.aws.application_autoscaling_policy:
state: present
policy_name: test_policy
service_namespace: ecs
resource_id: service/poc-pricing/test-as
scalable_dimension: ecs:service:DesiredCount
policy_type: StepScaling
minimum_tasks: 1
maximum_tasks: 6
step_scaling_policy_configuration:
AdjustmentType: ChangeInCapacity
StepAdjustments:
- MetricIntervalUpperBound: 123
ScalingAdjustment: 2
- MetricIntervalLowerBound: 123
ScalingAdjustment: -2
Cooldown: 123
MetricAggregationType: Average
# Create target tracking scaling policy for ECS Service
- name: scaling_policy
community.aws.application_autoscaling_policy:
state: present
policy_name: test_policy
service_namespace: ecs
resource_id: service/poc-pricing/test-as
scalable_dimension: ecs:service:DesiredCount
policy_type: TargetTrackingScaling
minimum_tasks: 1
maximum_tasks: 6
target_tracking_scaling_policy_configuration:
TargetValue: 60
PredefinedMetricSpecification:
PredefinedMetricType: ECSServiceAverageCPUUtilization
ScaleOutCooldown: 60
ScaleInCooldown: 60
# Remove scalable target for ECS Service
- name: scaling_policy
community.aws.application_autoscaling_policy:
state: absent
policy_name: test_policy
policy_type: StepScaling
service_namespace: ecs
resource_id: service/cluster-name/service-name
scalable_dimension: ecs:service:DesiredCount
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
List of the CloudWatch alarms associated with the scaling policy Returned: when state present |
|
The Amazon Resource Name (ARN) of the alarm Returned: when state present |
|
The name of the alarm Returned: when state present |
|
The Unix timestamp for when the scalable target was created. Returned: when state present Sample: |
|
The maximum value to scale to in response to a scale out event. Required if state is Returned: when state present Sample: |
|
The minimum value to scale to in response to a scale in event. Required if state is Returned: when state present Sample: |
|
The Amazon Resource Name (ARN) of the scaling policy.. Returned: when state present |
|
The name of the scaling policy. Returned: when state present |
|
The policy type. Returned: when state present |
|
The identifier of the resource associated with the scalable target. Returned: when state present Sample: |
|
The ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf. Required if state is Returned: when state present Sample: |
|
The scalable dimension associated with the scalable target. Returned: when state present Sample: |
|
The namespace of the AWS service. Returned: when state present Sample: |
|
The step scaling policy. Returned: when state present and the policy type is StepScaling |
|
The adjustment type Returned: when state present and the policy type is StepScaling Sample: |
|
The amount of time, in seconds, after a scaling activity completes where previous trigger-related scaling activities can influence future scaling events Returned: when state present and the policy type is StepScaling Sample: |
|
The aggregation type for the CloudWatch metrics Returned: when state present and the policy type is StepScaling Sample: |
|
A set of adjustments that enable you to scale based on the size of the alarm breach Returned: when state present and the policy type is StepScaling |
|
The target tracking policy. Returned: when state present and the policy type is TargetTrackingScaling |
|
A predefined metric Returned: when state present and the policy type is TargetTrackingScaling |
|
The metric type Returned: when state present and the policy type is TargetTrackingScaling Sample: |
|
Identifies the resource associated with the metric type Returned: when metric type is ALBRequestCountPerTarget |
|
The amount of time, in seconds, after a scale in activity completes before another scale in activity can start Returned: when state present and the policy type is TargetTrackingScaling Sample: |
|
The amount of time, in seconds, after a scale out activity completes before another scale out activity can start Returned: when state present and the policy type is TargetTrackingScaling Sample: |
|
The target value for the metric Returned: when state present and the policy type is TargetTrackingScaling Sample: |