Модуль amazon.aws.iam_managed_policy – управление пользовательскими управляемыми политиками IAM

Примечание

Этот модуль входит в коллекцию amazon.aws (версия 11.3.0).

Возможно, эта коллекция уже установлена, если вы используете пакет 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.35.0
botocore >= 1.35.0

Параметры

Параметр	Комментарии
access_key псевдонимы: aws_access_key_id, aws_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_ID` или `AWS_ACCESS_KEY` в порядке убывания предпочтительности. Параметры aws_access_key и profile являются взаимоисключающими. Псевдоним aws_access_key_id добавлен в выпуске 5.1.0 для единообразия с AWS botocore SDK.
aws_ca_bundle путь	Путь к пакету сертификатов центра сертификации, используемому для проверки SSL-сертификатов. Также можно использовать переменную среды `AWS_CA_BUNDLE`.
aws_config словарь	Словарь для изменения конфигурации botocore. Параметры перечислены в документации AWS: https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
debug_botocore_endpoint_logs логическое значение	Использовать регистратор `botocore.endpoint` для анализа уникальных (а не общих) вызовов API `"resource:action"`, выполненных во время задачи, и выводить их набор в ключ resource_actions результатов задачи. Используйте callback `aws_resource_action` для вывода общего списка вызовов, выполненных во время плейбука. Также можно использовать переменную среды `ANSIBLE_DEBUG_BOTOCORE_LOGS`. Варианты: `false` ← (по умолчанию) `true`
description псевдонимы: policy_description строка	Полезное описание этой политики. Значение неизменяемо и задаётся только при создании новой политики. В выпуске 7.2.0 параметр переименован из `policy_description` в `description`.
endpoint_url псевдонимы: aws_endpoint_url строка	URL для подключения вместо конечных точек AWS по умолчанию. Хотя этот параметр можно использовать для подключения к другим сервисам, совместимым с AWS, коллекции amazon.aws и community.aws тестируются только с AWS. Также можно использовать переменную среды `AWS_URL`.
make_default логическое значение	Сделать эту редакцию редакцией по умолчанию. Варианты: `false` `true` ← (по умолчанию)
name псевдонимы: policy_name строка / обязательный	Имя управляемой политики. Примечание: имена политик уникальны в пределах учётной записи. Пути (`path`) не влияют на требования уникальности для `name`. Например, в одной учётной записи не разрешается иметь одновременно `/Path1/MyPolicy` и `/Path2/MyPolicy`. В выпуске 7.2.0 параметр переименован из `policy_name` в `name`.
only_version логическое значение	Удалить все остальные редакции, кроме редакции по умолчанию. При использовании вместе с `make_default` все остальные версии этой политики будут удалены. Варианты: `false` ← (по умолчанию) `true`
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. Также можно использовать переменную среды `AWS_PROFILE`. Параметр profile взаимоисключающий с параметрами aws_access_key, aws_secret_key и session_token.
purge_tags логическое значение	Если задано `purge_tags=true` и `tags`, существующие теги ресурса будут удалены, чтобы они в точности соответствовали значению параметра `tags`. Если параметр `tags` не задан, теги не изменяются, даже если указано `purge_tags=True`. Ключи тегов, начинающиеся с `aws:`, зарезервированы Amazon и не могут быть изменены. Поэтому при обработке параметра `purge_tags` они игнорируются. Дополнительную информацию см. в документации Amazon: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions. Варианты: `false` `true` ← (по умолчанию)
region псевдонимы: aws_region строка	Регион AWS, который следует использовать. Для глобальных сервисов, таких как IAM, Route53 и CloudFront, параметр region игнорируется. Также можно использовать переменную среды `AWS_REGION`. Дополнительную информацию см. в документации Amazon AWS: http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.
secret_key псевдонимы: aws_secret_access_key, aws_secret_key строка	Секретный ключ доступа AWS. Дополнительную информацию о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные среды `AWS_SECRET_ACCESS_KEY` или `AWS_SECRET_KEY` в порядке убывания предпочтительности. Параметры secret_key и profile являются взаимоисключающими. Псевдоним aws_secret_access_key добавлен в выпуске 5.1.0 для единообразия с AWS botocore SDK.
session_token псевдонимы: aws_session_token строка	Токен сеанса AWS STS для использования с временными учётными данными. Дополнительную информацию о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменную среды `AWS_SESSION_TOKEN`. Параметры session_token и profile являются взаимоисключающими.
state строка	Должна ли эта управляемая политика существовать или отсутствовать. Установите значение absent, чтобы отсоединить от политики все сущности и удалить её, если она найдена. Варианты: `"present"` ← (по умолчанию) `"absent"`
tags псевдонимы: resource_tags словарь	Словарь, содержащий теги, которые следует применить к ресурсу. Если параметр `tags` не задан, теги не изменяются.
validate_certs логическое значение	Если задано значение `false`, SSL-сертификаты при обмене данными с API AWS проверяться не будут. Настоятельно не рекомендуется задавать validate_certs=false; вместо этого рассмотрите возможность указать aws_ca_bundle. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Поддержка tags и purge_tags добавлена в выпуске 7.2.0.
Внимание: Для модулей переменные среды и файлы конфигурации считываются из контекста «узла» Ansible, а не из контекста «контроллера». Поэтому файлы может потребоваться явно скопировать на «узел». Для плагинов поиска и подключения переменные среды и файлы конфигурации считываются из контекста «контроллера» Ansible, а не из контекста «узла».
Используемый Ansible пакет AWS SDK (boto3) также может считывать значения по умолчанию для учётных данных и других настроек, например региона, из файлов конфигурации в контексте «узла» 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 сложный	Возвращает основные сведения о политике; при `state=absent` возвращается значение удалённой политики. Возвращается: всегда
arn строка	Имя ресурса Amazon (ARN) политики. Возвращается: при успехе Пример: `"arn:aws:iam::123456789012:policy/ansible-test-12345/ansible-test-12345-policy"`
attachment_count целое число	Количество сущностей (пользователей, групп и ролей), к которым прикреплена политика. Возвращается: при успехе Пример: `5`
create_date строка	Дата и время создания политики в формате даты и времени ISO 8601. Возвращается: при успехе Пример: `"2017-02-08T04:36:28+00:00"`
default_version_id строка	Версия политики, используемая по умолчанию. Возвращается: при успехе Пример: `"/ansible-test-12345/"`
description строка	Понятное описание политики. Возвращается: при успехе Пример: `"My Example Policy"`
is_attachable логическое значение	Указывает, можно ли прикрепить политику к сущностям IAM. Возвращается: при успехе Пример: `false`
path строка	Путь к политике. Возвращается: при успехе Пример: `"/ansible-test-12345/"`
permissions_boundary_usage_count целое число	Количество сущностей IAM (пользователей, групп и ролей), использующих политику в качестве границы разрешений. Возвращается: при успехе Пример: `5`
policy_id строка	Стабильная и глобально уникальная строка, идентифицирующая политику. Возвращается: при успехе Пример: `"ANPA12345EXAMPLE12345"`
policy_name строка	Понятное имя, идентифицирующее политику. Возвращается: при успехе Пример: `"ansible-test-12345-policy"`
tags словарь	Словарь, содержащий теги, прикреплённые к управляемой политике. Возвращается: при успехе Пример: `{"Env": "Prod"}`
update_date строка	Дата и время последнего обновления политики в формате даты и времени ISO 8601. Возвращается: при успехе Пример: `"2017-02-08T05:12:13+00:00"`

Авторы

Dan Kozlowski (@dkhenry)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/amazon/aws/iam_managed_policy_module.html