Spec-Zone.ru › AWS CLI v2

[ aws . cloudfront ]

get-cache-policy-config

Описание

Получает конфигурацию политики кэширования.

Для получения конфигурации политики кэширования необходимо указать идентификатор политики. Если политика кэширования прикреплена к поведению кэширования распределения, вы можете получить идентификатор политики, используя ListDistributions или GetDistribution. Если политика кэширования не прикреплена к поведению кэширования, вы можете получить идентификатор, используя ListCachePolicies.

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

Синтаксис

  get-cache-policy-config
--id <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]

Параметры

--id (строка)

Уникальный идентификатор политики кэширования. Если политика кэширования прикреплена к поведению кэширования распределения, вы можете получить идентификатор политики, используя ListDistributions или GetDistribution. Если политика кэширования не прикреплена к поведению кэширования, вы можете получить идентификатор, используя ListCachePolicies.

--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.

Вывод

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

Конфигурация политики кэширования.

Комментарий -> (строка)

Комментарий для описания политики кэширования. Комментарий не должен превышать 128 символов.

Имя -> (строка)

Уникальное имя для идентификации политики кэширования.

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

Время в секундах, в течение которого объекты хранятся в кэше CloudFront до отправки нового запроса к источнику, чтобы проверить, обновлялся ли объект. CloudFront использует это значение как срок хранения (TTL) только тогда, когда источник *не* отправляет заголовки Cache-Control или Expires вместе с объектом. Дополнительную информацию см. в разделе «Управление сроком хранения контента в кэше на краю (Срок действия)» в руководстве разработчика Amazon CloudFront.

Значение по умолчанию для этого поля — 86400 секунд (один день). Если значение MinTTL больше 86400 секунд, то значение по умолчанию для этого поля равно значению MinTTL.

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

Максимальное время в секундах, в течение которого объекты хранятся в кэше CloudFront до отправки нового запроса к источнику, чтобы проверить, обновлялся ли объект. CloudFront использует это значение только тогда, когда источник отправляет заголовки Cache-Control или Expires вместе с объектом. Дополнительную информацию см. в разделе «Управление сроком хранения контента в кэше на краю (Срок действия)» в руководстве разработчика Amazon CloudFront.

Значение по умолчанию для этого поля — 31536000 секунд (один год). Если значение MinTTL или DefaultTTL больше 31536000 секунд, то значение по умолчанию для этого поля равно значению DefaultTTL.

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

Минимальное время в секундах, в течение которого вы хотите, чтобы объекты оставались в кэше CloudFront перед тем, как CloudFront отправит другой запрос к источнику, чтобы узнать, был ли объект обновлён. Дополнительную информацию см. в разделе «Управление сроком хранения контента в кэше на краю (Срок действия)» в руководстве разработчика Amazon CloudFront.

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

HTTP-заголовки, куки и параметры запроса URL, которые нужно включить в ключ кэша. Значения, включённые в ключ кэша, также включаются в запросы, которые CloudFront отправляет источнику.

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

Флаг, влияющий на включение HTTP-заголовка Accept-Encoding в ключ кэша и в запросы, которые CloudFront отправляет источнику.

Это поле связано с полем EnableAcceptEncodingBrotli. Если одно или оба из этих полей равны true, *и* запрос пользователя включает заголовок Accept-Encoding, CloudFront выполняет следующие действия:

  • Нормализует значение заголовка Accept-Encoding пользователя.
  • Включает нормализованный заголовок в ключ кэша.
  • Включает нормализованный заголовок в запрос к источнику, если запрос необходим.

Дополнительную информацию см. в разделе «Поддержка сжатия» в руководстве разработчика Amazon CloudFront.

Если вы установите это значение в true, и к этому поведению кэша также прикреплена политика запроса к источнику, не включайте заголовок Accept-Encoding в политику запроса к источнику. CloudFront всегда включает заголовок Accept-Encoding в запросы к источнику, когда значение этого поля равно true, поэтому включение этого заголовка в политику запроса к источнику не повлияет на результат.

Если оба этих поля равны false, CloudFront обрабатывает заголовок Accept-Encoding так же, как любой другой HTTP-заголовок в запросе пользователя. По умолчанию он не включается в ключ кэша и не включается в запросы к источнику. В этом случае вы можете вручную добавить Accept-Encoding в белый список заголовков, как любой другой HTTP-заголовок.

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

Флаг, влияющий на включение HTTP-заголовка Accept-Encoding в ключ кэша и в запросы, которые CloudFront отправляет источнику.

Это поле связано с полем EnableAcceptEncodingGzip. Если одно или оба из этих полей равны true, *и* запрос пользователя включает заголовок Accept-Encoding, CloudFront выполняет следующие действия:

  • Нормализует значение заголовка Accept-Encoding пользователя.
  • Включает нормализованный заголовок в ключ кэша.
  • Включает нормализованный заголовок в запрос к источнику, если запрос необходим.

