community.aws.acm_certificate_info 模块 – 从 AWS Certificate Manager 服务检索证书信息

注意

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

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

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

要在 Playbook 中使用它，请指定：community.aws.acm_certificate_info。

community.aws 1.0.0 中的新增功能

概要

• 检索 ACM 证书的信息。

• 请注意，由于 ACM API 的限制，这将不会返回有关大小为 4096 位的上传密钥的信息。

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

• 需要 IAM 权限 ‘acm:ListCertificates’、‘acm:DescribeCertificate’、‘acm:GetCertificate’、‘acm:ListTagsForCertificate’

别名：aws_acm_info

要求

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

• 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。
certificate_arn 别名：arn 字符串	如果提供，则结果将过滤为仅显示具有此 ARN 的证书。 如果不存在具有此 ARN 的证书，则此任务将失败。 如果具有此 ARN 的证书存在于不同的区域，则此任务将失败。
debug_botocore_endpoint_logs 布尔值	使用 botocore.endpoint 记录器来解析在任务期间进行的唯一（而不是总计）"resource:action" API 调用，并将集合输出到任务结果中的 resource_actions 键。使用 aws_resource_action 回调输出在 playbook 期间制作的总列表。 也可以使用 ANSIBLE_DEBUG_BOTOCORE_LOGS 环境变量。 选择 false ←（默认） true
domain_name 别名：name 字符串	用于限制搜索范围的 ACM 证书的域名。
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 之后的版本中删除。
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 之后的版本中删除。
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_secret_access_key 别名在 5.1.0 版本中添加，以与 AWS botocore SDK 保持一致。 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 之后的版本中删除。
statuses list / elements=string	用于筛选证书结果的状态。 选择 "PENDING_VALIDATION" "ISSUED" "INACTIVE" "EXPIRED" "VALIDATION_TIMED_OUT" "REVOKED" "FAILED"
tags 字典	筛选结果，仅显示与此处指定的所有标签匹配的证书。
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。

示例

- name: obtain all ACM certificates
  community.aws.acm_certificate_info:

- name: obtain all information for a single ACM certificate
  community.aws.acm_certificate_info:
    domain_name: "*.example_com"

- name: obtain all certificates pending validation
  community.aws.acm_certificate_info:
    statuses:
      - PENDING_VALIDATION

- name: obtain all certificates with tag Name=foo and myTag=bar
  community.aws.acm_certificate_info:
    tags:
      Name: foo
      myTag: bar


# The output is still a list of certificates, just one item long.
- name: obtain information about a certificate with a particular ARN
  community.aws.acm_certificate_info:
    certificate_arn: "arn:aws:acm:ap-southeast-2:123456789012:certificate/abcdeabc-abcd-1234-4321-abcdeabcde12"

返回值

通用返回值记录在此处 here，以下是此模块独有的字段

键	描述
certificates 复杂	证书列表 返回： 始终
certificate 字符串	ACM 证书主体 返回： 当证书创建完成时 示例： "-----BEGIN CERTIFICATE-----\\\\nMII.....-----END CERTIFICATE-----\\\\n"
certificate_arn 字符串	证书 ARN 返回： 始终 示例： "arn:aws:acm:ap-southeast-2:123456789012:certificate/abcd1234-abcd-1234-abcd-123456789abc"
certificate_chain 字符串	证书的完整证书链 返回： 当证书创建完成时 示例： "-----BEGIN CERTIFICATE-----\\\\nMII...\\\\n-----END CERTIFICATE-----\\\\n-----BEGIN CERTIFICATE-----\\\\n..."
created_at 字符串	证书创建日期 返回： 始终 示例： "2017-08-15T10:31:19+10:00"
domain_name 字符串	证书的域名 返回： 始终 示例： "*.example.com"
domain_validation_options 复杂	ACM 用于验证证书的选项 返回： 当证书类型为 AMAZON_ISSUED 时
domain_name 字符串	证书的完全限定域名 返回： 始终 示例： "example.com"
validation_domain 字符串	ACM 用于发送验证电子邮件的域名 返回： 始终 示例： "example.com"
validation_emails list / elements=string	ACM 用于发送域验证电子邮件的电子邮件地址列表 返回： 始终 示例： ["[email protected]", "[email protected]"]
validation_status 字符串	域的验证状态 返回： 始终 示例： "SUCCESS"
failure_reason 字符串	证书请求失败的原因 返回： 仅当证书颁发失败时 示例： "NO_AVAILABLE_CONTACTS"
in_use_by list / elements=string	正在使用证书的 AWS 资源的 ARN 列表。 返回： 始终 示例： []
issued_at 字符串	证书颁发日期 返回： 始终 示例： "2017-01-01T00:00:00+10:00"
issuer 字符串	证书的颁发者 返回： 始终 示例： "Amazon"
key_algorithm 字符串	用于生成证书的算法 返回： 始终 示例： "RSA-2048"
not_after 字符串	证书失效日期 返回： 始终 示例： "2019-01-01T00:00:00+10:00"
not_before 字符串	证书生效日期 返回： 始终 示例： "2017-01-01T00:00:00+10:00"
renewal_summary 复杂	有关托管续订流程的信息 返回： 当证书由 Amazon 颁发并且已开始续订时
domain_validation_options 复杂	ACM 用于验证证书的选项 返回： 当证书类型为 AMAZON_ISSUED 时
domain_name 字符串	证书的完全限定域名 返回： 始终 示例： "example.com"
validation_domain 字符串	ACM 用于发送验证电子邮件的域名 返回： 始终 示例： "example.com"
validation_emails list / elements=string	ACM 用于发送域验证电子邮件的电子邮件地址列表 返回： 始终 示例： ["[email protected]", "[email protected]"]
validation_status 字符串	域的验证状态 返回： 始终 示例： "SUCCESS"
renewal_status 字符串	域续订的状态 返回： 始终 示例： "PENDING_AUTO_RENEWAL"
revocation_reason 字符串	证书吊销的原因 返回： 当证书已被吊销时 示例： "SUPERCEDED"
revoked_at 字符串	证书吊销日期 返回： 当证书已被吊销时 示例： "2017-09-01T10:00:00+10:00"
serial 字符串	证书的序列号 返回： 始终 示例： "00:01:02:03:04:05:06:07:08:09:0a:0b:0c:0d:0e:0f"
signature_algorithm 字符串	用于签署证书的算法 返回： 始终 示例： "SHA256WITHRSA"
status 字符串	ACM 中证书的状态 返回： 始终 示例： "ISSUED"
subject 字符串	与证书中包含的公钥关联的实体的名称 返回： 始终 示例： "CN=*.example.com"
subject_alternative_names list / elements=string	证书的主题备用名称 返回： 始终 示例： ["*.example.com"]
tags 字典	与证书关联的标签 返回： 始终 示例： {"Application": "helloworld", "Environment": "test"}
类型 字符串	证书的来源 返回： 始终 示例： "AMAZON_ISSUED"

作者

• Will Thames (@willthames)

集合链接

• 问题跟踪器
• 存储库（源代码）
• 交流