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 string		Ключ доступа AWS. Если не задано, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. Псевдонимы: ec2_access_key, access_key
aws_secret_key string		Секретный ключ AWS. Если не задано, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. Псевдонимы: ec2_secret_key, secret_key
debug_botocore_endpoint_logs boolean добавлено в 2.8	Варианты: нет ← да	Использовать логгер botocore.endpoint для анализа уникальных (а не общих) вызовов API «ресурс:действие» во время задачи, выводя набор в ключ resource_actions результатов задачи. Используйте обратный вызов aws_resource_action, чтобы вывести полный список, созданный во время выполнения книги сценариев.
deploy_desc -	По умолчанию: "Автоматическое развертывание Ansible."	Описание развертывания — записывается и отображается в консоли AWS.
ec2_url string		URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль будет использовать конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задано, используется значение переменной окружения EC2_URL, если таковое есть.
profile string		Использует профиль boto. Работает только с boto >= 2.24.0.
region string		Регион AWS для использования. Если не задано, используется значение переменной окружения AWS_REGION или EC2_REGION, если таковое есть. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region Псевдонимы: aws_region, ec2_region
security_token string		Токен безопасности AWS STS. Если не задано, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Псевдонимы: access_token
stage -		Имя стадии, на которую должен быть развернут API.
state -	Варианты: present ← absent	НЕ РЕАЛИЗОВАНО Создание или удаление API — в настоящее время всегда создается.
swagger_dict -		Словарь Swagger API ansible, который будет преобразован в JSON и загружен.
swagger_file -		JSON или YAML-файл, содержащий определения Swagger для API. Должен присутствовать ровно один из swagger_file, swagger_text или swagger_dict.
swagger_text -		Определения Swagger для API в JSON или YAML в виде строки непосредственно из книги сценариев.
validate_certs boolean	Варианты: нет да ←	При значении «нет» сертификаты 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': 'MY REST API', 'createdDate': 1484233401}}

Статус

Интерфейс этого модуля не гарантирует обратной совместимости. [preview]
Этот модуль поддерживается сообществом 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.8/modules/aws_api_gateway_module.html