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

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

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

Синопсис

Получение информации о сертификатах ACM
Этот модуль назывался aws_acm_facts до Ansible 2.9. Использование не изменилось.

Псевдонимы: aws_acm_facts

Требования

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

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
debug_botocore_endpoint_logs логический тип добавлен в 2.8	Варианты: нет ← да	Использовать логирование botocore.endpoint для анализа уникальных (а не общих) API-вызовов «ресурс:действие», выполняемых во время задачи, выводящих набор в ключ resource_actions результатов задачи. Используйте обратный вызов aws_resource_action для вывода в общий список, созданный во время исполнения книги задач. Также может быть использована переменная окружения ANSIBLE_DEBUG_BOTOCORE_LOGS.
domain_name -		Имя домена сертификата ACM для ограничения поиска Псевдонимы: name
ec2_url строка		URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль будет использовать конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если она есть.
profile строка		Использует профиль 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 строка		Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Псевдонимы: access_token
statuses -	Варианты: PENDING_VALIDATION ISSUED INACTIVE EXPIRED VALIDATION_TIMED_OUT REVOKED FAILED	Статус для фильтрации результатов сертификатов
validate_certs логический тип	Варианты: нет да ←	При установке в «нет», сертификаты 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_info:

- name: obtain all information for a single ACM certificate
  aws_acm_info:
    domain_name: "*.example_com"

- name: obtain all certificates pending validation
  aws_acm_info:
    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 и начатом процессе продления	Информация о управляемом процессе продления
		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 string	always	Серийный номер сертификата Пример: 00:01:02:03:04:05:06:07:08:09:0a:0b:0c:0d:0e:0f
signature_algorithm string	always	Алгоритм, используемый для подписи сертификата Пример: SHA256WITHRSA
status string	always	Статус сертификата в ACM Пример: ISSUED
subject string	always	Имя сущности, связанной с открытым ключом, содержащимся в сертификате Пример: CN=*.example.com
subject_alternative_names list	always	Альтернативные имена субъекта для сертификата Пример: ['*.example.com']
tags dictionary	always	Теги, связанные с сертификатом Пример: {'Application': 'helloworld', 'Environment': 'test'}
type string	always	Источник сертификата Пример: AMAZON_ISSUED

Статус

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

Авторы

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