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

Примечание

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

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

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

Чтобы использовать его в плейбуке, укажите: amazon.aws.iam_access_key.

Добавлено в community.aws 2.1.0

Краткое описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Управление ключами доступа пользователей AWS 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 SDK botocore.
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` для анализа уникальных (а не общего количества) вызовов API `"resource:action"`, выполненных во время задачи, и выводить их набор в ключ resource_actions в результатах задачи. Используйте обработчик `aws_resource_action`, чтобы вывести общий список вызовов, выполненных в плейбуке. Также можно использовать переменную среды `ANSIBLE_DEBUG_BOTOCORE_LOGS`. Варианты: `false` ← (по умолчанию) `true`
endpoint_url псевдонимы: aws_endpoint_url строка	URL для подключения вместо стандартных конечных точек AWS. Хотя этот параметр можно использовать для подключения к другим совместимым с AWS сервисам, коллекции amazon.aws и community.aws тестируются только с AWS. Также можно использовать переменную среды `AWS_URL`.
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 и session_token.
region псевдонимы: aws_region строка	Регион AWS. Для глобальных сервисов, таких как IAM, Route53 и CloudFront, параметр region игнорируется. Также можно использовать переменную среды `AWS_REGION`. Дополнительные сведения см. в документации Amazon AWS: http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.
rotate_keys логическое значение	Если к пользователю IAM уже прикреплены 2 ключа доступа, самый старый ключ будет удалён и создан новый. Игнорируется, если `state=absent` Взаимоисключающий с `id`. Варианты: `false` ← (по умолчанию) `true`
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 SDK botocore.
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 строка	Создать или удалить ключ доступа. Если `state=present` и `id` не заданы, будет создан новый ключ. Варианты: `"present"` ← (по умолчанию) `"absent"`
user_name псевдонимы: username строка / обязательный	Имя пользователя IAM, которому принадлежит ключ.
validate_certs логическое значение	Если задано значение `false`, SSL-сертификаты при взаимодействии с API AWS проверяться не будут. Настоятельно не рекомендуется задавать validate_certs=false; вместо этого рассмотрите возможность указать aws_ca_bundle. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

В целях безопасности при создании нового ключа доступа этот модуль следует использовать с параметром no_log=true и функциональностью (register).
Внимание: Для модулей переменные среды и файлы конфигурации считываются из контекста «узла» Ansible, а не из контекста «контроллера». Поэтому может потребоваться явно скопировать файлы на «узел». Для плагинов поиска и подключения переменные среды и файлы конфигурации считываются из контекста «контроллера» Ansible, а не из контекста «узла».
Используемый Ansible AWS SDK (boto3) также может считывать значения учётных данных и других параметров по умолчанию, например региона, из файлов конфигурации в контексте «узла» 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 сложный тип	Словарь, содержащий все сведения о ключе доступа. Возвращается: если ключ существует.
access_key_id строка	Идентификатор ключа доступа. Возвращается: при успешном выполнении Пример: `"AKIA1EXAMPLE1EXAMPLE"`
create_date строка	Дата и время создания ключа доступа в формате даты и времени ISO 8601. Возвращается: при успешном выполнении Пример: `"2021-10-09T13:25:42+00:00"`
status строка	Статус ключа. `Active` означает, что его можно использовать. `Inactive` означает, что его нельзя использовать. Возвращается: при успешном выполнении Пример: `"Inactive"`
user_name строка	Имя пользователя IAM, к которому прикреплён ключ. Возвращается: при успешном выполнении Пример: `"example_user"`
deleted_access_key_id строка	Ключ доступа, удалённый при ротации. Возвращается: если ключ был удалён при ротации ключей доступа Пример: `"AKIA1EXAMPLE1EXAMPLE"`
secret_access_key строка	Секретный ключ доступа. Секретный ключ доступа эквивалентен паролю, который нельзя изменить, поэтому его следует считать конфиденциальными данными. Доступ к секретным ключам возможен только в момент их создания. Возвращается: при создании нового ключа. Пример: `"example/Example+EXAMPLE+example/Example"`

Авторы

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