aws_kms - Выполнение различных задач управления KMS.
Новая версия 2.3.
Синопсис
- Управление доступом роли/пользователя к ключу KMS. Не предназначено для шифрования/дешифрования.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- boto
- boto3
- python >= 2.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| 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 |
| clean_invalid_entries |
| Если добавляется/удаляется роль и найдены недопустимые получатели, удалить их. Эти записи приведут к сбою обновления во всех известных случаях. Очистка выполняется только при внесении изменений. |
| ec2_url | Значение по умолчанию: None | URL для подключения к EC2 или облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если таковое имеется. |
| grant_types | Список разрешений, предоставляемых пользователю/роли. Вероятно, «роль, разрешение роли» или «роль, разрешение роли, администратор». Требуется при mode=grant. | |
| key_alias | Метка псевдонима ключа. Требуется один из key_alias или key_arn. | |
| key_arn | Полный ARN ключа. Требуется один из key_alias или key_arn. | |
| mode обязательно |
| Предоставить или запретить доступ. |
| 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 | |
| role_arn | ARN роли, для предоставления/запрещения доступа. Требуется один из role_name или role_arn. | |
| role_name | Роль для предоставления/запрещения доступа. Требуется один из role_name или role_arn. | |
| security_token (добавлено в 1.6) | Значение по умолчанию: None | Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. псевдонимы: access_token |
| validate_certs (добавлено в 1.5) |
| При значении "нет" сертификаты 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 словарь | всегда | типы разрешений, которые будут изменены/были изменены. Пример: {'разрешение роли': 'добавить', 'роль': 'добавить'} |
| had_invalid_entries логический тип | всегда | в записи KMS есть недопустимые (не-ARN) записи. Они не считаются изменениями, но будут удалены, если какие-либо изменения вносятся. |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется обратной совместимостью.
Автор
- 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.5/modules/aws_kms_module.html