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

Примечание

Этот плагин является частью коллекции community.aws (версия 1.3.0).

Для его установки используйте: ansible-galaxy collection install community.aws.

Для использования в книге задач укажите: community.aws.aws_api_gateway.

Добавлен в версии 1.0.0: of community.aws

Обзор
Требования
Параметры
Примечания
Примеры
Значения возврата

Обзор

Позволяет управлять API Gateway API.
Обычно вы должны указать идентификатор 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. Если задан параметр profile, этот параметр игнорируется. Одновременное использование параметров aws_access_key и profile устарело и будет сделано взаимоисключающими после 2022-06-01. псевдонимы: ec2_access_key, access_key
aws_ca_bundle путь		Путь к файлу сертификатов CA для проверки SSL-сертификатов. Используется только для модулей, основанных на boto3. Примечание: Файл сертификатов CA читается на стороне модуля и может потребоваться явное копирование с контроллера, если выполнение не происходит локально.
aws_config словарь		Словарь для изменения конфигурации botocore. Параметры можно найти по адресу https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. Для модулей boto используется только ключ 'user_agent'. См. http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto для дополнительной конфигурации boto.
aws_secret_key строка		Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. Если задан параметр profile, этот параметр игнорируется. Одновременное использование параметров aws_secret_key и profile устарело и будет сделано взаимоисключающими после 2022-06-01. псевдонимы: ec2_secret_key, secret_key
cache_enabled логическое	Варианты: нет ← да	Включить кеширование API GW ответов от бэкенда.
cache_size строка	Варианты: 0.5 ← 1.6 6.1 13.5 28.4 58.2 118 237	Размер кеша API GW в ГБ, становится эффективным при cache_enabled=true.
debug_botocore_endpoint_logs логическое	Варианты: нет ← да	Использовать логгер botocore.endpoint для анализа уникальных (а не общих) вызовов API «ресурс:действие» во время задачи, выводить набор в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action, чтобы выводить в список всех вызовов во время книги задач. Переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS также может быть использована.
deploy_desc строка	Значение по умолчанию: "Автоматическое развертывание Ansible."	Описание развертывания. Записывается и отображается в консоли AWS.
ec2_url строка		URL для подключения к облаку EC2 или Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где регион требуется. Должен быть указан для всех остальных модулей, если регион не используется. Если не указан, используется значение переменной окружения EC2_URL, если она есть. псевдонимы: aws_endpoint_url, endpoint_url
endpoint_type строка	Варианты: EDGE ← REGIONAL PRIVATE	Тип конфигурации конечной точки. Используйте `EDGE` для оптимизированной конечной точки API, `REGIONAL` для простого регионального развертывания или `PRIVATE` для частного API. Этот флаг будет использоваться только при создании новой настройки API Gateway, а не для обновлений.
profile строка		Использует профиль boto. Работает только с boto >= 2.24.0. Использование profile переопределяет aws_access_key, aws_secret_key и security_token, и поддержка их одновременного использования с profile устарела. aws_access_key, aws_secret_key и security_token будут сделаны взаимоисключающими с profile после 2022-06-01. псевдонимы: aws_profile
region строка		Регион AWS для использования. Если не указан, используется значение переменной окружения AWS_REGION или EC2_REGION, если она есть. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region псевдонимы: aws_region, ec2_region
security_token строка		Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Если задан параметр profile, этот параметр игнорируется. Одновременное использование параметров security_token и profile устарело и будет сделано взаимоисключающими после 2022-06-01. псевдонимы: aws_security_token, access_token
stage строка		Название стадии, в которую должен быть развернут API.
stage_canary_settings словарь		Параметры для канадского развертывания стадии. Словарь с следующими настройками: `percentTraffic`: Процент (0-100) трафика, перенаправляемого на канадское развертывание. `deploymentId`: Идентификатор канадского развертывания. `stageVariableOverrides`: Переменные стадии, переопределённые для канадского развертывания. `useStageCache`: Логический флаг, указывающий, использует ли канадское развертывание кеш стадии или нет. См. документацию https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/apigateway.html#APIGateway.Client.create_stage
stage_variables словарь		Переменные среды для стадии. Определите словарь пар ключ-значение для переменных.
state строка	Варианты: present ← absent	Создать или удалить API Gateway.
swagger_dict json		Словарь Swagger API Ansible, который будет преобразован в JSON и загружен.
swagger_file путь		Файл JSON или YAML, содержащий определения Swagger для API. Должен быть указан один из параметров: swagger_file, swagger_text или swagger_dict. псевдонимы: src, api_file
swagger_text строка		Определения Swagger для API в JSON или YAML в виде строки напрямую из книги задач.
tracing_enabled логическое	Варианты: нет ← да	Указывает, включено ли активное отслеживание с X-ray для стадии API GW.
validate_certs логическое	нет да ←	При значении "нет" SSL-сертификаты не будут проверены для версий boto >= 2.6.0.

Примечания

Примечание

Будущая версия данного модуля, вероятно, будет использовать теги или другой идентификатор, чтобы API можно было создать только один раз.
В качестве временного решения промежуточная версия, вероятно, сделает то же самое, используя тег, встроенный в имя API.
Если параметры не заданы в модуле, следующие переменные среды могут быть использованы в порядке убывания приоритета AWS_URL или EC2_URL, AWS_PROFILE или AWS_DEFAULT_PROFILE, 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, AWS_CA_BUNDLE
Ansible использует конфигурационный файл boto (обычно ~/.boto), если учетные данные не предоставлены. См. https://boto.readthedocs.io/en/latest/boto_config_tut.html
AWS_REGION или EC2_REGION обычно используются для указания региона AWS, если это необходимо, но это также можно настроить в конфигурационном файле boto

Примеры

- name: Setup AWS API Gateway setup on AWS and deploy API definition
  community.aws.aws_api_gateway:
    swagger_file: my_api.yml
    stage: production
    cache_enabled: true
    cache_size: '1.6'
    tracing_enabled: true
    endpoint_type: EDGE
    state: present

- name: Update API definition to deploy new version
  community.aws.aws_api_gateway:
    api_id: 'abc123321cba'
    swagger_file: my_api.yml
    deploy_desc: Make auth fix available.
    cache_enabled: true
    cache_size: '1.6'
    endpoint_type: EDGE
    state: present

- name: Update API definitions and settings and deploy as canary
  community.aws.aws_api_gateway:
    api_id: 'abc123321cba'
    swagger_file: my_api.yml
    cache_enabled: true
    cache_size: '6.1'
    canary_settings: { percentTraffic: 50.0, deploymentId: '123', useStageCache: True }
    state: present

Значения возврата

Общие значения возврата документированы здесь, следующие поля уникальны для данного модуля:

Ключ	Возвращаемое значение	Описание
api_id строка	успех	Идентификатор API созданного API-эндпоинта Пример: 0ln4zq7p86
configure_response словарь	успех	Ответ AWS от вызова API configure Пример: {'api_key_source': 'HEADER', 'created_at': '2020-01-01T11:37:59+00:00', 'id': '0ln4zq7p86'}
deploy_response словарь	успех	Ответ AWS от вызова API deploy Пример: {'created_date': '2020-01-01T11:36:59+00:00', 'description': 'Автоматическое развертывание Ansible.', 'id': 'rptv4b'}
resource_actions список / элементы=строка	всегда	Действия, выполненные над API AWS Пример: ['apigateway:CreateRestApi', 'apigateway:CreateDeployment', 'apigateway:PutRestApi']

Авторы

Michael De La Rue (@mikedlr)

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