Spec-Zone.ru › AWS CLI v2

[ aws . dynamodb ]

update-global-table

Описание

Добавляет или удаляет реплики в указанную глобальную таблицу. Глобальная таблица должна уже существовать, чтобы использовать эту операцию. Любая добавляемая реплика должна быть пустой, иметь такое же имя, как и глобальная таблица, такую же схему ключей, иметь включенные потоки DynamoDB Streams и такие же значения единиц пропускной способности чтения и максимальных единиц пропускной способности записи.

Предупреждение

Данная документация относится к версии 2017.11.29 (Legacy) глобальных таблиц, от использования которой для новых глобальных таблиц следует воздержаться. По возможности, пользователи должны использовать глобальные таблицы версии 2019.11.21 (Current), поскольку она обеспечивает большую гибкость, более высокую эффективность и потребляет меньше единиц пропускной способности записи, чем версия 2017.11.29 (Legacy).

Чтобы определить используемую версию, см. Определение версии глобальной таблицы, которую вы используете. Чтобы обновить существующие глобальные таблицы с версии 2017.11.29 (Legacy) до версии 2019.11.21 (Current), см. Обновление глобальных таблиц.

Примечание

Для глобальных таблиц эта операция применяется только к глобальным таблицам, использующим версию 2019.11.21 (текущая версия). Если вы используете глобальные таблицы версии 2019.11.21, вы можете использовать UpdateTable вместо этого.

Хотя вы можете использовать UpdateGlobalTable для добавления и удаления реплик в одном запросе, для простоты рекомендуется отправлять отдельные запросы для добавления или удаления реплик.

Если указаны глобальные вторичные индексы, должны быть выполнены следующие условия:

  • Глобальные вторичные индексы должны иметь одинаковое имя.
  • Глобальные вторичные индексы должны иметь одинаковые ключи хеширования и сортировки (если они присутствуют).
  • Глобальные вторичные индексы должны иметь одинаковые значения единиц пропускной способности чтения и максимальных единиц пропускной способности записи.

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

Синтаксис

  update-global-table
--global-table-name <value>
--replica-updates <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]

Параметры

--global-table-name (строка)

Имя глобальной таблицы.

--replica-updates (список)

Список регионов, которые следует добавить или удалить из глобальной таблицы.

(структура)

Представляет одно из следующего:

  • Новая реплика, которая должна быть добавлена в существующую глобальную таблицу.
  • Новые параметры для существующей реплики.
  • Существующая реплика, которая должна быть удалена из существующей глобальной таблицы.

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

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

RegionName -> (строка)

Регион добавляемой реплики.

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

Имя существующей реплики, которая должна быть удалена.

RegionName -> (строка)

Регион удаляемой реплики.

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

Create={RegionName=string},Delete={RegionName=string} ...

Синтаксис JSON:

[
  {
    "Create": {
      "RegionName": "string"
    },
    "Delete": {
      "RegionName": "string"
    }
  }
  ...
]

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

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

Для обновления глобальной таблицы DynamoDB

Следующий update-global-table пример добавляет реплику в указанный регион в глобальную таблицу MusicCollection.

aws dynamodb update-global-table \
    --global-table-name MusicCollection \
    --replica-updates Create={RegionName=eu-west-1}

Вывод:

{
    "GlobalTableDescription": {
        "ReplicationGroup": [
            {
                "RegionName": "eu-west-1"
            },
            {
                "RegionName": "us-east-2"
            },
            {
                "RegionName": "us-east-1"
            }
        ],
        "GlobalTableArn": "arn:aws:dynamodb::123456789012:global-table/MusicCollection",
        "CreationDateTime": 1576625818.532,
        "GlobalTableStatus": "ACTIVE",
        "GlobalTableName": "MusicCollection"
    }
}

Дополнительную информацию см. в разделе DynamoDB Global Tables в Руководстве разработчика Amazon DynamoDB.

Вывод

ОписаниеГлобальнойТаблицы -> (структура)

Содержит сведения о глобальной таблице.

ГруппаРепликации -> (список)

Регионы, в которых имеются реплики глобальной таблицы.

(структура)

Содержит сведения о реплике.

ИмяРегиона -> (строка)

Название региона.

СтатусРеплики -> (строка)

Текущее состояние реплики:

  • CREATING - Реплика создаётся.
  • UPDATING - Реплика обновляется.
  • DELETING - Реплика удаляется.
  • ACTIVE - Реплика готова к использованию.
  • REGION_DISABLED - Реплика недоступна, так как регион Amazon Web Services отключён.

