Spec-Zone.ru › Ansible

amazon.aws.iam_access_key модуль — Управление ключами доступа AWS IAM пользователя

Примечание

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

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

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

Для использования в playbook укажите: amazon.aws.iam_access_key.

Новая в community.aws 2.1.0

  • Обзор
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Обзор

  • Управление ключами доступа к AWS IAM пользователя.

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

  • python >= 3.6
  • boto3 >= 1.26.0
  • botocore >= 1.29.0

Параметры

Параметр

Комментарии

access_key

псевдонимы: aws_access_key_id, aws_access_key, ec2_access_key

строка

ID ключа доступа 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.

active

псевдонимы: enabled

булево

Включить или отключить ключ.

По умолчанию true при создании нового ключа.

Варианты:

  • false
  • true

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.

id

строка

ID ключа доступа.

Требуется при state=absent.

Взаимоисключающее с rotate_keys.

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.

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.

rotate_keys

булево

Если к пользователю IAM уже прикреплено 2 ключа доступа, будет удален самый старый ключ и создан новый.

Игнорируется, если state=absent.

Взаимоисключающее с id.

Варианты:

  • false ← (по умолчанию)
  • true

secret_key

псевдонимы: aws_secret_access_key, aws_secret_key, ec2_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, или 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.
END_OF_DOCUMENT_MARKER

session_token

aliases: aws_session_token, security_token, aws_security_token, access_token

string

Токен сессии AWS STS для использования с временными учетными данными.

См. документацию AWS для получения дополнительной информации об access токенах 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

Создать или удалить ключ доступа.

Когда state=present и id не определены, будет создан новый ключ.

Выбори:

  • "present" ← (по умолчанию)
  • "absent"

user_name

aliases: username

string / обязательно

Имя пользователя IAM, к которому принадлежит ключ.

validate_certs

boolean

При установке в false, сертификаты SSL не будут проверены для связи с API AWS.

Установка validate_certs=false настоятельно не рекомендуется, в качестве альтернативы рассмотрите установку aws_ca_bundle вместо этого.

Выбори:

  • false
  • true ← (по умолчанию)

Примечания

Примечание

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

Примеры

# Note: These examples do not set authentication details, see the AWS Guide for details.

- name: Create a new access key
  amazon.aws.iam_access_key:
    user_name: example_user
    state: present
  no_log: true

- name: Delete the access_key
  amazon.aws.iam_access_key:
    user_name: example_user
    id: AKIA1EXAMPLE1EXAMPLE
    state: absent

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

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

Ключ

Описание

access_key

complex

Словарь, содержащий всю информацию о ключе доступа.

Возвращается: при существовании ключа.

access_key_id

string

Идентификатор ключа доступа.

Возвращается: успех

Пример: "AKIA1EXAMPLE1EXAMPLE"

create_date

string

Дата и время создания ключа доступа в формате ISO 8601.

Возвращается: успех

Пример: "2021-10-09T13:25:42+00:00"

status

string

Статус ключа.

Active означает, что он может быть использован.

Inactive означает, что он не может быть использован.

Возвращается: успех

Пример: "Inactive"

user_name

string

Имя пользователя IAM, к которому прикреплен ключ.

Возвращается: успех

Пример: "example_user"

deleted_access_key_id

string

Ключ доступа, удаленный при ротации.

Возвращается: При удалении ключа во время ротации ключей доступа

Пример: "AKIA1EXAMPLE1EXAMPLE"

secret_access_key

string

Секретный ключ доступа.

Секретный ключ доступа эквивалентен паролю, который не может быть изменен и, следовательно, должен рассматриваться как конфиденциальные данные.

К секретным ключам доступа можно получить доступ только во время создания.

Возвращается: При создании нового ключа.

Пример: "example/Example+EXAMPLE+example/Example"

Авторы

  • 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_access_key_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API