aws_application_scaling_policy - Manage Application Auto Scaling Scaling Policies

New in version 2.5.

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 Default:
None
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 Default:
None
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
ec2_url Default:
None
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.
policy_name
required
The name of the scaling policy.
policy_type
required
    Choices:
  • StepScaling
  • TargetTrackingScaling
The policy type.
profile
(added in 1.6)
 Default:
None
Uses a boto profile. Only works with boto >= 2.24.0.
region
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
    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
(added in 1.6)
 Default:
None
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
    Choices:
  • ecs
  • elasticmapreduce
  • ec2
  • appstream
  • dynamodb
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
(added in 1.5)
    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 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
  step_scaling_policy_configuration:
    AdjustmentType: ChangeInCapacity
    StepAdjustments:
      - MetricIntervalUpperBound: 123
        ScalingAdjustment: 2
      - MetricIntervalLowerBound: 123
        ScalingAdjustment: -2
    Cooldown: 123
    MetricAggregationType: Average

# 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:

Key Returned Description
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
int
 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
int
 when state present
The minimum value to scale to in response to a scale in event. Required if state is present.

Sample:
1
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


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author

  • Gustavo Maia(@gurumaia)

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.5/modules/aws_application_scaling_policy_module.html