amazon.aws.iam_group 模块 – 管理 AWS IAM 组

注意

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

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

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

要在 Playbook 中使用它，请指定：amazon.aws.iam_group。

community.aws 1.0.0 中的新增功能

概要

• 管理 AWS IAM 组。

要求

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

• 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 之后的版本中删除。
managed_policies 别名：managed_policy 列表 / 元素=字符串	要附加到角色的托管策略 ARN 或友好名称的列表。 如果已知，建议使用 ARN 而不是友好名称，以避免额外的查找。 要嵌入内联策略，请使用 amazon.aws.iam_policy。 默认： []
name 别名：group_name 字符串 / 必填	组的名称。 注意：组名称在一个账户内是唯一的。路径（path）不影响 name 的唯一性要求。例如，在同一个账户中不允许同时存在 /Path1/MyGroup 和 /Path2/MyGroup。 别名 group_name 在 7.2.0 版本中添加。
path 别名：prefix, path_prefix 字符串 在 amazon.aws 7.1.0 中添加	组路径。 有关 IAM 路径的更多信息，请参阅 AWS IAM 标识符文档 https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html。
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 选项互斥。
purge_policies 别名：purge_policy, purge_managed_policies 布尔值	当 purge_policies=true 时，任何未在 managed_policies 中列出的托管策略都将被分离。 选项 false ←（默认） true
purge_users 布尔值	当 purge_users=true 时，未包含在 users 中的用户将被分离。 选项 false ←（默认） true
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 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_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 字符串 / 必填	创建或删除 IAM 组。 选项 "present" "absent"
users 列表 / 元素=字符串	要添加为组成员的现有用户列表。 默认： []
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 group
  amazon.aws.iam_group:
    name: testgroup1
    state: present

- name: Create a group and attach a managed policy using its ARN
  amazon.aws.iam_group:
    name: testgroup1
    managed_policies:
      - arn:aws:iam::aws:policy/AmazonSNSFullAccess
    state: present

- name: Create a group with users as members and attach a managed policy using its ARN
  amazon.aws.iam_group:
    name: testgroup1
    managed_policies:
      - arn:aws:iam::aws:policy/AmazonSNSFullAccess
    users:
      - test_user1
      - test_user2
    state: present

- name: Remove all managed policies from an existing group with an empty list
  amazon.aws.iam_group:
    name: testgroup1
    state: present
    purge_policies: true

- name: Remove all group members from an existing group
  amazon.aws.iam_group:
    name: testgroup1
    managed_policies:
      - arn:aws:iam::aws:policy/AmazonSNSFullAccess
    purge_users: true
    state: present

- name: Delete the group
  amazon.aws.iam_group:
    name: testgroup1
    state: absent

返回值

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

键	描述
iam_group 复杂	包含所有组信息（包括组成员资格）的字典。 返回：成功
attached_policies 复杂 在 amazon.aws 7.1.0 中添加	包含有关附加到组的托管策略的基本信息的列表。 返回：成功
policy_arn 字符串	指定托管策略的 Amazon 资源名称 (ARN)。 返回：成功 示例： "arn:aws:iam::123456789012:policy/test_policy"
policy_name 字符串	标识策略的友好名称。 返回：成功 示例： "test_policy"
group 复杂	包含所有组信息的字典。 返回：成功
arn 字符串	指定组的 Amazon 资源名称 (ARN)。 返回：成功 示例： "arn:aws:iam::1234567890:group/testgroup1"
create_date 字符串	组创建的日期和时间，采用 ISO 8601 日期时间格式。 返回：成功 示例： "2017-02-08T04:36:28+00:00"
group_id 字符串	标识组的稳定且唯一的字符串。 返回：成功 示例： "AGPA12345EXAMPLE54321"
group_name 字符串	标识组的友好名称。 返回：成功 示例： "testgroup1"
路径 字符串	组的路径。 返回：成功 示例： "/"
users 复杂	包含所有组成员的列表。 返回：成功
arn 字符串	指定用户的 Amazon 资源名称 (ARN)。 返回：成功 示例： "arn:aws:iam::1234567890:user/test_user1"
create_date 字符串	用户创建的日期和时间，采用 ISO 8601 日期时间格式。 返回：成功 示例： "2017-02-08T04:36:28+00:00"
路径 字符串	用户的路径。 返回：成功 示例： "/"
user_id 字符串	标识用户的稳定且唯一的字符串。 返回：成功 示例： "AIDA12345EXAMPLE54321"
user_name 字符串	标识用户的友好名称。 返回：成功 示例： "testgroup1"

作者

• Nick Aslanidis (@naslanidis)

• Maksym Postument (@infectsoldier)

集合链接

• 问题跟踪器
• 存储库（源代码）
• 交流