Дополнительную информацию см. в разделе «Поддержка сжатия» в руководстве разработчика Amazon CloudFront.

Если вы установите это значение в true, и к этому поведению кэша также прикреплена политика запроса к источнику, не включайте заголовок Accept-Encoding в политику запроса к источнику. CloudFront всегда включает заголовок Accept-Encoding в запросы к источнику, когда значение этого поля равно true, поэтому включение этого заголовка в политику запроса к источнику не повлияет на результат.

Если оба этих поля равны false, CloudFront обрабатывает заголовок Accept-Encoding так же, как любой другой HTTP-заголовок в запросе пользователя. По умолчанию он не включается в ключ кэша и не включается в запросы к источнику. В этом случае вы можете вручную добавить Accept-Encoding в белый список заголовков, как любой другой HTTP-заголовок.

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

Объект, определяющий, включать ли HTTP-заголовки (и если да, то какие) в ключ кэша и в запросы, которые CloudFront отправляет источнику.

HeaderBehavior -> (строка)

Определяет, включать ли HTTP-заголовки в ключ кэша и в запросы, которые CloudFront отправляет источнику. Допустимые значения:

  • none — HTTP-заголовки не включаются в ключ кэша или в запросы, которые CloudFront отправляет источнику. Даже когда это поле установлено в значение none, любые заголовки, указанные в списке OriginRequestPolicy, *включаются* в запросы к источнику.
  • whitelist — В ключ кэша и в запросы, которые CloudFront отправляет источнику, включаются только HTTP-заголовки, указанные в списке типа Headers.

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

Содержит список имён HTTP-заголовков.

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

Количество имён заголовков в списке Items.

Items -> (список)

Список имён HTTP-заголовков.

(строка)

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

Объект, определяющий, включать ли куки из запросов пользователей (и если да, то какие) в ключ кэша и в запросы, которые CloudFront отправляет источнику.

CookieBehavior -> (строка)

Определяет, включать ли куки из запросов пользователей в ключ кэша и в запросы, которые CloudFront отправляет источнику. Допустимые значения:

  • none — Куки из запросов пользователей не включаются в ключ кэша или в запросы, которые CloudFront отправляет источнику. Даже когда это поле установлено в значение none, любые куки, указанные в списке OriginRequestPolicy, *включаются* в запросы к источнику.
  • whitelist — В ключ кэша и в запросы, которые CloudFront отправляет источнику, включаются только куки из запросов пользователей, указанные в списке типа CookieNames.
  • allExcept — Все куки из запросов пользователей включаются в ключ кэша и в запросы, которые CloudFront отправляет источнику, *исключая* те, что указаны в списке типа CookieNames.
  • all — Все куки из запросов пользователей включаются в ключ кэша и в запросы, которые CloudFront отправляет источнику.

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

Содержит список имён куки.

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

Количество имён куки в списке Items.

Items -> (список)

Список имён куки.

(строка)

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

Объект, определяющий, включать ли параметры URL-запроса из запросов пользователей (и если да, то какие) в ключ кэша и в запросы, которые CloudFront отправляет источнику.

QueryStringBehavior -> (строка)

Определяет, включать ли параметры URL-запроса из запросов пользователей в ключ кэша и в запросы, которые CloudFront отправляет источнику. Допустимые значения:

  • none — Параметры запроса из запросов пользователей не включаются в ключ кэша или в запросы, которые CloudFront отправляет источнику. Даже когда это поле установлено в значение none, любые параметры запроса, указанные в списке OriginRequestPolicy, *включаются* в запросы к источнику.
  • whitelist — В ключ кэша и в запросы, которые CloudFront отправляет источнику, включаются только параметры запроса из запросов пользователей, указанные в списке типа QueryStringNames.
  • allExcept — Все параметры запроса из запросов пользователей включаются в ключ кэша и в запросы, которые CloudFront отправляет источнику, *исключая* те, что указаны в списке типа QueryStringNames.
  • all — Все параметры запроса из запросов пользователей включаются в ключ кэша и в запросы, которые CloudFront отправляет источнику.

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

Содержит конкретные параметры запроса из запросов пользователей, которые *включаются* или *не включаются* в ключ кэша и в запросы, которые CloudFront отправляет источнику. Поведение зависит от того, установлено ли поле QueryStringBehavior в типе CachePolicyQueryStringsConfig в значение whitelist (указанные параметры *включаются*) или allExcept (указанные параметры *не включаются*, но все остальные параметры включаются).

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

Количество имён параметров запроса в списке Items.

Items -> (список)

Список имён параметров запроса.

(строка)

ETag -> (строка)

Текущая версия политики кэширования.

© Copyright 2025, Amazon Web Services. Created using Sphinx.

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API