create-cluster
Описание
Создаёт новый кластер MSK.
См. также: Документацию API AWS
Синтаксис
create-cluster
--broker-node-group-info <value>
[--client-authentication <value>]
--cluster-name <value>
[--configuration-info <value>]
[--encryption-info <value>]
[--enhanced-monitoring <value>]
[--open-monitoring <value>]
--kafka-version <value>
[--logging-info <value>]
--number-of-broker-nodes <value>
[--tags <value>]
[--storage-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]
Параметры
--broker-node-group-info (структура)
Информация о узлах брокера в кластере.
BrokerAZDistribution -> (строка)
Распределение узлов брокера по зонам доступности. Этот параметр является необязательным. Если вы его не укажете, Amazon MSK присвоит ему значение DEFAULT. Вы также можете явно установить этот параметр в значение DEFAULT. Другие значения в настоящее время недоступны.
Amazon MSK равномерно распределяет узлы брокера по зонам доступности, соответствующим подсетям, которые вы предоставляете при создании кластера.
ClientSubnets -> (список)
Список подсетей для подключения к виртуальной частной сети клиента (VPC). AWS создаёт интерфейсы сетевого доступа внутри этих подсетей. Клиентские приложения используют интерфейсы сетевого доступа для генерации и потребления данных. Клиентские подсети не могут занимать зону доступности с идентификатором use1-az3.
(строка)
InstanceType -> (строка)
SecurityGroups -> (список)
AWS группы безопасности, которые нужно ассоциировать с интерфейсами сетевого доступа, чтобы указать, кто может подключаться и общаться с кластером Amazon MSK. Если вы не укажете группу безопасности, Amazon MSK использует по умолчанию группу безопасности, связанную с VPC.
(строка)
StorageInfo -> (структура)
Содержит информацию о томах хранения, подключенных к узлам брокера MSK.
EbsStorageInfo -> (структура)
Информация о томах EBS.
ProvisionedThroughput -> (структура)
Информация о пропускной способности, зарезервированной для тома EBS.
Enabled -> (булево)
VolumeThroughput -> (целое число)
VolumeSize -> (целое число)
ConnectivityInfo -> (структура)
Информация о конфигурации доступа к брокеру.
PublicAccess -> (структура)
Управление доступом для общедоступных брокеров.
Type -> (строка)
VpcConnectivity -> (структура)
Управление доступом к подключению к VPC для брокеров.
ClientAuthentication -> (структура)
Включает всю информацию об аутентификации клиента для подключения к VPC.
Sasl -> (структура)
Подробности типа аутентификации SASL для подключения к VPC.
Scram -> (структура)
Подробности аутентификации клиента SASL/SCRAM для подключения к VPC.
Enabled -> (булево)
Iam -> (структура)
Подробности аутентификации клиента SASL/IAM для подключения к VPC.
Enabled -> (булево)
Tls -> (структура)
Подробности типа аутентификации TLS для подключения к VPC.
Enabled -> (булево)
ZoneIds -> (список)
Список идентификаторов зон для кластера в виртуальной частной сети (VPC).
(строка)
Синтаксис JSON:
{
"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", ...]
}
--client-authentication (структура)
Включает всю информацию, связанную с аутентификацией клиента.
Sasl -> (структура)
Подробности аутентификации клиента с использованием SASL.
Scram -> (структура)
Подробности аутентификации клиента SASL/SCRAM.
Enabled -> (булево)
Iam -> (структура)
Указывает, включен ли контроль доступа IAM.
Enabled -> (булево)
Tls -> (структура)
Подробности аутентификации клиента с использованием TLS.
CertificateAuthorityArnList -> (список)
Список ARNs центров сертификации ACM.
(строка)
Enabled -> (булево)
Unauthenticated -> (структура)
Содержит информацию о неаутентифицированном трафике в кластер.
Enabled -> (булево)
Синтаксис сокращённой формы:
Sasl={Scram={Enabled=boolean},Iam={Enabled=boolean}},Tls={CertificateAuthorityArnList=[string,string],Enabled=boolean},Unauthenticated={Enabled=boolean}
Синтаксис JSON:
{
"Sasl": {
"Scram": {
"Enabled": true|false
},
"Iam": {
"Enabled": true|false
}
},
"Tls": {
"CertificateAuthorityArnList": ["string", ...],
"Enabled": true|false
},
"Unauthenticated": {
"Enabled": true|false
}
}
--cluster-name (строка)
--configuration-info (структура)
Представляет конфигурацию, которую вы хотите использовать для брокеров в кластере.
Arn -> (строка)
Revision -> (целое число)
Синтаксис сокращённой формы:
Arn=string,Revision=long
Синтаксис JSON:
{
"Arn": "string",
"Revision": long
}
--encryption-info (структура)
Включает всю информацию, связанную с шифрованием.
EncryptionAtRest -> (структура)
Подробности шифрования тома данных.
DataVolumeKMSKeyId -> (строка)
EncryptionInTransit -> (структура)
Подробности шифрования в транзите.
ClientBroker -> (строка)
Указывает параметры шифрования данных в транзите между клиентами и брокерами. Возможные значения:
TLS — означает, что общение клиент-брокер включено только с TLS.
TLS_PLAINTEXT — означает, что общение клиент-брокер включено как для данных с TLS-шифрованием, так и для данных в открытом тексте.
PLAINTEXT — означает, что общение клиент-брокер включено только в открытом тексте.
Значение по умолчанию — TLS_PLAINTEXT.
InCluster -> (булево)
При значении true указывает, что общение между узлами брокера в кластере зашифровано. При значении false общение происходит в открытом тексте.
Значение по умолчанию — true.
Синтаксис сокращённой формы:
EncryptionAtRest={DataVolumeKMSKeyId=string},EncryptionInTransit={ClientBroker=string,InCluster=boolean}
Синтаксис JSON:
{
"EncryptionAtRest": {
"DataVolumeKMSKeyId": "string"
},
"EncryptionInTransit": {
"ClientBroker": "TLS"|"TLS_PLAINTEXT"|"PLAINTEXT",
"InCluster": true|false
}
}
--enhanced-monitoring (строка)
Устанавливает уровень мониторинга кластера MSK. Возможные значения: DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER и PER_TOPIC_PER_PARTITION.
Возможные значения:
DEFAULTPER_BROKERPER_TOPIC_PER_BROKERPER_TOPIC_PER_PARTITION
--open-monitoring (структура)
Настройки открытого мониторинга.
Prometheus -> (структура)
Настройки Prometheus.
JmxExporter -> (структура)
Указывает, хотите ли вы включить или выключить JMX Exporter.
EnabledInBroker -> (булево)
NodeExporter -> (структура)
Указывает, хотите ли вы включить или выключить Node Exporter.
EnabledInBroker -> (булево)
Синтаксис сокращённой формы:
Prometheus={JmxExporter={EnabledInBroker=boolean},NodeExporter={EnabledInBroker=boolean}}
Синтаксис JSON:
{
"Prometheus": {
"JmxExporter": {
"EnabledInBroker": true|false
},
"NodeExporter": {
"EnabledInBroker": true|false
}
}
}
--kafka-version (строка)
--logging-info (структура) BrokerLogs -> (структура)
CloudWatchLogs -> (структура)
Enabled -> (булево)
LogGroup -> (строка)
Firehose -> (структура)
DeliveryStream -> (строка)
Enabled -> (булево)
S3 -> (структура)
Bucket -> (строка)
Enabled -> (булево)
Prefix -> (строка)
Синтаксис сокращённой формы:
BrokerLogs={CloudWatchLogs={Enabled=boolean,LogGroup=string},Firehose={DeliveryStream=string,Enabled=boolean},S3={Bucket=string,Enabled=boolean,Prefix=string}}
Синтаксис JSON:
{
"BrokerLogs": {
"CloudWatchLogs": {
"Enabled": true|false,
"LogGroup": "string"
},
"Firehose": {
"DeliveryStream": "string",
"Enabled": true|false
},
"S3": {
"Bucket": "string",
"Enabled": true|false,
"Prefix": "string"
}
}
}
--number-of-broker-nodes (целое число)
--tags (массив)
Создание тегов при создании кластера.
value -> (строка)
Синтаксис сокращённой формы:
KeyName1=string,KeyName2=string
Синтаксис JSON:
{"string": "string"
...}
--storage-mode (строка)
Управляет режимом хранения для поддерживаемых уровней хранения.
Возможные значения:
LOCALTIERED
--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка следует формату, предоставленному --generate-cli-skeleton. Если на командной строке предоставлены другие аргументы, эти значения переопределят значения, предоставленные в JSON. Невозможно передавать произвольные двоичные значения с помощью значения, предоставленного в JSON, так как строка будет взята буквально. Это не может быть указано вместе с --cli-input-yaml.
--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса API. Если предоставлено значение null или 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.
Создание кластера Amazon MSK
Следующий create-cluster пример создает кластер MSK под названием MessagingCluster с тремя узлами брокера. Файл JSON под названием brokernodegroupinfo.json указывает три подсети, в которых вы хотите, чтобы Amazon MSK распределял узлы брокера. В данном примере уровень мониторинга не указан, поэтому кластер получит уровень DEFAULT.
aws kafka create-cluster \
--cluster-name "MessagingCluster" \
--broker-node-group-info file://brokernodegroupinfo.json \
--kafka-version "2.2.1" \
--number-of-broker-nodes 3
Содержимое brokernodegroupinfo.json:
{
"InstanceType": "kafka.m5.xlarge",
"BrokerAZDistribution": "DEFAULT",
"ClientSubnets": [
"subnet-0123456789111abcd",
"subnet-0123456789222abcd",
"subnet-0123456789333abcd"
]
}
Вывод:
{
"ClusterArn": "arn:aws:kafka:us-west-2:123456789012:cluster/MessagingCluster/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE-2",
"ClusterName": "MessagingCluster",
"State": "CREATING"
}
Дополнительную информацию см. в разделе Создание кластера Amazon MSK в Amazon Managed Streaming for Apache Kafka.
Вывод
ClusterArn -> (строка)
ClusterName -> (строка)
State -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.