community.aws.autoscaling_launch_config 模块 – 创建或删除 AWS 自动扩展启动配置

注意

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

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

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

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

community.aws 1.0.0 中的新增功能

概要 

可以创建或删除 AWS 自动扩展配置。
与 community.aws.autoscaling_group 模块一起使用来管理自动扩展组。
在 5.0.0 版本之前，此模块名为 community.aws.ec2_lc。用法没有改变。

别名：ec2_lc

要求 

执行此模块的主机需要满足以下要求。

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 之后的版本中删除。
assign_public_ip 布尔值	用于将实例启动到 Amazon 虚拟私有云中的自动扩展组。指定是否为在 Amazon VPC 中启动的每个实例分配公共 IP 地址。选项 `false` `true`
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。
classic_link_vpc_id 字符串	启用 ClassicLink 的 VPC 的 ID
classic_link_vpc_security_groups 列表 / 元素=字符串	用于关联 ClassicLink VPC 实例的安全组 ID 列表。
debug_botocore_endpoint_logs 布尔值	使用 `botocore.endpoint` 记录器解析任务期间发出的唯一（而不是总计）`"resource:action"` API 调用，将集合输出到任务结果中的 resource_actions 键。使用 `aws_resource_action` 回调输出到 playbook 期间生成的总列表。也可以使用 `ANSIBLE_DEBUG_BOTOCORE_LOGS` 环境变量。选项 `false` ← (默认) `true`
ebs_optimized 布尔值	指定实例是否针对 EBS I/O 进行了优化（true）或未优化（false）。选项 `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 之后的版本中删除。
image_id 字符串	用于该组的 AMI 唯一标识符。
instance_id 字符串	用作启动配置基础的正在运行的实例的 ID。可以用来代替 image_id 和 instance_type。
instance_monitoring 布尔值	指定是否使用详细监控启动实例。选项 `false` ← (默认) `true`
instance_profile_name 字符串	与实例的 IAM 角色关联的实例配置文件的名称或 Amazon 资源名称 (ARN)。
instance_type 字符串	实例要使用的实例类型。创建新的启动配置时是必需的。
kernel_id 字符串	EC2 实例的内核 ID。
key_name 字符串	用于访问托管实例的 SSH 密钥名称。
name 字符串 / 必需	配置的唯一名称。
placement_tenancy 字符串	确定实例是否在单租户硬件上运行。未设置时，AWS 将默认为 `default`。选项 `"默认"` `"专用"`
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 选项互斥。
ramdisk_id 字符串	实例的 RAM 磁盘 ID。
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 之后的版本中删除。
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 保持一致，aws_secret_access_key 别名在 5.1.0 版本中添加。 ec2_secret_key 别名已弃用，将在 2024-12-01 之后的版本中删除。对 `EC2_SECRET_KEY` 环境变量的支持已弃用，将在 2024-12-01 之后的版本中删除。
security_groups 列表 / 元素=字符串	要应用于实例的安全组列表。您可以指定安全组名称或 ID，或混合使用。默认: `[]`
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 之后的版本中删除。
spot_price 浮点数	您正在竞标的竞价价格。仅适用于使用竞价型实例的 Auto Scaling 组。
state 字符串	注册或注销实例。选项 `"present"` ← (默认) `"absent"`
user_data 字符串	可用于 ec2 实例的不透明数据块。与 user_data_path 互斥。
user_data_path 路径	包含 ec2 实例用户数据的文件路径。与 user_data 互斥。
validate_certs 布尔值	设置为 `false` 时，将不会验证与 AWS API 通信的 SSL 证书。强烈建议不要设置 validate_certs=false，作为替代方法，请考虑设置 aws_ca_bundle。选项 `false` `true` ← (默认)
volumes list / elements=dictionary	定义要创建的卷的字典列表。对于任何卷，小于 `1` 的卷大小将被解释为请求不创建卷。
delete_on_termination 布尔值	是否应在实例终止时自动删除卷。选项 `false` ← (默认) `true`
device_name 字符串 / 必需	卷的名称（例如 `/dev/sda`）。
encrypted 布尔值	是否应使用 'aws/ebs' KMS CMK 加密卷。选项 `false` ← (默认) `true`
ephemeral 字符串	该卷是否应为临时卷。当实例停止时，临时卷上的数据将丢失。与 snapshot 参数互斥。
iops 整数	为卷预置的每秒 IOPS 数。当 volume_type=io1 时为必需。
no_device 布尔值	当 no_device=true 时，将不创建设备。选项 `false` `true`
snapshot 字符串	创建卷时要复制的 EBS 快照的 ID。与 ephemeral 参数互斥。
throughput 整数在 community.aws 3.1.0 中添加	为 gp3 卷预置的吞吐量。有效范围为最小值 125 和最大值 1000。
volume_size 整数	卷的大小（以 GiB 为单位）。除非设置了 ephemeral、snapshot 或 no_device 之一，否则为必需。
volume_type 字符串	要创建的卷的类型。有关可用卷类型的更多信息，请参阅 https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html。
vpc_id 字符串	VPC ID，用于将安全组名称解析为 ID。

注释 

注意

Amazon ASG Auto Scaling 启动配置在创建后是不可变的，因此在更改后修改配置不会修改 AWS 上的启动配置。您必须创建一个新配置并将其分配给 ASG。
注意： 对于模块，环境变量和配置文件是从 Ansible“主机”上下文而不是“控制器”上下文读取的。因此，可能需要将文件显式复制到“主机”。对于查找和连接插件，环境变量和配置文件是从 Ansible“控制器”上下文而不是“主机”上下文读取的。
Ansible 使用的 AWS SDK (boto3) 也可以从 Ansible“主机”上下文中的配置文件（通常为 ~/.aws/credentials）读取凭证和其他设置（例如区域）的默认值。有关更多信息，请参阅 https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html。

示例 

- name: create a launch configuration with an encrypted volume
  community.aws.autoscaling_launch_config:
    name: special
    image_id: ami-XXX
    key_name: default
    security_groups:
      - 'group'
      - 'group2'
    instance_type: t1.micro
    volumes:
      - device_name: /dev/sda1
        volume_size: 100
        volume_type: io1
        iops: 3000
        delete_on_termination: true
        encrypted: true
      - device_name: /dev/sdb
        ephemeral: ephemeral0

- name: create a launch configuration using a running instance id as a basis
  community.aws.autoscaling_launch_config:
    name: special
    instance_id: i-00a48b207ec59e948
    key_name: default
    security_groups:
      - 'launch-wizard-2'
    volumes:
      - device_name: /dev/sda1
        volume_size: 120
        volume_type: io1
        iops: 3000
        delete_on_termination: true

- name: create a launch configuration to omit the /dev/sdf EBS device that is included in the AMI image
  community.aws.autoscaling_launch_config:
    name: special
    image_id: ami-XXX
    key_name: default
    security_groups:
      - 'group'
      - 'group2'
    instance_type: t1.micro
    volumes:
      - device_name: /dev/sdf
        no_device: true

- name: Use EBS snapshot ID for volume
  block:
    - name: Set Volume Facts
      ansible.builtin.set_fact:
        volumes:
          - device_name: /dev/sda1
            volume_size: 20
            ebs:
              snapshot: snap-XXXX
              volume_type: gp2
              delete_on_termination: true
              encrypted: false

    - name: Create launch configuration
      community.aws.autoscaling_launch_config:
        name: lc1
        image_id: ami-xxxx
        assign_public_ip: true
        instance_type: t2.medium
        key_name: my-key
        security_groups:
          - 'sg-xxxx'
        volumes: "{{ volumes }}"
      register: lc_info

返回值 

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

键	描述
arn 字符串	启动配置的 Amazon 资源名称。返回：当 state=present 时示例: `"arn:aws:autoscaling:us-east-1:123456789012:launchConfiguration:888d9b58-d93a-40c4-90cf-759197a2621a:launchConfigurationName/launch_config_name"`
changed 布尔值	启动配置的状态是否已更改。返回：始终示例: `false`
created_time 字符串	启动配置的创建日期和时间。返回：当 state=present 时示例: `"2017-11-03 23:46:44.841000"`
image_id 字符串	启动配置使用的 Amazon Machine Image 的 ID。返回：当 state=present 时示例: `"ami-9be6f38c"`
instance_type 字符串	实例的实例类型。返回：当 state=present 时示例: `"t1.micro"`
name 字符串	启动配置的名称。返回：当 state=present 时示例: `"launch_config_name"`
result 复杂	启动配置的规范详细信息。返回：当 state=present 时
associate_public_ip_address 布尔值	(EC2-VPC) 指示是否为每个实例分配公共 IP 地址。返回：当 state=present 时示例: `false`
block_device_mappings 复杂	块设备映射，指定块设备。返回：当 state=present 时
device_name 字符串	暴露给 EC2 实例的设备名称（例如，/dev/sdh 或 xvdh）。返回：当 state=present 时示例: `"/dev/sda1"`
ebs 复杂	有关 Amazon EBS 卷的信息。返回：当 state=present 时
snapshot_id 字符串	快照的 ID。返回：当 state=present 时
volume_size 字符串	卷大小，以 GiB 为单位。返回：当 state=present 时示例： `"100"`
virtual_name 字符串	虚拟设备的名称（例如，ephemeral0）。返回：当 state=present 时示例： `"ephemeral0"`
classic_link_vpc_id 字符串	启用 ClassicLink 的 VPC 的 ID，用于将您的 EC2-Classic 实例链接到该 VPC。返回：当 state=present 时
classic_link_vpc_security_groups 列表 / 元素=字符串	在 ClassicLinkVPCId 中指定的 VPC 的一个或多个安全组的 ID。返回：当 state=present 时示例： `[]`
created_time 字符串	启动配置的创建日期和时间。返回：当 state=present 时示例: `"2017-11-03 23:46:44.841000"`
delete_on_termination 布尔值	指示在实例终止时是否删除该卷。返回：当 state=present 时示例： `true`
ebs_optimized 布尔值	指示该实例是否针对 EBS I/O 进行了优化，`true` 表示优化，`false` 表示未优化。返回：当 state=present 时示例: `false`
image_id 字符串	启动配置使用的 Amazon Machine Image 的 ID。返回：当 state=present 时示例: `"ami-9be6f38c"`
instance_monitoring 布尔值	指示此组中的实例是以详细 `true` 还是基本 `false` 监控方式启动。返回：当 state=present 时示例： `true`
instance_profile_name 字符串	与实例的 IAM 角色关联的实例配置文件的名称或 Amazon 资源名称 (ARN)。返回：当 state=present 时
instance_type 字符串	实例的实例类型。返回：当 state=present 时示例: `"t1.micro"`
iops 整数	要为卷配置的每秒 I/O 操作数 (IOPS)。返回：当 state=present 时
kernel_id 字符串	与 AMI 关联的内核 ID。返回：当 state=present 时示例： `""`
key_name 字符串	密钥对的名称。返回：当 state=present 时示例： `"testkey"`
launch_configuration_arn 字符串	启动配置的 Amazon 资源名称 (ARN)。返回：当 state=present 时示例: `"arn:aws:autoscaling:us-east-1:123456789012:launchConfiguration:888d9b58-d93a-40c4-90cf-759197a2621a:launchConfigurationName/launch_config_name"`
成员字符串	返回：当 state=present 时示例： `"\n "`
name 字符串	启动配置的名称。返回：当 state=present 时示例: `"launch_config_name"`
PlacementTenancy 字符串	实例的租赁类型，可以是 default 或 dedicated。返回：当 state=present 时示例： `"default"`
ramdisk_id 字符串	与 AMI 关联的 RAM 磁盘的 ID。返回：当 state=present 时示例： `""`
security_groups 列表 / 元素=字符串	要与实例关联的安全组。返回：当 state=present 时示例： `["sg-5e27db2f"]`
spot_price 浮点数	启动竞价型实例时的竞标价格。返回：当 state=present 时
use_block_device_types 布尔值	指示是否禁止设备映射。返回：当 state=present 时示例: `false`
user_data 字符串	实例可用的用户数据。返回：当 state=present 时示例： `""`
volume_type 字符串	卷类型（标准、io1、gp2 之一）。返回：当 state=present 时示例： `"io1"`
security_groups 列表 / 元素=字符串	要与实例关联的安全组。返回：当 state=present 时示例： `["sg-5e27db2f"]`

作者

Gareth Rushgrove (@garethr)
Willem van Ketwich (@wilvk)