create-resource

Описание

Создает ресурс Resource.

См. также: Документация AWS API

Синтаксис

  create-resource
--rest-api-id <value>
--parent-id <value>
--path-part <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--rest-api-id (строка)

Идентификатор связанного RestApi.

--parent-id (строка)

Идентификатор родительского ресурса.

--path-part (строка)

Последний сегмент пути для этого ресурса.

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка соответствует формату, заданному в --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения переопределят значения, полученные из JSON. Невозможно передавать произвольные двоичные значения с помощью значения из JSON, так как строка будет интерпретироваться буквально. Это не может быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса к API. Если указано без значения или со значением input, выводит JSON-пример входных данных, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если указано yaml-input, он выведет пример входных данных YAML, который можно использовать с --cli-input-yaml. Если указано значение output, проверяет входные данные команды и возвращает JSON-пример выходных данных для этой команды. Сгенерированный JSON-скелет не является стабильным между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.

Глобальные параметры

--debug (логическое значение)

Включить отладочную запись в журнал.

--endpoint-url (строка)

Переопределяет URL команды заданным URL.

--no-verify-ssl (логическое значение)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI проверяет сертификаты SSL. Этот параметр переопределяет поведение по умолчанию, связанное с проверкой сертификатов SSL.

--no-paginate (логическое значение)

Отключить автоматическую постраничность. Если автоматическая постраничность отключена, AWS CLI сделает только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования вывода команды.

json
text
таблица
yaml
yaml-поток

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использование определенного профиля из файла учетных данных.

--region (строка)

Используемый регион. Переопределяет настройки конфигурации/среды.

--version (строка)

Отображение версии этого инструмента.

--color (строка)

Включение/отключение цветного вывода.

вкл
выкл
авто

--no-sign-request (логическое значение)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент указан.

--ca-bundle (строка)

Файл с пакетом сертификатов CA для проверки сертификатов SSL. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (целое число)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.

--cli-connect-timeout (целое число)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.

--cli-binary-format (строка)

Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — base64. Формат base64 предполагает, что двоичные блоки передаются как закодированная строка base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, соответствующего двоичному блоку, fileb:// всегда будет обрабатываться как двоичный, и будут использоваться непосредственно содержимое файла независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (логическое значение)

Отключить вывод страницы командной строки.

--cli-auto-prompt (логическое значение)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (логическое значение)

Отключить автоматическое запросы параметров ввода CLI.

Примеры

Примечание

Чтобы использовать следующие примеры, необходимо установить и настроить AWS CLI. См. руководство по началу работы в руководстве пользователя AWS CLI для получения дополнительной информации.

Если не указано иное, все примеры используют правила цитирования в стиле Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей терминальной оболочки. См. использование кавычек со строками в руководстве пользователя AWS CLI.

Создание ресурса в API

Команда:

aws apigateway create-resource --rest-api-id 1234123412 --parent-id a1b2c3 --path-part 'new-resource'

Вывод

id -> (строка)

Идентификатор ресурса.

parentId -> (строка)

Идентификатор родительского ресурса.

pathPart -> (строка)

Последний сегмент пути для этого ресурса.

path -> (строка)

Полный путь для этого ресурса.

resourceMethods -> (массив)

Получение метода ресурса API для заданного HTTP-глагола.

ключ -> (строка)

значение -> (структура)

Представляет клиентский интерфейс, с помощью которого клиент вызывает API для доступа к ресурсам бэкенда. Ресурс Method интегрирован с ресурсом Integration. Оба содержат запрос и один или несколько ответов. Запрос метода принимает входные данные клиента, которые передаются бэкенду через запрос интеграции. Ответ метода возвращает вывод бэкенда клиенту через ответ интеграции. Запрос метода реализуется в ресурсе Method, а запрос интеграции — в ресурсе Integration. С другой стороны, ответ метода представлен ресурсом MethodResponse, а ответ интеграции — ресурсом IntegrationResponse.

httpMethod -> (строка)

HTTP-глагол метода.

authorizationType -> (строка)

Тип авторизации метода. Допустимые значения: NONE для открытого доступа, AWS_IAM для использования разрешений AWS IAM, CUSTOM для использования пользовательского авторизатора или COGNITO_USER_POOLS для использования пула пользователей Cognito.