Примечание

Если регион Amazon Web Services остаётся недоступным более 20 часов, DynamoDB удалит эту реплику из группы репликации. Реплика не будет удалена, и репликация со и из этого региона прекратится.
  • INACCESSIBLE_ENCRYPTION_CREDENTIALS - Ключ KMS, используемый для шифрования таблицы, недоступен.

Примечание

Если ключ KMS остаётся недоступным более 20 часов, DynamoDB удалит эту реплику из группы репликации. Реплика не будет удалена, и репликация со и из этого региона прекратится.

ОписаниеСтатусаРеплики -> (строка)

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

ПроцентЗавершенияРеплики -> (строка)

Указывает процент выполнения операции создания, обновления или удаления реплики.

ИдентификаторКлючаKMS -> (строка)

Ключ KMS реплики, который будет использоваться для шифрования KMS.

ПереопределениеПропускнойСпособности -> (структура)

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

ЕдиницыПропускнойСпособностиЧтения -> (целое)

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

ПереопределениеПропускнойСпособностиПоТребованию -> (структура)

Заменяет максимальные настройки пропускной способности по требованию для указанной реплики таблицы.

МаксимальноеКоличествоЗапросовЧтения -> (целое)

Максимальное количество единиц запросов чтения для указанной таблицы реплики.

ТеплаяПропускнаяСпособность -> (структура)

Представляет значение тепловой пропускной способности для этой реплики.

ЕдиницыПропускнойСпособностиЧтенияВСекунду -> (целое)

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

ЕдиницыПропускнойСпособностиЗаписиВСекунду -> (целое)

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

Статус -> (строка)

Представляет значение тепловой пропускной способности базовой таблицы.

ГлобальныеВторичныеИндексы -> (список)

Настройки глобального вторичного индекса, специфичные для реплики.

(структура)

Представляет свойства реплики глобального вторичного индекса.

ИмяИндекса -> (строка)

Имя глобального вторичного индекса.

ПереопределениеПропускнойСпособности -> (структура)

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

ЕдиницыПропускнойСпособностиЧтения -> (целое)

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

ПереопределениеПропускнойСпособностиПоТребованию -> (структура)

Заменяет максимальную пропускную способность по требованию для указанного глобального вторичного индекса в указанной таблице реплики.

МаксимальноеКоличествоЗапросовЧтения -> (целое)

Максимальное количество единиц запросов чтения для указанной таблицы реплики.

ТеплаяПропускнаяСпособность -> (структура)

Представляет тепловую пропускную способность глобального вторичного индекса для этой реплики.

ЕдиницыПропускнойСпособностиЧтенияВСекунду -> (целое)

Представляет значение тепловой пропускной способности в единицах пропускной способности чтения в секунду для глобального вторичного индекса.

ЕдиницыПропускнойСпособностиЗаписиВСекунду -> (целое)

Представляет значение тепловой пропускной способности в единицах пропускной способности записи в секунду для глобального вторичного индекса.

Статус -> (строка)

Представляет статус тепловой пропускной способности, создаваемый или обновляемый в глобальном вторичном индексе. Статус может быть только UPDATING или ACTIVE .

ДатаНедоступностиРеплики -> (маркер времени)

Дата и время, когда реплика была впервые обнаружена как недоступная. Чтобы определить причину недоступности, проверьте свойство ReplicaStatus.

КраткоеОписаниеКлассаТаблицыРеплики -> (структура)

Содержит сведения о классе таблицы.

КлассТаблицы -> (строка)

Класс таблицы указанной таблицы. Допустимые значения - STANDARD и STANDARD_INFREQUENT_ACCESS.

ПоследняяДатаОбновления -> (маркер времени)

Дата и время последнего обновления класса таблицы.

ArnГлобальнойТаблицы -> (строка)

Уникальный идентификатор глобальной таблицы.

ДатаСоздания -> (маркер времени)

Время создания глобальной таблицы.

СтатусГлобальнойТаблицы -> (строка)

Текущее состояние глобальной таблицы:

  • CREATING - Глобальная таблица создаётся.
  • UPDATING - Глобальная таблица обновляется.
  • DELETING - Глобальная таблица удаляется.
  • ACTIVE - Глобальная таблица готова к использованию.

ИмяГлобальнойТаблицы -> (строка)

Имя глобальной таблицы.

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

Spec-Zone.ru

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