Spec-Zone.ru › AWS CLI v2

[ aws . keyspaces ]

update-keyspace

Описание

Добавляет новую зону Amazon Web Services в хранилище ключей. Вы можете добавить новую зону в хранилище ключей, которое является однозонным или многозонным. Amazon Keyspaces будет реплицировать все таблицы в хранилище ключей в новую зону. Для успешной репликации всех таблиц в новую зону необходимо использовать клиентские метки времени для разрешения конфликтов. Чтобы включить клиентские метки времени, укажите clientSideTimestamps.status = enabled при вызове API. Дополнительную информацию о клиентских метках времени см. в разделе Клиентские метки времени в Amazon Keyspaces в Руководстве разработчика Amazon Keyspaces.

Для добавления зоны в хранилище ключей с использованием UpdateKeyspace API, принципал IAM должен иметь разрешения для следующих действий IAM:

  • cassandra:Alter
  • cassandra:AlterMultiRegionResource
  • cassandra:Create
  • cassandra:CreateMultiRegionResource
  • cassandra:Select
  • cassandra:SelectMultiRegionResource
  • cassandra:Modify
  • cassandra:ModifyMultiRegionResource

Если хранилище ключей содержит таблицу, настроенную в режиме выделенных ресурсов с включенным автоматическим масштабированием, необходимо разрешить следующие дополнительные действия IAM.

  • application-autoscaling:RegisterScalableTarget
  • application-autoscaling:DeregisterScalableTarget
  • application-autoscaling:DescribeScalableTargets
  • application-autoscaling:PutScalingPolicy
  • application-autoscaling:DescribeScalingPolicies

Для использования UpdateKeyspace API, принципал IAM также должен иметь разрешения на создание роли связанной с сервисом со следующими элементами:

  • iam:CreateServiceLinkedRole — действие, которое может выполнить принципал.
  • arn:aws:iam::*:role/aws-service-role/replication.cassandra.amazonaws.com/AWSServiceRoleForKeyspacesReplication — ресурс, на котором может быть выполнено действие.
  • iam:AWSServiceName: replication.cassandra.amazonaws.com — единственным сервисом Amazon Web Services, к которому может быть прикреплена эта роль, является Amazon Keyspaces.

Дополнительную информацию см. в разделе Настройка разрешений IAM, необходимых для добавления зоны Amazon Web Services в хранилище ключей в Руководстве разработчика Amazon Keyspaces.

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

Синтаксис

  update-keyspace
--keyspace-name <value>
--replication-specification <value>
[--client-side-timestamps <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]

Параметры

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

Имя хранилища ключей.

--replication-specification (структура)

Спецификация репликации хранилища ключей включает:

  • regionList — зоны Amazon Web Services, в которых хранилище ключей реплицируется.
  • replicationStrategy — требуемое значение SINGLE_REGION или MULTI_REGION.

replicationStrategy -> (строка)

Стратегия репликации хранилища ключей, требуемое значение — SINGLE_REGION или MULTI_REGION.

regionList -> (список)

regionList содержит зоны Amazon Web Services, в которых хранилище ключей реплицируется.

(строка)

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

replicationStrategy=string,regionList=string,string

Синтаксис JSON:

{
  "replicationStrategy": "SINGLE_REGION"|"MULTI_REGION",
  "regionList": ["string", ...]
}

--client-side-timestamps (структура)

Настройка клиентских меток времени для таблицы.

Дополнительную информацию см. в разделе Как это работает: клиентские метки времени Amazon Keyspaces в Руководстве разработчика Amazon Keyspaces.

status -> (строка)

Показывает, как включить настройку клиентских меток времени для указанной таблицы.

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

status=string

Синтаксис JSON:

{
  "status": "ENABLED"
}

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

Вывод

resourceArn -> (строка)

Уникальный идентификатор хранилища ключей в формате Amazon Resource Name (ARN).

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

Spec-Zone.ru

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