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

Новое в версии 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 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 для вывода в общий список, созданный во время выполнения playbook. Также может использоваться переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS.
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 -		Словарь Ansible с определениями Swagger API, который будет преобразован в JSON и загружен.
swagger_file -		Файл JSON или YAML, содержащий определения Swagger для API. Должен быть указан ровно один из swagger_file, swagger_text или swagger_dict.
swagger_text -		Определения Swagger для API в формате JSON или YAML как строка, непосредственно из playbook.
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': 'МОЙ 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.9/modules/aws_api_gateway_module.html