Spec-Zone.ru › AWS CLI v2

[ aws . lightsail ]

обновить-распределение

Описание

Обновляет существующее распределение сети доставки содержимого (CDN) Amazon Lightsail.

Используйте этот параметр для обновления конфигурации существующего распределения.

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

Синтаксис

  update-distribution
--distribution-name <value>
[--origin <value>]
[--default-cache-behavior <value>]
[--cache-behavior-settings <value>]
[--cache-behaviors <value>]
[--is-enabled | --no-is-enabled]
[--viewer-minimum-tls-protocol-version <value>]
[--certificate-name <value>]
[--use-default-certificate | --no-use-default-certificate]
[--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]

Параметры

--distribution-name (строка)

Имя распределения, которое нужно обновить.

Используйте действие GetDistributions, чтобы получить список имён распределений, которые вы можете указать.

--origin (структура)

Объект, описывающий исходный ресурс для распределения, например, экземпляр Lightsail, ведро или балансировщик нагрузки.

Распределение извлекает, кеширует и предоставляет контент из источника.

name -> (строка)

Имя исходного ресурса.

regionName -> (строка)

Имя AWS региона исходного ресурса.

protocolPolicy -> (строка)

Протокол, который использует ваше Amazon Lightsail-распределение при установлении соединения с источником для извлечения контента.

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

Время в секундах, которое распределение ожидает ответа после перенаправления запроса к источнику. Минимальное время ожидания — 1 секунда, максимальное — 60 секунд, по умолчанию (если вы не укажете другое) — 30 секунд.

Краткая запись:

name=string,regionName=string,protocolPolicy=string,responseTimeout=integer

Формат JSON:

{
  "name": "string",
  "regionName": "us-east-1"|"us-east-2"|"us-west-1"|"us-west-2"|"eu-west-1"|"eu-west-2"|"eu-west-3"|"eu-central-1"|"ca-central-1"|"ap-south-1"|"ap-southeast-1"|"ap-southeast-2"|"ap-northeast-1"|"ap-northeast-2"|"eu-north-1",
  "protocolPolicy": "http-only"|"https-only",
  "responseTimeout": integer
}

--default-cache-behavior (структура)

Объект, описывающий поведение кеширования по умолчанию для распределения.

behavior -> (строка)

Поведение кеширования распределения.

Можно указать следующие поведения кеширования:

  • **cache ** — Этот вариант лучше всего подходит для статических сайтов. При указании этого параметра ваше распределение кеширует и предоставляет весь ваш сайт как статический контент. Это поведение идеально подходит для сайтов со статическим контентом, который не меняется в зависимости от пользователя, или для сайтов, которые не используют куки, заголовки или строки запроса для персонализации контента.
  • **dont-cache ** — Этот вариант лучше всего подходит для сайтов, которые предоставляют смесь статического и динамического контента. При указании этого параметра ваше распределение кеширует и предоставляет только тот контент, который указан в параметре CacheBehaviorPerPath распределения. Это поведение идеально подходит для веб-сайтов или веб-приложений, которые используют куки, заголовки и строки запроса для персонализации контента для каждого пользователя.

Краткая запись:

behavior=string

Формат JSON:

{
  "behavior": "dont-cache"|"cache"
}

--cache-behavior-settings (структура)

Объект, описывающий параметры поведения кеширования для распределения.

Примечание

Значение cacheBehaviorSettings, указанное в вашем UpdateDistributionRequest, заменит существующие параметры распределения.

defaultTTL -> (длинное целое число)

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

Примечание

Указанное значение применяется только в том случае, если источник не добавляет HTTP-заголовки, такие как Cache-Control max-age, Cache-Control s-maxage и Expires, к объектам.

minimumTTL -> (длинное целое число)

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

Значение 0 должно быть указано для minimumTTL, если распределение настроено на пересылку всех заголовков источнику.

maximumTTL -> (длинное целое число)

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

Указанное значение применяется только в том случае, если источник добавляет HTTP-заголовки, такие как Cache-Control max-age, Cache-Control s-maxage и Expires, к объектам.

allowedHTTPMethods -> (строка)

HTTP-методы, которые обрабатываются и пересылаются к источнику распределения.

Вы можете указать следующие варианты:

  • GET,HEAD — Распределение пересылает методы GET и HEAD.
  • GET,HEAD,OPTIONS — Распределение пересылает методы GET, HEAD и OPTIONS.
  • GET,HEAD,OPTIONS,PUT,PATCH,POST,DELETE — Распределение пересылает методы GET, HEAD, OPTIONS, PUT, PATCH, POST и DELETE.

Если вы укажете третий вариант, вам может потребоваться ограничить доступ к источнику вашего распределения, чтобы пользователи не могли выполнять операции, которые вы не хотите выполнять. Например, вы можете не захотеть, чтобы пользователи имели разрешение на удаление объектов из вашего источника.

cachedHTTPMethods -> (строка)

