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

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

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

Обзор

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

Требования

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

boto
boto3
python >= 2.6

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
aws_access_key -		Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. Псевдонимы: ec2_access_key, access_key
aws_secret_key -		Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. Псевдонимы: ec2_secret_key, secret_key
domain_name -		Имя домена сертификата ACM для ограничения поиска. Псевдонимы: name
ec2_url -		URL для подключения к EC2 или Eucalyptus облаку (по умолчанию используется конечная точка EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если она есть.
profile - добавлен в 1.6		Использует профиль 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		Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Псевдонимы: access_token
status -	Варианты: PENDING_VALIDATION ISSUED INACTIVE EXPIRED VALIDATION_TIMED_OUT	Статус для фильтрации результатов сертификатов
validate_certs boolean добавлен в 1.5	Варианты: no yes ←	При установке в "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), если учетные данные не предоставлены. См. https://boto.readthedocs.io/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:
    domain_name: "*.example_com"

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

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

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

Краткое описание полей				Возвращаемое значение	Описание
сертификаты сложный				всегда	Список сертификатов
	сертификат строка			после создания сертификата	Тело сертификата 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 сложный			при типе сертификата AMAZON_ISSUED	Параметры, используемые ACM для валидации сертификата
		domain_name строка		всегда	Полное доменное имя сертификата Пример: example.com
		validation_domain строка		всегда	Имя домена, которое ACM использовал для отправки электронных писем валидации Пример: example.com
		validation_emails список		всегда	Список адресов электронной почты, которые ACM использовал для отправки электронных писем валидации домена Пример: ['admin@example.com', 'postmaster@example.com']
		validation_status строка		всегда	Статус валидации домена Пример: SUCCESS
	failure_reason строка			только при ошибке выдачи сертификата	Причина ошибки запроса сертификата Пример: NO_AVAILABLE_CONTACTS
	in_use_by список			всегда	Список ARN для AWS-ресурсов, использующих сертификат.
	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 сертификате и начатом продлении	Информация о процессе продления (managed renewal)
		domain_validation_options сложный		при типе сертификата AMAZON_ISSUED	Параметры, используемые ACM для валидации сертификата
			domain_name строка	всегда	Полное доменное имя сертификата Пример: example.com
			validation_domain строка	всегда	Имя домена, которое ACM использовал для отправки электронных писем валидации Пример: example.com
			validation_emails список	всегда	Список адресов электронной почты, которые ACM использовал для отправки электронных писем валидации домена Пример: ['admin@example.com', 'postmaster@example.com']
			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

алгоритм_подписи строка	всегда	Алгоритм, используемый для подписи сертификата Пример: SHA256WITHRSA
статус строка	всегда	Статус сертификата в ACM Пример: ISSUED
субъект строка	всегда	Имя сущности, связанной с открытым ключом, содержащимся в сертификате Пример: CN=*.example.com
альтернативные_имена_субъекта список	всегда	Альтернативные имена субъекта для сертификата Пример: ['*.example.com']
метки словарь	всегда	Метки, связанные с сертификатом Пример: {'Приложение': 'helloworld', 'Среда': 'test'}
тип строка	всегда	Источник сертификата Пример: AMAZON_ISSUED

Статус

Данный модуль не гарантирует обратной совместимости интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

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.7/modules/aws_acm_facts_module.html