Spec-Zone.ru › AWS CLI v2

[ aws . kafka ]

обновить-хранилище-брокера

Описание

Обновляет хранилище EBS, связанное с брокерами MSK.

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

Синтаксис

  update-broker-storage
--cluster-arn <value>
--current-version <value>
--target-broker-ebs-volume-info <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-arn (строка)

Amazon Resource Name (ARN), уникально идентифицирующий кластер.

--current-version (строка)

Версия кластера, с которой нужно выполнить обновление. Успешная операция сгенерирует новую версию.

--target-broker-ebs-volume-info (список)

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

(структура)

Указывает информацию об обновлении тома EBS. Идентификатор брокера должен быть установлен в ключевое слово ALL. Это означает, что изменения применятся ко всем брокерам в кластере.

KafkaBrokerNodeId -> (строка)

Идентификатор брокера, который нужно обновить.

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

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

Enabled -> (булево)

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

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

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

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

Размер тома EBS для обновления.

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

KafkaBrokerNodeId=string,ProvisionedThroughput={Enabled=boolean,VolumeThroughput=integer},VolumeSizeGB=integer ...

Синтаксис JSON:

[
  {
    "KafkaBrokerNodeId": "string",
    "ProvisionedThroughput": {
      "Enabled": true|false,
      "VolumeThroughput": integer
    },
    "VolumeSizeGB": integer
  }
  ...
]

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

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

  • on
  • off
  • auto

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

Примеры

Примечание

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

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

Для обновления хранилища EBS для брокеров

Следующий update-broker-storage пример обновляет объем хранилища EBS для всех брокеров в кластере. Amazon MSK устанавливает целевой объем хранилища для каждого брокера в значение, указанное в примере. Текущую версию кластера можно получить, описав кластер или перечислив все кластеры.

aws kafka update-broker-storage \
    --cluster-arn "arn:aws:kafka:us-west-2:123456789012:cluster/MessagingCluster/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE-2" \
    --current-version "K21V3IB1VIZYYH" \
    --target-broker-ebs-volume-info "KafkaBrokerNodeId=ALL,VolumeSizeGB=1100"

Вывод возвращает ARN для этой update-broker-storage операции. Чтобы определить, завершена ли эта операция, используйте команду describe-cluster-operation с этим ARN в качестве входных данных.

{
    "ClusterArn": "arn:aws:kafka:us-west-2:123456789012:cluster/MessagingCluster/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE-2",
    "ClusterOperationArn": "arn:aws:kafka:us-west-2:123456789012:cluster-operation/V123450123/a1b2c3d4-1234-abcd-cdef-22222EXAMPLE-2/a1b2c3d4-abcd-1234-bcde-33333EXAMPLE"
}

Дополнительную информацию см. в разделе «Обновление хранилища EBS для брокеров» в Руководстве разработчика Amazon Managed Streaming for Apache Kafka.

Вывод

ClusterArn -> (строка)

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

ClusterOperationArn -> (строка)

Amazon Resource Name (ARN) операции кластера.

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

Spec-Zone.ru

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