aws_application_scaling_policy – Manage Application Auto Scaling Scaling Policies¶
New in version 2.5.
Requirements¶
The below requirements are needed on the host that executes this module.
- boto
- boto3
- botocore
- json
- python >= 2.6
Parameters¶
| Parameter | Choices/Defaults | Comments | 
|---|---|---|
| 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. aliases: ec2_access_key, access_key | |
| 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. aliases: ec2_secret_key, secret_key | |
| debug_botocore_endpoint_logs 
                    boolean
                                                                 added in 2.8 | 
 | 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. | |
| maximum_tasks 
                    -
                                                                 added in 2.6 | 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. | |
| minimum_tasks 
                    -
                                                                 added in 2.6 | 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. | |
| override_task_capacity 
                    boolean
                                                                 added in 2.6 | 
 | Whether or not to override values of minimum and/or maximum tasks if it's already set. | 
| policy_name 
                    -
                                             / required                     | The name of the scaling policy. | |
| policy_type 
                    -
                                             / required                     | 
 | The policy type. | 
| profile 
                    string
                                                                 | Uses a boto profile. Only works with boto >= 2.24.0. | |
| 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 | |
| resource_id 
                    -
                                             / required                     | The identifier of the resource associated with the scalable target. | |
| scalable_dimension 
                    -
                                             / required                     | 
 | The scalable dimension associated with the scalable target. | 
| 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. aliases: access_token | |
| service_namespace 
                    -
                                             / required                     | 
 | The namespace of the AWS service. | 
| step_scaling_policy_configuration 
                    -
                                                                 | A step scaling policy. This parameter is required if you are creating a policy and the policy type is StepScaling. | |
| target_tracking_scaling_policy_configuration 
                    -
                                                                 | A target tracking policy. This parameter is required if you are creating a new policy and the policy type is TargetTrackingScaling. | |
| validate_certs 
                    boolean
                                                                 | 
 | When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0. | 
Notes¶
Note
- for details of the parameters and returns see http://boto3.readthedocs.io/en/latest/reference/services/application-autoscaling.html#ApplicationAutoScaling.Client.put_scaling_policy
- If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence AWS_URLorEC2_URL,AWS_ACCESS_KEY_IDorAWS_ACCESS_KEYorEC2_ACCESS_KEY,AWS_SECRET_ACCESS_KEYorAWS_SECRET_KEYorEC2_SECRET_KEY,AWS_SECURITY_TOKENorEC2_SECURITY_TOKEN,AWS_REGIONorEC2_REGION
- 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_REGIONor- EC2_REGIONcan be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file
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
  aws_application_scaling_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
  aws_application_scaling_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
  aws_application_scaling_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:
Status¶
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors¶
- Gustavo Maia (@gurumaia)
- Chen Leibovich (@chenl87)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.