authorizerId -> (строка)

Идентификатор авторизатора, используемого для этого метода. authorizationType должен быть CUSTOM.

apiKeyRequired -> (логическое значение)

Флаг логического типа, указывающий, требуется ли действительный ApiKey для вызова этого метода.

requestValidatorId -> (строка)

Идентификатор RequestValidator для проверки запросов.

operationName -> (строка)

Человекочитаемый идентификатор операции для метода. Например, можно назначить operationName значения ListPets для метода GET /pets в примере PetStore.

requestParameters -> (массив)

Массив пар "ключ-значение", определяющий необходимые или необязательные параметры запроса метода, которые могут быть приняты API Gateway. Ключ — это имя параметра запроса метода, соответствующее шаблону method.request.{location}.{name}, где location — это querystring, path или header, а name — допустимое и уникальное имя параметра. Значение, связанное с ключом, представляет собой флаг Boolean, указывающий, является ли параметр необходимым (true) или необязательным (false). Имена параметров запроса метода, определенные здесь, доступны в Integration для сопоставления с параметрами запроса интеграции или шаблонами.

ключ -> (строка)

значение -> (логическое значение)

requestModels -> (массив)

Массив пар "ключ-значение", определяющий схемы данных, представленные ресурсами Model (как сопоставляемое значение), нагрузок запроса заданных типов контента (как ключ сопоставления).

ключ -> (строка)

значение -> (строка)

methodResponses -> (массив)

Получение ответа метода, связанного с заданным HTTP-кодом состояния.

ключ -> (строка)

значение -> (структура)

Представляет ответ метода для заданного HTTP-кода состояния, возвращаемого клиенту. Ответ метода передается с бэкенда через связанный ответ интеграции, который может быть преобразован с помощью шаблона сопоставления.

statusCode -> (строка)

Код состояния ответа метода.

responseParameters -> (массив)

Массив пар "ключ-значение", определяющий необходимые или необязательные параметры ответа, которые API Gateway может отправлять обратно вызывающей стороне. Ключ определяет заголовок ответа метода, а значение указывает, требуется ли соответствующий заголовок ответа метода. Выражение ключа должно соответствовать шаблону method.response.header.{name}, где name — действительное и уникальное имя заголовка. API Gateway передает определенные данные ответа интеграции в заголовки ответа метода, указанные здесь, в соответствии с заданным вами сопоставлением в IntegrationResponse API. Данные ответа интеграции, которые могут быть сопоставлены, включают заголовок ответа интеграции, выраженный в integration.response.header.{name}, статическое значение, заключенное в пару одинарных кавычек (например, 'application/json') или JSON-выражение из полезной нагрузки ответа бэкенда в виде integration.response.body.{JSON-expression}, где JSON-expression — действительное JSON-выражение без префикса $).

ключ -> (строка)

значение -> (логическое значение)

responseModels -> (массив)

Определяет ресурсы Model, используемые для типа контента ответа. Модели ответов представлены в виде массива пар "ключ-значение", где тип контента — ключ, а имя модели — значение.

ключ -> (строка)

значение -> (строка)

methodIntegration -> (структура)

Получает интеграцию метода, отвечающую за передачу запроса, отправленного клиентом, на бэкенд и выполнение необходимых преобразований для соответствия запроса бэкенду.

type -> (строка)

Определяет тип интеграции API-метода. Допустимое значение — одно из следующих:

Для интеграций HTTP и HTTP-прокси каждая интеграция может указать протокол (http/https ), порт и путь. Поддерживаются стандартные порты 80 и 443, а также пользовательские порты выше 1024. Интеграция HTTP или HTTP-прокси с connectionType VPC_LINK называется частной интеграцией и использует VpcLink для подключения API Gateway к балансировщику нагрузки сети VPC.

httpMethod -> (строка)

Определяет тип HTTP-метода интеграции. Для свойства Type, если вы указали MOCK , это свойство необязательно. Для интеграций Lambda вы должны установить метод интеграции на POST . Для всех других типов вы должны указать это свойство.

uri -> (строка)

Определяет универсальный идентификатор ресурса (URI) конечной точки интеграции.

