aws_api_gateway - Управление API AWS API Gateway

Новая в версии 2.4.

Обзор
- Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус
Техническое обслуживание
- Автор

Обзор

Позволяет управлять API Gateway API
Обычно следует указывать api_id, так как нет другого стабильного и гарантированно уникального идентификатора API. Если вы не укажете api_id, каждый раз при выполнении этого модуля будет создаваться новый API.
Обратите внимание, что существуют очень жёсткие ограничения на скорость вызовов REST API API Gateway. Возможно, вам потребуется изменить ваш boto. См. https://github.com/boto/boto3/issues/876 и обсудите это со своим представителем AWS.
swagger_file и swagger_text передаются напрямую в AWS прозрачно, в то время как swagger_dict — это словарь ansible, который преобразуется в JSON перед загрузкой определений API.

Требования

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

boto
boto3
python >= 2.6

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_id		Идентификатор API, который вы хотите управлять.
aws_access_key		Ключ доступа AWS. Если не задано, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. Псевдонимы: ec2_access_key, access_key
aws_secret_key		Секретный ключ AWS. Если не задано, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. Псевдонимы: ec2_secret_key, secret_key
deploy_desc	По умолчанию: "Автоматическая установка Ansible"	Описание установки — записывается и отображается в консоли AWS.
ec2_url		URL для подключения к EC2 или облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задано, используется значение переменной окружения EC2_URL, если она есть.
profile (добавлено в 1.6)		Использует профиль boto. Работает только с boto >= 2.24.0.
region		Регион AWS для использования. Если не указано, используется значение переменной окружения AWS_REGION или EC2_REGION, если она есть. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region Псевдонимы: aws_region, ec2_region
security_token (добавлено в 1.6)		Токен безопасности AWS STS. Если не задано, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Псевдонимы: access_token
stage		Имя этапа развертывания API.
state	Варианты: present ← absent	НЕ РЕАЛИЗОВАНО Создание или удаление API — в настоящее время всегда создается.
swagger_dict		Словарь Ansible Swagger API определений, который будет преобразован в JSON и загружен.
swagger_file		Файл JSON или YAML, содержащий определения swagger для API. Должен быть указан один из swagger_file, swagger_text или swagger_dict.
swagger_text		Определения swagger для API в формате JSON или YAML в виде строки, непосредственно из плейбука.
validate_certs bool (добавлено в 1.5)	Варианты: no yes ←	Если значение равно "no", сертификаты SSL не будут проверяться для версий boto >= 2.6.0.

Примечания

Примечание

Будущая версия этого модуля, вероятно, будет использовать теги или другой идентификатор, чтобы API можно было создать только один раз.
В качестве временного решения в промежуточной версии, вероятно, будет использоваться тот же подход с тегом, встроенным в имя API.
Если параметры не заданы в модуле, могут быть использованы следующие переменные окружения в порядке убывания приоритета AWS_URL или EC2_URL, 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
Ansible использует файл конфигурации boto (обычно ~/.boto), если учетные данные не предоставлены. См. http://boto.readthedocs.org/en/latest/boto_config_tut.html
AWS_REGION или EC2_REGION обычно используются для указания региона AWS, когда это требуется, но это также можно настроить в файле конфигурации boto

Примеры

# Update API resources for development
- name: update API
  aws_api_gateway:
    api_id: 'abc123321cba'
    state: present
    swagger_file: my_api.yml

# update definitions and deploy API to production
- name: deploy API
  aws_api_gateway:
    api_id: 'abc123321cba'
    state: present
    swagger_file: my_api.yml
    stage: production
    deploy_desc: Make auth fix available.

Возвращаемые значения

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

Ключ	Возвращаемое значение	Описание
output dict	success	данные, возвращаемые put_restapi в boto3 Пример: {'data': {'id': 'abc123321cba', 'name': 'МОЙ REST API', 'createdDate': 1484233401}}

Статус

Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.

Техническое обслуживание

Этот модуль помечен как сообщество, что означает, что его поддерживает сообщество Ansible. См. Техническое обслуживание и поддержка модулей для получения дополнительной информации.

Список других модулей, также поддерживаемых сообществом Ansible, см. здесь.

Автор

Michael De La Rue (@mikedlr)

Подсказка

Если вы обнаружите какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/aws_api_gateway_module.html