describe-global-table-settings
Описание
Описывает региональные настройки глобальной таблицы.
Предупреждение
Данная документация относится к версии 2017.11.29 (Устаревшая) глобальных таблиц, от использования которой следует отказаться при создании новых глобальных таблиц. По возможности, пользователям рекомендуется использовать глобальные таблицы версии 2019.11.21 (Текущая), так как она предоставляет большую гибкость, более высокую эффективность и потребляет меньше емкости записи, чем версия 2017.11.29 (Устаревшая).
Чтобы определить используемую версию, см. Определение используемой версии глобальной таблицы. Для обновления существующих глобальных таблиц из версии 2017.11.29 (Устаревшая) до версии 2019.11.21 (Текущая), см. Обновление глобальных таблиц.
См. также: Документацию API AWS
Синтаксис
describe-global-table-settings
--global-table-name <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 (строка)
--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 (строка)
Переопределить адрес по умолчанию команды на указанный адрес.
--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
Следующий describe-global-table-settings пример отображает настройки глобальной таблицы MusicCollection.
aws dynamodb describe-global-table-settings \
--global-table-name MusicCollection
Вывод:
{
"GlobalTableName": "MusicCollection",
"ReplicaSettings": [
{
"RegionName": "us-east-1",
"ReplicaStatus": "ACTIVE",
"ReplicaProvisionedReadCapacityUnits": 10,
"ReplicaProvisionedReadCapacityAutoScalingSettings": {
"AutoScalingDisabled": true
},
"ReplicaProvisionedWriteCapacityUnits": 5,
"ReplicaProvisionedWriteCapacityAutoScalingSettings": {
"AutoScalingDisabled": true
}
},
{
"RegionName": "us-east-2",
"ReplicaStatus": "ACTIVE",
"ReplicaProvisionedReadCapacityUnits": 10,
"ReplicaProvisionedReadCapacityAutoScalingSettings": {
"AutoScalingDisabled": true
},
"ReplicaProvisionedWriteCapacityUnits": 5,
"ReplicaProvisionedWriteCapacityAutoScalingSettings": {
"AutoScalingDisabled": true
}
}
]
}
Дополнительную информацию см. в разделе DynamoDB Global Tables в Руководстве разработчика Amazon DynamoDB.
Вывод
GlobalTableName -> (строка)
ReplicaSettings -> (список)
Настройки глобальной таблицы, специфичные для региона.
(структура)
Представляет свойства реплики.
RegionName -> (строка)
ReplicaStatus -> (строка)
Текущее состояние региона:
-
CREATING- Регион создается. -
UPDATING- Регион обновляется. -
DELETING- Регион удаляется. -
ACTIVE- Регион готов к использованию.
ReplicaBillingModeSummary -> (структура)
Режим емкости чтения/записи реплики.
BillingMode -> (строка)
Управляет тем, как вы оплачиваете пропускную способность чтения и записи и как управляете емкостью. Этот параметр можно изменить позже.
-
PROVISIONED- Устанавливает режим емкости чтения/записи вPROVISIONED. Рекомендуется использоватьPROVISIONEDдля предсказуемых рабочих нагрузок. -
PAY_PER_REQUEST- Устанавливает режим емкости чтения/записи вPAY_PER_REQUEST. Рекомендуется использоватьPAY_PER_REQUESTдля непредсказуемых рабочих нагрузок.
LastUpdateToPayPerRequestDateTime -> (временная метка)
PAY_PER_REQUEST был последний раз установлен в качестве режима емкости чтения/записи.ReplicaProvisionedReadCapacityUnits -> (целое число)
ThrottlingException . Для получения дополнительной информации см. раздел Указание требований к чтению и записи в Руководстве разработчика Amazon DynamoDB .ReplicaProvisionedReadCapacityAutoScalingSettings -> (структура)
Настройки автоматического масштабирования для единиц емкости чтения реплики глобальной таблицы.
MinimumUnits -> (целое число)
MaximumUnits -> (целое число)
AutoScalingDisabled -> (булево)
AutoScalingRoleArn -> (строка)
ScalingPolicies -> (список)
Информация о политиках масштабирования.
(структура)
Представляет свойства политики масштабирования.
PolicyName -> (строка)
TargetTrackingScalingPolicyConfiguration -> (структура)
Представляет конфигурацию политики масштабирования по отслеживанию целевых значений.
DisableScaleIn -> (булево)
ScaleInCooldown -> (целое число)
ScaleOutCooldown -> (целое число)
TargetValue -> (двойное число)
ReplicaProvisionedWriteCapacityUnits -> (целое число)
ThrottlingException . Для получения дополнительной информации см. раздел Указание требований к чтению и записи в Руководстве разработчика Amazon DynamoDB .ReplicaProvisionedWriteCapacityAutoScalingSettings -> (структура)
Настройки автоматического масштабирования для единиц емкости записи реплики глобальной таблицы.
MinimumUnits -> (целое число)
MaximumUnits -> (целое число)
AutoScalingDisabled -> (булево)
AutoScalingRoleArn -> (строка)
ScalingPolicies -> (список)
Информация о политиках масштабирования.
(структура)
Представляет свойства политики масштабирования.
PolicyName -> (строка)
TargetTrackingScalingPolicyConfiguration -> (структура)
Представляет конфигурацию политики масштабирования по отслеживанию целевых значений.
DisableScaleIn -> (булево)
ScaleInCooldown -> (целое число)
ScaleOutCooldown -> (целое число)
TargetValue -> (двойное число)
ReplicaGlobalSecondaryIndexSettings -> (список)
Параметры глобального вторичного индекса реплики для глобальной таблицы.
(структура)
Представляет свойства глобального вторичного индекса.
IndexName -> (строка)
IndexStatus -> (строка)
Текущий статус глобального вторичного индекса:
-
CREATING- Глобальный вторичный индекс создается. -
UPDATING- Глобальный вторичный индекс обновляется. -
DELETING- Глобальный вторичный индекс удаляется. -
ACTIVE- Глобальный вторичный индекс готов к использованию.
ProvisionedReadCapacityUnits -> (целое число)
ThrottlingException .ProvisionedReadCapacityAutoScalingSettings -> (структура)
Настройки автоматического масштабирования для единиц провизионной емкости для чтений реплики глобального вторичного индекса.
MinimumUnits -> (целое число)
MaximumUnits -> (целое число)
AutoScalingDisabled -> (булево)
AutoScalingRoleArn -> (строка)
ScalingPolicies -> (список)
Информация о политиках масштабирования.
(структура)
Представляет свойства политики масштабирования.
PolicyName -> (строка)
TargetTrackingScalingPolicyConfiguration -> (структура)
Представляет конфигурацию политики масштабирования с отслеживанием целевого значения.
DisableScaleIn -> (булево)
ScaleInCooldown -> (целое число)
ScaleOutCooldown -> (целое число)
TargetValue -> (число с плавающей точкой)
ProvisionedWriteCapacityUnits -> (целое число)
ThrottlingException .ProvisionedWriteCapacityAutoScalingSettings -> (структура)
Настройки автоматического масштабирования для единиц провизионной емкости для записей реплики глобального вторичного индекса.
MinimumUnits -> (целое число)
MaximumUnits -> (целое число)
AutoScalingDisabled -> (булево)
AutoScalingRoleArn -> (строка)
ScalingPolicies -> (список)
Информация о политиках масштабирования.
(структура)
Представляет свойства политики масштабирования.
PolicyName -> (строка)
TargetTrackingScalingPolicyConfiguration -> (структура)
Представляет конфигурацию политики масштабирования с отслеживанием целевого значения.
DisableScaleIn -> (булево)
ScaleInCooldown -> (целое число)
ScaleOutCooldown -> (целое число)
TargetValue -> (число с плавающей точкой)
ReplicaTableClassSummary -> (структура)
Содержит подробности о классе таблицы.
TableClass -> (строка)
STANDARD и STANDARD_INFREQUENT_ACCESS .LastUpdateDateTime -> (метка времени)
© Copyright 2025, Amazon Web Services. Created using Sphinx.