Для интеграций HTTP или HTTP_PROXY URI должен быть полностью сформированной, закодированной HTTP(S) ссылкой в соответствии со спецификацией RFC-3986 для стандартных интеграций. Если connectionType VPC_LINK , укажите имя DNS балансировщика сети. Для интеграций AWS или AWS_PROXY URI имеет вид arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api} . Здесь {Region} — регион API Gateway (например, us-east-1); {service} — имя интегрированной службы Amazon Web Services (например, s3); и {subdomain} — выделенный домен, поддерживаемый некоторыми службами Amazon Web Services для быстрого поиска имени хоста. action может использоваться для API, основанных на действиях службы Amazon Web Services, используя строку запроса Action={name}&{p1}={v1}&p2={v2}… Полученное {service_api} относится к поддерживаемому действию {name} плюс любые необходимые входные параметры. В качестве альтернативы, можно использовать путь для API, основанных на путях службы Amazon Web Services. Полученное service_api относится к пути к ресурсу службы Amazon Web Services, включая регион интегрированной службы Amazon Web Services, если применимо. Например, для интеграции с API S3 GetObject URI может быть либо arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} , либо arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}

connectionType -> (строка)

Тип сетевого подключения к конечной точке интеграции. Допустимое значение — INTERNET для подключений через общедоступный маршрутизируемый интернет или VPC_LINK для частных подключений между API Gateway и балансировщиком нагрузки сети в VPC. Значение по умолчанию — INTERNET .

connectionId -> (строка)

Идентификатор VpcLink, используемый для интеграции, когда connectionType=VPC_LINK и неопределено, в противном случае.

credentials -> (строка)

Определяет необходимые учетные данные для интеграции, если таковые имеются. Для интеграций с AWS доступны три варианта. Чтобы указать роль IAM для принятия API Gateway, используйте Amazon Resource Name (ARN) роли. Чтобы потребовать передачи идентификатора вызывающего абонента из запроса, укажите строку arn:aws:iam::\*:user/\* . Чтобы использовать разрешения на основе ресурсов для поддерживаемых служб Amazon Web Services, укажите null.

requestParameters -> (карта)

Ключевое значение отображения параметров запроса, передаваемых от запроса метода к бэкенду. Ключ — имя параметра запроса интеграции, а соответствующее значение — значение параметра запроса метода или статическое значение, которое должно быть заключено в одинарные кавычки и предварительно закодировано в соответствии с требованиями бэкенда. Значение параметра запроса метода должно соответствовать шаблону method.request.{location}.{name} , где location querystring , path или header и name должно быть допустимым и уникальным именем параметра запроса метода.

key -> (строка)

value -> (строка)

requestTemplates -> (карта)

Представляет карту шаблонов Velocity, которые применяются к загрузке запроса на основе значения заголовка Content-Type, отправленного клиентом. Значение типа содержимого — ключ в этой карте, а шаблон (как строка) — значение.

key -> (строка)

value -> (строка)

passthroughBehavior -> (строка)

Определяет, как тело запроса метода с неотображенным типом содержимого будет передаваться через запрос интеграции на бэкенд без преобразования. Тип содержимого не отображается, если шаблон отображения не определен в интеграции или тип содержимого не совпадает ни с одним из отображаемых типов содержимого, как указано в requestTemplates . Допустимое значение — одно из следующих: WHEN_NO_MATCH : передает тело запроса метода через запрос интеграции на бэкенд без преобразования, когда тип содержимого запроса метода не совпадает ни с одним типом содержимого, связанным с шаблонами отображения, определенными в запросе интеграции. WHEN_NO_TEMPLATES : передает тело запроса метода через запрос интеграции на бэкенд без преобразования, когда в запросе интеграции не определен ни один шаблон отображения. Если шаблон определен, когда выбран этот параметр, запрос метода с неотображенным типом содержимого будет отклонен с ответом HTTP 415 Unsupported Media Type. NEVER : отклоняет запрос метода с ответом HTTP 415 Unsupported Media Type, когда либо тип содержимого запроса метода не соответствует ни одному типу содержимого, связанному с шаблонами отображения, определенными в запросе интеграции, либо в запросе интеграции не определен ни один шаблон отображения.

contentHandling -> (строка)

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

Если это свойство не определено, загрузка запроса будет передана из запроса метода в запрос интеграции без изменений, при условии, что passthroughBehavior настроен на поддержку передачи загрузки.

