amazon.aws.iam_access_key 模块 – 管理 AWS IAM 用户访问密钥

注意

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

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

要安装它，请使用：ansible-galaxy collection install amazon.aws。您需要其他要求才能使用此模块，请参阅 需求 以了解详情。

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

community.aws 2.1.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 botocore SDK 保持一致，在 5.1.0 版本中添加了 aws_access_key_id 别名。

ec2_access_key 别名已弃用，将在 2024-12-01 之后的一个版本中移除。

EC2_ACCESS_KEY 环境变量的支持已弃用，将在 2024-12-01 之后的一个版本中移除。

active

别名：enabled

布尔值

密钥是否应启用或禁用。

创建新密钥时默认为 true。

选项

  • 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。

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

字符串

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

也可以使用 AWS_URL 或 EC2_URL 环境变量，优先级依次递减。

ec2_url 和 s3_url 别名已弃用，将在 2024-12-01 之后的一个版本中移除。

EC2_URL 环境变量的支持已弃用，将在 2024-12-01 之后的一个版本中移除。

id

字符串

访问密钥的 ID。

当 state=absent 时需要。

与 rotate_keys 互斥。

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之后的一个版本中移除。

rotate_keys

布尔值

如果已经有2个访问密钥附加到IAM用户，则将删除最旧的密钥并创建一个新密钥。

如果state=absent，则忽略。

与id互斥。

选项

  • false ← (默认)

  • true

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

字符串

创建或删除访问密钥。

当state=present且未定义id时，将创建一个新密钥。

选项

  • "present" ← (默认)

  • "absent"

user_name

别名：username

字符串 / 必需

密钥所属的IAM用户的名称。

validate_certs

布尔值

设置为false时，将不会验证与AWS API通信的SSL证书。

强烈建议不要设置validate_certs=false，作为替代方案，请考虑设置aws_ca_bundle。

选项

  • false

  • true ← (默认)

备注

注意

  • 出于安全原因，创建新访问密钥时，此模块应与no_log=true和(register)功能一起使用。

  • 警告：对于模块，环境变量和配置文件是从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 new access key
  amazon.aws.iam_access_key:
    user_name: example_user
    state: present
  no_log: true

- name: Delete the access_key
  amazon.aws.iam_access_key:
    user_name: example_user
    id: AKIA1EXAMPLE1EXAMPLE
    state: absent

返回值

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

键

描述

access_key

复杂类型

包含所有访问密钥信息的字典。

返回：密钥存在时。

access_key_id

字符串

访问密钥的ID。

返回：成功

示例："AKIA1EXAMPLE1EXAMPLE"

create_date

字符串

创建访问密钥的日期和时间(ISO 8601日期时间格式)。

返回：成功

示例："2021-10-09T13:25:42+00:00"

status

字符串

密钥的状态。

Active表示它可以使用。

Inactive表示它不能使用。

返回：成功

示例："Inactive"

user_name

字符串

附加密钥的IAM用户的名称。

返回：成功

示例："example_user"

deleted_access_key_id

字符串

在密钥轮换期间删除的访问密钥。

返回：在访问密钥轮换期间删除密钥时。

示例："AKIA1EXAMPLE1EXAMPLE"

secret_access_key

字符串

密钥访问密钥。

密钥访问密钥相当于密码，不能更改，因此应将其视为敏感数据。

密钥访问密钥只能在创建时访问。

返回：创建新密钥时。

示例："example/Example+EXAMPLE+example/Example"

作者

  • Mark Chappell (@tremble)