Модуль community.aws.acm_certificate_info – получение информации о сертификатах из службы AWS Certificate Manager
Примечание
Этот модуль входит в коллекцию community.aws (версия 10.1.0).
Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install community.aws. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: community.aws.acm_certificate_info.
Добавлено в community.aws 1.0.0
Краткое описание
- Получение информации о сертификатах ACM.
- Обратите внимание: информация о загруженных ключах размером 4096 бит не возвращается из-за ограничения API ACM.
- До выпуска версии 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.34.0
- botocore >= 1.34.0
Параметры
Параметр | Описание |
|---|---|
access_key псевдонимы: aws_access_key_id, aws_access_key строка | Идентификатор ключа доступа AWS. Дополнительные сведения о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные окружения Параметры aws_access_key и profile являются взаимоисключающими. Псевдоним aws_access_key_id добавлен в выпуске 5.1.0 для согласованности с AWS botocore SDK. |
aws_ca_bundle путь | Путь к пакету сертификатов CA, используемому для проверки SSL-сертификатов. Также можно использовать переменную окружения |
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 логический | Использовать регистратор Также можно использовать переменную окружения Варианты:
|
domain_name псевдонимы: name строка | Доменное имя сертификата ACM, которым следует ограничить поиск. |
endpoint_url псевдонимы: aws_endpoint_url строка | URL-адрес для подключения вместо конечных точек AWS по умолчанию. Хотя этот параметр можно использовать для подключения к другим службам, совместимым с AWS, коллекции amazon.aws и community.aws тестируются только с AWS. Также можно использовать переменную окружения |
profile псевдонимы: aws_profile строка | Именованный профиль AWS для аутентификации. Дополнительные сведения об именованных профилях см. в документации AWS: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Также можно использовать переменную окружения Параметр profile взаимоисключающий с параметрами aws_access_key, aws_secret_key и session_token. |
region псевдонимы: aws_region строка | Регион AWS для использования. Для глобальных служб, таких как IAM, Route53 и CloudFront, параметр region игнорируется. Также можно использовать переменную окружения Дополнительные сведения см. в документации Amazon AWS: http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. |
secret_key псевдонимы: aws_secret_access_key, aws_secret_key строка | Секретный ключ доступа AWS. Дополнительные сведения о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные окружения Параметры secret_key и profile являются взаимоисключающими. Псевдоним aws_secret_access_key добавлен в выпуске 5.1.0 для согласованности с AWS botocore SDK. |
session_token псевдонимы: aws_session_token строка | Токен сеанса AWS STS для использования с временными учетными данными. Дополнительные сведения о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменную окружения Параметры session_token и profile являются взаимоисключающими. |
statuses список / элементы=строка | Статус для фильтрации результатов поиска сертификатов. Варианты:
|
tags словарь | Отфильтровать результаты, чтобы показывались только сертификаты с тегами, соответствующими всем указанным здесь тегам. |
validate_certs логический | Если установлено значение Настоятельно не рекомендуется устанавливать validate_certs=false; вместо этого рассмотрите возможность указать aws_ca_bundle. Варианты:
|
Примечания
Примечание
- Внимание: Для модулей переменные окружения и файлы конфигурации считываются из контекста «хоста» 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"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, ниже приведены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
certificates complex | Список сертификатов Возвращается: всегда |
|
certificate string |
Содержимое сертификата ACM Возвращается: после завершения создания сертификата Пример: |
|
certificate_arn string |
ARN сертификата Возвращается: всегда Пример: |
|
certificate_chain string |
Полная цепочка сертификатов для сертификата Возвращается: после завершения создания сертификата Пример: |
|
created_at string |
Дата создания сертификата Возвращается: всегда Пример: |
|
domain_name string |
Доменное имя сертификата Возвращается: всегда Пример: |
|
domain_validation_options complex |
Параметры, используемые ACM для проверки сертификата Возвращается: если тип сертификата — AMAZON_ISSUED |
|
domain_name string |
Полное доменное имя сертификата Возвращается: всегда Пример: |
|
validation_domain string |
Доменное имя, которое ACM использовал для отправки писем с запросом подтверждения Возвращается: всегда Пример: |
|
validation_emails list / elements=string |
Список адресов электронной почты, на которые ACM отправлял письма для подтверждения домена Возвращается: всегда Пример: |
|
validation_status string |
Статус проверки домена Возвращается: всегда Пример: |
|
failure_reason string |
Причина сбоя запроса сертификата Возвращается: только если выпуск сертификата завершился с ошибкой Пример: |
|
in_use_by list / elements=string |
Список ARN ресурсов AWS, использующих этот сертификат. Возвращается: всегда Пример: |
|
issued_at string |
Дата выпуска сертификата Возвращается: всегда Пример: |
|
issuer string |
Издатель сертификата Возвращается: всегда Пример: |
|
key_algorithm string |
Алгоритм, использованный для создания сертификата Возвращается: всегда Пример: |
|
not_after string |
Дата, после которой сертификат недействителен Возвращается: всегда Пример: |
|
not_before string |
Дата, до которой сертификат недействителен Возвращается: всегда Пример: |
|
renewal_summary complex |
Информация об автоматизированном процессе продления Возвращается: если сертификат выдан Amazon и началось его продление |
|
domain_validation_options complex |
Параметры, используемые ACM для проверки сертификата Возвращается: если тип сертификата — AMAZON_ISSUED |
|
domain_name string |
Полное доменное имя сертификата Возвращается: всегда Пример: |
|
validation_domain string |
Доменное имя, которое ACM использовал для отправки писем с запросом подтверждения Возвращается: всегда Пример: |
|
validation_emails list / elements=string |
Список адресов электронной почты, на которые ACM отправлял письма для подтверждения домена Возвращается: всегда Пример: |
|
validation_status string |
Статус проверки домена Возвращается: всегда Пример: |
|
renewal_status string |
Статус продления домена Возвращается: всегда Пример: |
|
revocation_reason string |
Причина отзыва сертификата Возвращается: если сертификат был отозван Пример: |
|
revoked_at string |
Дата отзыва сертификата Возвращается: если сертификат был отозван Пример: |
|
serial string |
Серийный номер сертификата Возвращается: всегда Пример: |
|
signature_algorithm string |
Алгоритм, использованный для подписания сертификата Возвращается: всегда Пример: |
|
status string |
Статус сертификата в ACM Возвращается: всегда Пример: |
|
subject string |
Имя сущности, связанной с открытым ключом, содержащимся в сертификате Возвращается: всегда Пример: |
|
subject_alternative_names list / elements=string |
Альтернативные имена субъекта сертификата Возвращается: всегда Пример: |
|
tags dictionary |
Теги, связанные с сертификатом Возвращается: всегда Пример: |
|
type string |
Источник сертификата Возвращается: всегда Пример: |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/aws/acm_certificate_info_module.html