community.aws.iam_saml_federation – Поддержание конфигурации федерации IAM SAML.

Примечание

Этот плагин входит в коллекцию community.aws (версия 1.3.0).

Для его установки используйте: ansible-galaxy collection install community.aws.

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

Добавлена в версии 1.0.0: из community.aws

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

Обзор

Предоставляет механизм управления поставщиками федерации идентификации AWS IAM SAML (создание/обновление/удаление метаданных).

Требования

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

boto
boto3
python >= 2.6

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
aws_access_key строка		Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. Если установлен параметр profile, этот параметр игнорируется. Передача параметров aws_access_key и profile одновременно устарела и после 2022-06-01 параметры будут взаимно исключать друг друга. псевдонимы: ec2_access_key, access_key
aws_ca_bundle путь		Расположение файла с пакетом сертификатов CA для проверки SSL-сертификатов. Используется только для модулей на основе boto3. Примечание: пакет сертификатов CA считывается на стороне модуля и может потребоваться явное копирование с контроллера, если он не выполняется локально.
aws_config словарь		Словарь для изменения конфигурации botocore. Параметры можно найти по адресу https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. Для boto-модулей используется только ключ 'user_agent'. Подробнее о конфигурации boto см. по адресу http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto.
aws_secret_key строка		Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. Если установлен параметр profile, этот параметр игнорируется. Передача параметров aws_secret_key и profile одновременно устарела и после 2022-06-01 параметры будут взаимно исключать друг друга. псевдонимы: ec2_secret_key, secret_key
debug_botocore_endpoint_logs булево	Варианты: нет ← да	Используйте логирование botocore.endpoint для анализа уникальных (а не общих) вызовов API "ресурс:действие", сделанных во время задачи, выводив набор в ключ resource_actions результатов задачи. Используйте обратный вызов aws_resource_action для вывода полного списка, сделанного во время книги задач. Переменная окружения ANSIBLE_DEBUG_BOTOCORE_LOGS также может быть использована.
ec2_url строка		URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если таковая имеется. псевдонимы: aws_endpoint_url, endpoint_url
name строка / обязательно		Имя поставщика для создания.
profile строка		Использует профиль boto. Работает только с boto >= 2.24.0. Использование profile переопределяет aws_access_key, aws_secret_key и security_token, а поддержка одновременной передачи их вместе с profile устарела. aws_access_key, aws_secret_key и security_token будут взаимно исключать друг друга с profile после 2022-06-01. псевдонимы: aws_profile
region строка		Регион AWS для использования. Если не указан, используется значение переменной окружения AWS_REGION или EC2_REGION, если таковая имеется. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region псевдонимы: aws_region, ec2_region
saml_metadata_document строка		XML-документ, сгенерированный поставщиком идентификации (IdP), поддерживающим SAML 2.0.
security_token строка		Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Если установлен параметр profile, этот параметр игнорируется. Передача параметров security_token и profile одновременно устарела и после 2022-06-01 параметры будут взаимно исключать друг друга. псевдонимы: aws_security_token, access_token
state строка	Варианты: present ← absent	Определяет, создать или удалить поставщика идентификации. Если указано 'present', будет произведена попытка обновить поставщика идентификации, соответствующего имени в поле name.
validate_certs булево	Варианты: нет да ←	Если установлено значение "нет", SSL-сертификаты не будут проверены для версий boto >= 2.6.0.

Примечания

Примечание

Если параметры не установлены в модуле, следующие переменные окружения могут использоваться в порядке убывания приоритета AWS_URL или EC2_URL, AWS_PROFILE или AWS_DEFAULT_PROFILE, AWS_ACCESS_KEY_ID или AWS_ACCESS_KEY или EC2_ACCESS_KEY, AWS_SECRET_ACCESS_KEY или AWS_SECRET_KEY или EC2_SECRET_KEY, AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN, AWS_REGION или EC2_REGION, AWS_CA_BUNDLE
Ansible использует файл конфигурации boto (обычно ~/.boto), если учетные данные не указаны. См. https://boto.readthedocs.io/en/latest/boto_config_tut.html
AWS_REGION или EC2_REGION обычно используются для указания региона AWS, если он требуется, но его также можно настроить в файле конфигурации boto

Примеры

# Note: These examples do not set authentication details, see the AWS Guide for details.
# It is assumed that their matching environment variables are set.
# Creates a new iam saml identity provider if not present
- name: saml provider
  community.aws.iam_saml_federation:
      name: example1
      # the > below opens an indented block, so no escaping/quoting is needed when in the indentation level under this key
      saml_metadata_document: >
          <?xml version="1.0"?>...
          <md:EntityDescriptor
# Creates a new iam saml identity provider if not present
- name: saml provider
  community.aws.iam_saml_federation:
      name: example2
      saml_metadata_document: "{{ item }}"
  with_file: /path/to/idp/metdata.xml
# Removes iam saml identity provider
- name: remove saml provider
  community.aws.iam_saml_federation:
      name: example3
      state: absent

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

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

Ключ		Возвращаемое значение	Описание
saml_provider сложное		present	Подробная информация о поставщике идентификации SAML, который был создан/изменён.
	arn строка	present	ARN поставщика идентификации. Пример: arn:aws:iam::123456789012:saml-provider/my_saml_provider
	create_date строка	present	Дата и время создания поставщика SAML в формате ISO 8601. Пример: 2017-02-08T04:36:28+00:00
	expire_date строка	present	Дата и время истечения срока действия поставщика SAML в формате ISO 8601. Пример: 2017-02-08T04:36:28+00:00
	metadata_document строка	present	XML-документ метаданных, который содержит информацию о поставщике идентификации.

Авторы

Tony (@axc450)
Aidan Rowe (@aidan-)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/aws/iam_saml_federation_module.html