Spec-Zone.ru › AWS CLI v2

[ aws . iot ]

register-ca-certificate

Описание

Регистрирует сертификат CA в Amazon Web Services IoT Core. Количество регистрируемых сертификатов CA в вашей учетной записи Amazon Web Services не ограничено. Вы можете зарегистрировать до 10 сертификатов CA с одинаковым CA subject field в одной учетной записи Amazon Web Services.

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

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

Синтаксис

  register-ca-certificate
--ca-certificate <value>
[--verification-certificate <value>]
[--set-as-active | --no-set-as-active]
[--allow-auto-registration | --no-allow-auto-registration]
[--registration-config <value>]
[--tags <value>]
[--certificate-mode <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]

Параметры

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

Сертификат CA.

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

Сертификат проверки закрытого ключа. Если certificateMode равен SNI_ONLY, поле verificationCertificate должно быть пустым. Если certificateMode равен DEFAULT или не указан, поле verificationCertificate не должно быть пустым.

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

Логическое значение, указывающее, активен ли сертификат CA.

Допустимые значения: ACTIVE | INACTIVE

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

Разрешает использование этого сертификата CA для автоматической регистрации сертификатов устройств.

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

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

templateBody -> (строка)

Тело шаблона.

roleArn -> (строка)

ARN роли.

templateName -> (строка)

Имя шаблона развёртывания.

Краткий синтаксис:

templateBody=string,roleArn=string,templateName=string

Синтаксис JSON:

{
  "templateBody": "string",
  "roleArn": "string",
  "templateName": "string"
}

--tags (список)

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

Примечание

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

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

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

(структура)

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

Key -> (строка)

Ключ тега.

Value -> (строка)

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

Краткий синтаксис:

Key=string,Value=string ...

Синтаксис JSON:

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

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

Описывает режим сертификата, в котором будет зарегистрирован Центр сертификации (CA). Если поле verificationCertificate не указано, установите certificateMode на SNI_ONLY. Если поле verificationCertificate указано, установите certificateMode на DEFAULT. Когда certificateMode не указан, он по умолчанию равен DEFAULT. Все сертификаты устройств, зарегистрированные с помощью этого CA, будут зарегистрированы в том же режиме сертификата, что и CA. Дополнительную информацию о режиме сертификатов для сертификатов устройств см. в разделе режим сертификата.

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

  • DEFAULT
  • SNI_ONLY

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

Переопределить 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.

Примеры

Примечание

Чтобы использовать следующие примеры, у вас должна быть установлена и настроена AWS CLI. Более подробную информацию см. в руководстве по началу работы в Руководстве пользователя AWS CLI.

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

Для регистрации сертификата удостоверяющего центра (CA)

В следующем register-ca-certificate примере регистрируется сертификат CA. Команда предоставляет сертификат CA и сертификат проверки ключа, который доказывает, что вы владеете закрытым ключом, связанным с сертификатом CA.

aws iot register-ca-certificate \
    --ca-certificate file://rootCA.pem \
    --verification-cert file://verificationCert.pem

Вывод:

{
    "certificateArn": "arn:aws:iot:us-west-2:123456789012:cacert/f4efed62c0142f16af278166f61962501165c4f0536295207426460058cd1467",
    "certificateId": "f4efed62c0142f16af278166f61962501165c4f0536295207426460058cd1467"
 }

Дополнительную информацию см. в разделе RegisterCACertificate в Справочнике по API AWS IoT.

Вывод

certificateArn -> (строка)

ARN сертификата CA.

certificateId -> (строка)

Идентификатор сертификата CA.

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

Spec-Zone.ru

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