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 -		Словарь API определений Swagger ansible, который будет преобразован в JSON и загружен.
swagger_file -		Файл JSON или YAML, содержащий определения swagger для API. Должен быть указан один из swagger_file, swagger_text или swagger_dict.
swagger_text -		Определения swagger для API в формате JSON или YAML в виде строки, полученной непосредственно из playbook.
validate_certs boolean добавлен в 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), если не предоставлены данные для аутентификации. См. https://boto.readthedocs.io/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 словарь	успех	данные, возвращаемые put_restapi в boto3 Пример: {'data': {'id': 'abc123321cba', 'name': 'МОЙ REST API', 'createdDate': 1484233401}}

Статус

Данный модуль не гарантирует обратную совместимость. [превью]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

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.7/modules/aws_api_gateway_module.html