community.aws.autoscaling_policy 模块 – 创建或删除自动伸缩组的 AWS 伸缩策略

注意

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

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

要安装它，请使用：ansible-galaxy collection install community.aws。您需要其他要求才能使用此模块，请参阅 要求 获取详细信息。

要在 playbook 中使用它，请指定：community.aws.autoscaling_policy。

community.aws 1.0.0 中的新增功能

概要

• 可以创建或删除自动伸缩组的伸缩策略。

• 引用的自动伸缩组必须已经存在。

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

别名：ec2_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_access_key_id 别名在 5.1.0 版本中添加，以与 AWS botocore SDK 保持一致。 ec2_access_key 别名已弃用，将在 2024-12-01 后的版本中删除。 EC2_ACCESS_KEY 环境变量的支持已弃用，将在 2024-12-01 后的版本中删除。
adjustment_type 字符串	自动伸缩组容量变化的类型。 如果 state 为 present，则需要此参数。 选项 "ChangeInCapacity" "ExactCapacity" "PercentChangeInCapacity"
asg_name 字符串	关联的自动伸缩组的名称。 如果 state 为 present，则需要此参数。
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。
cooldown 整数	自动伸缩操作之间可以进行的最短时间段（以秒为单位）。 仅当 policy_type 为 SimpleScaling 时使用。
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 后的版本中删除。
estimated_instance_warmup 整数	新启动的实例才能对 CloudWatch 指标做出贡献的预计时间（以秒为单位）。
metric_aggregation 字符串	CloudWatch 指标的聚合类型。 仅当 policy_type 不是 SimpleScaling 时使用。 选项 "Minimum" "Maximum" "Average" ← (默认)
min_adjustment_step 整数	策略触发时的最小调整量。 仅当 adjustment_type 为 PercentChangeInCapacity 时使用。
name 字符串 / 必需	伸缩策略的唯一名称。
policy_type 字符串	自动伸缩调整策略。 选项 "StepScaling" "SimpleScaling" ← (默认) "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 之后某个版本中移除。
scaling_adjustment 整数	策略调整自动缩放组的数量。 负数表示缩减 ASG。 单位是实例数量（对于 ExactCapacity 或 ChangeInCapacity）或现有实例的百分比（对于 PercentChangeInCapacity）。 当 policy_type 为 SimpleScaling 时必需。
secret_key 别名：aws_secret_access_key，aws_secret_key，ec2_secret_key 字符串	AWS 密钥。 有关访问令牌的更多信息，请参阅 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 之后某个版本中移除。
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 选项互斥。 在 3.2.0 版本中添加了 aws_session_token 和 session_token 别名，在 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 字符串	注册或注销策略。 选项 "present" ← (默认) "absent"
step_adjustments 列表 / 元素=字典	包含 lower_bound、upper_bound 和 scaling_adjustment 的字典列表。 区间不能重叠或之间有间隙。 最多只有一个项目的 lower_bound 未定义。如果任何项目的 lower_bound 为负数，则必须有一个 step adjustment 具有未定义的 lower_bound。 最多只有一个项目的 upper_bound 未定义。如果任何项目的 upper_bound 为正数，则必须有一个 step adjustment 具有未定义的 upper_bound。 边界是警报阈值与 CloudWatch 指标之间的差值，在此差值下将触发调整。这意味着对于警报阈值为 50 的情况，要在 75 时触发需要 25 的下界。请参阅 http://docs.aws.amazon.com/AutoScaling/latest/APIReference/API_StepAdjustment.html。
lower_bound 整数	警报阈值与 CloudWatch 指标之间的差值的下界。
scaling_adjustment 整数 / 必需	缩放的幅度。
upper_bound 整数	警报阈值与 CloudWatch 指标之间的差值的上界。
target_tracking_config 字典 在 community.aws 4.1.0 中添加	允许您为 AWS 中的自动缩放策略指定 target_tracking_config。 target_tracking_config 可以接受 customized_metric_spec 或 predefined_metric_spec 的嵌套字典。每个规范与其 boto3 等效项一致。 当指定 TargetTrackingScaling 策略时必需。
customized_metric_spec 字典	指定将作为 TargetTrackingConfiguration 的调用传递的字典。
dimensions 列表 / 元素=字典	指标的维度。列表的元素应为字典。
metric_name 字符串 / 必需	指标的名称。
namespace 字符串 / 必需	指标的命名空间。
statistic 字符串 / 必需	指标的统计量。 选项 "Average" "Minimum" "Maximum" "SampleCount" "Sum"
unit 字符串	指标的单位。参考 Amazon CloudWatch API 以获取有效的单位。
disable_scalein 布尔值	指示目标跟踪缩放策略是否禁用了缩减。 选项 false true
predefined_metric_spec 字典	指定将作为 TargetTrackingConfiguration 的调用传递的字典。
predefined_metric_type 字符串 / 必需	如果使用 predefined_metric_spec，则必需。 选项 "ASGAverageCPUUtilization" "ASGAverageNetworkIn" "ASGAverageNetworkOut" "ALBRequestCountPerTarget"
resource_label 字符串	唯一标识特定 ALB 目标组，从中确定自动缩放组服务的平均请求数。 除非目标组附加到自动缩放组，否则您无法指定资源标签。
target_value 浮点数 / 必需	指定目标利用率的浮点数。 当指定 target_tracking_config 时必需。
validate_certs 布尔值	设置为 false 时，将不会验证与 AWS API 通信的 SSL 证书。 强烈建议不要设置 validate_certs=false，作为替代方案，请考虑设置 aws_ca_bundle。 选项 false true ← (默认)

