create-cache-policy

Описание

Создаёт политику кэширования.

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

Значения, которые CloudFront включает в ключ кэша. Эти значения могут включать HTTP-заголовки, куки и строки запроса URL. CloudFront использует ключ кэша, чтобы найти объект в своём кэше, который он может вернуть просматривающему.
Значения по умолчанию, минимальное и максимальное время жизни (TTL), которые вы хотите, чтобы объекты хранились в кэше CloudFront.

Заголовки, куки и строки запроса, которые включены в ключ кэша, также включены в запросы, которые CloudFront отправляет источнику. CloudFront отправляет запрос, когда не может найти объект в своём кэше, соответствующий ключу кэша запроса. Если вы хотите отправить значения источнику, но не включать их в ключ кэша, используйте OriginRequestPolicy.

Дополнительную информацию о политиках кэширования см. в Руководстве разработчика Amazon CloudFront в разделе Управление ключом кэша.

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

Синопсис

  create-cache-policy
--cache-policy-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]

Параметры

--cache-policy-config (structure)

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

Comment -> (string)

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

Name -> (string)

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

DefaultTTL -> (long)

Время по умолчанию в секундах, в течение которого объекты должны оставаться в кеше CloudFront, прежде чем CloudFront отправит другой запрос к источнику, чтобы увидеть, был ли объект обновлен. CloudFront использует это значение в качестве времени жизни объекта (TTL), только если источник не отправляет заголовки Cache-Control или Expires с объектом. Для получения дополнительной информации см. раздел Managing How Long Content Stays in an Edge Cache (Expiration) в Amazon CloudFront Developer Guide .

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

MaxTTL -> (long)

Максимальное время в секундах, в течение которого объекты остаются в кеше CloudFront, прежде чем CloudFront отправит другой запрос к источнику, чтобы увидеть, был ли объект обновлен. CloudFront использует это значение, только когда источник отправляет заголовки Cache-Control или Expires с объектом. Для получения дополнительной информации см. раздел Managing How Long Content Stays in an Edge Cache (Expiration) в Amazon CloudFront Developer Guide .

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

MinTTL -> (long)

Минимальное время в секундах, в течение которого объекты должны оставаться в кеше CloudFront, прежде чем CloudFront отправит другой запрос к источнику, чтобы увидеть, был ли объект обновлен. Для получения дополнительной информации см. раздел Managing How Long Content Stays in an Edge Cache (Expiration) в Amazon CloudFront Developer Guide .

ParametersInCacheKeyAndForwardedToOrigin -> (structure)

Заголовки HTTP, файлы cookie и строки запросов URL для включения в ключ кэша. Значения, включенные в ключ кэша, также включаются в запросы, которые CloudFront отправляет в источник.

EnableAcceptEncodingGzip -> (boolean)

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

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

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

Для получения дополнительной информации см. Compression support в Amazon CloudFront Developer Guide .

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

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

EnableAcceptEncodingBrotli -> (boolean)

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

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

Для получения дополнительной информации см. Compression support в Amazon CloudFront Developer Guide .

HeadersConfig -> (structure)

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

HeaderBehavior -> (string)

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

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

Headers -> (structure)

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

Quantity -> (integer)

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

Items -> (list)

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

(string)

CookiesConfig -> (structure)

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

CookieBehavior -> (string)

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

none – никакие файлы cookie в запросах зрителей не включаются в ключ кэша или в запросы, которые CloudFront отправляет в источник. Даже если это поле установлено в значение none , любые файлы cookie, перечисленные в OriginRequestPolicy , включаются в запросы к источнику.
whitelist – только файлы cookie в запросах зрителей, перечисленные в типе CookieNames , включаются в ключ кэша и в запросы, которые CloudFront отправляет в источник.
allExcept – все файлы cookie в запросах зрителей включаются в ключ кэша и в запросы, которые CloudFront отправляет в источник, * за исключением * тех, которые перечислены в типе CookieNames , которые не включаются.
all – все файлы cookie в запросах зрителей включаются в ключ кэша и в запросы, которые CloudFront отправляет в источник.

