community.aws.secretsmanager_secret 模块 – 管理存储在 AWS Secrets Manager 中的密钥

注意

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

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

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

要在 playbook 中使用它，请指定：community.aws.secretsmanager_secret。

community.aws 1.0.0 中的新增功能

概要

• 创建、更新和删除存储在 AWS Secrets Manager 中的密钥。

• 在 5.0.0 版本之前，此模块称为 community.aws.aws_secret。用法没有改变。

别名：aws_secret

要求

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

• 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 字符串	指定用户提供的密钥描述。 默认值： ""
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 之后的发行版中移除。
json_secret json community.aws 4.1.0 中新增	指定要加密并存储在密钥新版本中的 JSON 格式数据。 与 secret 选项互斥。
kms_key_id 字符串	指定用于加密此密钥中存储的版本中的 secret 值的 AWS KMS 客户主密钥 (CMK) 的 ARN 或别名。
name 字符串 / 必填	要创建的密钥的友好名称。
overwrite 布尔值 community.aws 5.3.0 中新增	是否使用相同名称覆盖现有密钥。 如果设置为 True，则将覆盖具有相同 name 的现有密钥。 如果设置为 False，则只有在不存在具有给定 name 的密钥时才会创建密钥。 选项 false true ← (默认)
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 ← (默认)
recovery_window 整数	仅在 state 为 absent 时使用。 指定 Secrets Manager 在可以删除密钥之前等待的天数。 如果设置为 0，则强制删除而无需恢复。 默认值： 30
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 之后的一个版本中删除。
replica 列表 / 元素=字典 community.aws 5.3.0 中新增	指定要将密钥复制到的区域和 kms_key_ids（可选）列表
kms_key_id 字符串	指定要使用的目标区域中的 AWS KMS 客户主密钥 (CMK) 的 ARN 或别名（如果未指定，则假定为 alias/aws/secretsmanager）
region 字符串 / 必填	要将密钥复制到的区域。
resource_policy json 在 community.aws 3.1.0 中添加	指定要附加到密钥的 JSON 格式的资源策略。在授予对密钥的跨帐户访问权限时非常有用。
rotation_interval 整数	指定密钥自动计划轮换之间的时间（天数）。 默认值： 30
rotation_lambda 字符串	指定可以轮换密钥的 Lambda 函数的 ARN。
secret 字符串	指定要加密并存储在密钥新版本中的字符串或二进制数据。 与 json_secret 选项互斥。 默认值： ""
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 之后的一个版本中删除。
secret_type 字符串	指定要加密的数据类型。 选项 "binary" "string" ← (默认)
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 字符串	密钥是否存在。 选项 "present" ← (默认) "absent"
tags 别名：resource_tags 字典	表示要应用于资源的标签的字典。 如果没有设置 tags 参数，则不会修改标签。
validate_certs 布尔值	设置为 false 时，将不会验证与 AWS API 通信的 SSL 证书。 强烈建议不要设置 validate_certs=false，作为替代方案，请考虑改用 aws_ca_bundle。 选项 false true ← (默认)

注释

注意

• 在 4.0.0 版本中添加了对 purge_tags 的支持。

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

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

示例

- name: Add string to AWS Secrets Manager
  community.aws.secretsmanager_secret:
    name: 'test_secret_string'
    state: present
    secret_type: 'string'
    secret: "{{ super_secret_string }}"

- name: Add a secret with resource policy attached
  community.aws.secretsmanager_secret:
    name: 'test_secret_string'
    state: present
    secret_type: 'string'
    secret: "{{ super_secret_string }}"
    resource_policy: "{{ lookup('template', 'templates/resource_policy.json.j2', convert_data=False) | string }}"

- name: remove string from AWS Secrets Manager
  community.aws.secretsmanager_secret:
    name: 'test_secret_string'
    state: absent
    secret_type: 'string'
    secret: "{{ super_secret_string }}"

- name: Only create a new secret, but do not update if alredy exists by name
  community.aws.secretsmanager_secret:
    name: 'random_string'
    state: present
    secret_type: 'string'
    secret: "{{ lookup('community.general.random_string', length=16, special=false) }}"
    overwrite: false

返回值

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

Key	描述
secret 复杂	密钥信息 返回：始终
arn 字符串	密钥的 ARN。 返回：始终 示例： "arn:aws:secretsmanager:eu-west-1:xxxxxxxxxx:secret:xxxxxxxxxxx"
description 字符串	密钥的描述。 返回：当密钥有描述时 示例： "An example description"
last_accessed_date 字符串	上次访问密钥的日期。 返回：始终 示例： "2018-11-20T01:00:00+01:00"
last_changed_date 字符串	上次修改密钥的日期。 返回：始终 示例： "2018-11-20T12:16:38.433000+01:00"
name 字符串	密钥名称。 返回：始终 示例： "my_secret"
rotation_enabled 布尔值	密钥轮换状态。 返回：始终 示例： false
tags 列表 / 元素=字典	以标准 boto3 格式表示与密钥关联的标签的字典列表。 返回：当密钥有标签时
key 字符串	标签的名称或键。 返回：成功 示例： "MyTag"
value 字符串	标签的值。 返回：成功 示例： "Some value."
tags_dict 字典 在 community.aws 4.0.0 中添加	表示与密钥关联的标签的字典。 返回：当密钥有标签时 示例： {"MyTagName": "Some Value"}
version_ids_to_stages 字典	提供密钥版本 ID 和关联的密钥阶段。 返回：始终 示例： {"dc1ed59b-6d8e-4450-8b41-536dfe4600a9": ["AWSCURRENT"]}

作者

• REY Remi (@rrey)

集合链接

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