Docs4dev
Docs
ansible / latest / collections / community / aws / aws_application_scaling_policy_module.html

community.aws.aws_application_scaling_policy – Manage Application Auto Scaling Scaling Policies

Note

This plugin is part of the community.aws collection (version 1.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.

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

New in version 1.0.0: of community.aws

Synopsis

  • Creates, updates or removes a Scaling Policy.

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.
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
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
maximum_tasks
integer
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
integer
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
    Choices:
  • no
  • yes
Whether or not to override values of minimum and/or maximum tasks if it's already set.
Defaults to false.
policy_name
string / required
The name of the scaling policy.
policy_type
string / required
    Choices:
  • StepScaling
  • TargetTrackingScaling
The policy type.
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
resource_id
string / required
The identifier of the resource associated with the scalable target.
scalable_dimension
string / required
    Choices:
  • ecs:service:DesiredCount
  • ec2:spot-fleet-request:TargetCapacity
  • elasticmapreduce:instancegroup:InstanceCount
  • appstream:fleet:DesiredCapacity
  • dynamodb:table:ReadCapacityUnits
  • dynamodb:table:WriteCapacityUnits
  • dynamodb:index:ReadCapacityUnits
  • dynamodb:index:WriteCapacityUnits
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.
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
service_namespace
string / required
    Choices:
  • ecs
  • elasticmapreduce
  • ec2
  • appstream
  • dynamodb
The namespace of the AWS service.
state
string / required
    Choices:
  • absent
  • present
Whether a policy should be present or absent.
step_scaling_policy_configuration
dictionary
A step scaling policy. This parameter is required if you are creating a policy and policy_type=StepScaling.
target_tracking_scaling_policy_configuration
dictionary
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:
CustomizedMetricSpecification
dictionary
The metric to use if using a customized metric.
DisableScaleIn
boolean
    Choices:
  • no
  • yes
Whether scaling-in should be disabled.
PredefinedMetricSpecification
dictionary
The metric to use if using a predefined metric.
ScaleInCooldown
integer
The time (in seconds) to wait after scaling-in before another scaling action can occur.
ScaleOutCooldown
integer
The time (in seconds) to wait after scaling-out before another scaling action can occur.
TargetValue
float
The target value for the 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

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.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
  community.aws.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
  community.aws.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:

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 / elements=dictionary
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


Authors

  • Gustavo Maia (@gurumaia)
  • Chen Leibovich (@chenl87)

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