iam_role — Управление ролями AWS IAM
Новое в версии 2.3.
- Описание
- Требования (к хосту, на котором выполняется модуль)
- Параметры
- Примеры
- Возвращаемые значения
- Примечания
Описание
- Управление ролями AWS IAM
Требования (к хосту, на котором выполняется модуль)
- boto
- boto3
- botocore
- python >= 2.6
Параметры
| Параметр | Обязателен | Значение по умолчанию | Варианты | Комментарии |
|---|---|---|---|---|
| assume_role_policy_document |
нет | Политика доверия, предоставляющая сущности разрешение на принятие роли. Этот параметр требуется при state: present. |
||
| 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 |
||
| ec2_url |
нет | URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если таковая существует. |
||
| managed_policy |
да | Список ARNs управляемых политик или, начиная с Ansible 2.4, список ARNs или дружественных имён управляемых политик. Для встраивания встроенной политики используйте iam_policy. Для удаления существующих политик используйте пустой элемент списка.
псевдонимы: managed_policies |
||
| name |
да | Имя создаваемой роли. |
||
| path |
нет | / | Путь к роли. Для получения дополнительной информации о путях см. http://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html. |
|
| profile (добавлено в 1.6)
|
нет | Использует профиль boto. Работает только с boto >= 2.24.0. |
||
| security_token (добавлено в 1.6)
|
нет | Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN.
псевдонимы: access_token |
||
| state |
да | Создать или удалить роль IAM |
||
| validate_certs (добавлено в 1.5)
|
нет | да | При значении "нет" сертификаты SSL не будут проверены для версий boto >= 2.6.0. |
Примеры
# Note: These examples do not set authentication details, see the AWS Guide for details.
# Create a role
- iam_role:
name: mynewrole
assume_role_policy_document: "{{ lookup('file','policy.json') }}"
state: present
# Create a role and attach a managed policy called "PowerUserAccess"
- iam_role:
name: mynewrole
assume_role_policy_document: "{{ lookup('file','policy.json') }}"
state: present
managed_policy:
- arn:aws:iam::aws:policy/PowerUserAccess
# Keep the role created above but remove all managed policies
- iam_role:
name: mynewrole
assume_role_policy_document: "{{ lookup('file','policy.json') }}"
state: present
managed_policy:
-
# Delete the role
- iam_role:
name: mynewrole
assume_role_policy_document: "{{ lookup('file','policy.json') }}"
state: absent
Возвращаемые значения
Общие возвращаемые значения документированы здесь Возвращаемые значения, следующие поля уникальны для данного модуля:
| Имя | Описание | Возвращается | Тип | Пример |
|---|---|---|---|---|
| arn | Amazon Resource Name (ARN), определяющий роль |
всегда | строка | arn:aws:iam::1234567890:role/mynewrole |
| assume_role_policy_document | Политика, предоставляющая сущности разрешение на принятие роли |
всегда | строка | {'version': '2012-10-17', 'statement': [{'action': 'sts:AssumeRole', 'principal': {'service': 'ec2.amazonaws.com'}, 'effect': 'Allow', 'sid': ''}]} |
| attached_policies | Список словарей, содержащих имя и ARN прикрепленных управляемых политик IAM к роли |
всегда | список | [{'policy_arn': 'arn:aws:iam::aws:policy/PowerUserAccess', 'policy_name': 'PowerUserAccess'}] |
| create_date | Дата и время создания роли в формате ISO 8601 |
всегда | строка | 2016-08-14T04:36:28+00:00 |
| path | Путь к роли |
всегда | строка | / |
| role_id | Уникальная строка, идентифицирующая роль |
всегда | строка | ABCDEFF4EZ4ABCDEFV4ZC |
| role_name | Дружественное имя, идентифицирующее роль |
всегда | строка | myrole |
Примечания
Примечание
- Если параметры не заданы в модуле, можно использовать следующие переменные окружения в порядке убывания приоритета
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
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется как обратной совместимый.
Для получения помощи в разработке модулей, если вам это нужно, пожалуйста, прочтите Информация сообщества и вклад, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/iam_role_module.html