HTTP-методы ответов, которые кэшируются вашим распределением.

Вы можете указать следующие варианты:

  • GET,HEAD — Распределение кэширует ответы на методы GET и HEAD.
  • GET,HEAD,OPTIONS — Распределение кэширует ответы на методы GET, HEAD и OPTIONS.

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

Объект, описывающий куки, которые пересылаются источнику. Ваш контент кэшируется на основе пересылаемых куки.

option -> (строка)

Указывает, какие куки пересылать источнику распределения: all, none или allow-list, чтобы пересылать только куки, указанные в параметре cookiesAllowList.

cookiesAllowList -> (список)

Конкретные куки, которые пересылаются источнику вашего распределения.

(строка)

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

Объект, описывающий заголовки, которые пересылаются источнику. Ваш контент кэшируется на основе пересылаемых заголовков.

option -> (строка)

Заголовки, которые вы хотите, чтобы ваше распределение пересылало своему источнику и на основе которых основывать кеширование.

Вы можете настроить распределение, выполнив одно из следующих действий:

  • **all ** — Пересылать все заголовки в источник.
  • **none ** — Пересылать только стандартные заголовки.
  • **allow-list ** — Пересылать только указанные вами заголовки с помощью параметра headersAllowList.

headersAllowList -> (список)

Конкретные заголовки, которые пересылаются источнику вашего распределения.

(строка)

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

Объект, описывающий строки запроса, которые пересылаются в источник. Ваш контент кэшируется на основе пересылаемых строк запроса.

option -> (булево)

Указывает, пересылает ли распределение и кэширует ли на основе строк запроса.

queryStringsAllowList -> (список)

Конкретные строки запроса, которые распределение пересылает источнику.

Ваше распределение будет кэшировать контент на основе указанных строк запроса.

Если параметр option имеет значение true, то ваше распределение пересылает все строки запроса независимо от того, что вы указали с помощью параметра queryStringsAllowList.

(строка)

Краткая запись:

defaultTTL=long,minimumTTL=long,maximumTTL=long,allowedHTTPMethods=string,cachedHTTPMethods=string,forwardedCookies={option=string,cookiesAllowList=[string,string]},forwardedHeaders={option=string,headersAllowList=[string,string]},forwardedQueryStrings={option=boolean,queryStringsAllowList=[string,string]}

Формат JSON:

{
  "defaultTTL": long,
  "minimumTTL": long,
  "maximumTTL": long,
  "allowedHTTPMethods": "string",
  "cachedHTTPMethods": "string",
  "forwardedCookies": {
    "option": "none"|"allow-list"|"all",
    "cookiesAllowList": ["string", ...]
  },
  "forwardedHeaders": {
    "option": "none"|"allow-list"|"all",
    "headersAllowList": ["Accept"|"Accept-Charset"|"Accept-Datetime"|"Accept-Encoding"|"Accept-Language"|"Authorization"|"CloudFront-Forwarded-Proto"|"CloudFront-Is-Desktop-Viewer"|"CloudFront-Is-Mobile-Viewer"|"CloudFront-Is-SmartTV-Viewer"|"CloudFront-Is-Tablet-Viewer"|"CloudFront-Viewer-Country"|"Host"|"Origin"|"Referer", ...]
  },
  "forwardedQueryStrings": {
    "option": true|false,
    "queryStringsAllowList": ["string", ...]
  }
}

--cache-behaviors (список)

Массив объектов, описывающих поведение кеширования по каждой траектории для распределения.

(структура)

Описывает поведение кеширования по каждой траектории для Amazon Lightsail-распределения CDN.

Поведение кеширования по каждой траектории используется для переопределения или добавления исключения к поведению кеширования по умолчанию для распределения. Например, если cacheBehavior установлено в cache, то поведение кеширования по каждой траектории может использоваться для указания каталога, файла или типа файла, который ваше распределение будет кэшировать. В противном случае, если cacheBehavior распределения установлено в dont-cache, то поведение кеширования по каждой траектории может использоваться для указания каталога, файла или типа файла, который ваше распределение не будет кэшировать.

path -> (строка)

