Spec-Zone.ru › AWS CLI v2

[ aws . cloudfront ]

update-distribution-tenant

Описание

Обновляет арендатора распределения.

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

Синтаксис

  update-distribution-tenant
--id <value>
[--distribution-id <value>]
[--domains <value>]
[--customizations <value>]
[--parameters <value>]
[--connection-group-id <value>]
--if-match <value>
[--managed-certificate-request <value>]
[--enabled | --no-enabled]
[--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 (строка)

Идентификатор арендатора распределения.

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

Идентификатор распределения для нескольких арендаторов.

--domains (список)

Домены для обновления арендатора распределения. Объект домена может содержать только свойство домена. Вы должны указать как минимум один домен. Каждый арендатор распределения может иметь до 5 доменов.

(структура)

Домен для указанного арендатора распределения.

Домен -> (строка)

Имя домена.

Сокращенный синтаксис:

Domain=string ...

Синтаксис JSON:

[
  {
    "Domain": "string"
  }
  ...
]

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

Настройки для арендатора распределения. Для каждого арендатора распределения можно указать географические ограничения и Amazon Resource Names (ARN) для сертификата ACM и WAF web ACL. Это специфические значения, которые можно переопределить или отключить для распределения для нескольких арендаторов, которое использовалось для создания арендатора распределения.

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

WAF web ACL.

Действие -> (строка)

Действие для настройки WAF web ACL. Можно указать override, чтобы указать отдельный WAF web ACL для арендатора распределения. Если вы укажете disable, у арендатора распределения не будет защиты WAF web ACL и он не будет наследовать настройки из распределения для нескольких арендаторов.

Arn -> (строка)

Amazon Resource Name (ARN) WAF web ACL.

Сертификат -> (структура)

Сертификат Certificate Manager (ACM).

Arn -> (строка)

Amazon Resource Name (ARN) сертификата ACM.

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

Географические ограничения.

RestrictionType -> (строка)

Метод ограничения распространения контента по странам:

  • none : Географические ограничения не включены, доступ к контенту не ограничен географическим местоположением клиента.
  • blacklist : Элементы Location указывают страны, в которых CloudFront не должен распространять контент.
  • whitelist : Элементы Location указывают страны, в которых CloudFront должен распространять контент.

Locations -> (список)

Местоположения для географических ограничений.

(строка)

Сокращенный синтаксис:

WebAcl={Action=string,Arn=string},Certificate={Arn=string},GeoRestrictions={RestrictionType=string,Locations=[string,string]}

Синтаксис JSON:

{
  "WebAcl": {
    "Action": "override"|"disable",
    "Arn": "string"
  },
  "Certificate": {
    "Arn": "string"
  },
  "GeoRestrictions": {
    "RestrictionType": "blacklist"|"whitelist"|"none",
    "Locations": ["string", ...]
  }
}

--parameters (список)

Список значений параметров для добавления к ресурсу. Параметр задается как пара ключ-значение. Для любого параметра, помеченного как обязательный в распределении для нескольких арендаторов, должно существовать корректное значение параметра.

(структура)

Список значений параметров для добавления к ресурсу. Параметр задается как пара ключ-значение. Для любого параметра, помеченного как обязательный в распределении для нескольких арендаторов, должно существовать корректное значение параметра.

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

Имя параметра.

Значение -> (строка)

Значение параметра.

Сокращенный синтаксис:

Name=string,Value=string ...

Синтаксис JSON:

[
  {
    "Name": "string",
    "Value": "string"
  }
  ...
]

--connection-group-id (строка)

Идентификатор целевой группы соединений.

--if-match (строка)

Значение заголовка ETag, полученное при получении арендатора распределения для обновления. Это значение возвращается в ответе операции API GetDistributionTenant.

--managed-certificate-request (структура)

Объект, содержащий запрос сертификата ACM, управляемый CloudFront.

ValidationTokenHost -> (строка)

Укажите, как токен проверки HTTP будет обслуживаться при запросе управляемого сертификата ACM CloudFront.

  • Для cloudfront CloudFront автоматически обслуживает токен проверки. Выберите этот режим, если вы можете сразу перенаправить DNS домена на CloudFront.
  • Для self-hosted вы обслуживаете токен проверки из вашей существующей инфраструктуры. Выберите этот режим, когда вам нужно сохранить текущий поток трафика, пока ваш сертификат не будет выпущен. Вы можете поместить токен проверки по известному пути на ваш существующий веб-сервер, подождать, пока ACM проверит и выпустит сертификат, а затем обновить DNS, чтобы он указывать на CloudFront.

PrimaryDomainName -> (строка)

Основное имя домена, связанное с управляемым сертификатом ACM CloudFront.

CertificateTransparencyLoggingPreference -> (строка)

Вы можете отказаться от протоколирования прозрачности сертификатов, указав параметр disabled. Включите его, указав enabled. Дополнительную информацию см. в разделе Протоколирование прозрачности сертификатов в Руководстве пользователя Certificate Manager.

Сокращенный синтаксис:

ValidationTokenHost=string,PrimaryDomainName=string,CertificateTransparencyLoggingPreference=string

Синтаксис JSON:

{
  "ValidationTokenHost": "cloudfront"|"self-hosted",
  "PrimaryDomainName": "string",
  "CertificateTransparencyLoggingPreference": "enabled"|"disabled"
}

--enabled | --no-enabled (логическое значение)

Указывает, должен ли арендатор распределения быть обновлен в состояние включения. Если вы обновите арендатора распределения, и он не включен, арендатор распределения не будет обрабатывать трафик.

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

--cli-auto-prompt (логическое значение)

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

--no-cli-auto-prompt (логическое значение)

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

Вывод

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

Арендант распределения, который вы обновляете.

Id -> (строка)

Идентификатор аренданта распределения.

DistributionId -> (строка)

Идентификатор распределения с несколькими арендатами.

Name -> (строка)

Имя аренданта распределения.

Arn -> (строка)

Amazon Resource Name (ARN) аренданта распределения.

Domains -> (список)

Домены, связанные с арендантом распределения.

(структура)

Подробности о результате домена.

Domain -> (строка)

Указанный домен.

Status -> (строка)

Активен или неактивен домен.

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

Сложный тип, содержащий ноль или более элементов Tag.

Items -> (список)

Сложный тип, содержащий элементы Tag.

(структура)

Сложный тип, содержащий ключ Tag и значение Tag.

Key -> (строка)

Строка, содержащая ключ Tag.

Длина строки должна быть от 1 до 128 символов. Допустимые символы включают a-z , A-Z , 0-9 , пробелы и специальные символы _ - . : / = + @.

Value -> (строка)

Строка, содержащая необязательное значение Tag.

Длина строки должна быть от 0 до 256 символов. Допустимые символы включают a-z , A-Z , 0-9 , пробелы и специальные символы _ - . : / = + @.

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

Настройки для аренданта распределения. Для каждого аренданта распределения вы можете указать географические ограничения и Amazon Resource Names (ARN) для сертификата ACM и WAF web ACL. Это конкретные значения, которые вы можете переопределить или отключить из распределения с несколькими арендатами, которое использовалось для создания аренданта распределения.

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

WAF web ACL.

Action -> (строка)

Действие для настройки WAF web ACL. Вы можете указать override, чтобы указать отдельный WAF web ACL для аренданта распределения. Если вы укажете disable, у аренданта распределения не будет защиты WAF web ACL и он не унаследует её от распределения с несколькими арендатами.

Arn -> (строка)

Amazon Resource Name (ARN) WAF web ACL.

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

Сертификат Certificate Manager (ACM).

Arn -> (строка)

Amazon Resource Name (ARN) сертификата ACM.

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

Географические ограничения.

RestrictionType -> (строка)

Метод, который вы хотите использовать для ограничения распространения вашего контента по странам:

  • none : Географические ограничения не включены, доступ к контенту не ограничен географическим положением клиента.
  • blacklist : Элементы Location указывают страны, в которых вы не хотите, чтобы CloudFront распространял ваш контент.
  • whitelist : Элементы Location указывают страны, в которых вы хотите, чтобы CloudFront распространял ваш контент.

Locations -> (список)

Расположения для географических ограничений.

(строка)

Parameters -> (список)

Список значений параметров для добавления к ресурсу. Параметр задаётся как пара ключ-значение. Действительное значение параметра должно существовать для любого параметра, который помечен как обязательный в распределении с несколькими арендатами.

(структура)

Список значений параметров для добавления к ресурсу. Параметр задаётся как пара ключ-значение. Действительное значение параметра должно существовать для любого параметра, который помечен как обязательный в распределении с несколькими арендатами.

Name -> (строка)

Имя параметра.

Value -> (строка)

Значение параметра.

ConnectionGroupId -> (строка)

Идентификатор группы подключений для аренданта распределения. Если вы не укажете группу подключений, CloudFront использует группу подключений по умолчанию.

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

Дата и время создания аренданта распределения.

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

Дата и время обновления аренданта распределения.

Enabled -> (булево)

Указывает, находится ли арендант распределения в состоянии включения. Если выключен, арендант распределения не будет обрабатывать трафик.

Status -> (строка)

Состояние аренданта распределения.

ETag -> (строка)

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

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

Spec-Zone.ru

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