aws_kms — Выполнение различных задач управления KMS.

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

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

Обзор

Управление доступом пользователя/роли к ключу KMS. Не предназначен для шифрования/расшифрования.

Требования

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

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
clean_invalid_entries bool	Варианты: no yes ←	Если добавляется/удаляется роль и обнаружены недопустимые получатели, они будут удалены. Эти записи в известных случаях приведут к ошибке обновления. Очистка выполняется только при внесении изменений.
ec2_url		URL для подключения к EC2 или облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если таковое имеется.
grant_types		Список разрешений, которые нужно предоставить пользователю/роли. Вероятно, "роль, разрешение роли" или "роль, разрешение роли, администратор". Требуется при `mode=grant`.
key_alias		Метка псевдонима ключа. Требуется один из `key_alias` или `key_arn`.
key_arn		Полный ARN ключа. Требуется один из `key_alias` или `key_arn`.
mode требуется	Варианты: grant ← deny	Предоставить или запретить доступ.
profile (добавлено в 1.6)		Использует профиль 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
role_arn		ARN роли, для которой разрешен/запрещен доступ. Требуется один из `role_name` или `role_arn`.
role_name		Роль, для которой разрешен/запрещен доступ. Требуется один из `role_name` или `role_arn`.
security_token (добавлено в 1.6)		Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. псевдонимы: access_token
validate_certs bool (добавлено в 1.5)	Варианты: no yes ←	При значении "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

Примеры

- name: grant user-style access to production secrets
  kms:
  args:
    mode: grant
    key_alias: "alias/my_production_secrets"
    role_name: "prod-appServerRole-1R5AQG2BSEL6L"
    grant_types: "role,role grant"
- name: remove access to production secrets from role
  kms:
  args:
    mode: deny
    key_alias: "alias/my_production_secrets"
    role_name: "prod-appServerRole-1R5AQG2BSEL6L"

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

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

Ключ	Возвращаемое значение	Описание
changes_needed dict	всегда	Типы разрешений, которые должны быть изменены/были изменены. Пример: {'role': 'add', 'role grant': 'add'}
had_invalid_entries boolean	всегда	Существуют недопустимые (не являющиеся ARN) записи в записи KMS. Они не считаются изменением, но будут удалены, если будут внесены какие-либо изменения.

Статус

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

Техническое обслуживание

Этот модуль помечен как сертифицированный, что означает, что он поддерживается партнером Ansible. См. Техническое обслуживание и поддержка модулей для получения дополнительной информации.

Список других модулей, также поддерживаемых партнером Ansible, см. здесь.

Автор

tedder

Подсказка

Если вы заметили какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/aws_kms_module.html