community.aws.application_autoscaling_policy 模块 – 管理应用程序自动扩展策略

注意

此模块是 community.aws 集合（版本 9.0.0）的一部分。

如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install community.aws。您需要进一步的要求才能使用此模块，请参阅 要求 了解详细信息。

要在 Playbook 中使用它，请指定：community.aws.application_autoscaling_policy。

community.aws 1.0.0 中的新增功能

概要

• 创建、更新或删除扩展策略。

• 在 5.0.0 版本之前，此模块名为 community.aws.aws_application_scaling_policy。用法没有改变。

别名：aws_application_scaling_policy

要求

在执行此模块的主机上需要以下要求。

• python >= 3.6

• boto3 >= 1.28.0

• botocore >= 1.31.0

参数

参数	注释
access_key 别名：aws_access_key_id, aws_access_key, ec2_access_key 字符串	AWS 访问密钥 ID。 有关访问令牌的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys。 也可以按优先级递减的顺序使用 AWS_ACCESS_KEY_ID、AWS_ACCESS_KEY 或 EC2_ACCESS_KEY 环境变量。 aws_access_key 和 profile 选项是互斥的。 为了与 AWS botocore SDK 保持一致，在 5.1.0 版本中添加了 aws_access_key_id 别名。 ec2_access_key 别名已弃用，将在 2024-12-01 之后的版本中删除。 对 EC2_ACCESS_KEY 环境变量的支持已弃用，将在 2024-12-01 之后的版本中删除。
aws_ca_bundle 路径	验证 SSL 证书时要使用的 CA 包的位置。 也可以使用 AWS_CA_BUNDLE 环境变量。
aws_config 字典	用于修改 botocore 配置的字典。 可以在 AWS 文档中找到参数 https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config。
debug_botocore_endpoint_logs 布尔值	使用 botocore.endpoint 记录器来解析任务期间进行的唯一（而不是总计）"resource:action" API 调用，并将该集合输出到任务结果中的 resource_actions 键。使用 aws_resource_action 回调输出到 Playbook 期间制作的总列表。 也可以使用 ANSIBLE_DEBUG_BOTOCORE_LOGS 环境变量。 选项 false ← (默认) true
endpoint_url 别名：ec2_url, aws_endpoint_url, s3_url 字符串	连接到 AWS 默认端点而不是其他 URL。虽然这可以用于连接到其他与 AWS 兼容的服务，但 amazon.aws 和 community.aws 集合仅针对 AWS 进行测试。 可以使用 AWS_URL 或 EC2_URL 环境变量，优先级依次降低。 ec2_url 和 s3_url 别名已被弃用，将在 2024-12-01 之后的版本中移除。 对 EC2_URL 环境变量的支持已被弃用，将在 2024-12-01 之后的版本中移除。
maximum_tasks integer	在响应扩展事件时要扩展到的最大值。如果您正在为指定服务创建第一个新策略，则此参数是必需的。
minimum_tasks integer	在响应缩减事件时要缩减到的最小值。如果您正在为指定服务创建第一个新策略，则此参数是必需的。
override_task_capacity 布尔值	是否覆盖已设置的最小值和/或最大任务值。 默认为 false。 选项 false true
policy_name string / required	扩展策略的名称。
policy_type string / required	策略类型。 选项 "StepScaling" "TargetTrackingScaling"
profile 别名: aws_profile 字符串	用于身份验证的已命名 AWS 配置文件。 有关已命名配置文件的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html。 也可以使用 AWS_PROFILE 环境变量。 profile 选项与 aws_access_key、aws_secret_key 和 security_token 选项互斥。
region 别名: aws_region, ec2_region 字符串	要使用的 AWS 区域。 对于 IAM、Route53 和 CloudFront 等全局服务，将忽略 region。 也可以使用 AWS_REGION 或 EC2_REGION 环境变量。 有关更多信息，请参阅 Amazon AWS 文档 http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region。 ec2_region 别名已被弃用，将在 2024-12-01 之后的版本中移除。 对 EC2_REGION 环境变量的支持已被弃用，将在 2024-12-01 之后的版本中移除。
resource_id string / required	与可扩展目标关联的资源的标识符。
scalable_dimension string / required	与可扩展目标关联的可扩展维度。 选项 "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"
secret_key 别名: aws_secret_access_key, aws_secret_key, ec2_secret_key 字符串	AWS secret access key。 有关访问令牌的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys。 也可以使用 AWS_SECRET_ACCESS_KEY、AWS_SECRET_KEY 或 EC2_SECRET_KEY 环境变量，优先级依次降低。 secret_key 和 profile 选项互斥。 为了与 AWS botocore SDK 保持一致，在 5.1.0 版本中添加了 aws_secret_access_key 别名。 ec2_secret_key 别名已被弃用，将在 2024-12-01 之后的版本中移除。 对 EC2_SECRET_KEY 环境变量的支持已被弃用，将在 2024-12-01 之后的版本中移除。
service_namespace string / required	AWS 服务的命名空间。 选项 "ecs" "elasticmapreduce" "ec2" "appstream" "dynamodb"
session_token 别名: aws_session_token, security_token, aws_security_token, access_token 字符串	用于临时凭证的 AWS STS 会话令牌。 有关访问令牌的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys。 也可以使用 AWS_SESSION_TOKEN、AWS_SECURITY_TOKEN 或 EC2_SECURITY_TOKEN 环境变量，优先级依次降低。 security_token 和 profile 选项互斥。 别名 aws_session_token 和 session_token 在 3.2.0 版本中添加，参数在 6.0.0 版本中从 security_token 重命名为 session_token。 security_token、aws_security_token 和 access_token 别名已被弃用，将在 2024-12-01 之后的版本中移除。 对 EC2_SECRET_KEY 和 AWS_SECURITY_TOKEN 环境变量的支持已被弃用，将在 2024-12-01 之后的版本中移除。
state string / required	策略应为 present 或 absent。 选项 "absent" "present"
step_scaling_policy_configuration 字典	步进扩展策略。如果您正在创建策略且 policy_type=StepScaling，则此参数是必需的。
target_tracking_scaling_policy_configuration 字典	目标跟踪策略。如果您正在创建新策略且 policy_type=TargetTrackingScaling，则此参数是必需的。 子选项的完整文档可以在 API 文档中找到 https://docs.aws.amazon.com/autoscaling/application/APIReference/API_TargetTrackingScalingPolicyConfiguration.html
CustomizedMetricSpecification 字典	如果使用自定义指标，则要使用的指标。
DisableScaleIn 布尔值	是否应禁用缩减。 选项 false true
PredefinedMetricSpecification 字典	如果使用预定义指标，则要使用的指标。
ScaleInCooldown integer	在缩减后等待多长时间（以秒为单位），才能发生另一次扩展操作。
ScaleOutCooldown integer	在扩展后等待多长时间（以秒为单位），才能发生另一次扩展操作。
TargetValue float	指标的目标值。
validate_certs 布尔值	设置为 false 时，将不会验证与 AWS API 通信的 SSL 证书。 强烈建议不要设置 validate_certs=false，作为替代方法，请考虑设置 aws_ca_bundle。 选项 false true ← (默认)

