Spec-Zone.ru › AWS CLI v2

[ aws . cloudhsmv2 ]

create-cluster

Описание

Создает новый кластер CloudHSM.

Использование между аккаунтами: Да. Чтобы выполнить эту операцию с резервной копией CloudHSM в другом аккаунте AWS, укажите полный ARN резервной копии в параметре SourceBackupId.

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

Синтаксис

  create-cluster
[--backup-retention-policy <value>]
--hsm-type <value>
[--source-backup-id <value>]
--subnet-ids <value>
[--network-type <value>]
[--tag-list <value>]
[--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]

Параметры

--backup-retention-policy (структура)

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

Тип -> (строка)

Тип политики сохранения резервных копий. Для типа DAYS значением является количество дней для хранения резервных копий.

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

Используйте значение от 7 до 379.

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

Type=string,Value=string

Синтаксис JSON:

{
  "Type": "DAYS",
  "Value": "string"
}

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

Тип HSM для использования в кластере. Допустимые значения — hsm1.medium и hsm2m.medium.

--source-backup-id (строка)

Идентификатор (ID) или Amazon Resource Name (ARN) резервной копии кластера для восстановления. Используйте это значение для восстановления кластера из резервной копии вместо создания нового кластера. Чтобы найти идентификатор или ARN резервной копии, используйте DescribeBackups. Если используется резервная копия в другом аккаунте, необходимо указать полный ARN.

--subnet-ids (список)

Идентификаторы (ID) подсетей, в которых вы создаете кластер. Вы должны указать хотя бы одну подсеть. Если вы указываете несколько подсетей, они должны соответствовать следующим критериям:

  • Все подсети должны находиться в одной виртуальной частной сети (VPC).
  • Вы можете указать только одну подсеть на зону доступности.

(строка)

Синтаксис:

"string" "string" ...

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

NetworkType для создания кластера. Допустимые значения — IPV4 и DUALSTACK.

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

  • IPV4
  • DUALSTACK

--tag-list (список)

Теги, которые необходимо применить к кластеру CloudHSM при его создании.

(структура)

Содержит тег. Тег — это пара ключ-значение.

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

Ключ тега.

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

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

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

Key=string,Value=string ...

Синтаксис JSON:

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

--mode (строка)

Режим использования в кластере. Допустимые значения — FIPS и NON_FIPS.

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

  • FIPS
  • NON_FIPS

--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 (строка)

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

  • вкл
  • выкл
  • авто

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

Вывод

Кластер -> (структура)

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

BackupPolicy -> (строка)

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

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

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

Тип -> (строка)

Тип политики сохранения резервных копий. Для типа DAYS значением является количество дней для сохранения резервных копий.

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

Используйте значение от 7 до 379.

ClusterId -> (строка)

Идентификатор (ID) кластера.

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

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

Hsms -> (список)

Содержит информацию об HSM в кластере.

(структура)

Содержит информацию о модуле аппаратной защиты (HSM) в кластере CloudHSM.

AvailabilityZone -> (строка)

Доступная зона, содержащая HSM.

ClusterId -> (строка)

Идентификатор (ID) кластера, содержащего HSM.

SubnetId -> (строка)

Подсеть, содержащая интерфейс эластичной сети (ENI) HSM.

EniId -> (строка)

Идентификатор (ID) интерфейса эластичной сети (ENI) HSM.

EniIp -> (строка)

IP-адрес интерфейса эластичной сети (ENI) HSM.

EniIpV6 -> (строка)

IPv6-адрес (если есть) интерфейса эластичной сети (ENI) HSM.

HsmId -> (строка)

Идентификатор (ID) HSM.

HsmType -> (строка)

Тип HSM.

Состояние -> (строка)

Состояние HSM.

StateMessage -> (строка)

Описание состояния HSM.

HsmType -> (строка)

Тип HSM, содержащийся в кластере.

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

Метка времени, до которой кластер может быть откачен к исходному типу HSM.

PreCoPassword -> (строка)

По умолчанию пароль для пользователя Pre-Crypto Officer (PRECO) кластера.

SecurityGroup -> (строка)

Идентификатор (ID) группы безопасности кластера.

SourceBackupId -> (строка)

Идентификатор (ID) резервной копии, используемой для создания кластера. Это значение существует только в случае, если кластер был создан из резервной копии.

Состояние -> (строка)

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

StateMessage -> (строка)

Описание состояния кластера.

SubnetMapping -> (карта)

Карта доступных зон к подсети кластера в этой доступной зоне.

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

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

VpcId -> (строка)

Идентификатор (ID) виртуальной частной облачной сети (VPC), содержащей кластер.

NetworkType -> (строка)

Тип сети кластера может быть IPv4 (по умолчанию) или DUALSTACK. Тип сети IPv4 ограничивает общение между вашим приложением и модулями аппаратной защиты (HSM) только протоколом IPv4. Тип сети DUALSTACK позволяет общение по протоколам IPv4 и IPv6. Для использования DUALSTACK необходимо настроить вашу виртуальную частную облачную сеть (VPC) и подсети для поддержки как IPv4, так и IPv6. Эта настройка включает добавление блоков IPv6 CIDR к существующим блокам IPv4 CIDR в ваших подсетях. Выбранный тип сети влияет на параметры адресации сети для вашего кластера. DUALSTACK обеспечивает большую гибкость, поддерживая как IPv4, так и IPv6 общение.

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

Содержит один или несколько сертификатов или запрос на подписание сертификата (CSR).

ClusterCsr -> (строка)

Запрос на подписание сертификата (CSR) кластера. CSR существует только когда состояние кластера является UNINITIALIZED.

HsmCertificate -> (строка)

Сертификат HSM, выданный (подписанный) аппаратным HSM.

AwsHardwareCertificate -> (строка)

Сертификат аппаратного HSM, выданный (подписанный) CloudHSM.

ManufacturerHardwareCertificate -> (строка)

Сертификат аппаратного HSM, выданный (подписанный) производителем оборудования.

ClusterCertificate -> (строка)

Сертификат кластера, выданный (подписанный) удостоверяющим центром (ЦС) владельца кластера.

TagList -> (список)

Список тегов для кластера.

(структура)

Содержит тег. Тег — это пара «ключ-значение».

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

Ключ тега.

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

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

Режим -> (строка)

Режим кластера.

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

Spec-Zone.ru

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