Spec-Zone.ru › AWS CLI v2

[ aws . kafka ]

create-cluster-v2

Описание

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

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

Синтаксис

  create-cluster-v2
--cluster-name <value>
[--tags <value>]
[--provisioned <value>]
[--serverless <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]

Параметры

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

Имя кластера.

--tags (массив)

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

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

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

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

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

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

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

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

Информация о брокерах.

BrokerAZDistribution -> (строка)

Распределение узлов брокеров по зонам доступности. Этот параметр является необязательным. Если вы его не укажете, Amazon MSK присвоит ему значение DEFAULT. Вы также можете явно установить этот параметр в значение DEFAULT. Другие значения в настоящее время недоступны.

Amazon MSK равномерно распределяет узлы брокеров по зонам доступности, соответствующим подсетям, которые вы предоставляете при создании кластера.

ClientSubnets -> (список)

Список подсетей для подключения в виртуальной частной сети клиента (VPC). AWS создаёт сетевые интерфейсы внутри этих подсетей. Приложения клиентов используют сетевые интерфейсы для генерации и потребления данных. Клиентские подсети не могут находиться в зоне доступности с идентификатором use1-az3.

(строка)

InstanceType -> (строка)

Тип экземпляров Amazon EC2, используемых для узлов Apache Kafka-брокеров. Разрешены следующие типы экземпляров: kafka.m5.large, kafka.m5.xlarge, kafka.m5.2xlarge, kafka.m5.4xlarge, kafka.m5.12xlarge и kafka.m5.24xlarge.

SecurityGroups -> (список)

AWS-группы безопасности, которые необходимо ассоциировать с сетевыми интерфейсами для указания того, кто может подключаться и взаимодействовать с кластером Amazon MSK. Если вы не указываете группу безопасности, Amazon MSK использует группу безопасности по умолчанию, связанную с VPC.

(строка)

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

Содержит информацию о томах хранения, подключённых к узлам брокеров MSK.

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

Информация о томах EBS.

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

Информация о пропускной способности выделенных томов EBS.

Enabled -> (булево)

Включена или выключена пропускная способность.

VolumeThroughput -> (целое число)

Значение пропускной способности томов EBS для диска данных на каждом узле брокера Kafka в МБ в секунду.

VolumeSize -> (целое число)

Размер тома EBS в ГиБ для диска данных на каждом узле брокера.

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

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

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

Управление доступом к публичному доступу для брокеров.

Type -> (строка)

Значение DISABLED указывает, что общедоступный доступ отключён. SERVICE_PROVIDED_EIPS указывает, что общедоступный доступ включён.

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

Управление доступом к подключению VPC для брокеров.

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

Включает всю информацию об аутентификации клиентов для подключения VPC.

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

Подробности о типе аутентификации SASL для подключения VPC.

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

Подробности об аутентификации клиента SASL/SCRAM для подключения VPC.

Enabled -> (булево)

Аутентификация SASL/SCRAM включена или выключена для подключения VPC.

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

Подробности об аутентификации клиента SASL/IAM для подключения VPC.

Enabled -> (булево)

Аутентификация SASL/IAM включена или выключена для подключения VPC.

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

Подробности о типе аутентификации TLS для подключения VPC.

Enabled -> (булево)

Аутентификация TLS включена или выключена для подключения VPC.

ZoneIds -> (список)

Список идентификаторов зон для кластера в виртуальной частной сети (VPC).

(строка)

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

Включает всю информацию об аутентификации клиентов.

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

Подробности об аутентификации клиента SASL.

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

Подробности об аутентификации клиента SASL/SCRAM.

Enabled -> (булево)

Аутентификация SASL/SCRAM включена или выключена.

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

Указывает, включен ли контроль доступа IAM.

Enabled -> (булево)

Указывает, включен ли контроль доступа IAM.

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

Подробности об аутентификации клиента TLS.

CertificateAuthorityArnList -> (список)

Список ARNs сертификатов Центра сертификации ACM.

(строка)

Enabled -> (булево)

Указывает, хотите ли вы включить или отключить аутентификацию TLS.

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

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

Enabled -> (булево)

Указывает, хотите ли вы включить или отключить неаутентифицированный трафик в свой кластер.

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

Представляет конфигурацию, которую вы хотите использовать для брокеров в кластере Amazon MSK.

Arn -> (строка)

ARN используемой конфигурации.

Revision -> (целое число с длинной точностью)

Ревизия используемой конфигурации.

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

Включает всю информацию, связанную с шифрованием.

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

Подробности шифрования томов данных.

DataVolumeKMSKeyId -> (строка)

ARN ключа AWS KMS для шифрования данных в состоянии покоя. Если вы не укажете ключ KMS, MSK создаст его для вас и будет использовать его.

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

Подробности шифрования в транзите.

ClientBroker -> (строка)

Указывает настройку шифрования для данных в транзите между клиентами и брокерами. Возможные значения:

TLS означает, что общение между клиентом и брокером включено только с TLS.

TLS_PLAINTEXT означает, что общение между клиентом и брокером включено для шифрования TLS, а также для данных в текстовом формате.

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

Значение по умолчанию — TLS_PLAINTEXT.