Путь к каталогу или файлу, который будет кэшироваться или не кэшироваться. Используйте символ звездочки для указания каталогов-подстановок (path/to/assets/*) и типов файлов (*.html, *jpg, *js). Каталоги и пути к файлам чувствительны к регистру.

Примеры:

  • Укажите следующее, чтобы кэшировать все файлы в корневом каталоге веб-сервера Apache, работающего на экземпляре Lightsail. var/www/html/
  • Укажите следующий файл, чтобы кэшировать только страницу index в корневом каталоге веб-сервера Apache. var/www/html/index.html
  • Укажите следующее, чтобы кэшировать только файлы .html в корневом каталоге веб-сервера Apache. var/www/html/*.html
  • Укажите следующее, чтобы кэшировать только файлы .jpg, .png и .gif в подкаталоге images корневого каталога веб-сервера Apache. var/www/html/images/*.jpg var/www/html/images/*.png var/www/html/images/*.gif Укажите следующее, чтобы кэшировать все файлы в подкаталоге images корневого каталога веб-сервера Apache. var/www/html/images/

behavior -> (строка)

Поведение кеширования для указанного пути.

Вы можете указать одно из следующих поведений кеширования по каждой траектории:

  • **cache ** — Это поведение кэширует указанный путь.
  • **dont-cache ** — Это поведение не кэширует указанный путь.

Краткая запись:

path=string,behavior=string ...

Формат JSON:

[
  {
    "path": "string",
    "behavior": "dont-cache"|"cache"
  }
  ...
]

--is-enabled | --no-is-enabled (булево)

Указывает, включить ли распределение.

--viewer-minimum-tls-protocol-version (строка)

Используйте этот параметр для обновления минимальной версии TLS-протокола для сертификата SSL/TLS, прикреплённого к распределению.

Возможные значения:

  • TLSv1.1_2016
  • TLSv1.2_2018
  • TLSv1.2_2019
  • TLSv1.2_2021

--certificate-name (строка)

Имя сертификата SSL/TLS, который вы хотите прикрепить к распределению.

Только сертификаты со статусом ISSUED могут быть прикреплены к распределению.

Используйте действие GetCertificates, чтобы получить список имён сертификатов, которые вы можете указать.

--use-default-certificate | --no-use-default-certificate (boolean)

Указывает, прикреплен ли к распространению сертификат SSL/TLS по умолчанию. Значение по умолчанию — true. При значении true распространение использует имя домена по умолчанию, например, d111111abcdef8.cloudfront.net.

Установите это значение в false, чтобы прикрепить новый сертификат к распространению.

--cli-input-json | --cli-input-yaml (string) Читает аргументы из предоставленной JSON-строки. JSON-строка следует формату, предоставленному --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения переопределят значения, предоставленные JSON. Невозможно передать произвольные двоичные значения с помощью значения, предоставленного JSON, так как строка будет взята буквально. Это может не быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (string) Выводит JSON-скелет в стандартный вывод без отправки запроса API. Если предоставлено значение по умолчанию или значение input, выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено значение yaml-input, будет выведен пример входного YAML, который можно использовать с --cli-input-yaml. Если предоставлено значение output, выполняется валидация входных данных команд и возвращается пример выходного JSON для этой команды. Сгенерированный JSON-скелет нестабилен между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.

Глобальные параметры

--debug (boolean)

Включить отладочную запись в журнал.

--endpoint-url (string)

Переопределить URL по умолчанию команды заданным URL.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого соединения SSL AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет поведение проверки сертификатов SSL по умолчанию.

--no-paginate (boolean)

Отключить автоматическую постраничность. Если автоматическая постраничность отключена, AWS CLI сделает только один вызов для первой страницы результатов.

--output (string)

Стиль форматирования для вывода команды.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

Запрос JMESPath для использования при фильтрации данных ответа.

--profile (string)

Использовать определенный профиль из файла с учетными данными.

--region (string)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (string)

Показать версию этого инструмента.

--color (string)

Включить/выключить цветной вывод.

  • on
  • off
  • auto

--no-sign-request (boolean)

Не подписывать запросы. Учетные данные не будут загружаться, если этот аргумент предоставлен.

--ca-bundle (string)

Набор сертификатов CA для использования при проверке сертификатов SSL. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.

--cli-binary-format (string)

Стиль форматирования, который следует использовать для двоичных блоков. Формат по умолчанию — 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 (boolean)

Отключить пейджер cli для вывода.

--cli-auto-prompt (boolean)

Автоматически запрашивать параметры входных данных CLI.

--no-cli-auto-prompt (boolean)

Отключить автоматическое запросы параметров входных данных CLI.

Вывод

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

Массив объектов, описывающих результат действия, например, статус запроса, метка времени запроса и ресурсы, затронутые запросом.

id -> (строка)

Идентификатор операции.

resourceName -> (строка)

Имя ресурса.

resourceType -> (строка)

Тип ресурса.

createdAt -> (метка времени)

Метка времени, когда была инициирована операция (1479816991.349).

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

Регион и зона доступности Amazon Web Services.

availabilityZone -> (строка)

Зона доступности. Следует формату us-east-2a (регистрозависимый).

regionName -> (строка)

Имя региона Amazon Web Services.

isTerminal -> (boolean)

Булево значение, указывающее, является ли операция терминальной.

operationDetails -> (строка)

Подробности об операции (Debian-1GB-Ohio-1).

operationType -> (строка)

Тип операции.

status -> (строка)

Статус операции.

statusChangedAt -> (метка времени)

Метка времени, когда был изменен статус (1479816991.349).

errorCode -> (строка)

Код ошибки.

errorDetails -> (строка)

Подробности об ошибке.

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

Spec-Zone.ru

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