community.aws.aws_kms_facts – Сбор информации о ключах AWS KMS

Примечание

Этот плагин входит в состав коллекции community.aws (версия 1.3.0).

Для его установки используйте: ansible-galaxy collection install community.aws

Для использования в playbook, укажите: community.aws.aws_kms_facts

Новый в версии 1.0.0: of community.aws

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

Обзор

Сбор информации о ключах AWS KMS, включая теги и разрешения
Этот модуль назывался aws_kms_facts до Ansible 2.9. Способ использования не изменился.

Требования

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

python >= 2.6
boto

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
aws_access_key строка		Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. Если задан параметр profile, этот параметр игнорируется. Одновременное указание параметров aws_access_key и profile устарело, и эти параметры станут взаимоисключающими после 2022-06-01. Псевдонимы: ec2_access_key, access_key
aws_ca_bundle путь		Расположение файла CA-сертификатов для проверки SSL-сертификатов. Используется только для модулей, основанных на boto3. Примечание: CA-сертификаты считываются на стороне модуля и могут потребовать явного копирования с контроллера, если они не выполняются локально.
aws_config словарь		Словарь для изменения конфигурации botocore. Параметры можно найти по адресу https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. Для модулей boto используется только ключ 'user_agent'. См. http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto для получения дополнительной информации о конфигурации boto.
aws_secret_key строка		Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. Если задан параметр profile, этот параметр игнорируется. Одновременное указание параметров aws_secret_key и profile устарело, и эти параметры станут взаимоисключающими после 2022-06-01. Псевдонимы: ec2_secret_key, secret_key
debug_botocore_endpoint_logs логический тип	Варианты: нет ← да	Использовать логгер botocore.endpoint для анализа уникальных (а не общих) API-вызовов "resource:action", сделанных во время выполнения задачи, выводя набор в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода полного списка, созданного во время выполнения playbook. Переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS также может быть использована.
ec2_url строка		URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если не используется регион. Если не задан, используется значение переменной окружения EC2_URL, если таковая имеется. Псевдонимы: aws_endpoint_url, endpoint_url
filters словарь		Словарь фильтров для применения. Каждый элемент словаря состоит из ключа фильтра и значения фильтра. Фильтры не поддерживаются напрямую boto3, но поддерживаются для обеспечения сходной функциональности с другими модулями. Доступны стандартные фильтры тегов (`tag-key`, `tag-value` и `tag:tagName`), а также `key-id` и `alias`
pending_deletion логический тип	Варианты: нет ← да	Указывает, необходимо ли получить полные данные (теги, разрешения и т. д.) для ключей, ожидающих удаления
profile строка		Использует профиль boto. Работает только с boto >= 2.24.0. Использование profile переопределяет aws_access_key, aws_secret_key и security_token, и поддержка их одновременного указания с profile устарела. aws_access_key, aws_secret_key и security_token будут взаимоисключающими с profile после 2022-06-01. Псевдонимы: aws_profile
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. Если задан параметр profile, этот параметр игнорируется. Одновременное указание параметров security_token и profile устарело, и эти параметры станут взаимоисключающими после 2022-06-01. Псевдонимы: aws_security_token, access_token
validate_certs логический тип	Варианты: нет да ←	Если установлено в "нет", SSL-сертификаты не будут проверятся для версий boto >= 2.6.0.

Примечания

Примечание

Если параметры не заданы в модуле, можно использовать следующие переменные среды в порядке убывания приоритета AWS_URL или EC2_URL, AWS_PROFILE или AWS_DEFAULT_PROFILE, 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, AWS_CA_BUNDLE
Ansible использует конфигурационный файл boto (обычно ~/.boto), если учетные данные не предоставлены. См. https://boto.readthedocs.io/en/latest/boto_config_tut.html
AWS_REGION или EC2_REGION обычно используются для указания региона AWS, когда это необходимо, но это также можно настроить в конфигурационном файле boto

Примеры

# Note: These examples do not set authentication details, see the AWS Guide for details.

# Gather information about all KMS keys
- community.aws.aws_kms_info:

# Gather information about all keys with a Name tag
- community.aws.aws_kms_info:
    filters:
      tag-key: Name

# Gather information about all keys with a specific name
- community.aws.aws_kms_info:
    filters:
      "tag:Name": Example

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

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

