amazon.aws.ec2_placement_group 模块 – 创建或删除 EC2 置放组

注意

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

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

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

要在 playbook 中使用它，请指定：amazon.aws.ec2_placement_group。

community.aws 1.0.0 中的新增功能

概要

• 创建 EC2 置放组；如果置放组已存在，则不会执行任何操作。或者，删除现有的置放组。如果置放组不存在，则不执行任何操作。另请参见 https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html。

要求

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

• 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 之后的一个版本中删除。
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 字符串	连接到的 URL，而不是默认的 AWS 端点。虽然这可以用于连接到其他与 AWS 兼容的服务，但 amazon.aws 和 community.aws 集合仅针对 AWS 进行了测试。 也可以使用 AWS_URL 或 EC2_URL 环境变量，优先级依次递减。 ec2_url 和 s3_url 别名已弃用，并将在 2024-12-01 之后的一个版本中删除。 EC2_URL 环境变量的支持已弃用，并将在 2024-12-01 之后的一个版本中删除。
name 字符串 / 必需	置放组的名称。
partition_count 整数 amazon.aws 3.1.0 中添加	分区数量。 仅当strategy设置为partition时有效。 必须是1到7之间的值。
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之后的发行版中删除。
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_secret_access_key在5.1.0版本中添加，以与AWS botocore SDK保持一致。 别名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"
strategy 字符串	放置组策略。Cluster会将实例聚集到单个可用区中的低延迟组中，而Spread会将实例分散到底层硬件中。 选项 "cluster" ← (默认) "spread" "partition"
tags 字典 在amazon.aws 8.1.0中添加	要与放置组关联的键值对字典。
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。

示例

# Note: These examples do not set authentication details, see the AWS Guide
# for details.

- name: Create a placement group.
  amazon.aws.ec2_placement_group:
    name: my-cluster
    state: present

- name: Create a Spread placement group.
  amazon.aws.ec2_placement_group:
    name: my-cluster
    state: present
    strategy: spread

- name: Create a Partition strategy placement group.
  amazon.aws.ec2_placement_group:
    name: my-cluster
    state: present
    strategy: partition
    partition_count: 3

- name: Delete a placement group.
  amazon.aws.ec2_placement_group:
    name: my-cluster
    state: absent

返回值

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

键	描述
placement_group 字典	放置组属性。 返回：当state != absent时
group_arn 字符串	放置组ARN。 返回：始终返回 示例："arn:aws:ec2:us-east-1:123456789012:placement-group"
group_id 字符串	放置组ID。 返回：始终返回 示例："pg-123456789012"
name 字符串	放置组名称。 返回：始终返回 示例："my-cluster"
partition_count 字符串	分区计数。 返回：如果适用 示例："my-cluster"
state 字符串	放置组状态。 返回：如果适用 示例："available"
strategy 字符串	放置组策略。 返回：如果适用 示例："cluster"
tags 字典 在amazon.aws 8.1.0中添加	与放置组关联的标签。 返回：如果适用 示例：{"tags": {"other": "value2", "some": "value1"}}

作者

• Brad Macpherson (@iiibrad)

集合链接

• 问题追踪器
• 代码库（源代码）
• 通信