Spec-Zone.ru › AWS CLI v2

[ aws . keyspaces ]

update-table

Описание

Добавляет новые столбцы в таблицу или обновляет ее настройки, например, режим емкости, автоматическое масштабирование, шифрование, восстановление по состоянию на определенную точку времени или настройки ttl. Обратите внимание, что вы можете обновить только одну конкретную настройку таблицы за операцию обновления.

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

Синтаксис

  update-table
--keyspace-name <value>
--table-name <value>
[--add-columns <value>]
[--capacity-specification <value>]
[--encryption-specification <value>]
[--point-in-time-recovery <value>]
[--ttl <value>]
[--default-time-to-live <value>]
[--client-side-timestamps <value>]
[--auto-scaling-specification <value>]
[--replica-specifications <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 (строка)

Имя хранилища ключей, в котором хранится указанная таблица.

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

Имя таблицы.

--add-columns (список)

Для каждого столбца, который необходимо добавить в указанную таблицу:

  • name - Имя столбца.
  • type - Тип данных Amazon Keyspaces. Дополнительная информация в руководстве разработчика Amazon Keyspaces в разделе «Типы данных».

(структура)

Имена и типы данных обычных столбцов.

name -> (строка)

Имя столбца.

type -> (строка)

Тип данных столбца. Список доступных типов данных см. в руководстве разработчика Amazon Keyspaces в разделе «Типы данных».

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

name=string,type=string ...

Синтаксис JSON:

[
  {
    "name": "string",
    "type": "string"
  }
  ...
]

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

Изменяет режим емкости пропускной способности чтения/записи для таблицы. Доступные варианты:

  • throughputMode:PAY_PER_REQUEST и
  • throughputMode:PROVISIONED - Режим выделенной емкости требует readCapacityUnits и writeCapacityUnits в качестве входных данных.

По умолчанию throughput_mode:PAY_PER_REQUEST.

Дополнительная информация в руководстве разработчика Amazon Keyspaces в разделе «Режимы пропускной способности чтения/записи».

throughputMode -> (строка)

Режим емкости пропускной способности чтения/записи для таблицы. Доступные варианты:

  • throughputMode:PAY_PER_REQUEST и
  • throughputMode:PROVISIONED - Режим выделенной емкости требует readCapacityUnits и writeCapacityUnits в качестве входных данных.

По умолчанию throughput_mode:PAY_PER_REQUEST.

Дополнительная информация в руководстве разработчика Amazon Keyspaces в разделе «Режимы пропускной способности чтения/записи».

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

Емкость пропускной способности, заданная для операций read, определенных в read capacity units (RCUs) .

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

Емкость пропускной способности, заданная для операций write, определенных в write capacity units (WCUs) .

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

throughputMode=string,readCapacityUnits=long,writeCapacityUnits=long

Синтаксис JSON:

{
  "throughputMode": "PAY_PER_REQUEST"|"PROVISIONED",
  "readCapacityUnits": long,
  "writeCapacityUnits": long
}

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

Изменяет настройки шифрования таблицы. Вы можете выбрать один из следующих ключей KMS:

  • type:AWS_OWNED_KMS_KEY - Этот ключ принадлежит Amazon Keyspaces.
  • type:CUSTOMER_MANAGED_KMS_KEY - Этот ключ хранится в вашем аккаунте и создается, принадлежит и управляется вами. Этот вариант требует kms_key_identifier идентификатора ключа KMS в формате Amazon Resource Name (ARN).

По умолчанию AWS_OWNED_KMS_KEY.

Дополнительная информация в руководстве разработчика Amazon Keyspaces в разделе «Шифрование в состоянии покоя».

type -> (строка)

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

  • type:AWS_OWNED_KMS_KEY - Этот ключ принадлежит Amazon Keyspaces.
  • type:CUSTOMER_MANAGED_KMS_KEY - Этот ключ хранится в вашем аккаунте и создается, принадлежит и управляется вами. Этот вариант требует kms_key_identifier идентификатора ключа KMS в формате Amazon Resource Name (ARN).

По умолчанию type:AWS_OWNED_KMS_KEY.

Дополнительная информация в руководстве разработчика Amazon Keyspaces в разделе «Шифрование в состоянии покоя».

kmsKeyIdentifier -> (строка)

Amazon Resource Name (ARN) управляемого пользователем ключа KMS, например kms_key_identifier:ARN .

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

type=string,kmsKeyIdentifier=string

Синтаксис JSON:

{
  "type": "CUSTOMER_MANAGED_KMS_KEY"|"AWS_OWNED_KMS_KEY",
  "kmsKeyIdentifier": "string"
}

--point-in-time-recovery (структура)

Изменяет параметры pointInTimeRecovery таблицы. Доступные варианты:

  • status=ENABLED
  • status=DISABLED

Если не указано, по умолчанию status=DISABLED.

Дополнительная информация в руководстве разработчика Amazon Keyspaces в разделе «Восстановление по состоянию на определенную точку времени».

status -> (строка)

Доступные варианты:

  • status=ENABLED
  • status=DISABLED

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

status=string

Синтаксис JSON:

{
  "status": "ENABLED"|"DISABLED"
}

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

Изменяет пользовательские настройки Time to Live для таблицы. Доступные варианты:

  • status:enabled
  • status:disabled

По умолчанию status:disabled. После активации ttl, ее нельзя отключить для таблицы.

Дополнительная информация в руководстве разработчика Amazon Keyspaces в разделе «Истечение срока действия данных с использованием Amazon Keyspaces Time to Live (TTL)».

status -> (строка)

Показывает, как включить пользовательские настройки Time to Live (TTL) для указанной таблицы.

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

status=string

Синтаксис JSON:

{
  "status": "ENABLED"
}

--default-time-to-live (целое число)

Значение Time to Live по умолчанию в секундах для таблицы.

Дополнительная информация в руководстве разработчика Amazon Keyspaces в разделе «Установка значения TTL по умолчанию для таблицы».

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

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

  • status: "enabled"

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

status -> (строка)

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

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

status=string

Синтаксис JSON:

{
  "status": "ENABLED"
}

--auto-scaling-specification (структура)

Дополнительные настройки автоматического масштабирования для обновления таблицы в режиме выделенных ресурсов. Указывает, может ли служба автоматически управлять пропускной способностью выделенной таблицы от вашего имени. Автоматическое масштабирование Amazon Keyspaces помогает эффективно выделять пропускную способность для переменных рабочих нагрузок, увеличивая и уменьшая пропускную способность чтения и записи вашей таблицы автоматически в ответ на трафик приложения.

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

Для получения дополнительной информации см. Управление пропускной способностью автоматически с помощью автоматического масштабирования Amazon Keyspaces в Руководстве разработчика Amazon Keyspaces.

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

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

autoScalingDisabled -> (логическое значение)

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

minimumUnits -> (длинное целое число)

Минимальный уровень пропускной способности, который таблица всегда должна быть готова поддерживать. Значение должно быть между 1 и максимальным лимитом пропускной способности в секунду для вашей учетной записи (по умолчанию 40 000).

maximumUnits -> (длинное целое число)

Управляйте затратами, указав максимальный объем пропускной способности для выделения. Значение должно быть между 1 и максимальным лимитом пропускной способности в секунду для вашей учетной записи (по умолчанию 40 000).

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

Amazon Keyspaces поддерживает target tracking политику автоматического масштабирования. С этой политикой Amazon Keyspaces автоматического масштабирования гарантирует, что отношение потребленной к выделенной пропускной способности таблицы остается на целевом значении, которое вы указали, или близко к нему. Вы определяете целевое значение как процент между 20 и 90.

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

Автоматическое масштабирование автоматически увеличивает пропускную способность, когда трафик превышает эту целевую скорость использования, а затем уменьшает ее, когда она падает ниже целевого значения. double значение между 20 и 90.

disableScaleIn -> (логическое значение)

Указывает, включено ли scale-in.

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

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

Указывает период охлаждения scale-in.

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

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

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

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

targetValue -> (вещественное число)

Указывает целевое значение для политики автоматического масштабирования по отслеживанию целей.

Автоматическое масштабирование Amazon Keyspaces автоматически увеличивает пропускную способность, когда трафик превышает эту целевую скорость использования, а затем уменьшает ее, когда она падает ниже целевого значения. Это гарантирует, что отношение потребленной пропускной способности к выделенной пропускной способности остается около этого значения. Вы определяете targetValue в процентах. double значение между 20 и 90.

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

Настройки автоматического масштабирования для пропускной способности чтения таблицы.

autoScalingDisabled -> (логическое значение)

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

minimumUnits -> (длинное целое число)

Минимальный уровень пропускной способности, который таблица всегда должна быть готова поддерживать. Значение должно быть между 1 и максимальным лимитом пропускной способности в секунду для вашей учетной записи (по умолчанию 40 000).

maximumUnits -> (длинное целое число)

Управляйте затратами, указав максимальный объем пропускной способности для выделения. Значение должно быть между 1 и максимальным лимитом пропускной способности в секунду для вашей учетной записи (по умолчанию 40 000).

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

Amazon Keyspaces поддерживает target tracking политику автоматического масштабирования. С этой политикой Amazon Keyspaces автоматического масштабирования гарантирует, что отношение потребленной к выделенной пропускной способности таблицы остается на целевом значении, которое вы указали, или близко к нему. Вы определяете целевое значение как процент между 20 и 90.

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

Автоматическое масштабирование автоматически увеличивает пропускную способность, когда трафик превышает эту целевую скорость использования, а затем уменьшает ее, когда она падает ниже целевого значения. double значение между 20 и 90.

disableScaleIn -> (логическое значение)

Указывает, включено ли scale-in.

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

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

Указывает период охлаждения scale-in.

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

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

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

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

targetValue -> (вещественное число)

Указывает целевое значение для политики автоматического масштабирования по отслеживанию целей.

Автоматическое масштабирование Amazon Keyspaces автоматически увеличивает пропускную способность, когда трафик превышает эту целевую скорость использования, а затем уменьшает ее, когда она падает ниже целевого значения. Это гарантирует, что отношение потребленной пропускной способности к выделенной пропускной способности остается около этого значения. Вы определяете targetValue в процентах. double значение между 20 и 90.

Синтаксис JSON:

{
  "writeCapacityAutoScaling": {
    "autoScalingDisabled": true|false,
    "minimumUnits": long,
    "maximumUnits": long,
    "scalingPolicy": {
      "targetTrackingScalingPolicyConfiguration": {
        "disableScaleIn": true|false,
        "scaleInCooldown": integer,
        "scaleOutCooldown": integer,
        "targetValue": double
      }
    }
  },
  "readCapacityAutoScaling": {
    "autoScalingDisabled": true|false,
    "minimumUnits": long,
    "maximumUnits": long,
    "scalingPolicy": {
      "targetTrackingScalingPolicyConfiguration": {
        "disableScaleIn": true|false,
        "scaleInCooldown": integer,
        "scaleOutCooldown": integer,
        "targetValue": double
      }
    }
  }
}

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

Региональные настройки многорегиональной таблицы.

(структура)

Настройки многорегиональной таблицы для конкретного региона Amazon Web Services.

Для многорегиональной таблицы вы можете настроить пропускную способность чтения таблицы по-разному для каждого региона Amazon Web Services. Это можно сделать, настроив следующие параметры.

  • region: Регион, в котором применяются эти настройки. (Необходимо)
  • readCapacityUnits: Выделенные единицы пропускной способности чтения. (Необязательно)
  • readCapacityAutoScaling: Настройки автоматического масштабирования пропускной способности чтения таблицы. (Необязательно)

region -> (строка)

Регион Amazon Web Services.

readCapacityUnits -> (длинное целое число)

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

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

Настройки автоматического масштабирования пропускной способности чтения для многорегиональной таблицы в указанном регионе Amazon Web Services.

autoScalingDisabled -> (логическое значение)

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

minimumUnits -> (длинное целое число)

Минимальный уровень пропускной способности, который таблица всегда должна быть готова поддерживать. Значение должно быть между 1 и максимальным лимитом пропускной способности в секунду для вашей учетной записи (по умолчанию 40 000).

maximumUnits -> (длинное целое число)

Управляйте затратами, указав максимальный объем пропускной способности для выделения. Значение должно быть между 1 и максимальным лимитом пропускной способности в секунду для вашей учетной записи (по умолчанию 40 000).

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

Amazon Keyspaces поддерживает target tracking политику автоматического масштабирования. С этой политикой Amazon Keyspaces автоматического масштабирования гарантирует, что отношение потребленной к выделенной пропускной способности таблицы остается на целевом значении, которое вы указали, или близко к нему. Вы определяете целевое значение как процент между 20 и 90.

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

Автоматическое масштабирование автоматически увеличивает пропускную способность, когда трафик превышает эту целевую скорость использования, а затем уменьшает ее, когда она падает ниже целевого значения. double значение между 20 и 90.

disableScaleIn -> (логическое значение)

Указывает, включено ли scale-in.

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

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

Указывает период охлаждения scale-in.

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

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

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

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

targetValue -> (вещественное число)

Указывает целевое значение для политики автоматического масштабирования по отслеживанию целей.

Автоматическое масштабирование Amazon Keyspaces автоматически увеличивает пропускную способность, когда трафик превышает эту целевую скорость использования, а затем уменьшает ее, когда она падает ниже целевого значения. Это гарантирует, что отношение потребленной пропускной способности к выделенной пропускной способности остается около этого значения. Вы определяете targetValue в процентах. double значение между 20 и 90.

Синтаксис JSON:

[
  {
    "region": "string",
    "readCapacityUnits": long,
    "readCapacityAutoScaling": {
      "autoScalingDisabled": true|false,
      "minimumUnits": long,
      "maximumUnits": long,
      "scalingPolicy": {
        "targetTrackingScalingPolicyConfiguration": {
          "disableScaleIn": true|false,
          "scaleInCooldown": integer,
          "scaleOutCooldown": integer,
          "targetValue": double
        }
      }
    }
  }
  ...
]

--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 для вывода.

--cli-auto-prompt (boolean)

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

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

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

Вывод

resourceArn -> (string)

Amazon Resource Name (ARN) изменённой таблицы.

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

Spec-Zone.ru

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