Spec-Zone.ru › AWS CLI v2

[ aws . docdb-elastic ]

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

Описание

Изменяет эластичный кластер. Это включает обновление имени/пароля администратора, обновление версии API и настройку окна резервного копирования и окна технического обслуживания.

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

Синтаксис

  update-cluster
[--admin-user-password <value>]
[--auth-type <value>]
[--backup-retention-period <value>]
[--client-token <value>]
--cluster-arn <value>
[--preferred-backup-window <value>]
[--preferred-maintenance-window <value>]
[--shard-capacity <value>]
[--shard-count <value>]
[--shard-instance-count <value>]
[--subnet-ids <value>]
[--vpc-security-group-ids <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]

Параметры

--admin-user-password (строка)

Пароль, связанный с администратором эластичного кластера. Этот пароль может содержать любые печатные символы ASCII, кроме слеша (/), двойной кавычки (“) или символа "собаки" (@).

Ограничения: Должен содержать от 8 до 100 символов.

--auth-type (строка)

Тип аутентификации, используемый для определения места получения пароля для доступа к эластичному кластеру. Допустимые типы — PLAIN_TEXT или SECRET_ARN.

Возможные значения:

  • PLAIN_TEXT
  • SECRET_ARN

--backup-retention-period (целое число)

Количество дней, в течение которых сохраняются автоматические снимки.

--client-token (строка)

Маркер клиента для эластичного кластера.

--cluster-arn (строка)

Идентификатор ARN эластичного кластера.

--preferred-backup-window (строка)

Ежедневный интервал времени, в течение которого создаются автоматические резервные копии, если автоматические резервные копии включены, как определено backupRetentionPeriod.

--preferred-maintenance-window (строка)

Еженедельный интервал времени, в течение которого может происходить техническое обслуживание системы, в формате универсального времени координации (UTC).

Формат: ddd:hh24:mi-ddd:hh24:mi

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

Допустимые дни: Пн, Вт, Ср, Чт, Пт, Сб, Вс

Ограничения: Минимальный интервал 30 минут.

--shard-capacity (целое число)

Количество vCPU, назначенных каждому фрагменту эластичного кластера. Максимальное значение — 64. Допустимые значения — 2, 4, 8, 16, 32, 64.

--shard-count (целое число)

Количество фрагментов, назначенных эластичному кластеру. Максимальное значение — 32.

--shard-instance-count (целое число)

Количество реплицированных экземпляров, применяемых ко всем фрагментам в эластичном кластере. Значение shardInstanceCount, равное 1, означает, что имеется один экземпляр записи, а любые дополнительные экземпляры являются репликами, которые могут использоваться для чтения и повышения доступности.

--subnet-ids (список)

Идентификаторы подсетей Amazon EC2 для эластичного кластера.

(строка)

Синтаксис:

"string" "string" ...

--vpc-security-group-ids (список)

Список групп безопасности VPC EC2 для ассоциации с эластичным кластером.

(строка)

Синтаксис:

"string" "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
  • текст
  • таблица
  • yaml
  • yaml-поток

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать определенный профиль из файла учетных данных.

--region (строка)

Регион для использования. Переопределяет параметры конфигурации/среды.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

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

  • вкл
  • выкл
  • авто

--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-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Вывод

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

Возвращает информацию об обновленном эластичном кластере.

adminUserName -> (строка)

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

authType -> (строка)

Тип аутентификации для эластичного кластера.

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

Количество дней, в течение которых сохраняются автоматические снимки.

clusterArn -> (строка)

Идентификатор ARN эластичного кластера.

clusterEndpoint -> (строка)

URL, используемый для подключения к эластичному кластеру.

clusterName -> (строка)

Имя эластичного кластера.

createTime -> (строка)

Время создания эластичного кластера в формате универсального времени координации (UTC).

kmsKeyId -> (строка)

Идентификатор ключа KMS для шифрования эластичного кластера.

preferredBackupWindow -> (строка)

Ежедневный интервал времени, в течение которого создаются автоматические резервные копии, если автоматические резервные копии включены, как определено backupRetentionPeriod.

preferredMaintenanceWindow -> (строка)

Еженедельный интервал времени, в течение которого может происходить техническое обслуживание системы, в формате универсального времени координации (UTC).

Формат: ddd:hh24:mi-ddd:hh24:mi

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

Количество vCPU, назначенных каждому фрагменту эластичного кластера. Максимальное значение — 64. Допустимые значения — 2, 4, 8, 16, 32, 64.

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

Количество фрагментов, назначенных эластичному кластеру. Максимальное значение — 32.

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

Количество реплицированных экземпляров, применяемых ко всем фрагментам в кластере. Значение shardInstanceCount, равное 1, означает, что имеется один экземпляр записи, а любые дополнительные экземпляры являются репликами, которые могут использоваться для чтения и повышения доступности.

shards -> (список)

Общее количество фрагментов в кластере.

(структура)

Имя фрагмента.

createTime -> (строка)

Время создания фрагмента в формате универсального времени координации (UTC).

shardId -> (строка)

Идентификатор фрагмента.

status -> (строка)

Текущий статус фрагмента.

status -> (строка)

Статус эластичного кластера.

subnetIds -> (список)

Идентификаторы подсетей Amazon EC2 для эластичного кластера.

(строка)

vpcSecurityGroupIds -> (список)

Список групп безопасности VPC EC2, связанных с этим эластичным кластером.

(строка)

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

Spec-Zone.ru

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