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

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

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

Обзор

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

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

Требования

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

python >= 2.6
boto

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
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, чтобы вывести в полный список, созданный во время выполнения книги задач.
ec2_url строка		URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль будет использовать конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если она есть.
filters -		Словарь фильтров для применения. Каждый элемент словаря состоит из ключа фильтра и значения фильтра. Фильтры не поддерживаются boto3 напрямую, но поддерживаются для обеспечения сходной функциональности с другими модулями. Доступны стандартные фильтры тегов (`tag-key`, `tag-value` и `tag:tagName`), а также `key-id` и `alias`.
pending_deletion логический	Варианты: нет ← да	Указывает, нужно ли получить подробную информацию (теги, разрешения и т. д.) о ключах, ожидающих удаления
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
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

Примеры

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

# Gather information about all KMS keys
- aws_kms_info:

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

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

Значения возврата

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

Ключ			Возвращаемое	Описание
ключи сложный			всегда	список ключей
	псевдонимы список		всегда	список псевдонимов, связанных с ключом Пример: ['aws/acm', 'aws/ebs']
	aws_account_id строка		всегда	Идентификатор учетной записи AWS, к которой относится ключ Пример: 1234567890123
	дата_создания строка		всегда	Дата создания ключа Пример: 2017-04-18T15:12:08.551000+10:00
	описание строка		всегда	Описание ключа Пример: Мой ключ для защиты важных данных
	активирован строка		всегда	Включен ли ключ. 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
		id_разрешения строка	всегда	Уникальный идентификатор разрешения Пример: abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234
		субъект_получатель строка	всегда	Субъект, который получает разрешения по разрешению Пример: arn:aws:sts::0123456789012:assumed-role/lambda_xyz/xyz
		выпускающая_учетная_запись строка	всегда	Учетная запись AWS, под которой было выдано разрешение Пример: arn:aws:iam::01234567890:root
		id_ключа строка	всегда	Ключ ARN, к которому относится разрешение. Пример: arn:aws:kms:ap-southeast-2:123456789012:key/abcd1234-abcd-1234-5678-ef1234567890
		название строка	всегда	Напоминающее имя, которое идентифицирует разрешение Пример: xyz
		операции список	всегда	Список операций, разрешенных разрешением Пример: ['Decrypt', 'RetireGrant']
		возвращающий_субъект строка	всегда	Субъект, который может отозвать разрешение Пример: arn:aws:sts::0123456789012:assumed-role/lambda_xyz/xyz
	arn_ключа строка		всегда	ARN ключа Пример: arn:aws:kms:ap-southeast-2:123456789012:key/abcd1234-abcd-1234-5678-ef1234567890
	id_ключа строка		всегда	Идентификатор ключа Пример: abcd1234-abcd-1234-5678-ef1234567890
	состояние_ключа строка		всегда	Состояние ключа Пример: PendingDeletion
	использование_ключа строка		всегда	Криптографические операции, которые вы можете использовать с ключом. Пример: ENCRYPT_DECRYPT
	источник строка		всегда	Источник материала ключа. Когда это значение равно `AWS_KMS`, материал ключа создала AWS KMS. Когда это значение равно `EXTERNAL`, материал ключа был импортирован или в CMK отсутствует материал ключа. Пример: AWS_KMS
	политики список		всегда	список документов политики для ключей. Пустой, когда доступ запрещен, даже если есть политики. Пример: {'Version': '2012-10-17', 'Id': 'auto-ebs-2', 'Statement': [{'Sid': 'Разрешить доступ через EBS для всех субъектов в учетной записи, уполномоченных использовать EBS', 'Effect': 'Allow', 'Principal': {'AWS': ''}, 'Action': ['kms:Encrypt', 'kms:Decrypt', 'kms:ReEncrypt', 'kms:GenerateDataKey', 'kms:CreateGrant', 'kms:DescribeKey'], 'Resource': '', 'Condition': {'StringEquals': {'kms:CallerAccount': '111111111111', 'kms:ViaService': 'ec2.ap-southeast-2.amazonaws.com'}}}, {'Sid': 'Разрешить прямой доступ к метаданным ключа учетной записи', 'Effect': 'Allow', 'Principal': {'AWS': 'arn:aws:iam::111111111111:root'}, 'Action': ['kms:Describe', 'kms:Get', 'kms:List', 'kms:RevokeGrant'], 'Resource': ''}]}
	метки словарь		всегда	словарь меток, примененных к ключу. Пустой, когда доступ запрещен, даже если метки есть. Пример: {'Название': 'мойКлюч', 'Назначение': 'защита_данных'}

Состояние

Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается сообществом 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.9/modules/aws_kms_info_module.html