Ключи			Возвращаемое	Описание
ключевые сложный			всегда	список ключей
	псевдонимы список / элементы=строка		всегда	список псевдонимов, связанных с ключом Пример: ['aws/acm', 'aws/ebs']
	aws_account_id строка		всегда	Идентификатор AWS-аккаунта, к которому принадлежит ключ Пример: 1234567890123
	дата_создания строка		всегда	Дата создания ключа Пример: 2017-04-18T15:12:08.551000+10:00
	описание строка		всегда	Описание ключа Пример: Мой ключ для защиты важных данных
	enable_key_rotation логическое		всегда	Включено ли автоматическое ежегодное обновление ключа. Возвращает None, если состояние вращения ключа определить невозможно.
	активирован строка		всегда	Включен ли ключ. True, если `KeyState` равно true.
	граны сложный		всегда	список грантов, связанных с ключом
		ограничения словарь	всегда	Ограничения по контексту шифрования, разрешенные грантом. Подробнее см. https://docs.aws.amazon.com/kms/latest/APIReference/API_GrantConstraints.html Пример: {'encryption_context_equals': {'aws:lambda:_function_arn': 'arn:aws:lambda:ap-southeast-2:012345678912:function:xyz'}}
		дата_создания строка	всегда	Дата создания гранта Пример: 2017-04-18T15:12:08+10:00
		grant_id строка	всегда	Уникальный идентификатор гранта Пример: abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234
		grantee_principal строка	всегда	Субъект, получающий разрешения гранта Пример: arn:aws:sts::0123456789012:assumed-role/lambda_xyz/xyz
		issuing_account строка	всегда	AWS-аккаунт, выпустивший грант Пример: arn:aws:iam::01234567890:root
		key_id строка	всегда	ARN ключа, к которому применяется грант. Пример: arn:aws:kms:ap-southeast-2:123456789012:key/abcd1234-abcd-1234-5678-ef1234567890
		название строка	всегда	Наименование гранта Пример: xyz
		операции список / элементы=строка	всегда	Список разрешенных операций Пример: ['Decrypt', 'RetireGrant']
		retiring_principal строка	всегда	Субъект, который может отозвать грант Пример: arn:aws:sts::0123456789012:assumed-role/lambda_xyz/xyz
	key_arn строка		всегда	ARN ключа Пример: arn:aws:kms:ap-southeast-2:123456789012:key/abcd1234-abcd-1234-5678-ef1234567890
	key_id строка		всегда	Идентификатор ключа Пример: abcd1234-abcd-1234-5678-ef1234567890
	key_state строка		всегда	Состояние ключа Пример: PendingDeletion
	key_usage строка		всегда	Криптографические операции, которые можно выполнить с помощью ключа. Пример: ENCRYPT_DECRYPT
	источник строка		всегда	Источник материала ключа. При значении `AWS_KMS`, материал ключа создан AWS KMS. При значении `EXTERNAL`, материал ключа был импортирован или CMK не имеет материала ключа. Пример: AWS_KMS
	политики список / элементы=строка		всегда	список документов политики для ключей. Пустой, когда доступ запрещён, даже если политики существуют. Пример: {'Id': 'auto-ebs-2', 'Statement': [{'Action': ['kms:Encrypt', 'kms:Decrypt', 'kms:ReEncrypt', 'kms:GenerateDataKey', 'kms:CreateGrant', 'kms:DescribeKey'], 'Condition': {'StringEquals': {'kms:CallerAccount': '111111111111', 'kms:ViaService': 'ec2.ap-southeast-2.amazonaws.com'}}, 'Effect': 'Allow', 'Principal': {'AWS': ''}, 'Resource': '', 'Sid': 'Разрешить доступ через EBS для всех субъектов в аккаунте, авторизованных для использования EBS'}, {'Action': ['kms:Describe', 'kms:Get', 'kms:List', 'kms:RevokeGrant'], 'Effect': 'Allow', 'Principal': {'AWS': 'arn:aws:iam::111111111111:root'}, 'Resource': '', 'Sid': 'Разрешить прямой доступ к метаданным ключа для аккаунта'}], 'Version': '2012-10-17'}
	метки словарь		всегда	словарь меток, примененных к ключу. Пустой, когда доступ запрещен, даже если метки существуют. Пример: {'Name': 'myKey', 'Purpose': 'protecting_stuff'}

Авторы

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.10/collections/community/aws/aws_kms_facts_module.html