обновить-кеш-api
Описание
Обновляет кеш для GraphQL API.
См. также: Документация AWS API
Синтаксис
update-api-cache
--api-id <value>
--ttl <value>
--api-caching-behavior <value>
--type <value>
[--health-metrics-config <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]
Параметры
--api-id (строка)
--ttl (целое число)
Срок жизни (TTL) в секундах для записей кеша.
Допустимые значения: от 1 до 3600 секунд.
--api-caching-behavior (строка)
Поведение кеширования.
- FULL_REQUEST_CACHING : Все запросы от одного пользователя кешируются. Индивидуальные разрешающие функции автоматически кешируются. Все вызовы API будут пытаться вернуть ответы из кеша.
- PER_RESOLVER_CACHING : Кешируются только те разрешающие функции, которые вы указали.
- OPERATION_LEVEL_CACHING : Полные запросы кешируются вместе и возвращаются без выполнения разрешающих функций.
Возможные значения:
FULL_REQUEST_CACHINGPER_RESOLVER_CACHINGOPERATION_LEVEL_CACHING
--type (строка)
Тип экземпляра кеша. Допустимые значения:
SMALLMEDIUMLARGEXLARGELARGE_2XLARGE_4X-
LARGE_8X(недоступно во всех регионах) LARGE_12X
Исторически типы экземпляров обозначались значениями в стиле EC2. Начиная с июля 2020 года, это устарело, и следует использовать приведенные выше общие идентификаторы.
Следующие устаревшие типы экземпляров доступны, но их использование не рекомендуется:
- T2_SMALL : Тип экземпляра t2.small.
- T2_MEDIUM : Тип экземпляра t2.medium.
- R4_LARGE : Тип экземпляра r4.large.
- R4_XLARGE : Тип экземпляра r4.xlarge.
- R4_2XLARGE : Тип экземпляра r4.2xlarge.
- R4_4XLARGE : Тип экземпляра r4.4xlarge.
- R4_8XLARGE : Тип экземпляра r4.8xlarge.
Возможные значения:
T2_SMALLT2_MEDIUMR4_LARGER4_XLARGER4_2XLARGER4_4XLARGER4_8XLARGESMALLMEDIUMLARGEXLARGELARGE_2XLARGE_4XLARGE_8XLARGE_12X
--health-metrics-config (строка)
Управляет тем, как метрики состояния кеша будут отправляться в CloudWatch. Метрики состояния кеша включают:
- NetworkBandwidthOutAllowanceExceeded: сетевые пакеты были потеряны из-за превышения агрегированного лимита пропускной способности. Это полезно для диагностики узких мест в конфигурации кеша.
- EngineCPUUtilization: использование ЦП (в процентах), выделенное процессу Redis. Это полезно для диагностики узких мест в конфигурации кеша.
Метрики будут регистрироваться по идентификатору API. Вы можете установить значение на ENABLED или DISABLED .
Возможные значения:
ENABLEDDISABLED
--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 (строка)
Файл сертификата корневого центра для проверки сертификатов 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 для вывода.
--cli-auto-prompt (булево)
Автоматически запрашивать параметры ввода CLI.
--no-cli-auto-prompt (булево)
Отключить автоматическое запроса параметров ввода CLI.
Вывод
apiCache -> (структура)
Объект ApiCache.
ttl -> (целое число)
Срок жизни (TTL) в секундах для записей кеша.
Допустимые значения: от 1 до 3600 секунд.
apiCachingBehavior -> (строка)
Поведение кеширования.
- FULL_REQUEST_CACHING : Все запросы от одного пользователя кешируются. Индивидуальные разрешающие функции автоматически кешируются. Все вызовы API будут пытаться вернуть ответы из кеша.
- PER_RESOLVER_CACHING : Кешируются только те разрешающие функции, которые вы указали.
- OPERATION_LEVEL_CACHING : Полные запросы кешируются вместе и возвращаются без выполнения разрешающих функций.
transitEncryptionEnabled -> (булево)
atRestEncryptionEnabled -> (булево)
type -> (строка)
Тип экземпляра кеша. Допустимые значения:
SMALLMEDIUMLARGEXLARGELARGE_2XLARGE_4X-
LARGE_8X(недоступно во всех регионах) LARGE_12X
Исторически типы экземпляров обозначались значениями в стиле EC2. Начиная с июля 2020 года, это устарело, и следует использовать приведенные выше общие идентификаторы.
Следующие устаревшие типы экземпляров доступны, но их использование не рекомендуется:
- T2_SMALL : Тип экземпляра t2.small.
- T2_MEDIUM : Тип экземпляра t2.medium.
- R4_LARGE : Тип экземпляра r4.large.
- R4_XLARGE : Тип экземпляра r4.xlarge.
- R4_2XLARGE : Тип экземпляра r4.2xlarge.
- R4_4XLARGE : Тип экземпляра r4.4xlarge.
- R4_8XLARGE : Тип экземпляра r4.8xlarge.
status -> (строка)
Статус экземпляра кеша.
- ДОСТУПНО : Экземпляр доступен для использования.
- СОЗДАЕТСЯ : Экземпляр в процессе создания.
- УДАЛЯЕТСЯ : Экземпляр в процессе удаления.
- ИЗМЕНЯЕТСЯ : Экземпляр в процессе изменения.
- ОШИБКА : Создание экземпляра завершилось с ошибкой.
healthMetricsConfig -> (строка)
Управляет тем, как метрики состояния кеша будут отправляться в CloudWatch. Метрики состояния кеша включают:
- NetworkBandwidthOutAllowanceExceeded: сетевые пакеты были потеряны из-за превышения агрегированного лимита пропускной способности. Это полезно для диагностики узких мест в конфигурации кеша.
- EngineCPUUtilization: использование ЦП (в процентах), выделенное процессу Redis. Это полезно для диагностики узких мест в конфигурации кеша.
Метрики будут регистрироваться по идентификатору API. Вы можете установить значение на ENABLED или DISABLED .
© Copyright 2025, Amazon Web Services. Created using Sphinx.
|
|