amazon.aws.iam_policy 模块 – 管理用户、组和角色的内联 IAM 策略

注意

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

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

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

要在 playbook 中使用它,请指定: amazon.aws.iam_policy

amazon.aws 5.0.0 中的新增功能

概要

要求

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

  • 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_IDAWS_ACCESS_KEYEC2_ACCESS_KEY 环境变量。

aws_access_keyprofile 选项互斥。

为了与 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

endpoint_url

别名: ec2_url, aws_endpoint_url, s3_url

字符串

连接到的 URL,而不是默认的 AWS 端点。虽然这可以用于连接到其他 AWS 兼容服务,但 amazon.aws 和 community.aws 集合仅针对 AWS 进行了测试。

还可以按优先级递减的顺序使用 AWS_URLEC2_URL 环境变量。

ec2_urls3_url 别名已被弃用,将在 2024-12-01 之后的版本中删除。

EC2_URL 环境变量的支持已被弃用,将在 2024-12-01 之后的版本中删除。

iam_name

字符串 / 必需

您希望进行策略操作的目标 IAM 资源的名称。换句话说,用户名、组名或角色名。

iam_type

字符串 / 必需

IAM 资源的类型。

选项

  • "用户"

  • "组"

  • "角色"

policy_json

json

正确格式化的 JSON 策略字符串。

policy_name

字符串 / 必需

要创建或删除的策略的名称标签。

profile

别名: aws_profile

字符串

用于身份验证的命名 AWS 配置文件。

有关命名配置文件的更多信息,请参阅 AWS 文档 https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html

还可以使用 AWS_PROFILE 环境变量。

profile 选项与 aws_access_keyaws_secret_keysecurity_token 选项互斥。

region

别名: aws_region, ec2_region

字符串

要使用的 AWS 区域。

对于 IAM、Route53 和 CloudFront 等全局服务,将忽略 region

还可以使用 AWS_REGIONEC2_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_KEYAWS_SECRET_KEYEC2_SECRET_KEY 环境变量,优先级依次降低。

secret_keyprofile 选项是互斥的。

为了与 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_TOKENAWS_SECURITY_TOKENEC2_SECURITY_TOKEN 环境变量,优先级依次降低。

security_tokenprofile 选项是互斥的。

别名 aws_session_tokensession_token 在 3.2.0 版本中添加,参数名称从 security_token 重命名为 session_token 在 6.0.0 版本中完成。

security_tokenaws_security_tokenaccess_token 别名已被弃用,并将在 2024-12-01 之后的版本中删除。

EC2_SECRET_KEYAWS_SECURITY_TOKEN 环境变量的支持已被弃用,并将在 2024-12-01 之后的版本中删除。

skip_duplicates

布尔值

skip_duplicates=true 时,模块会查找任何与您传入的文档匹配的策略。如果存在匹配项,它将不会创建具有相同规则的新策略对象。

选项

  • false ← (默认)

  • true

state

字符串

是否创建或删除 IAM 策略。

选项

  • "present" ← (默认)

  • "absent"

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

示例

# Advanced example, create two new groups and add a READ-ONLY policy to both
# groups.
- name: Create Two Groups, Mario and Luigi
  amazon.aws.iam_group:
    name: "{{ item }}"
    state: present
  loop:
    - Mario
    - Luigi
  register: new_groups

- name: Apply READ-ONLY policy to new groups that have been recently created
  amazon.aws.iam_policy:
    iam_type: group
    iam_name: "{{ item.iam_group.group.group_name }}"
    policy_name: "READ-ONLY"
    policy_json: "{{ lookup('template', 'readonly.json.j2') }}"
    state: present
  loop: "{{ new_groups.results }}"

# Create a new S3 policy with prefix per user
- name: Create S3 policy from template
  amazon.aws.iam_policy:
    iam_type: user
    iam_name: "{{ item.user }}"
    policy_name: "s3_limited_access_{{ item.prefix }}"
    state: present
    policy_json: "{{ lookup('template', 's3_policy.json.j2') }}"
    loop:
      - user: s3_user
        prefix: s3_user_prefix

返回值

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

描述

diff

字典

一个字典,表示应用于 IAM 资源(用户、组或角色)的策略之间的差异。

返回: 始终

after

字典

应用新策略后 IAM 资源上的当前策略。

返回: 始终

示例: {"READ-ONLY": {"Statement": [{"Action": "ec2:DescribeAccountAttributes", "Effect": "Allow", "Resource": "*", "Sid": "VisualEditor0"}], "Version": "2012-10-17"}}

before

字典

应用新策略之前 IAM 资源上存在的策略。

返回: 始终

示例: {"READ-ONLY": {"Statement": [{"Action": "ec2:DescribeAccountAttributes", "Effect": "Deny", "Resource": "*", "Sid": "VisualEditor0"}], "Version": "2012-10-17"}}

group_name

字符串

IAM 组的名称。

返回:iam_type=group

示例: "ExampleGroup001"

policy_names

list / 元素=string

嵌入在指定的 IAM 资源(用户、组或角色)中的内联策略的名称列表。

返回: 始终

示例: ["READ-ONLY"]

role_name

字符串

IAM 角色的名称。

返回:iam_type=role

示例: "ExampleRole001"

user_name

字符串

IAM 用户的名称。

返回:iam_type=user

示例: "ExampleUser001"

作者

  • Jonathan I. Davila (@defionscode)

  • Dennis Podkovyrin (@sbj-ss)