Cookies -> (structure)

Содержит список имен файлов cookie.

Quantity -> (integer)

Количество имен файлов cookie в списке Items .

Items -> (list)

Список имен файлов cookie.

(string)

QueryStringsConfig -> (structure)

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

QueryStringBehavior -> (string)

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

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

QueryStrings -> (structure)

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

Quantity -> (integer)

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

Items -> (list)

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

(string)

Синтаксис JSON:

{
  "Comment": "string",
  "Name": "string",
  "DefaultTTL": long,
  "MaxTTL": long,
  "MinTTL": long,
  "ParametersInCacheKeyAndForwardedToOrigin": {
    "EnableAcceptEncodingGzip": true|false,
    "EnableAcceptEncodingBrotli": true|false,
    "HeadersConfig": {
      "HeaderBehavior": "none"|"whitelist",
      "Headers": {
        "Quantity": integer,
        "Items": ["string", ...]
      }
    },
    "CookiesConfig": {
      "CookieBehavior": "none"|"whitelist"|"allExcept"|"all",
      "Cookies": {
        "Quantity": integer,
        "Items": ["string", ...]
      }
    },
    "QueryStringsConfig": {
      "QueryStringBehavior": "none"|"whitelist"|"allExcept"|"all",
      "QueryStrings": {
        "Quantity": integer,
        "Items": ["string", ...]
      }
    }
  }
}

--cli-input-json | --cli-input-yaml (string) Читает аргументы из предоставленной строки 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.

Output

CachePolicy -> (structure)

A cache policy.

Id -> (string)

The unique identifier for the cache policy.

LastModifiedTime -> (timestamp)

The date and time when the cache policy was last modified.

CachePolicyConfig -> (structure)

The cache policy configuration.

Comment -> (string)

A comment to describe the cache policy. The comment cannot be longer than 128 characters.

Name -> (string)

A unique name to identify the cache policy.

DefaultTTL -> (long)

The default amount of time, in seconds, that you want objects to stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. CloudFront uses this value as the object’s time to live (TTL) only when the origin does not send Cache-Control or Expires headers with the object. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .

The default value for this field is 86400 seconds (one day). If the value of MinTTL is more than 86400 seconds, then the default value for this field is the same as the value of MinTTL .

MaxTTL -> (long)

The maximum amount of time, in seconds, that objects stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. CloudFront uses this value only when the origin sends Cache-Control or Expires headers with the object. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .

The default value for this field is 31536000 seconds (one year). If the value of MinTTL or DefaultTTL is more than 31536000 seconds, then the default value for this field is the same as the value of DefaultTTL .

MinTTL -> (long)

The minimum amount of time, in seconds, that you want objects to stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .

ParametersInCacheKeyAndForwardedToOrigin -> (structure)

The HTTP headers, cookies, and URL query strings to include in the cache key. The values included in the cache key are also included in requests that CloudFront sends to the origin.

EnableAcceptEncodingGzip -> (boolean)

A flag that can affect whether the Accept-Encoding HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.

This field is related to the EnableAcceptEncodingBrotli field. If one or both of these fields is true and the viewer request includes the Accept-Encoding header, then CloudFront does the following:

Normalizes the value of the viewer’s Accept-Encoding header
Includes the normalized header in the cache key
Includes the normalized header in the request to the origin, if a request is necessary

For more information, see Compression support in the Amazon CloudFront Developer Guide .

If you set this value to true , and this cache behavior also has an origin request policy attached, do not include the Accept-Encoding header in the origin request policy. CloudFront always includes the Accept-Encoding header in origin requests when the value of this field is true , so including this header in an origin request policy has no effect.

If both of these fields are false , then CloudFront treats the Accept-Encoding header the same as any other HTTP header in the viewer request. By default, it’s not included in the cache key and it’s not included in origin requests. In this case, you can manually add Accept-Encoding to the headers whitelist like any other HTTP header.

