Модуль amazon.aws.iam_instance_profile — управление профилями IAM экземпляров

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install amazon.aws. Для использования этого модуля потребуются дополнительные зависимости, см. Требования для получения подробностей.

Для использования в книге задач укажите: amazon.aws.iam_instance_profile.

Новая функция в amazon.aws 6.2.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_ID`, `AWS_ACCESS_KEY` или `EC2_ACCESS_KEY` в порядке убывания приоритета. Параметры aws_access_key и profile взаимоисключающие. Псевдоним aws_access_key_id был добавлен в релизе 5.1.0 для обеспечения согласованности с SDK AWS botocore. Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды `EC2_ACCESS_KEY` устарела и будет удалена в релизе после 2024-12-01.
aws_ca_bundle путь	Расположение пакета CA для проверки сертификатов 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`, чтобы проанализировать уникальные (а не все) `"resource:action"` API-вызовы, выполненные во время задачи, выведя набор в ключ resource_actions в результатах задачи. Используйте обратный вызов `aws_resource_action`, чтобы вывести полный список, выполненный во время выполнения плейбука. Также может быть использована переменная среды `ANSIBLE_DEBUG_BOTOCORE_LOGS`. Варианты: `false` ← (по умолчанию) `true`
endpoint_url псевдонимы: ec2_url, aws_endpoint_url, s3_url строка	URL для подключения вместо стандартных конечных точек AWS. Хотя это можно использовать для подключения к другим службам, совместимым с AWS, коллекции amazon.aws и community.aws протестированы только с AWS. Также могут быть использованы переменные среды `AWS_URL` или `EC2_URL` в порядке убывания приоритета. Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01. Поддержка переменной среды `EC2_URL` устарела и будет удалена в релизе после 2024-12-01.
name псевдонимы: instance_profile_name строка / обязательно	Имя профиля экземпляра. Примечание: имена профилей уникальны в рамках учетной записи. Пути (`path`) не влияют на требования уникальности `name`. Например, нельзя иметь как `/Path1/MyProfile`, так и `/Path2/MyProfile` в одной учетной записи.
path псевдонимы: path_prefix, prefix строка	Путь профиля экземпляра. Дополнительную информацию о путях IAM см. в документации по идентификаторам AWS IAM https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html. Обновление пути существующего профиля в настоящее время не поддерживается и приведет к предупреждению. Параметр был переименован из `prefix` в `path` в релизе 7.2.0.
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 и security_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, ec2_region строка	Используемый регион AWS. Для глобальных служб, таких как IAM, Route53 и CloudFront, region игнорируется. Также могут быть использованы переменные среды `AWS_REGION` или `EC2_REGION`. См. документацию Amazon AWS для получения дополнительной информации http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. Псевдоним `ec2_region` устарел и будет удален в релизе после 2024-12-01 Поддержка переменной среды `EC2_REGION` устарела и будет удалена в релизе после 2024-12-01.
role строка	Имя роли, которая должна быть прикреплена к профилю экземпляра. Чтобы удалить все роли из профиля экземпляра, установите `role=""`.

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. Также могут быть использованы переменные среды `AWS_SECRET_ACCESS_KEY`, `AWS_SECRET_KEY`, или `EC2_SECRET_KEY` в порядке убывания приоритета. Параметры secret_key и profile взаимоисключающие. Псевдоним aws_secret_access_key был добавлен в релизе 5.1.0 для соответствия SDK AWS botocore. Псевдоним ec2_secret_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды `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. Также могут быть использованы переменные среды `AWS_SESSION_TOKEN`, `AWS_SECURITY_TOKEN` или `EC2_SECURITY_TOKEN` в порядке убывания приоритета. Параметры 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. Поддержка переменных среды `EC2_SECRET_KEY` и `AWS_SECURITY_TOKEN` устарела и будет удалена в релизе после 2024-12-01.
state string	Желаемое состояние профиля экземпляра. Варианты: `"absent"` `"present"` ← (по умолчанию)
tags aliases: resource_tags dictionary	Словарь, представляющий теги, которые будут применены к ресурсу. Если параметр tags не задан, теги не будут изменены.
validate_certs boolean	Если установлено значение `false`, сертификаты SSL не будут проверены для связи с API AWS. Установка validate_certs=false категорически не рекомендуется. В качестве альтернативы можно установить aws_ca_bundle. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Внимание: Для модулей переменные среды и конфигурационные файлы считываются из контекста Ansible «хост», а не «контроллер». Поэтому файлы могут потребоваться скопировать на «хост». Для плагинов поиска и подключения переменные среды и конфигурационные файлы считываются из контекста Ansible «контроллер», а не «хост».
AWS SDK (boto3), который используется Ansible, также может считывать значения по умолчанию для учетных данных и других настроек, таких как регион, из своих конфигурационных файлов в контексте Ansible «хост» (обычно ~/.aws/credentials). См. https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html для получения дополнительной информации.

Примеры

- name: Create Instance Profile
  amazon.aws.iam_instance_profile:
    name: "ExampleInstanceProfile"
    role: "/OurExamples/MyExampleRole"
    path: "/OurExamples/"
    tags:
      ExampleTag: Example Value
  register: profile_result

- name: Create second Instance Profile with default path
  amazon.aws.iam_instance_profile:
    name: "ExampleInstanceProfile2"
    role: "/OurExamples/MyExampleRole"
    tags:
      ExampleTag: Another Example Value
  register: profile_result

- name: Find all IAM instance profiles starting with /OurExamples/
  amazon.aws.iam_instance_profile_info:
    path_prefix: /OurExamples/
  register: result

- name: Delete second Instance Profile
  amazon.aws.iam_instance_profile:
    name: "ExampleInstanceProfile2"
    state: absent

Значения возврата

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

Ключ	Описание
iam_instance_profile сложный	Список профилей IAM для экземпляров. Возвращается: всегда
arn строка	Amazon Resource Name для профиля экземпляра. Возвращается: всегда Пример: `"arn:aws:iam::123456789012:instance-profile/AnsibleTestProfile"`
create_date строка	Дата создания профиля экземпляра. Возвращается: всегда Пример: `"2023-01-12T11:18:29+00:00"`
instance_profile_id строка	Amazon идентификатор профиля экземпляра. Возвращается: всегда Пример: `"AROA12345EXAMPLE54321"`
instance_profile_name строка	Имя профиля экземпляра. Возвращается: всегда Пример: `"AnsibleTestEC2Policy"`
path строка	Путь профиля экземпляра. Возвращается: всегда Пример: `"/"`
roles список / элементы=строка	Список ролей, связанных с этим профилем экземпляра. Возвращается: всегда Пример: `[]`
tags словарь	Теги профиля экземпляра. Возвращается: всегда Пример: `{"Env": "Prod"}`

Авторы

Mark Chappell (@tremble)

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

© 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_instance_profile_module.html