создать-кэш-api
Описание
Создаёт кэш для GraphQL API.
См. также: Документацию AWS API
Синтаксис
create-api-cache
--api-id <value>
--ttl <value>
[--transit-encryption-enabled | --no-transit-encryption-enabled]
[--at-rest-encryption-enabled | --no-at-rest-encryption-enabled]
--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 секунд.
--transit-encryption-enabled | --no-transit-encryption-enabled (логическое значение)
--at-rest-encryption-enabled | --no-at-rest-encryption-enabled (логическое значение)
--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
- 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 версии 1, и двоичные значения должны быть предоставлены буквально. При предоставлении содержимого из файла, которое соответствует двоичному блоку, 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.
Вывод
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 -> (строка)
Статус экземпляра кэша.
- AVAILABLE : Экземпляр доступен для использования.
- CREATING : Экземпляр в процессе создания.
- DELETING : Экземпляр в процессе удаления.
- MODIFYING : Экземпляр в процессе изменения.
- FAILED : Экземпляр не был создан.
healthMetricsConfig -> (строка)
Управляет тем, как метрики состояния кэша будут отправляться в CloudWatch. Метрики состояния кэша включают:
- NetworkBandwidthOutAllowanceExceeded: сетевые пакеты были потеряны из-за превышения агрегированного лимита пропускной способности. Это полезно для диагностики узких мест в конфигурации кэша.
- EngineCPUUtilization: использование ЦП (в процентах), выделенное процессу Redis. Это полезно для диагностики узких мест в конфигурации кэша.
Метрики будут регистрироваться по идентификатору API. Вы можете установить значение на ENABLED или DISABLED.
© Copyright 2025, Amazon Web Services. Created using Sphinx.