aws_kms_facts - Сбор фактов о ключах AWS KMS

В версии 2.5.

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

Обзор

Сбор фактов о ключах AWS KMS, включая теги и разрешения

Требования

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

python >= 2.6
boto

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
aws_access_key	Значение по умолчанию: None	Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. Псевдонимы: ec2_access_key, access_key
aws_secret_key	Значение по умолчанию: None	Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. Псевдонимы: ec2_secret_key, secret_key
ec2_url	Значение по умолчанию: None	URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где необходим регион. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если она есть.
filters		Словарь фильтров для применения. Каждый элемент словаря состоит из ключа фильтра и значения фильтра. Фильтры не поддерживаются непосредственно boto3, но поддерживаются для обеспечения аналогичной функциональности другим модулям. Доступны стандартные фильтры тегов (`tag-key`, `tag-value` и `tag:tagName`), а также `key-id` и `alias`.
pending_deletion	Значение по умолчанию: no	Необходимо ли получить подробные сведения (теги, разрешения и т. д.) о ключах, ожидающих удаления?
profile (добавлено в 1.6)	Значение по умолчанию: None	Использует профиль 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)	Значение по умолчанию: None	Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Псевдонимы: access_token
validate_certs (добавлено в 1.5)	Варианты: 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), если учетные данные не предоставлены. См. http://boto.readthedocs.org/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 facts about all KMS keys
- kms_facts

# Gather facts about all keys with a Name tag
- kms_facts:
    filters:
      tag-key: Name

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

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

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

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

Статус

Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется обратной совместимостью.

Автор

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