注释

注意

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

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

示例

- name: Simple Scale Down policy
  community.aws.autoscaling_policy:
    state: present
    region: US-XXX
    name: "scaledown-policy"
    adjustment_type: "ChangeInCapacity"
    asg_name: "application-asg"
    scaling_adjustment: -1
    min_adjustment_step: 1
    cooldown: 300

# For an alarm with a breach threshold of 20, the
# following creates a stepped policy:
# From 20-40 (0-20 above threshold), increase by 50% of existing capacity
# From 41-infinity, increase by 100% of existing capacity
- community.aws.autoscaling_policy:
    state: present
    region: US-XXX
    name: "step-scale-up-policy"
    policy_type: StepScaling
    metric_aggregation: Maximum
    step_adjustments:
      - upper_bound: 20
        scaling_adjustment: 50
      - lower_bound: 20
        scaling_adjustment: 100
    adjustment_type: "PercentChangeInCapacity"
    asg_name: "application-asg"

- name: create TargetTracking predefined policy
  community.aws.autoscaling_policy:
    name: "predefined-policy-1"
    policy_type: TargetTrackingScaling
    target_tracking_config:
      predefined_metric_spec:
        predefined_metric_type: ASGAverageCPUUtilization
      target_value: 98.0
    asg_name: "asg-test-1"
  register: result

- name: create TargetTracking predefined policy with resource_label
  community.aws.autoscaling_policy:
    name: "predefined-policy-1"
    policy_type: TargetTrackingScaling
    target_tracking_config:
      predefined_metric_spec:
        predefined_metric_type: ALBRequestCountPerTarget
        resource_label: app/my-alb/778d41231d141a0f/targetgroup/my-alb-target-group/942f017f100becff
      target_value: 98.0
    asg_name: "asg-test-1"
  register: result

- name: create TargetTrackingScaling custom policy
  community.aws.autoscaling_policy:
    name: "custom-policy-1"
    policy_type: TargetTrackingScaling
    target_tracking_config:
      customized_metric_spec:
        metric_name: metric_1
        namespace: namespace_1
        statistic: Minimum
        unit: Gigabits
        dimensions: [{'Name': 'dimension1', 'Value': 'value1'}]
      disable_scalein: true
      target_value: 98.0
    asg_name: asg-test-1
  register: result

返回值

此处记录了常见的返回值 此处，以下是此模块特有的字段

Key	描述
adjustment_type 字符串	缩放策略调整类型。 返回：始终 示例："PercentChangeInCapacity"
alarms 复杂	与策略相关的 CloudWatch 警报。 返回：始终
alarm_arn 字符串	CloudWatch 警报的 ARN。 返回：始终 示例："arn:aws:cloudwatch:us-east-2:1234567890:alarm:cpu-very-high"
alarm_name 字符串	CloudWatch 警报的名称。 返回：始终 示例："cpu-very-high"
arn 字符串	缩放策略的 ARN。为了向后兼容，该值与 policy_arn 相同。 返回：始终 示例："arn:aws:autoscaling:us-east-2:123456789012:scalingPolicy:59e37526-bd27-42cf-adca-5cd3d90bc3b9:autoScalingGroupName/app-asg:policyName/app-policy"
as_name 字符串	自动伸缩组名称。为向后兼容性提供，值与auto_scaling_group_name相同。 返回：始终 示例： "app-asg"
auto_scaling_group_name 字符串	自动伸缩组的名称。 返回：始终 示例： "app-asg"
metric_aggregation_type 字符串	用于聚合指标的方法。 返回：当policy_type为StepScaling时 示例： "Maximum"
name 字符串	伸缩策略的名称。为向后兼容性提供，值与policy_name相同。 返回：始终 示例： "app-policy"
policy_arn 字符串	伸缩策略的ARN。 返回：始终 示例："arn:aws:autoscaling:us-east-2:123456789012:scalingPolicy:59e37526-bd27-42cf-adca-5cd3d90bc3b9:autoScalingGroupName/app-asg:policyName/app-policy"
policy_name 字符串	伸缩策略的名称。 返回：始终 示例： "app-policy"
policy_type 字符串	自动伸缩策略的类型。 返回：始终 示例： "StepScaling"
scaling_adjustment 整数	触发警报时进行的调整。 返回：当policy_type为SimpleScaling时 示例： 1
step_adjustments 复杂	步骤调整列表。 返回：始终
metric_interval_lower_bound 浮点数	指标区间的下界。 返回：如果步骤有下界 示例： 20.0
metric_interval_upper_bound 浮点数	指标区间的上界。 返回：如果步骤有上界 示例： 40.0
scaling_adjustment 整数	如果达到此步骤，则进行的调整。 返回：始终 示例： 50

作者

• Zacharie Eakin (@zeekin)

• Will Thames (@willthames)

资料链接

• 问题追踪器
• 代码仓库
• 沟通