Модуль community.aws.acm_certificate_info – Получение информации о сертификатах из сервиса AWS Certificate Manager
Примечание
Этот модуль является частью коллекции community.aws (версия 8.0.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. Использование не изменилось.
Псевдонимы: aws_acm_info
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 3.6
- boto3 >= 1.26.0
- botocore >= 1.29.0
Параметры
Параметр | Комментарии |
|---|---|
access_key aliases: aws_access_key_id, aws_access_key, ec2_access_key string | Идентификатор ключа доступа 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. Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды |
aws_ca_bundle path | Расположение пакета CA, используемого при проверке SSL-сертификатов. Также может использоваться переменная среды |
aws_config dictionary | Словарь для изменения конфигурации botocore. Параметры можно найти в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. |
certificate_arn aliases: arn string | Если указано, результаты будут отфильтрованы, чтобы отображать только сертификат с этим ARN. Если сертификата с этим ARN не существует, эта задача завершится ошибкой. Если сертификат с этим ARN существует в другом регионе, эта задача завершится ошибкой. |
debug_botocore_endpoint_logs boolean | Использовать Также может использоваться переменная среды Варианты:
|
domain_name aliases: name string | Доменное имя сертификата ACM для ограничения поиска. |
endpoint_url aliases: ec2_url, aws_endpoint_url, s3_url string | URL для подключения вместо стандартных конечных точек AWS. Хотя это может использоваться для подключения к другим совместимым с AWS сервисам, коллекции amazon.aws и community.aws тестируются только с AWS. Также могут использоваться переменные среды Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01. Поддержка переменной среды |
profile aliases: aws_profile string | Именованный профиль AWS для использования при аутентификации. Дополнительная информация об именованных профилях приведена в документации AWS https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Также может использоваться переменная среды Параметр profile является взаимоисключающим с параметрами aws_access_key, aws_secret_key и security_token. |
region aliases: aws_region, ec2_region string | Используемый регион AWS. Для глобальных служб, таких как IAM, Route53 и CloudFront, region игнорируется. Также могут использоваться переменные среды Дополнительная информация приведена в документации Amazon AWS http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. Псевдоним Поддержка переменной среды |
secret_key aliases: aws_secret_access_key, aws_secret_key, ec2_secret_key string | Секретный ключ доступа 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. Псевдоним ec2_secret_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды |
session_token aliases: aws_session_token, security_token, aws_security_token, access_token строка | Токен сессии AWS STS для использования с временными учетными данными. Дополнительную информацию об access-токенах см. в документации AWS https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также могут использоваться переменные среды Параметры security_token и profile взаимоисключающие. Алиасы aws_session_token и session_token были добавлены в релизе 3.2.0, а параметр был переименован из security_token в session_token в релизе 6.0.0. Алиасы security_token, aws_security_token и access_token устарели и будут удалены в релизе после 2024-12-01. Поддержка переменных среды |
statuses список / элементы=строка | Статус для фильтрации результатов сертификатов. Варианты:
|
метки словарь | Фильтрует результаты, показывая только сертификаты с метками, которые соответствуют всем указанным здесь меткам. |
validate_certs логическое значение | При установке в Сильно не рекомендуется устанавливать validate_certs=false, как альтернативу, рассмотрите установку aws_ca_bundle вместо этого. Варианты:
|
Примечания
Примечание
- Внимание: Для модулей переменные среды и конфигурационные файлы читаются из контекста Ansible «хост», а не «контроллера». Поэтому файлы могут потребоваться явно скопировать на «хост». Для плагинов поиска и подключения переменные среды и конфигурационные файлы читаются из контекста Ansible «контроллера», а не «хоста».
- AWS SDK (boto3), используемый Ansible, также может читать значения по умолчанию для учетных данных и других настроек, таких как регион, из своих конфигурационных файлов в контексте 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/aws/acm_certificate_info_module.html