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

Примечание

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

Эта коллекция может быть уже установлена, если вы используете пакет 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.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 путь	Путь к пакету сертификатов 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` для анализа уникальных (а не общего количества) вызовов API `"resource:action"`, выполненных во время задачи, и записывать полученный набор в ключ resource_actions результатов задачи. Используйте callback `aws_resource_action`, чтобы вывести общий список вызовов, выполненных в плейбуке. Также можно использовать переменную среды `ANSIBLE_DEBUG_BOTOCORE_LOGS`. Варианты: `false` ← (по умолчанию) `true`
endpoint_url псевдонимы: aws_endpoint_url строка	URL для подключения вместо конечных точек AWS по умолчанию. Хотя этот параметр можно использовать для подключения к другим сервисам, совместимым с AWS, коллекции amazon.aws и community.aws тестируются только с AWS. Также можно использовать переменную среды `AWS_URL`.
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. Изменение пути существующего профиля в настоящее время не поддерживается и приводит к предупреждению. В выпуске 7.2.0 параметр переименован из `prefix` в `path`.
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.
role строка	Имя роли, которую нужно прикрепить к профилю экземпляра. Чтобы удалить все роли из профиля экземпляра, задайте `role=""`.
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"` ← (по умолчанию)
tags псевдонимы: resource_tags словарь	Словарь с тегами, которые нужно применить к ресурсу. Если параметр `tags` не задан, теги не изменяются.
validate_certs логический	Если задано значение `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 для профиля экземпляра. Возвращается: всегда Пример: `"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 список / элементы типа string	Список ролей, связанных с этим профилем экземпляра. Возвращается: всегда Пример: `[]`
tags словарь	Теги профиля экземпляра. Возвращается: всегда Пример: `{"Env": "Prod"}`

Авторы

Mark Chappell (@tremble)

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

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