Настройка доменной конфигурации

Описание

Обновляет значения, хранящиеся в конфигурации домена. Конфигурации доменов для стандартных конечных точек обновить нельзя.

Требуется разрешение для доступа к действию UpdateDomainConfiguration.

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

Синтаксис

  update-domain-configuration
--domain-configuration-name <value>
[--authorizer-config <value>]
[--domain-configuration-status <value>]
[--remove-authorizer-config | --no-remove-authorizer-config]
[--tls-config <value>]
[--server-certificate-config <value>]
[--authentication-type <value>]
[--application-protocol <value>]
[--client-certificate-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]

Параметры

--domain-configuration-name (строка)

--authorizer-config (структура)

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

defaultAuthorizerName=string,allowAuthorizerOverride=boolean

Синтаксис JSON:

{
  "defaultAuthorizerName": "string",
  "allowAuthorizerOverride": true|false
}

--domain-configuration-status (строка)

--remove-authorizer-config | --no-remove-authorizer-config (булево)

--tls-config (структура)

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

securityPolicy=string

Синтаксис JSON:

{
  "securityPolicy": "string"
}

--server-certificate-config (структура)

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

enableOCSPCheck=boolean,ocspLambdaArn=string,ocspAuthorizedResponderArn=string

Синтаксис JSON:

{
  "enableOCSPCheck": true|false,
  "ocspLambdaArn": "string",
  "ocspAuthorizedResponderArn": "string"
}

--authentication-type (строка)

--application-protocol (строка)

--client-certificate-config (структура)

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

clientCertificateCallbackArn=string

Синтаксис JSON:

{
  "clientCertificateCallbackArn": "string"
}

--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
• table
• yaml
• yaml-stream

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

Вывод версии этого инструмента.

--color (строка)

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

• on
• off
• auto

--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 для вывода.

--cli-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Примеры

Для обновления конфигурации домена

В следующем update-domain-configuration примере отключена указанная конфигурация домена.

aws iot update-domain-configuration \
    --domain-configuration-name "additionalDataDomain" \
    --domain-configuration-status "DISABLED"

Вывод:

{
    "domainConfigurationName": "additionalDataDomain",
    "domainConfigurationArn": "arn:aws:iot:us-west-2:123456789012:domainconfiguration/additionalDataDomain/dikMh"
}

Дополнительная информация в разделе Настраиваемые конечные точки в руководстве разработчика AWS IoT.

Вывод

domainConfigurationName -> (строка)

domainConfigurationArn -> (строка)