说明

注意

• 有关参数和返回值的更多详细信息，请参阅 http://boto3.readthedocs.io/en/latest/reference/services/application-autoscaling.html#ApplicationAutoScaling.Client.put_scaling_policy

• 注意： 对于模块，环境变量和配置文件是从 Ansible“主机”上下文而不是“控制器”上下文读取的。因此，可能需要将文件显式复制到“主机”。对于查找和连接插件，环境变量和配置文件是从 Ansible“控制器”上下文而不是“主机”上下文读取的。

• Ansible 使用的 AWS SDK (boto3) 也可能会从 Ansible“主机”上下文中的配置文件（通常是 ~/.aws/credentials）读取凭证和其他设置（例如区域）的默认值。有关更多信息，请参阅 https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html。

示例

# 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

返回值

通用返回值在此处记录 此处，以下是此模块独有的字段

键	描述
alarms 复杂	与扩展策略关联的 CloudWatch 警报列表 返回： 当状态为 present 时
alarm_arn 字符串	警报的 Amazon 资源名称 (ARN) 返回： 当状态为 present 时
alarm_name 字符串	警报的名称 返回： 当状态为 present 时
creation_time 字符串	创建可扩展目标时的 Unix 时间戳。 返回： 当状态为 present 时 示例： "2017-09-28T08:22:51.881000-03:00"
max_capacity integer	在响应扩展事件时要扩展到的最大值。如果 state 为 present，则为必需。 返回： 当状态为 present 时 示例： 2
min_capacity integer	在响应缩减事件时要缩减到的最小值。如果 state 为 present，则为必需。 返回： 当状态为 present 时 示例： 1
policy_arn 字符串	扩展策略的 Amazon 资源名称 (ARN)。 返回： 当状态为 present 时
policy_name 字符串	扩展策略的名称。 返回： 当状态为 present 时
policy_type 字符串	策略类型。 返回： 当状态为 present 时
resource_id 字符串	与可扩展目标关联的资源的标识符。 返回： 当状态为 present 时 示例： "service/cluster-name/service-name"
role_arn 字符串	允许应用程序自动扩展代表您修改可扩展目标的 IAM 角色的 ARN。如果 state 为 present，则为必需。 返回： 当状态为 present 时 示例： "arn:aws:iam::123456789012:role/roleName"
scalable_dimension 字符串	与可扩展目标关联的可扩展维度。 返回： 当状态为 present 时 示例： "ecs:service:DesiredCount"
service_namespace 字符串	AWS 服务的命名空间。 返回： 当状态为 present 时 示例： "ecs"
step_scaling_policy_configuration 复杂	步进扩展策略。 返回： 当状态为 present 且策略类型为 StepScaling 时
adjustment_type 字符串	调整类型 返回： 当状态为 present 且策略类型为 StepScaling 时 示例： "ChangeInCapacity, PercentChangeInCapacity, ExactCapacity"
cooldown integer	在扩展活动完成之后的一段时间（以秒为单位），之前与触发器相关的扩展活动可以在多大程度上影响未来的扩展事件 返回： 当状态为 present 且策略类型为 StepScaling 时 示例： 60
metric_aggregation_type 字符串	CloudWatch 指标的聚合类型 返回： 当状态为 present 且策略类型为 StepScaling 时 示例： "Average, Minimum, Maximum"
step_adjustments list / elements=dictionary	一组调整，使您能够根据警报违规的大小进行扩展 返回： 当状态为 present 且策略类型为 StepScaling 时
target_tracking_scaling_policy_configuration 复杂	目标跟踪策略。 返回: 当状态为present且策略类型为TargetTrackingScaling时返回
predefined_metric_specification 复杂	一个预定义的指标 返回: 当状态为present且策略类型为TargetTrackingScaling时返回
predefined_metric_type 字符串	指标类型 返回: 当状态为present且策略类型为TargetTrackingScaling时返回 示例: "ECSServiceAverageCPUUtilization, ECSServiceAverageMemoryUtilization"
resource_label 字符串	标识与指标类型关联的资源 返回: 当指标类型为ALBRequestCountPerTarget时返回
scale_in_cooldown integer	在缩减活动完成后，才能开始另一个缩减活动的时间量，以秒为单位 返回: 当状态为present且策略类型为TargetTrackingScaling时返回 示例： 60
scale_out_cooldown integer	在扩展活动完成后，才能开始另一个扩展活动的时间量，以秒为单位 返回: 当状态为present且策略类型为TargetTrackingScaling时返回 示例： 60
target_value integer	指标的目标值 返回: 当状态为present且策略类型为TargetTrackingScaling时返回 示例: 70

作者

• Gustavo Maia (@gurumaia)

• Chen Leibovich (@chenl87)

集合链接

• 问题跟踪器
• 存储库（源代码）
• 沟通