timeoutInMillis -> (целое число)

Настраиваемая задержка между 50 и 29 000 миллисекундами. Значение по умолчанию — 29 000 миллисекунд или 29 секунд.

cacheNamespace -> (строка)

Определяет группу связанных кэшированных параметров. По умолчанию API Gateway использует идентификатор ресурса в качестве cacheNamespace . Вы можете указать тот же cacheNamespace для разных ресурсов, чтобы получить одинаковые кэшированные данные для запросов к различным ресурсам.

cacheKeyParameters -> (список)

Список параметров запроса, значения которых API Gateway кэширует. Чтобы быть допустимыми значениями для cacheKeyParameters , эти параметры также должны быть указаны для метода requestParameters .

(строка)

integrationResponses -> (карта)

Определяет ответы интеграции.

key -> (строка)

value -> (структура)

Представляет ответ интеграции. Код состояния должен сопоставляться с существующим MethodResponse, и параметры и шаблоны могут использоваться для преобразования ответа бэкенда.

statusCode -> (строка)

Определяет код состояния, используемый для сопоставления ответа интеграции с существующим MethodResponse.

selectionPattern -> (строка)

Определяет шаблон регулярного выражения (regex), используемый для выбора ответа интеграции на основе ответа от бэкенда. Например, если успешный ответ ничего не возвращает, а ответ об ошибке возвращает некоторую строку, вы можете использовать regex .+ для сопоставления ответа об ошибке. Однако убедитесь, что ответ об ошибке не содержит символа новой строки (\n ) в таких случаях. Если бэкенд — функция Lambda, соответствует заголовок ошибки функции Lambda. Для всех других HTTP- и Amazon Web Services бэкендов сопоставляется HTTP-код состояния.

responseParameters -> (карта)

Ключевое значение отображения параметров ответа, передаваемых в ответ метода от бэкенда. Ключ — имя параметра заголовка ответа метода, а сопоставленное значение — значение заголовка ответа интеграции, статическое значение, заключенное в одинарные кавычки, или выражение JSON из тела ответа интеграции. Ключ отображения должен соответствовать шаблону method.response.header.{name} , где name — допустимое и уникальное имя заголовка. Сопоставленное нестатическое значение должно соответствовать шаблону integration.response.header.{name} или integration.response.body.{JSON-expression} , где name — допустимое и уникальное имя заголовка ответа, а JSON-expression — допустимое выражение JSON без префикса $ .

key -> (строка)

value -> (строка)

responseTemplates -> (карта)

Определяет шаблоны, используемые для преобразования тела ответа интеграции. Шаблоны ответов представляют собой карту ключ/значение, где тип содержимого — ключ, а шаблон — значение.

key -> (строка)

value -> (строка)

contentHandling -> (строка)

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

Если это свойство не определено, загрузка ответа будет передана из ответа интеграции в ответ метода без изменений.

tlsConfig -> (структура)

Определяет конфигурацию TLS для интеграции.

insecureSkipVerification -> (булево)

Определяет, пропускать ли проверку API Gateway того, выдан ли сертификат для конечной точки интеграции авторизованным центром сертификации. Это не рекомендуется, но оно позволяет использовать сертификаты, подписанные частными центрами сертификации или самоподписанные сертификаты. Если включено, API Gateway все равно выполняет базовую проверку сертификата, которая включает проверку даты истечения срока действия сертификата, имени хоста и наличия корневого сертификата. Поддерживается только для интеграций HTTP и HTTP_PROXY.

Предупреждение

Включение insecureSkipVerification не рекомендуется, особенно для интеграций с общедоступными HTTPS-конечными точками. Если вы включите insecureSkipVerification , вы повышаете риск атак «человек посередине».

authorizationScopes -> (список)

Список областей авторизации, настроенных в методе. Области используются с авторизатором COGNITO_USER_POOLS для авторизации вызова метода. Авторизация работает путем сопоставления областей метода с областями, полученными из маркера доступа в запросе. Вызов метода авторизован, если какая-либо область метода соответствует области, указанной в маркере доступа. В противном случае вызов не авторизован. При настройке области метода клиент должен предоставить маркер доступа вместо маркера идентификации для целей авторизации.

(строка)