amazon.aws.ec2_key 模块 – 创建或删除 EC2 密钥对

注意

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

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

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

要在剧本中使用它，请指定：amazon.aws.ec2_key。

amazon.aws 1.0.0 中的新增功能

概要

• 创建或删除 EC2 密钥对。

要求

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

• 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 回调输出到剧本期间制作的总列表。 也可以使用 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 之后的版本中删除。
file_name 路径 在 amazon.aws 6.4.0 中添加	将保存生成的私钥的文件名。 提供后，key.private_key 属性将从返回值中删除。 该文件写入在“主机”端而不是“控制器”端。 当 state=absent 或 key_material 时将被忽略。
force 布尔值	如果密钥已更改，则强制覆盖已存在的密钥对。 选项 false true ←（默认）
key_material 字符串	公钥材料。
key_type 字符串 在 amazon.aws 3.1.0 中添加	要创建的密钥对类型。 请注意，Windows 实例、EC2 Instance Connect 和 EC2 串行控制台不支持 ED25519 密钥。 默认情况下，Amazon 将创建一个 RSA 密钥。 与参数 key_material 互斥。 选项 "rsa" "ed25519"
name 字符串 / 必选	密钥对的名称。
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 选项互斥。 别名 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"
tags 别名：resource_tags 字典	表示要应用于资源的标签的字典。 如果未设置 tags 参数，则不会修改标签。
validate_certs 布尔值	当设置为 false 时，与 AWS API 通信时将不会验证 SSL 证书。 强烈建议不要设置 validate_certs=false，作为替代方案，请考虑设置 aws_ca_bundle。 选项 false true ←（默认）

注释

注意

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

• 出于安全原因，在创建新密钥对且不提供 key_material 时，应将此模块与 no_log=true 和 (register) 功能结合使用。

• 注意： 对于模块，环境变量和配置文件是从 Ansible ‘host’ 上下文读取的，而不是从 ‘controller’ 上下文读取的。 因此，可能需要将文件显式复制到 ‘host’。 对于 lookup 和连接插件，环境变量和配置文件是从 Ansible ‘controller’ 上下文读取的，而不是从 ‘host’ 上下文读取的。

• Ansible 使用的 AWS SDK (boto3) 也可能从其在 Ansible ‘host’ 上下文中的配置文件（通常是 ~/.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 EC2 key pair, returns generated private key
  # use no_log to avoid private key being displayed into output
  amazon.aws.ec2_key:
    name: my_keypair
  no_log: true
  register: aws_ec2_key_pair

- name: create key pair using provided key_material
  amazon.aws.ec2_key:
    name: my_keypair
    key_material: 'ssh-rsa AAAAxyz...== [email protected]'

- name: create key pair using key_material obtained using 'file' lookup plugin
  amazon.aws.ec2_key:
    name: my_keypair
    key_material: "{{ lookup('file', '/path/to/public_key/id_rsa.pub') }}"

- name: Create ED25519 key pair and save private key into a file
  amazon.aws.ec2_key:
    name: my_keypair
    key_type: ed25519
    file_name: /tmp/aws_ssh_rsa

# try creating a key pair with the name of an already existing keypair
# but don't overwrite it even if the key is different (force=false)
- name: try creating a key pair with name of an already existing keypair
  amazon.aws.ec2_key:
    name: my_existing_keypair
    key_material: 'ssh-rsa AAAAxyz...== [email protected]'
    force: false

- name: remove key pair from AWS by name
  amazon.aws.ec2_key:
    name: my_keypair
    state: absent

返回值

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

Key	描述
changed 布尔值	是否创建/删除了密钥对。 返回： 始终 示例： true
key 复杂	密钥对的详细信息（当状态为 absent 时，此值设置为 null）。 返回： 始终
fingerprint 字符串	密钥的指纹。 返回： 当 state=present 时 示例： "b0:22:49:61:d9:44:9d:0c:7e:ac:8a:32:93:21:6c:e8:fb:59:62:43"
id 字符串	密钥对的 ID。 返回： 当 state=present 时 示例： "key-123456789abc"
name 字符串	密钥对的名称。 返回： 当 state=present 时 示例： "my_keypair"
private_key 字符串	新创建的密钥对的私钥。 返回： 当 AWS 创建新密钥对（未提供 key_material）且未提供 file_name 时。 示例： "-----BEGIN RSA PRIVATE KEY----- MIIEowIBAAKC... -----END RSA PRIVATE KEY-----"
tags 字典	表示附加到密钥对的标签的字典。 返回： 当 state=present 时 示例： {"my_key": "my value"}
type 字符串 在 amazon.aws 3.1.0 中添加	新创建的密钥对的类型。 返回： 当 AWS 创建新密钥对时 示例： "rsa"
msg 字符串	描述所执行操作的简短消息。 返回： 始终 示例： "key pair created"

作者

• Vincent Viallet (@zbal)

• Prasad Katti (@prasadkatti)

集合链接

• 问题跟踪器
• 存储库（源代码）
• 通信