New in version 2.5.
The below requirements are needed on the host that executes this module.
| 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. |
Note
AWS_URL or EC2_URL, 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_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# 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
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description | ||
|---|---|---|---|---|
| alarms complex | when state present | List of the CloudWatch alarms associated with the scaling policy | ||
| alarm_arn string | when state present | The Amazon Resource Name (ARN) of the alarm | ||
| alarm_name string | when state present | The name of the alarm | ||
| creation_time string | when state present | The Unix timestamp for when the scalable target was created. Sample: 2017-09-28T08:22:51.881000-03:00 | ||
| max_capacity integer | when state present | The maximum value to scale to in response to a scale out event. Required if state is present.Sample: 2 | ||
| min_capacity integer | when state present | The minimum value to scale to in response to a scale in event. Required if state is present.Sample: 1 | ||
| policy_arn string | when state present | The Amazon Resource Name (ARN) of the scaling policy.. | ||
| policy_name string | when state present | The name of the scaling policy. | ||
| policy_type string | when state present | The policy type. | ||
| resource_id string | when state present | The identifier of the resource associated with the scalable target. Sample: service/cluster-name/service-name | ||
| role_arn string | when state present | The ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf. Required if state is present.Sample: arn:aws:iam::123456789123:role/roleName | ||
| scalable_dimension string | when state present | The scalable dimension associated with the scalable target. Sample: ecs:service:DesiredCount | ||
| service_namespace string | when state present | The namespace of the AWS service. Sample: ecs | ||
| step_scaling_policy_configuration complex | when state present and the policy type is StepScaling | The step scaling policy. | ||
| adjustment_type string | when state present and the policy type is StepScaling | The adjustment type Sample: ChangeInCapacity, PercentChangeInCapacity, ExactCapacity | ||
| cooldown integer | when state present and the policy type is StepScaling | The amount of time, in seconds, after a scaling activity completes where previous trigger-related scaling activities can influence future scaling events Sample: 60 | ||
| metric_aggregation_type string | when state present and the policy type is StepScaling | The aggregation type for the CloudWatch metrics Sample: Average, Minimum, Maximum | ||
| step_adjustments list of complex | when state present and the policy type is StepScaling | A set of adjustments that enable you to scale based on the size of the alarm breach | ||
| target_tracking_scaling_policy_configuration complex | when state present and the policy type is TargetTrackingScaling | The target tracking policy. | ||
| predefined_metric_specification complex | when state present and the policy type is TargetTrackingScaling | A predefined metric | ||
| predefined_metric_type string | when state present and the policy type is TargetTrackingScaling | The metric type Sample: ECSServiceAverageCPUUtilization, ECSServiceAverageMemoryUtilization | ||
| resource_label string | when metric type is ALBRequestCountPerTarget | Identifies the resource associated with the metric type | ||
| scale_in_cooldown integer | when state present and the policy type is TargetTrackingScaling | The amount of time, in seconds, after a scale in activity completes before another scale in activity can start Sample: 60 | ||
| scale_out_cooldown integer | when state present and the policy type is TargetTrackingScaling | The amount of time, in seconds, after a scale out activity completes before another scale out activity can start Sample: 60 | ||
| target_value integer | when state present and the policy type is TargetTrackingScaling | The target value for the metric Sample: 70 | ||
Hint
If you notice any issues in this documentation, you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/aws_application_scaling_policy_module.html