[ aws . apigateway ]
update-authorizer
Описание
Обновляет существующий ресурс Authorizer.
См. также: Документацию AWS API
Синтаксис
update-authorizer
--rest-api-id <value>
--authorizer-id <value>
[--patch-operations <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 (строка)
--authorizer-id (строка)
--patch-operations (список)
Для получения дополнительной информации о поддерживаемых операциях обновления см. Операции обновления.
(структура)
Для получения дополнительной информации о поддерживаемых операциях обновления см. Операции обновления.
op -> (строка)
path -> (строка)
value -> (строка)
from -> (строка)
Сокращенный синтаксис:
op=string,path=string,value=string,from=string ...
Синтаксис JSON:
[
{
"op": "add"|"remove"|"replace"|"move"|"copy"|"test",
"path": "string",
"value": "string",
"from": "string"
}
...
]
--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
- текст
- таблица
- 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.
Изменение имени пользовательского Authorizer
Команда:
aws apigateway update-authorizer --rest-api-id 1234123412 --authorizer-id gfi4n3 --patch-operations op='replace',path='/name',value='testAuthorizer'
Вывод:
{
"authType": "custom",
"name": "testAuthorizer",
"authorizerUri": "arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123412341234:function:customAuthorizer/invocations",
"authorizerResultTtlInSeconds": 300,
"identitySource": "method.request.header.Authorization",
"type": "TOKEN",
"id": "gfi4n3"
}
Изменение функции Lambda, вызываемой пользовательским Authorizer
Команда:
aws apigateway update-authorizer --rest-api-id 1234123412 --authorizer-id gfi4n3 --patch-operations op='replace',path='/authorizerUri',value='arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123412341234:function:newAuthorizer/invocations'
Вывод:
{
"authType": "custom",
"name": "testAuthorizer",
"authorizerUri": "arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123412341234:function:newAuthorizer/invocations",
"authorizerResultTtlInSeconds": 300,
"identitySource": "method.request.header.Authorization",
"type": "TOKEN",
"id": "gfi4n3"
}
Вывод
id -> (строка)
name -> (строка)
type -> (строка)
TOKEN для функции Lambda, использующей один токен авторизации, переданный в пользовательском заголовке; REQUEST для функции Lambda, использующей параметры входящего запроса; и COGNITO_USER_POOLS для использования пула пользователей Amazon Cognito.providerARNs -> (список)
Список Amazon Cognito ARN пулов пользователей для авторизатора COGNITO_USER_POOLS. Каждый элемент имеет формат: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. Для авторизатора типа TOKEN или REQUEST это не определено.
(строка)
authType -> (строка)
authorizerUri -> (строка)
TOKEN или REQUEST это должна быть правильно сформированная URI функции Lambda, например, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. В общем случае URI имеет такой формат arn:aws:apigateway:{region}:lambda:path/{service_api}, где {region} — та же область, что и область размещения функции Lambda, path указывает, что оставшаяся часть URI должна обрабатываться как путь к ресурсу, включая начальный /. Для функций Lambda это обычно имеет вид /2015-03-31/functions/[FunctionARN]/invocations.authorizerCredentials -> (строка)
identitySource -> (строка)
TOKEN или COGNITO_USER_POOLS это обязательно и указывает выражение сопоставления заголовков запроса для пользовательского заголовка, содержащего токен авторизации, отправленный клиентом. Например, если имя заголовка токена — Auth, выражение сопоставления заголовка — method.request.header.Auth. Для авторизатора REQUEST это обязательно при включенной кэшировании авторизации. Значение — это строка, содержащая через запятую одно или несколько выражений сопоставления указанных параметров запроса. Например, если в качестве источников идентификации определены заголовок Auth и параметр запроса Name, это значение будет method.request.header.Auth, method.request.querystring.Name. Эти параметры будут использоваться для вывода ключа кэша авторизации и для выполнения проверки авторизатора REQUEST во время выполнения, проверяя, что все параметры запроса, относящиеся к идентификации, присутствуют, не равны null и не пусты. Только в этом случае авторизатор вызовет функцию Lambda авторизатора; в противном случае он вернёт ответ 401 Unauthorized без вызова функции Lambda. Допустимое значение — строка с выражениями сопоставления указанных параметров запроса, разделёнными запятыми. Если кэширование авторизации отключено, это свойство является необязательным.identityValidationExpression -> (строка)
TOKEN это регулярное выражение. Для авторизаторов COGNITO_USER_POOLS API Gateway сопоставит поле aud входящего токена от клиента с указанным регулярным выражением. При совпадении будет вызвать функцию Lambda авторизатора. В противном случае вернёт ответ 401 Unauthorized без вызова функции Lambda. Выражение валидации не применяется к авторизатору REQUEST.authorizerResultTtlInSeconds -> (целое число)
© Copyright 2025, Amazon Web Services. Created using Sphinx.