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

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

Обзор
- Требования
Параметры
Примечания
Примеры
Значения возврата
Статус
- Автор

Обзор

Позволяет управлять API шлюзами API Gateway.
Обычно следует указывать 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	По умолчанию: None	Ключ доступа AWS. Если не задан, используется значение переменной среды AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. Псевдонимы: ec2_access_key, access_key
aws_secret_key	По умолчанию: None	Секретный ключ AWS. Если не задан, используется значение переменной среды AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. Псевдонимы: ec2_secret_key, secret_key
deploy_desc	По умолчанию: Автоматическое развертывание Ansible.	Описание развертывания — сохраняется и отображается в консоли AWS.
ec2_url	По умолчанию: None	URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной среды EC2_URL, если она есть.
profile (добавлено в 1.6)	По умолчанию: None	Использует профиль 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)	По умолчанию: None	Токен безопасности 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 в виде строки, взятой непосредственно из плейбука.
validate_certs (добавлено в 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	успех	данные, возвращаемые put_restapi в boto3 Пример: {'data': {'id': 'abc123321cba', 'name': 'МОЙ REST API', 'createdDate': 1484233401}}

Статус

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

Автор

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