EnableAcceptEncodingBrotli -> (boolean)

A flag that can affect whether the Accept-Encoding HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.

This field is related to the EnableAcceptEncodingGzip field. If one or both of these fields is true and the viewer request includes the Accept-Encoding header, then CloudFront does the following:

Normalizes the value of the viewer’s Accept-Encoding header
Includes the normalized header in the cache key
Includes the normalized header in the request to the origin, if a request is necessary

For more information, see Compression support in the Amazon CloudFront Developer Guide .

HeadersConfig -> (structure)

An object that determines whether any HTTP headers (and if so, which headers) are included in the cache key and in requests that CloudFront sends to the origin.

HeaderBehavior -> (string)

Determines whether any HTTP headers are included in the cache key and in requests that CloudFront sends to the origin. Valid values are:

none – No HTTP headers are included in the cache key or in requests that CloudFront sends to the origin. Even when this field is set to none , any headers that are listed in an OriginRequestPolicy are included in origin requests.
whitelist – Only the HTTP headers that are listed in the Headers type are included in the cache key and in requests that CloudFront sends to the origin.

Headers -> (structure)

Contains a list of HTTP header names.

Quantity -> (integer)

The number of header names in the Items list.

Items -> (list)

A list of HTTP header names.

(string)

CookiesConfig -> (structure)

An object that determines whether any cookies in viewer requests (and if so, which cookies) are included in the cache key and in requests that CloudFront sends to the origin.

CookieBehavior -> (string)

Determines whether any cookies in viewer requests are included in the cache key and in requests that CloudFront sends to the origin. Valid values are:

none – No cookies in viewer requests are included in the cache key or in requests that CloudFront sends to the origin. Even when this field is set to none , any cookies that are listed in an OriginRequestPolicy are included in origin requests.
whitelist – Only the cookies in viewer requests that are listed in the CookieNames type are included in the cache key and in requests that CloudFront sends to the origin.
allExcept – All cookies in viewer requests are included in the cache key and in requests that CloudFront sends to the origin, * except * for those that are listed in the CookieNames type, which are not included.
all – All cookies in viewer requests are included in the cache key and in requests that CloudFront sends to the origin.

Cookies -> (structure)

Contains a list of cookie names.

Quantity -> (integer)

The number of cookie names in the Items list.

Items -> (list)

A list of cookie names.

(string)

QueryStringsConfig -> (structure)

An object that determines whether any URL query strings in viewer requests (and if so, which query strings) are included in the cache key and in requests that CloudFront sends to the origin.

QueryStringBehavior -> (string)

Determines whether any URL query strings in viewer requests are included in the cache key and in requests that CloudFront sends to the origin. Valid values are:

none – No query strings in viewer requests are included in the cache key or in requests that CloudFront sends to the origin. Even when this field is set to none , any query strings that are listed in an OriginRequestPolicy are included in origin requests.
whitelist – Only the query strings in viewer requests that are listed in the QueryStringNames type are included in the cache key and in requests that CloudFront sends to the origin.
allExcept – All query strings in viewer requests are included in the cache key and in requests that CloudFront sends to the origin, * except * those that are listed in the QueryStringNames type, which are not included.
all – All query strings in viewer requests are included in the cache key and in requests that CloudFront sends to the origin.

QueryStrings -> (structure)

Contains the specific query strings in viewer requests that either * are * or * are not * included in the cache key and in requests that CloudFront sends to the origin. The behavior depends on whether the QueryStringBehavior field in the CachePolicyQueryStringsConfig type is set to whitelist (the listed query strings * are * included) or allExcept (the listed query strings * are not * included, but all other query strings are).

Quantity -> (integer)

The number of query string names in the Items list.

Items -> (list)

A list of query string names.

(string)

Location -> (string)

The fully qualified URI of the cache policy just created.

ETag -> (string)

The current version of the cache policy.