Spec-Zone.ru › AWS CLI v2

[ aws . iot ]

create-domain-configuration

Описание

Создаёт конфигурацию домена.

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

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

Синтаксис

  create-domain-configuration
--domain-configuration-name <value>
[--domain-name <value>]
[--server-certificate-arns <value>]
[--validation-certificate-arn <value>]
[--authorizer-config <value>]
[--service-type <value>]
[--tags <value>]
[--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 (строка)

Имя конфигурации домена. Это значение должно быть уникальным для региона.

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

Имя домена.

--server-certificate-arns (список)

ARN-ы сертификатов, которые IoT передаёт устройству во время рукопожатия TLS. В настоящее время можно указать только один ARN сертификата. Это значение не требуется для управляемых Amazon Web Services доменов.

(строка)

Синтаксис:

"string" "string" ...

--validation-certificate-arn (строка)

Сертификат, используемый для проверки серверного сертификата и подтверждения владения именем домена. Этот сертификат должен быть подписан общедоступным центром сертификации. Это значение не требуется для управляемых Amazon Web Services доменов.

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

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

defaultAuthorizerName -> (строка)

Имя службы авторизации для конфигурации домена.

allowAuthorizerOverride -> (логическое)

Логическое значение, указывающее, можно ли переопределить службу авторизации конфигурации домена.

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

defaultAuthorizerName=string,allowAuthorizerOverride=boolean

JSON синтаксис:

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

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

Тип службы, предоставляемой конечной точкой.

Примечание

Amazon Web Services IoT Core в настоящее время поддерживает только тип службы DATA.

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

  • DATA
  • CREDENTIAL_PROVIDER
  • JOBS

--tags (список)

Метаданные, которые могут быть использованы для управления конфигурацией домена.

Примечание

Для параметров запроса URI используйте формат: …key1=value1&key2=value2…

Для параметра командной строки CLI используйте формат: &&tags “key1=value1&key2=value2…”

Для файла cli-input-json используйте формат: “tags”: “key1=value1&key2=value2…”

(структура)

Набор пар ключ/значение, используемых для управления ресурсом.

Ключ -> (строка)

Ключ тега.

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

Значение тега.

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

Key=string,Value=string ...

JSON синтаксис:

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

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

Объект, определяющий конфигурацию TLS для домена.

securityPolicy -> (строка)

Политика безопасности для конфигурации домена. Дополнительная информация в разделе Политики безопасности в руководстве разработчика Amazon Web Services IoT Core.

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

securityPolicy=string

JSON синтаксис:

{
  "securityPolicy": "string"
}

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

Конфигурация серверного сертификата.

enableOCSPCheck -> (логическое)

Логическое значение, указывающее, включена или нет проверка серверного сертификата OCSP (Online Certificate Status Protocol).

Дополнительная информация в руководстве разработчика Amazon Web Services IoT Core в разделе Конфигурация серверного сертификата для OCSP stapling.

ocspLambdaArn -> (строка)

Amazon Resource Name (ARN) функции Lambda, которая действует как ответчик OCSP (Online Certificate Status Protocol) RFC 6960, поддерживающий базовые ответы OCSP. Функция Lambda принимает base64-кодирование запроса OCSP в формате DER. Ответ функции Lambda также является base64-кодированным ответом OCSP в формате DER. Размер ответа не должен превышать 4 килобайт (KiB). Функция Lambda должна находиться в той же учетной записи Amazon Web Services и регионе, что и конфигурация домена. Дополнительная информация в руководстве разработчика Amazon Web Services IoT Core в разделе Настройка серверного сертификата OCSP для частных конечных точек.

ocspAuthorizedResponderArn -> (строка)

Amazon Resource Name (ARN) для сертификата X.509, хранящегося в Amazon Web Services Certificate Manager (ACM). Если указано, Amazon Web Services IoT Core будет использовать этот сертификат для проверки подписи полученного ответа OCSP. Ответчик OCSP должен подписывать ответы с использованием этого авторизованного сертификата ответчика или сертификата выдачи в зависимости от того, предоставлен ли ARN или нет. Сертификат должен находиться в той же учетной записи Amazon Web Services и регионе, что и конфигурация домена.

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

enableOCSPCheck=boolean,ocspLambdaArn=string,ocspAuthorizedResponderArn=string

JSON синтаксис:

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

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

Перечисление, указывающее тип аутентификации.

  • CUSTOM_AUTH_X509 - Использование настраиваемой аутентификации и авторизации с дополнительными данными из сертификата клиента X.509.
  • CUSTOM_AUTH - Использование настраиваемой аутентификации и авторизации. Дополнительная информация в разделе Настраиваемая аутентификация и авторизация.
  • AWS_X509 - Использование сертификатов клиентов X.509 без настраиваемой аутентификации и авторизации. Дополнительная информация в разделе Сертификаты клиентов X.509.
  • AWS_SIGV4 - Использование Amazon Web Services Signature Version 4. Дополнительная информация в разделе Пользователи, группы и роли IAM.
  • DEFAULT - Использование комбинации порта и Application Layer Protocol Negotiation (ALPN) для указания типа аутентификации. Дополнительная информация в разделе Протоколы связи устройств.

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

  • CUSTOM_AUTH_X509
  • CUSTOM_AUTH
  • AWS_X509
  • AWS_SIGV4
  • DEFAULT

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

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

  • SECURE_MQTT - MQTT по TLS.
  • MQTT_WSS - MQTT по WebSocket.
  • HTTPS - HTTP по TLS.
  • DEFAULT - Использование комбинации порта и Application Layer Protocol Negotiation (ALPN) для указания протокола прикладного уровня. Дополнительная информация в разделе Протоколы связи устройств.

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

  • SECURE_MQTT
  • MQTT_WSS
  • HTTPS
  • DEFAULT

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

Объект, определяющий конфигурацию сертификата клиента для домена.

clientCertificateCallbackArn -> (строка)

ARN функции Lambda, которую IoT вызывает после аутентификации взаимного TLS во время подключения.

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

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 (boolean)

Включить отладку логов.

--endpoint-url (string)

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

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

Примеры

Примечание

Для использования следующих примеров, необходимо установить и настроить AWS CLI. Подробнее об этом можно узнать в руководстве по началу работы в Руководстве пользователя AWS CLI.

Если не указано иное, во всех примерах используются правила цитирования, подобные Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей терминальной оболочки. Смотрите раздел «Использование кавычек со строками» в Руководстве пользователя AWS CLI.

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

Следующий create-domain-configuration пример создает управляемую AWS конфигурацию домена с типом сервиса DATA.

aws iot create-domain-configuration \
    --domain-configuration-name "additionalDataDomain" \
    --service-type "DATA"

Вывод:

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

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

Вывод

domainConfigurationName -> (string)

Имя конфигурации домена.

domainConfigurationArn -> (string)

ARN конфигурации домена.

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

Spec-Zone.ru

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