amazon.aws.iam_managed_policy модуль — Управление управляемыми пользователем политиками IAM
Примечание
Этот модуль является частью коллекции amazon.aws (версия 8.2.1).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install amazon.aws. Вам потребуются дополнительные зависимости для использования этого модуля. Подробнее см. Требования.
Чтобы использовать его в плейбуке, укажите: amazon.aws.iam_managed_policy.
Новое в community.aws 1.0.0
Описание
- Позволяет создавать и удалять управляемые пользователем политики IAM.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 3.6
- boto3 >= 1.26.0
- botocore >= 1.29.0
Параметры
Параметр | Комментарии |
|---|---|
access_key псевдонимы: aws_access_key_id, aws_access_key, ec2_access_key строка | Идентификатор ключа доступа AWS. См. документацию AWS для получения дополнительной информации о маркерах доступа https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также могут быть использованы переменные окружения Параметры aws_access_key и profile взаимоисключающие. Псевдоним aws_access_key_id был добавлен в релизе 5.1.0 для согласованности с SDK AWS botocore. Псевдоним ec2_access_key устарел и будет удалён в релизе после 2024-12-01. Поддержка переменной окружения |
aws_ca_bundle путь | Расположение пакета CA-сертификатов для проверки SSL-сертификатов. Также может быть использована переменная окружения |
aws_config словарь | Словарь для изменения конфигурации botocore. Параметры можно найти в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. |
debug_botocore_endpoint_logs булево | Используйте Также может быть использована переменная окружения Варианты:
|
description псевдонимы: policy_description строка | Полезна описательная информация об этом политике; это значение неизменно и устанавливается только при создании новой политики. Параметр был переименован с |
endpoint_url псевдонимы: ec2_url, aws_endpoint_url, s3_url строка | URL для подключения вместо стандартных конечных точек AWS. Хотя это можно использовать для подключения к другим совместимым с AWS службам, коллекции amazon.aws и community.aws протестированы только для AWS. Также могут быть использованы переменные окружения Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01. Поддержка переменной окружения |
make_default булево | Сделать эту ревизию стандартной. Варианты:
|
name псевдонимы: policy_name строка / обязательно | Имя управляемой политики. Примечание: Имена политик уникальны в рамках аккаунта. Пути ( Параметр был переименован с |
only_version булево | Удалить все другие нестандартные ревизии; если это используется с Варианты:
|
path псевдонимы: prefix, path_prefix строка добавлен в amazon.aws 7.2.0 | Путь управляемой политики. Дополнительную информацию о путях IAM см. в документации по идентификаторам AWS IAM https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html. |
policy json | Политика в формате JSON. |
profile псевдонимы: aws_profile строка | Используемый именованный профиль AWS для аутентификации. См. документацию AWS для получения дополнительной информации об именованных профилях https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Также может быть использована переменная окружения Параметр profile взаимоисключающий с параметрами aws_access_key, aws_secret_key и security_token. |
purge_tags boolean | Если purge_tags=true и tags задано, существующие теги ресурса будут удалены, чтобы точно соответствовать тому, что определено параметром tags. Если параметр tags не задан, то теги не будут изменены, даже если purge_tags=True. Ключи тегов, начинающиеся с Варианты:
|
region aliases: aws_region, ec2_region string | AWS-регион для использования. Для глобальных служб, таких как IAM, Route53 и CloudFront, параметр region игнорируется. Также могут быть использованы переменные среды Дополнительную информацию см. в документации Amazon AWS http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. Псевдоним Поддержка переменной среды |
secret_key aliases: aws_secret_access_key, aws_secret_key, ec2_secret_key string | Секретный ключ доступа AWS. Дополнительную информацию о маркерах доступа см. в документации AWS https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Переменные среды Параметры secret_key и profile взаимоисключают друг друга. Псевдоним aws_secret_access_key добавлен в релизе 5.1.0 для соответствия AWS botocore SDK. Псевдоним ec2_secret_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды |
session_token aliases: aws_session_token, security_token, aws_security_token, access_token string | Токен сессии AWS STS для использования с временными учетными данными. Дополнительную информацию о маркерах доступа см. в документации AWS https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Переменные среды Параметры security_token и profile взаимоисключают друг друга. Псевдонимы aws_session_token и session_token добавлены в релизе 3.2.0, при этом параметр был переименован из security_token в session_token в релизе 6.0.0. Псевдонимы security_token, aws_security_token и access_token устарели и будут удалены в релизе после 2024-12-01. Поддержка переменных среды |
state string | Должна ли эта управляемая политика присутствовать или отсутствовать. Установите в значение absent, чтобы отсоединить все сущности от этой политики и удалить ее, если она найдена. Варианты:
|
tags aliases: resource_tags dictionary | Словарь, представляющий теги, которые будут применены к ресурсу. Если параметр tags не задан, теги не будут изменены. |
validate_certs boolean | При установке в значение Установка validate_certs=false категорически не рекомендуется, вместо этого рассмотрите возможность установки aws_ca_bundle. Варианты:
|
Примечания
Примечание
- Поддержка
tagsиpurge_tagsбыла добавлена в релизе 7.2.0. - Внимание: Для модулей переменные среды и конфигурационные файлы считываются из контекста Ansible «хост», а не «контроллер». Поэтому файлы могут потребоваться скопировать на «хост». Для плагинов поиска и подключения переменные среды и конфигурационные файлы считываются из контекста Ansible «контроллер», а не «хост».
- AWS SDK (boto3), используемый Ansible, также может считывать значения по умолчанию для учетных данных и других параметров, таких как регион, из своих конфигурационных файлов в контексте Ansible «хост» (обычно
~/.aws/credentials). Дополнительную информацию см. в https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html.
Примеры
# Create a policy
- name: Create IAM Managed Policy
amazon.aws.iam_managed_policy:
policy_name: "ManagedPolicy"
policy_description: "A Helpful managed policy"
policy: "{{ lookup('template', 'managed_policy.json.j2') }}"
state: present
# Update a policy with a new default version
- name: Update an IAM Managed Policy with new default version
amazon.aws.iam_managed_policy:
policy_name: "ManagedPolicy"
policy: "{{ lookup('file', 'managed_policy_update.json') }}"
state: present
# Update a policy with a new non default version
- name: Update an IAM Managed Policy with a non default version
amazon.aws.iam_managed_policy:
policy_name: "ManagedPolicy"
policy:
Version: "2012-10-17"
Statement:
- Effect: "Allow"
Action: "logs:CreateLogGroup"
Resource: "*"
make_default: false
state: present
# Update a policy and make it the only version and the default version
- name: Update an IAM Managed Policy with default version as the only version
amazon.aws.iam_managed_policy:
policy_name: "ManagedPolicy"
policy: |
{
"Version": "2012-10-17",
"Statement":[{
"Effect": "Allow",
"Action": "logs:PutRetentionPolicy",
"Resource": "*"
}]
}
only_version: true
state: present
# Remove a policy
- name: Remove an existing IAM Managed Policy
amazon.aws.iam_managed_policy:
policy_name: "ManagedPolicy"
state: absent
Значения возврата
Общие значения возврата документированы здесь, следующие — поля, уникальные для данного модуля:
Ключ | Описание |
|---|---|
policy complex | Возвращает основную информацию о политике. Если Возвращается: всегда |
|
arn string |
Amazon Resource Name (ARN) политики. Возвращается: при успехе Пример: |
|
attachment_count integer |
Количество сущностей (пользователей, групп и ролей), к которым прикреплена политика. Возвращается: при успехе Пример: |
|
create_date string |
Дата и время создания политики в формате ISO 8601. Возвращается: при успехе Пример: |
|
default_version_id string |
Используемая по умолчанию версия политики. Возвращается: при успехе Пример: |
|
description string |
Дружественное описание политики. Возвращается: при успехе Пример: |
|
is_attachable boolean |
Указывает, может ли политика быть прикреплена к сущностям IAM. Возвращается: при успехе Пример: |
|
path string |
Путь к политике. Возвращается: при успехе Пример: |
|
permissions_boundary_usage_count integer |
Количество сущностей IAM (пользователи, группы и роли), использующих политику в качестве границы разрешений. Возвращается: при успехе Пример: |
|
policy_id string |
Уникальная строка, идентифицирующая политику. Возвращается: при успехе Пример: |
|
policy_name string |
Дружественное имя, идентифицирующее политику. Возвращается: при успехе Пример: |
|
tags dictionary |
Словарь тегов, прикреплённых к управляемой политике. Возвращается: при успехе Пример: |
|
update_date string |
Дата и время последнего обновления политики в формате ISO 8601. Возвращается: при успехе Пример: |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/amazon/aws/iam_managed_policy_module.html