InCluster -> (булево)

При значении true указывает, что общение между узлами брокера кластера зашифровано. При значении false общение происходит в текстовом формате.

Значение по умолчанию — true.

EnhancedMonitoring -> (строка)

Указывает уровень мониторинга для кластера MSK. Возможные значения: DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER и PER_TOPIC_PER_PARTITION.

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

Настройки для мониторинга открытого типа.

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

Настройки Prometheus.

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

Указывает, хотите ли вы включить или отключить JMX Exporter.

EnabledInBroker -> (булево)

Указывает, хотите ли вы включить или отключить JMX Exporter.

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

Указывает, хотите ли вы включить или отключить Node Exporter.

EnabledInBroker -> (булево)

Указывает, хотите ли вы включить или отключить Node Exporter.

KafkaVersion -> (строка)

Версия Apache Kafka, которую вы хотите использовать для кластера.

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

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

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

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

Enabled -> (булево)

LogGroup -> (строка)

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

DeliveryStream -> (строка)

Enabled -> (булево)

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

Bucket -> (строка)

Enabled -> (булево)

Prefix -> (строка)

NumberOfBrokerNodes -> (целое число)

Количество узлов брокеров в кластере.

StorageMode -> (строка)

Управляет режимом хранения для поддерживаемых уровней хранения.

Синтаксис JSON:

{
  "BrokerNodeGroupInfo": {
    "BrokerAZDistribution": "DEFAULT",
    "ClientSubnets": ["string", ...],
    "InstanceType": "string",
    "SecurityGroups": ["string", ...],
    "StorageInfo": {
      "EbsStorageInfo": {
        "ProvisionedThroughput": {
          "Enabled": true|false,
          "VolumeThroughput": integer
        },
        "VolumeSize": integer
      }
    },
    "ConnectivityInfo": {
      "PublicAccess": {
        "Type": "string"
      },
      "VpcConnectivity": {
        "ClientAuthentication": {
          "Sasl": {
            "Scram": {
              "Enabled": true|false
            },
            "Iam": {
              "Enabled": true|false
            }
          },
          "Tls": {
            "Enabled": true|false
          }
        }
      }
    },
    "ZoneIds": ["string", ...]
  },
  "ClientAuthentication": {
    "Sasl": {
      "Scram": {
        "Enabled": true|false
      },
      "Iam": {
        "Enabled": true|false
      }
    },
    "Tls": {
      "CertificateAuthorityArnList": ["string", ...],
      "Enabled": true|false
    },
    "Unauthenticated": {
      "Enabled": true|false
    }
  },
  "ConfigurationInfo": {
    "Arn": "string",
    "Revision": long
  },
  "EncryptionInfo": {
    "EncryptionAtRest": {
      "DataVolumeKMSKeyId": "string"
    },
    "EncryptionInTransit": {
      "ClientBroker": "TLS"|"TLS_PLAINTEXT"|"PLAINTEXT",
      "InCluster": true|false
    }
  },
  "EnhancedMonitoring": "DEFAULT"|"PER_BROKER"|"PER_TOPIC_PER_BROKER"|"PER_TOPIC_PER_PARTITION",
  "OpenMonitoring": {
    "Prometheus": {
      "JmxExporter": {
        "EnabledInBroker": true|false
      },
      "NodeExporter": {
        "EnabledInBroker": true|false
      }
    }
  },
  "KafkaVersion": "string",
  "LoggingInfo": {
    "BrokerLogs": {
      "CloudWatchLogs": {
        "Enabled": true|false,
        "LogGroup": "string"
      },
      "Firehose": {
        "DeliveryStream": "string",
        "Enabled": true|false
      },
      "S3": {
        "Bucket": "string",
        "Enabled": true|false,
        "Prefix": "string"
      }
    }
  },
  "NumberOfBrokerNodes": integer,
  "StorageMode": "LOCAL"|"TIERED"
}

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

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

VpcConfigs -> (список)

Конфигурация Amazon VPC для кластера.

(структура)

Конфигурация Amazon VPC для кластера.

SubnetIds -> (список)

Идентификаторы подсетей, связанных с кластером.

(строка)

SecurityGroupIds -> (список)

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

(строка)

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

Включает всю информацию об аутентификации клиентов.

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

Подробности об аутентификации клиента SASL.

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

Указывает, включен ли контроль доступа IAM.

Enabled -> (булево)

Указывает, включен ли контроль доступа IAM.

Синтаксис JSON:

{
  "VpcConfigs": [
    {
      "SubnetIds": ["string", ...],
      "SecurityGroupIds": ["string", ...]
    }
    ...
  ],
  "ClientAuthentication": {
    "Sasl": {
      "Iam": {
        "Enabled": true|false
      }
    }
  }
}

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

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

--no-cli-auto-prompt (boolean)

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

Вывод

ClusterArn -> (string)

Amazon Resource Name (ARN) кластера.

ClusterName -> (string)

Имя кластера MSK.

State -> (string)

Состояние кластера. Возможные состояния: ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER и UPDATING.

ClusterType -> (string)

Тип кластера. Возможные состояния: PROVISIONED или SERVERLESS.

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

Spec-Zone.ru

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