Spec-Zone.ru › Ansible 2.5

aws_acm_facts - Получение фактов сертификатов из сервиса AWS Certificate Manager

Новое в версии 2.5.

  • Обзор
    • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения
  • Статус
    • Автор

Обзор

  • Получить факты для сертификатов ACM

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

  • boto
  • boto3
  • python >= 2.6

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
aws_access_key Значение по умолчанию:
None
Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY.

псевдонимы: ec2_access_key, access_key
aws_secret_key Значение по умолчанию:
None
Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY.

псевдонимы: ec2_secret_key, secret_key
ec2_url Значение по умолчанию:
None
URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если таковое есть.
name
Имя сертификата ACM
profile
(добавлен в 1.6)
Значение по умолчанию:
None
Использует профиль boto. Работает только с boto >= 2.24.0.
region
Регион AWS для использования. Если не указан, используется значение переменной окружения AWS_REGION или EC2_REGION, если таковое есть. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region

псевдонимы: aws_region, ec2_region
security_token
(добавлен в 1.6)
Значение по умолчанию:
None
Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN.

псевдонимы: access_token
status
    Варианты:
  • PENDING_VALIDATION
  • ISSUED
  • INACTIVE
  • EXPIRED
  • VALIDATION_TIMED_OUT
Статус для фильтрации результатов сертификата
validate_certs
(добавлен в 1.5)
    Варианты:
  • no
  • да ←
Если установлено "нет", SSL-сертификаты не будут проверены для версий boto >= 2.6.0.

Примечания

Примечание

  • Если параметры не заданы в модуле, можно использовать следующие переменные окружения в порядке убывания приоритета AWS_URL или EC2_URL, AWS_ACCESS_KEY_ID или AWS_ACCESS_KEY или EC2_ACCESS_KEY, AWS_SECRET_ACCESS_KEY или AWS_SECRET_KEY или EC2_SECRET_KEY, AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN, AWS_REGION или EC2_REGION
  • Ansible использует конфигурационный файл boto (обычно ~/.boto), если учетные данные не предоставлены. См. http://boto.readthedocs.org/en/latest/boto_config_tut.html
  • AWS_REGION или EC2_REGION можно использовать для указания региона AWS, когда это необходимо, но это также можно настроить в конфигурационном файле boto

Примеры

- name: obtain all ACM certificates
  aws_acm_facts:

- name: obtain all facts for a single ACM certificate
  aws_acm_facts:
    name: "*.example_com"

- name: obtain all certificates pending validiation
  aws_acm_facts:
    statuses:
    - PENDING_VALIDATION

Возвращаемые значения

Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:

Ключ Возвращаемое значение Описание
сертификаты
сложный
всегда
Список сертификатов

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

Пример:
ВЫДАН
алгоритм_ключа
строка
всегда
Алгоритм, используемый для генерации сертификата

Пример:
RSA-2048
метки
словарь
всегда
Метки, связанные с сертификатом

Пример:
{'Среда': 'тест', 'Приложение': 'helloworld'}
цепь_сертификатов
строка
после создания сертификата
Полная цепочка сертификатов для сертификата

Пример:
-----BEGIN CERTIFICATE-----\nMII...\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\n...
используется_в
список
всегда
Список ARNs для ресурсов AWS, использующих сертификат.

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

Пример:
SHA256WITHRSA
выдан_в
строка
всегда
Дата выдачи сертификата

Пример:
2017-01-01T00:00:00+10:00
серийный_номер
строка
всегда
Серийный номер сертификата

Пример:
00:01:02:03:04:05:06:07:08:09:0a:0b:0c:0d:0e:0f
альтернативные_имена_субъекта
список
всегда
Альтернативные имена субъекта для сертификата

Пример:
['*.example.com']
не_раньше
строка
всегда
Дата, до которой сертификат недействителен

Пример:
2017-01-01T00:00:00+10:00
субъект
строка
всегда
Имя сущности, связанной с открытым ключом, содержащимся в сертификате

Пример:
CN=*.example.com
отменён_в
строка
при отмене сертификата
Дата отмены сертификата

Пример:
2017-09-01T10:00:00+10:00
параметры_валидации_домена
сложный
когда тип сертификата AMAZON_ISSUED
Параметры, используемые ACM для проверки сертификата

домен_валидации
строка
всегда
Имя домена, используемое ACM для отправки писем подтверждения

Пример:
example.com
статус_валидации
строка
всегда
Статус проверки домена

Пример:
УСПЕШНО
имя_домена
строка
всегда
Полное доменное имя сертификата

Пример:
example.com
электронные_адреса_валидации
список
всегда
Список адресов электронной почты, используемых ACM для отправки писем подтверждения домена

Пример:
['admin@example.com', 'postmaster@example.com']
сертификат
строка
после создания сертификата
Основной текст сертификата ACM

Пример:
-----BEGIN CERTIFICATE-----\nMII.....-----END CERTIFICATE-----\n
сводка_обновления
сложный
при выдаче сертификата Amazon и запуске обновления
Информация о процессе управляемого обновления

статус_обновления
строка
всегда
Статус обновления домена

Пример:
ОЖИДАЕТ_АВТОМАТИЧЕСКОГО_ОБНОВЛЕНИЯ
параметры_валидации_домена
сложный
когда тип сертификата AMAZON_ISSUED
Параметры, используемые ACM для проверки сертификата

домен_валидации
строка
всегда
Имя домена, используемое ACM для отправки писем подтверждения

Пример:
example.com
статус_валидации
строка
всегда
Статус проверки домена

Пример:
УСПЕШНО
имя_домена
строка
всегда
Полное доменное имя сертификата

Пример:
example.com
электронные_адреса_валидации
список
всегда
Список адресов электронной почты, используемых ACM для отправки писем подтверждения домена

Пример:
['admin@example.com', 'postmaster@example.com']
не_позже
строка
всегда
Дата, после которой сертификат недействителен

Пример:
2019-01-01T00:00:00+10:00
создан_в
строка
всегда
Дата создания сертификата

Пример:
2017-08-15T10:31:19+10:00
domain_name
строка
всегда
Имя домена сертификата

Пример:
*.example.com
revocation_reason
строка
при аннулировании сертификата
Причина аннулирования сертификата

Пример:
SUPERCEDED
failure_reason
строка
только при ошибке выдачи сертификата
Причина ошибки запроса сертификата

Пример:
NO_AVAILABLE_CONTACTS
certificate_arn
строка
всегда
ARN сертификата

Пример:
arn:aws:acm:ap-southeast-2:123456789012:certificate/abcd1234-abcd-1234-abcd-123456789abc
issuer
строка
всегда
Издатель сертификата

Пример:
Amazon
type
строка
всегда
Источник сертификата

Пример:
AMAZON_ISSUED


Статус

Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.

Автор

  • Will Thames (@willthames)

Подсказка

Если вы заметили какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/aws_acm_facts_module.html

Spec-Zone.ru

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