aws_api_gateway - Управление API шлюзом AWS API Gateway

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

Обзор
Требования (к хосту, на котором выполняется модуль)
Параметры
Примеры
Значения возврата
Примечания
- Статус

Обзор

Позволяет управлять API шлюзами API Gatway.
Обычно необходимо указать 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.
security_token (добавлено в 1.6)	нет			Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. псевдонимы: access_token
stage	нет			Имя этапа, на котором должен быть развернут API.
state	нет	present	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 (добавлено в 1.5)	нет	да	да нет	При значении "нет" сертификаты SSL не будут проверяться для версий boto >= 2.6.0.

Примеры

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

# update definitions and deploy API to production
tasks:
- 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}}

Примечания

Примечание

В будущей версии этого модуля, вероятно, будут использоваться теги или другой идентификатор, чтобы 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

Статус

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

Для получения помощи в разработке модулей, если вы заинтересованы, прочтите Информация о сообществе и участие, Тестирование Ansible и Разработка модулей.

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