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

Примечание

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

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

Для использования в книге задач укажите: community.aws.aws_kms_info.

Новый в версии 1.0.0: из 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'. Дополнительную конфигурацию boto см. по адресу http://boto.cloudhackers.com/en/latest/boto_config_tut.html#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_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода общего списка, созданного во время книги задач. Переменная окружения 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, если статус ротации ключа определить невозможно.
	enabled строка		всегда	Включен ли ключ. 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
		name строка	всегда	Наименование разрешения Пример: xyz
		operations список / элементы=строка	всегда	Список операций, разрешенных разрешением Пример: ['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
	origin строка		всегда	Источник материала ключа. Если значение равно `AWS_KMS`, материал ключа был создан AWS KMS. Если значение равно `EXTERNAL`, материал ключа был импортирован или CMK не имеет материала ключа. Пример: AWS_KMS
	policies список / элементы=строка		всегда	список политик документов для ключей. Пустой, когда доступ запрещен, даже если политики есть. Пример: {'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': 'Allow access through EBS for all principals in the account that are authorized to use EBS'}, {'Action': ['kms:Describe', 'kms:Get', 'kms:List', 'kms:RevokeGrant'], 'Effect': 'Allow', 'Principal': {'AWS': 'arn:aws:iam::111111111111:root'}, 'Resource': '', 'Sid': 'Allow direct access to key metadata to the account'}], 'Version': '2012-10-17'}
	метки словарь		всегда	словарь меток, примененных к ключу. Пустой, когда доступ запрещен, даже если метки есть. Пример: {'Name': 'мойКлюч', 'Purpose': 'защита_данных'}

Авторы

Will Thames (@willthames)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/aws/aws_kms_info_module.html