community.aws.autoscaling_policy 模块 – 为 Autoscaling 组创建或删除 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 botocore SDK 保持一致，在 5.1.0 版本中添加了 aws_access_key_id 别名。 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 字符串	要连接的 URL，而不是默认的 AWS 端点。虽然这可以用于连接到其他 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 时使用。 选项 “最小值” “最大值” "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 选项互斥。 别名 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 字符串	注册或注销策略。 选项 "present" ← (默认) “absent”
step_adjustments 列表 / 元素=字典	包含 lower_bound、upper_bound 和 scaling_adjustment 的字典列表。 间隔不得重叠或彼此之间存在间隔。 最多一项可以具有未定义的 lower_bound。如果任何一项具有负的 lower_bound，则必须存在一个具有未定义 lower_bound 的步进调整。 最多一项可以具有未定义的 upper_bound。如果任何一项具有正的 upper_bound，则必须存在一个具有未定义 upper_bound 的步进调整。 边界是触发调整的警报阈值以上的量。这意味着，对于 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 字符串 / 必填	指标的统计信息。 选项 “平均值” “最小值” “最大值” “样本计数” “总和”
unit 字符串	指标的单位。请参考 AmazonCloudWatch 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 float	指标间隔的下限。 返回: 如果步骤有下限 示例: 20.0
metric_interval_upper_bound float	指标间隔的上限。 返回: 如果步骤有上限 示例: 40.0
scaling_adjustment 整数	如果达到此步骤要进行的调整。 返回: 始终 示例: 50

作者

• Zacharie Eakin (@zeekin)

• Will Thames (@willthames)

集合链接

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