Spec-Zone.ru › Ansible

Модуль 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_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY в порядке убывания предпочтения.

Параметры aws_access_key и profile являются взаимоисключающими.

Псевдоним aws_access_key_id был добавлен в релизе 5.1.0 для согласованности с AWS botocore SDK.

Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01.

Поддержка переменной среды EC2_ACCESS_KEY устарела и будет удалена в релизе после 2024-12-01.

aws_ca_bundle

path

Расположение пакета CA, используемого при проверке SSL-сертификатов.

Также может использоваться переменная среды AWS_CA_BUNDLE.

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

Использовать botocore.endpoint регистратор для анализа уникальных (а не общих) "resource:action" вызовов API, выполненных во время задачи, выводя набор в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода в общий список, созданный во время playbook.

Также может использоваться переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS.

Варианты:

  • false ← (по умолчанию)
  • true

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.

Также могут использоваться переменные среды AWS_URL или EC2_URL в порядке убывания предпочтения.

Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01.

Поддержка переменной среды EC2_URL устарела и будет удалена в релизе после 2024-12-01.

profile

aliases: aws_profile

string

Именованный профиль 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

aliases: aws_region, ec2_region

string

Используемый регион 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

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.

Также могут использоваться переменные среды 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

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.

Также могут использоваться переменные среды AWS_SESSION_TOKEN, AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN в порядке убывания приоритета.

Параметры 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.

Поддержка переменных среды EC2_SECRET_KEY и AWS_SECURITY_TOKEN устарела и будет удалена в релизе после 2024-12-01.

statuses

список / элементы=строка

Статус для фильтрации результатов сертификатов.

Варианты:

  • "PENDING_VALIDATION"
  • "ISSUED"
  • "INACTIVE"
  • "EXPIRED"
  • "VALIDATION_TIMED_OUT"
  • "REVOKED"
  • "FAILED"

метки

словарь

Фильтрует результаты, показывая только сертификаты с метками, которые соответствуют всем указанным здесь меткам.

validate_certs

логическое значение

При установке в false, SSL-сертификаты не будут проверяться для связи с API AWS.

Сильно не рекомендуется устанавливать validate_certs=false, как альтернативу, рассмотрите установку aws_ca_bundle вместо этого.

Варианты:

  • false
  • true ← (по умолчанию)

Примечания

Примечание

  • Внимание: Для модулей переменные среды и конфигурационные файлы читаются из контекста 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

Возвращается: когда создание сертификата завершено

Пример: "-----BEGIN CERTIFICATE-----\\\\nMII.....-----END CERTIFICATE-----\\\\n"

certificate_arn

string

ARN сертификата

Возвращается: всегда

Пример: "arn:aws:acm:ap-southeast-2:123456789012:certificate/abcd1234-abcd-1234-abcd-123456789abc"

certificate_chain

string

Полная цепочка сертификатов

Возвращается: когда создание сертификата завершено

Пример: "-----BEGIN CERTIFICATE-----\\\\nMII...\\\\n-----END CERTIFICATE-----\\\\n-----BEGIN CERTIFICATE-----\\\\n..."

created_at

string

Дата создания сертификата

Возвращается: всегда

Пример: "2017-08-15T10:31:19+10:00"

domain_name

string

Доменное имя для сертификата

Возвращается: всегда

Пример: "*.example.com"

domain_validation_options

complex

Параметры, используемые ACM для проверки сертификата

Возвращается: когда тип сертификата AMAZON_ISSUED

domain_name

string

Полностью квалифицированное доменное имя сертификата

Возвращается: всегда

Пример: "example.com"

validation_domain

string

Доменное имя, используемое ACM для отправки писем проверки

Возвращается: всегда

Пример: "example.com"

validation_emails

list / elements=string

Список адресов электронной почты, которые ACM использовал для отправки писем проверки домена

Возвращается: всегда

Пример: ["admin@example.com", "postmaster@example.com"]

validation_status

string

Статус проверки домена

Возвращается: всегда

Пример: "SUCCESS"

failure_reason

string

Причина сбоя запроса сертификата

Возвращается: только при сбое выдачи сертификата

Пример: "NO_AVAILABLE_CONTACTS"

in_use_by

list / elements=string

Список ARN для ресурсов AWS, использующих сертификат.

Возвращается: всегда

Пример: []

issued_at

string

Дата выдачи сертификата

Возвращается: всегда

Пример: "2017-01-01T00:00:00+10:00"

issuer

string

Выдавший сертификат

Возвращается: всегда

Пример: "Amazon"

key_algorithm

string

Алгоритм, используемый для генерации сертификата

Возвращается: всегда

Пример: "RSA-2048"

not_after

string

Дата, после которой сертификат недействителен

Возвращается: всегда

Пример: "2019-01-01T00:00:00+10:00"

not_before

string

Дата, до которой сертификат недействителен

Возвращается: всегда

Пример: "2017-01-01T00:00:00+10:00"

renewal_summary

complex

Информация о процессе управляемого продления

Возвращается: когда сертификат выпущен Amazon и начато продление

domain_validation_options

complex

Параметры, используемые ACM для проверки сертификата

Возвращается: когда тип сертификата AMAZON_ISSUED

domain_name

string

Полностью квалифицированное доменное имя сертификата

Возвращается: всегда

Пример: "example.com"

validation_domain

string

Доменное имя, использованное ACM для отправки писем проверки

Возвращается: всегда

Пример: "example.com"

validation_emails

list / elements=string

Список адресов электронной почты, использованных ACM для отправки писем проверки домена

Возвращается: всегда

Пример: ["admin@example.com", "postmaster@example.com"]

validation_status

string

Статус проверки домена

Возвращается: всегда

Пример: "SUCCESS"

renewal_status

string

Статус продления домена

Возвращается: всегда

Пример: "PENDING_AUTO_RENEWAL"

revocation_reason

string

Причина аннулирования сертификата

Возвращается: когда сертификат был аннулирован

Пример: "SUPERCEDED"

revoked_at

string

Дата аннулирования сертификата

Возвращается: когда сертификат был аннулирован

Пример: "2017-09-01T10:00:00+10:00"

serial

string

Серийный номер сертификата

Возвращается: всегда

Пример: "00:01:02:03:04:05:06:07:08:09:0a:0b:0c:0d:0e:0f"

signature_algorithm

string

Алгоритм, использованный для подписи сертификата

Возвращается: всегда

Пример: "SHA256WITHRSA"

status

string

Статус сертификата в ACM

Возвращается: всегда

Пример: "ISSUED"

subject

string

Имя субъекта, связанного с открытым ключом, содержащимся в сертификате

Возвращается: всегда

Пример: "CN=*.example.com"

subject_alternative_names

list / elements=string

Альтернативные имена субъекта для сертификата

Возвращается: всегда

Пример: ["*.example.com"]

tags

dictionary

Теги, связанные с сертификатом

Возвращается: всегда

Пример: {"Application": "helloworld", "Environment": "test"}

type

string

Источник сертификата

Возвращается: всегда

Пример: "AMAZON_ISSUED"

Авторы

  • Will Thames (@willthames)

Ссылки на коллекцию

  • Отслеживание проблем
  • Репозиторий (источники)
  • Общение

© 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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API