amazon.aws.iam_managed_policy 模块 – 管理用户管理的 IAM 策略

注意

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

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

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

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

community.aws 1.0.0 中的新增功能

概要

• 允许创建和删除托管 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 botocore SDK 保持一致，在 5.1.0 版本中添加了 aws_access_key_id 别名。 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
description 别名：policy_description 字符串	此策略的有用描述，此值是不可变的，仅在创建新策略时设置。 在 7.2.0 版本中，参数名称已从 policy_description 重命名为 description。
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 之后的一个版本中移除。
make_default 布尔值	将此版本设置为默认版本。 选项 false true ← (默认)
name 别名：policy_name 字符串 / 必填	托管策略的名称。 注意：策略名称在同一个账户内必须唯一。路径（path）不会影响name的唯一性要求。例如，不允许在同一个账户中同时存在/Path1/MyPolicy和/Path2/MyPolicy。 在7.2.0版本中，参数名称从policy_name改为了name。
only_version 布尔值	如果与make_default一起使用，则会删除所有其他非默认版本，从而删除此策略的所有其他版本。 选项 false ← (默认) true
path 别名：prefix, path_prefix 字符串 添加到amazon.aws 7.2.0	托管策略的路径。 有关IAM路径的更多信息，请参阅AWS IAM标识符文档https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html。
policy json	正确格式化的JSON策略
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_tags 布尔值	如果purge_tags=true且tags已设置，则将从资源中清除现有标签，以完全匹配tags参数定义的内容。 如果没有设置tags参数，则即使purge_tags=True，也不会修改标签。 以aws:开头的标签键由Amazon保留，不能修改。因此，在purge_tags参数中将忽略它们。有关更多信息，请参阅Amazon文档https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions。 选项 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密钥访问密钥。 有关访问令牌的更多信息，请参阅 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 字符串	此托管策略是否存在。设置为absent以将所有实体与该策略分离，如果找到则将其删除。 选项 "present" ← (默认) "absent"
tags 别名：resource_tags 字典	表示要应用于资源的标签的字典。 如果没有设置tags参数，则不会修改标签。
validate_certs 布尔值	设置为false时，将不会验证与AWS API通信的SSL证书。 强烈建议不要设置validate_certs=false，作为替代方案，可以考虑改为设置aws_ca_bundle。 选项 false true ← (默认)

注释

注意

• 在7.2.0版本中添加了对tags和purge_tags的支持。

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

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

示例

# Create a policy
- name: Create IAM Managed Policy
  amazon.aws.iam_managed_policy:
    policy_name: "ManagedPolicy"
    policy_description: "A Helpful managed policy"
    policy: "{{ lookup('template', 'managed_policy.json.j2') }}"
    state: present

# Update a policy with a new default version
- name: Update an IAM Managed Policy with new default version
  amazon.aws.iam_managed_policy:
    policy_name: "ManagedPolicy"
    policy: "{{ lookup('file', 'managed_policy_update.json') }}"
    state: present

# Update a policy with a new non default version
- name: Update an IAM Managed Policy with a non default version
  amazon.aws.iam_managed_policy:
    policy_name: "ManagedPolicy"
    policy:
      Version: "2012-10-17"
      Statement:
        - Effect: "Allow"
          Action: "logs:CreateLogGroup"
          Resource: "*"
    make_default: false
    state: present

# Update a policy and make it the only version and the default version
- name: Update an IAM Managed Policy with default version as the only version
  amazon.aws.iam_managed_policy:
    policy_name: "ManagedPolicy"
    policy: |
      {
        "Version": "2012-10-17",
        "Statement":[{
          "Effect": "Allow",
          "Action": "logs:PutRetentionPolicy",
          "Resource": "*"
        }]
      }
    only_version: true
    state: present

# Remove a policy
- name: Remove an existing IAM Managed Policy
  amazon.aws.iam_managed_policy:
    policy_name: "ManagedPolicy"
    state: absent

返回值

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

键	描述
policy 复杂类型	返回基本的策略信息，当state=absent时，这将返回已删除策略的值。 返回：始终
arn 字符串	策略的Amazon资源名称 (ARN)。 返回：成功 示例："arn:aws:iam::123456789012:policy/ansible-test-12345/ansible-test-12345-policy"
attachment_count 整数	策略附加到的实体（用户、组和角色）的数量。 返回：成功 示例：5
create_date 字符串	创建策略时的日期和时间（ISO 8601 日期时间格式）。 返回：成功 示例："2017-02-08T04:36:28+00:00"
default_version_id 字符串	要使用的默认策略版本。 返回：成功 示例："/ansible-test-12345/"
description 字符串	策略的友好描述。 返回：成功 示例："My Example Policy"
is_attachable 布尔值	指定策略是否可以附加到IAM实体。 返回：成功 示例：false
路径 字符串	策略的路径。 返回：成功 示例："/ansible-test-12345/"
permissions_boundary_usage_count 整数	使用该策略作为权限边界的IAM实体（用户、组和角色）的数量。 返回：成功 示例：5
policy_id 字符串	标识策略的稳定且全局唯一的字符串。 返回：成功 示例："ANPA12345EXAMPLE12345"
policy_name 字符串	标识策略的友好名称。 返回：成功 示例： "ansible-test-12345-policy"
标签 字典	表示附加到托管策略的标签的字典。 返回：成功 示例： {"Env": "Prod"}
更新日期 字符串	策略上次更新的日期和时间，采用 ISO 8601 日期时间格式。 返回：成功 示例： "2017-02-08T05:12:13+00:00"

作者

• Dan Kozlowski (@dkhenry)

资源链接

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