#!/usr/bin/python # -*- coding: utf-8 -*- # Copyright: Ansible Project # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) DOCUMENTATION = r""" --- module: application_autoscaling_policy version_added: 1.0.0 short_description: Manage Application Auto Scaling Scaling Policies notes: - For more details of the parameters and returns see U(http://boto3.readthedocs.io/en/latest/reference/services/application-autoscaling.html#ApplicationAutoScaling.Client.put_scaling_policy) description: - Creates, updates or removes a Scaling Policy. - Prior to release 5.0.0 this module was called C(community.aws.aws_application_scaling_policy). The usage did not change. author: - Gustavo Maia (@gurumaia) - Chen Leibovich (@chenl87) options: state: description: Whether a policy should be C(present) or C(absent). required: true choices: ['absent', 'present'] type: str policy_name: description: The name of the scaling policy. required: true type: str service_namespace: description: The namespace of the AWS service. required: true choices: ['ecs', 'elasticmapreduce', 'ec2', 'appstream', 'dynamodb'] type: str resource_id: description: The identifier of the resource associated with the scalable target. required: true type: str scalable_dimension: description: The scalable dimension associated with the scalable target. required: true 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'] type: str policy_type: description: The policy type. required: true choices: ['StepScaling', 'TargetTrackingScaling'] type: str step_scaling_policy_configuration: description: A step scaling policy. This parameter is required if you are creating a policy and I(policy_type=StepScaling). required: false type: dict target_tracking_scaling_policy_configuration: description: - A target tracking policy. This parameter is required if you are creating a new policy and I(policy_type=TargetTrackingScaling). - 'Full documentation of the suboptions can be found in the API documentation:' - 'U(https://docs.aws.amazon.com/autoscaling/application/APIReference/API_TargetTrackingScalingPolicyConfiguration.html)' required: false type: dict suboptions: CustomizedMetricSpecification: description: The metric to use if using a customized metric. type: dict DisableScaleIn: description: Whether scaling-in should be disabled. type: bool PredefinedMetricSpecification: description: The metric to use if using a predefined metric. type: dict ScaleInCooldown: description: The time (in seconds) to wait after scaling-in before another scaling action can occur. type: int ScaleOutCooldown: description: The time (in seconds) to wait after scaling-out before another scaling action can occur. type: int TargetValue: description: The target value for the metric. type: float 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 type: int 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 type: int override_task_capacity: description: - Whether or not to override values of minimum and/or maximum tasks if it's already set. - Defaults to C(false). required: false type: bool extends_documentation_fragment: - amazon.aws.common.modules - amazon.aws.region.modules - amazon.aws.boto3 """ EXAMPLES = r""" # 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.application_autoscaling_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.application_autoscaling_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.application_autoscaling_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 = r""" alarms: description: List of the CloudWatch alarms associated with the scaling policy returned: when state present type: complex 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 service_namespace: description: The namespace of the AWS service. returned: when state present type: str sample: ecs resource_id: description: The identifier of the resource associated with the scalable target. returned: when state present type: str sample: service/cluster-name/service-name scalable_dimension: description: The scalable dimension associated with the scalable target. returned: when state present type: str sample: ecs:service:DesiredCount 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 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 type: int sample: 1 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 type: int sample: 2 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 type: str sample: arn:aws:iam::123456789012:role/roleName step_scaling_policy_configuration: description: The step scaling policy. returned: when state present and the policy type is StepScaling type: complex contains: adjustment_type: description: The adjustment type returned: when state present and the policy type is StepScaling type: str sample: "ChangeInCapacity, PercentChangeInCapacity, ExactCapacity" 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 type: int sample: 60 metric_aggregation_type: description: The aggregation type for the CloudWatch metrics returned: when state present and the policy type is StepScaling type: str sample: "Average, Minimum, Maximum" 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 elements: dict target_tracking_scaling_policy_configuration: description: The target tracking policy. returned: when state present and the policy type is TargetTrackingScaling type: complex contains: predefined_metric_specification: description: A predefined metric returned: when state present and the policy type is TargetTrackingScaling type: complex contains: predefined_metric_type: description: The metric type returned: when state present and the policy type is TargetTrackingScaling type: str sample: "ECSServiceAverageCPUUtilization, ECSServiceAverageMemoryUtilization" resource_label: description: Identifies the resource associated with the metric type returned: when metric type is ALBRequestCountPerTarget type: str 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 type: int sample: 60 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 type: int sample: 60 target_value: description: The target value for the metric returned: when state present and the policy type is TargetTrackingScaling type: int sample: 70 creation_time: description: The Unix timestamp for when the scalable target was created. returned: when state present type: str sample: '2017-09-28T08:22:51.881000-03:00' """ try: import botocore except ImportError: pass # handled by AnsibleAWSModule from ansible.module_utils.common.dict_transformations import _camel_to_snake from ansible.module_utils.common.dict_transformations import camel_dict_to_snake_dict from ansible_collections.community.aws.plugins.module_utils.modules import AnsibleCommunityAWSModule as AnsibleAWSModule # Merge the results of the scalable target creation and policy deletion/creation # There's no risk in overriding values since mutual keys have the same values in our case def merge_results(scalable_target_result, policy_result): changed = bool(scalable_target_result["changed"] or policy_result["changed"]) merged_response = scalable_target_result["response"].copy() merged_response.update(policy_result["response"]) return {"changed": changed, "response": merged_response} def delete_scaling_policy(connection, module): changed = False try: scaling_policy = connection.describe_scaling_policies( ServiceNamespace=module.params.get("service_namespace"), ResourceId=module.params.get("resource_id"), ScalableDimension=module.params.get("scalable_dimension"), PolicyNames=[module.params.get("policy_name")], MaxResults=1, ) except (botocore.exceptions.ClientError, botocore.exceptions.BotoCoreError) as e: module.fail_json_aws(e, msg="Failed to describe scaling policies") if scaling_policy["ScalingPolicies"]: try: connection.delete_scaling_policy( ServiceNamespace=module.params.get("service_namespace"), ResourceId=module.params.get("resource_id"), ScalableDimension=module.params.get("scalable_dimension"), PolicyName=module.params.get("policy_name"), ) changed = True except (botocore.exceptions.ClientError, botocore.exceptions.BotoCoreError) as e: module.fail_json_aws(e, msg="Failed to delete scaling policy") return {"changed": changed} def create_scalable_target(connection, module): changed = False try: scalable_targets = connection.describe_scalable_targets( ServiceNamespace=module.params.get("service_namespace"), ResourceIds=[ module.params.get("resource_id"), ], ScalableDimension=module.params.get("scalable_dimension"), ) except (botocore.exceptions.ClientError, botocore.exceptions.BotoCoreError) as e: module.fail_json_aws(e, msg="Failed to describe scalable targets") # Scalable target registration will occur if: # 1. There is no scalable target registered for this service # 2. A scalable target exists, different min/max values are defined and override is set to "yes" if not scalable_targets["ScalableTargets"] or ( module.params.get("override_task_capacity") and ( scalable_targets["ScalableTargets"][0]["MinCapacity"] != module.params.get("minimum_tasks") or scalable_targets["ScalableTargets"][0]["MaxCapacity"] != module.params.get("maximum_tasks") ) ): changed = True try: connection.register_scalable_target( ServiceNamespace=module.params.get("service_namespace"), ResourceId=module.params.get("resource_id"), ScalableDimension=module.params.get("scalable_dimension"), MinCapacity=module.params.get("minimum_tasks"), MaxCapacity=module.params.get("maximum_tasks"), ) except (botocore.exceptions.ClientError, botocore.exceptions.BotoCoreError) as e: module.fail_json_aws(e, msg="Failed to register scalable target") try: response = connection.describe_scalable_targets( ServiceNamespace=module.params.get("service_namespace"), ResourceIds=[ module.params.get("resource_id"), ], ScalableDimension=module.params.get("scalable_dimension"), ) except (botocore.exceptions.ClientError, botocore.exceptions.BotoCoreError) as e: module.fail_json_aws(e, msg="Failed to describe scalable targets") if response["ScalableTargets"]: snaked_response = camel_dict_to_snake_dict(response["ScalableTargets"][0]) else: snaked_response = {} return {"changed": changed, "response": snaked_response} def create_scaling_policy(connection, module): try: scaling_policy = connection.describe_scaling_policies( ServiceNamespace=module.params.get("service_namespace"), ResourceId=module.params.get("resource_id"), ScalableDimension=module.params.get("scalable_dimension"), PolicyNames=[module.params.get("policy_name")], MaxResults=1, ) except (botocore.exceptions.ClientError, botocore.exceptions.BotoCoreError) as e: module.fail_json_aws(e, msg="Failed to describe scaling policies") changed = False if scaling_policy["ScalingPolicies"]: scaling_policy = scaling_policy["ScalingPolicies"][0] # check if the input parameters are equal to what's already configured for attr in ( "PolicyName", "ServiceNamespace", "ResourceId", "ScalableDimension", "PolicyType", "StepScalingPolicyConfiguration", "TargetTrackingScalingPolicyConfiguration", ): if attr in scaling_policy and scaling_policy[attr] != module.params.get(_camel_to_snake(attr)): changed = True scaling_policy[attr] = module.params.get(_camel_to_snake(attr)) else: changed = True scaling_policy = { "PolicyName": module.params.get("policy_name"), "ServiceNamespace": module.params.get("service_namespace"), "ResourceId": module.params.get("resource_id"), "ScalableDimension": module.params.get("scalable_dimension"), "PolicyType": module.params.get("policy_type"), "StepScalingPolicyConfiguration": module.params.get("step_scaling_policy_configuration"), "TargetTrackingScalingPolicyConfiguration": module.params.get( "target_tracking_scaling_policy_configuration" ), } if changed: try: if module.params.get("step_scaling_policy_configuration"): connection.put_scaling_policy( PolicyName=scaling_policy["PolicyName"], ServiceNamespace=scaling_policy["ServiceNamespace"], ResourceId=scaling_policy["ResourceId"], ScalableDimension=scaling_policy["ScalableDimension"], PolicyType=scaling_policy["PolicyType"], StepScalingPolicyConfiguration=scaling_policy["StepScalingPolicyConfiguration"], ) elif module.params.get("target_tracking_scaling_policy_configuration"): connection.put_scaling_policy( PolicyName=scaling_policy["PolicyName"], ServiceNamespace=scaling_policy["ServiceNamespace"], ResourceId=scaling_policy["ResourceId"], ScalableDimension=scaling_policy["ScalableDimension"], PolicyType=scaling_policy["PolicyType"], TargetTrackingScalingPolicyConfiguration=scaling_policy["TargetTrackingScalingPolicyConfiguration"], ) except (botocore.exceptions.ClientError, botocore.exceptions.BotoCoreError) as e: module.fail_json_aws(e, msg="Failed to create scaling policy") try: response = connection.describe_scaling_policies( ServiceNamespace=module.params.get("service_namespace"), ResourceId=module.params.get("resource_id"), ScalableDimension=module.params.get("scalable_dimension"), PolicyNames=[module.params.get("policy_name")], MaxResults=1, ) except (botocore.exceptions.ClientError, botocore.exceptions.BotoCoreError) as e: module.fail_json_aws(e, msg="Failed to describe scaling policies") if response["ScalingPolicies"]: snaked_response = camel_dict_to_snake_dict(response["ScalingPolicies"][0]) else: snaked_response = {} return {"changed": changed, "response": snaked_response} def main(): argument_spec = dict( state=dict(type="str", required=True, choices=["present", "absent"]), policy_name=dict(type="str", required=True), service_namespace=dict( type="str", required=True, choices=["appstream", "dynamodb", "ec2", "ecs", "elasticmapreduce"] ), resource_id=dict(type="str", required=True), scalable_dimension=dict( type="str", required=True, 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", ], ), policy_type=dict(type="str", required=True, choices=["StepScaling", "TargetTrackingScaling"]), step_scaling_policy_configuration=dict(type="dict"), target_tracking_scaling_policy_configuration=dict( type="dict", options=dict( CustomizedMetricSpecification=dict(type="dict"), DisableScaleIn=dict(type="bool"), PredefinedMetricSpecification=dict(type="dict"), ScaleInCooldown=dict(type="int"), ScaleOutCooldown=dict(type="int"), TargetValue=dict(type="float"), ), ), minimum_tasks=dict(type="int"), maximum_tasks=dict(type="int"), override_task_capacity=dict(type="bool"), ) module = AnsibleAWSModule(argument_spec=argument_spec, supports_check_mode=True) connection = module.client("application-autoscaling") # Remove any target_tracking_scaling_policy_configuration suboptions that are None policy_config_options = [ "CustomizedMetricSpecification", "DisableScaleIn", "PredefinedMetricSpecification", "ScaleInCooldown", "ScaleOutCooldown", "TargetValue", ] if isinstance(module.params["target_tracking_scaling_policy_configuration"], dict): for option in policy_config_options: if module.params["target_tracking_scaling_policy_configuration"][option] is None: module.params["target_tracking_scaling_policy_configuration"].pop(option) if module.params.get("state") == "present": # A scalable target must be registered prior to creating a scaling policy scalable_target_result = create_scalable_target(connection, module) policy_result = create_scaling_policy(connection, module) # Merge the results of the scalable target creation and policy deletion/creation # There's no risk in overriding values since mutual keys have the same values in our case merged_result = merge_results(scalable_target_result, policy_result) module.exit_json(**merged_result) else: policy_result = delete_scaling_policy(connection, module) module.exit_json(**policy_result) if __name__ == "__main__": main()