Try SpotterManage Application Auto Scaling Scaling Policies
| "added in version" 2.5 of ansible.builtin"
Authors: Gustavo Maia (@gurumaia), Chen Leibovich (@chenl87)
preview | supported by community
pipInstall with pip install ansible==2.9.17
Creates, updates or removes a Scaling Policy
# 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
region:
aliases:
- aws_region
- ec2_region
description:
- 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 U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region)
type: str
ec2_url:
aliases:
- aws_endpoint_url
- endpoint_url
description:
- 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.
type: str
profile:
aliases:
- aws_profile
description:
- Using I(profile) will override I(aws_access_key), I(aws_secret_key) and I(security_token)
and support for passing them at the same time as I(profile) has been deprecated.
- I(aws_access_key), I(aws_secret_key) and I(security_token) will be made mutually
exclusive with I(profile) after 2022-06-01.
type: str
aws_config:
description:
- A dictionary to modify the botocore configuration.
- Parameters can be found at U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config).
- Only the 'user_agent' key is used for boto modules. See U(http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto)
for more boto configuration.
type: dict
policy_name:
description: The name of the scaling policy.
required: true
policy_type:
choices:
- StepScaling
- TargetTrackingScaling
description: The policy type.
required: true
resource_id:
description: The identifier of the resource associated with the scalable target.
required: true
aws_ca_bundle:
description:
- The location of a CA Bundle to use when validating SSL certificates.
- Not used by boto 2 based modules.
- 'Note: The CA Bundle is read ''module'' side and may need to be explicitly copied
from the controller if not run locally.'
type: path
maximum_tasks:
description: 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.
required: false
version_added: '2.6'
version_added_collection: ansible.builtin
minimum_tasks:
description: 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.
required: false
version_added: '2.6'
version_added_collection: ansible.builtin
aws_access_key:
aliases:
- ec2_access_key
- access_key
description:
- C(AWS access key). If not set then the value of the C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY)
or C(EC2_ACCESS_KEY) environment variable is used.
- If I(profile) is set this parameter is ignored.
- Passing the I(aws_access_key) and I(profile) options at the same time has been deprecated
and the options will be made mutually exclusive after 2022-06-01.
type: str
aws_secret_key:
aliases:
- ec2_secret_key
- secret_key
description:
- C(AWS secret key). If not set then the value of the C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY),
or C(EC2_SECRET_KEY) environment variable is used.
- If I(profile) is set this parameter is ignored.
- Passing the I(aws_secret_key) and I(profile) options at the same time has been deprecated
and the options will be made mutually exclusive after 2022-06-01.
type: str
security_token:
aliases:
- aws_security_token
- access_token
description:
- C(AWS STS security token). If not set then the value of the C(AWS_SECURITY_TOKEN)
or C(EC2_SECURITY_TOKEN) environment variable is used.
- If I(profile) is set this parameter is ignored.
- Passing the I(security_token) and I(profile) options at the same time has been deprecated
and the options will be made mutually exclusive after 2022-06-01.
type: str
validate_certs:
default: true
description:
- When set to "no", SSL certificates will not be validated for communication with
the AWS APIs.
type: bool
service_namespace:
choices:
- ecs
- elasticmapreduce
- ec2
- appstream
- dynamodb
description: The namespace of the AWS service.
required: true
scalable_dimension:
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
description: The scalable dimension associated with the scalable target.
required: true
override_task_capacity:
default: false
description: Whether or not to override values of minimum and/or maximum tasks if
it's already set.
required: false
type: bool
version_added: '2.6'
version_added_collection: ansible.builtin
debug_botocore_endpoint_logs:
default: 'no'
description:
- 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.
type: bool
step_scaling_policy_configuration:
description: A step scaling policy. This parameter is required if you are creating
a policy and the policy type is StepScaling.
required: false
target_tracking_scaling_policy_configuration:
description: A target tracking policy. This parameter is required if you are creating
a new policy and the policy type is TargetTrackingScaling.
required: false
alarms:
contains:
alarm_arn:
description: The Amazon Resource Name (ARN) of the alarm
returned: when state present
type: str
alarm_name:
description: The name of the alarm
returned: when state present
type: str
description: List of the CloudWatch alarms associated with the scaling policy
returned: when state present
type: complex
creation_time:
description: The Unix timestamp for when the scalable target was created.
returned: when state present
sample: '2017-09-28T08:22:51.881000-03:00'
type: str
max_capacity:
description: The maximum value to scale to in response to a scale out event. Required
if I(state) is C(present).
returned: when state present
sample: 2
type: int
min_capacity:
description: The minimum value to scale to in response to a scale in event. Required
if I(state) is C(present).
returned: when state present
sample: 1
type: int
policy_arn:
description: The Amazon Resource Name (ARN) of the scaling policy..
returned: when state present
type: str
policy_name:
description: The name of the scaling policy.
returned: when state present
type: str
policy_type:
description: The policy type.
returned: when state present
type: str
resource_id:
description: The identifier of the resource associated with the scalable target.
returned: when state present
sample: service/cluster-name/service-name
type: str
role_arn:
description: The ARN of an IAM role that allows Application Auto Scaling to modify
the scalable target on your behalf. Required if I(state) is C(present).
returned: when state present
sample: arn:aws:iam::123456789123:role/roleName
type: str
scalable_dimension:
description: The scalable dimension associated with the scalable target.
returned: when state present
sample: ecs:service:DesiredCount
type: str
service_namespace:
description: The namespace of the AWS service.
returned: when state present
sample: ecs
type: str
step_scaling_policy_configuration:
contains:
adjustment_type:
description: The adjustment type
returned: when state present and the policy type is StepScaling
sample: ChangeInCapacity, PercentChangeInCapacity, ExactCapacity
type: str
cooldown:
description: 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: 60
type: int
metric_aggregation_type:
description: The aggregation type for the CloudWatch metrics
returned: when state present and the policy type is StepScaling
sample: Average, Minimum, Maximum
type: str
step_adjustments:
description: 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
type: list of complex
description: The step scaling policy.
returned: when state present and the policy type is StepScaling
type: complex
target_tracking_scaling_policy_configuration:
contains:
predefined_metric_specification:
contains:
predefined_metric_type:
description: The metric type
returned: when state present and the policy type is TargetTrackingScaling
sample: ECSServiceAverageCPUUtilization, ECSServiceAverageMemoryUtilization
type: str
resource_label:
description: Identifies the resource associated with the metric type
returned: when metric type is ALBRequestCountPerTarget
type: str
description: A predefined metric
returned: when state present and the policy type is TargetTrackingScaling
type: complex
scale_in_cooldown:
description: 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: 60
type: int
scale_out_cooldown:
description: 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: 60
type: int
target_value:
description: The target value for the metric
returned: when state present and the policy type is TargetTrackingScaling
sample: 70
type: int
description: The target tracking policy.
returned: when state present and the policy type is TargetTrackingScaling
type: complex