Spec-Zone.ru › AWS CLI v2

[ aws . memorydb ]

update-cluster

Описание

Изменяет параметры кластера. Можно использовать эту операцию для изменения одного или нескольких параметров конфигурации кластера, указав параметры и новые значения.

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

Синтаксис

  update-cluster
--cluster-name <value>
[--description <value>]
[--security-group-ids <value>]
[--maintenance-window <value>]
[--sns-topic-arn <value>]
[--sns-topic-status <value>]
[--parameter-group-name <value>]
[--snapshot-window <value>]
[--snapshot-retention-limit <value>]
[--node-type <value>]
[--engine <value>]
[--engine-version <value>]
[--replica-configuration <value>]
[--shard-configuration <value>]
[--acl-name <value>]
[--ip-discovery <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]

Параметры

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

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

--description (строка)

Описание кластера для обновления.

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

SecurityGroupIds для обновления.

(строка)

Синтаксис:

"string" "string" ...

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

Указывает еженедельный временной интервал, в течение которого выполняется техническое обслуживание кластера. Задаётся как диапазон в формате ddd:hh24:mi-ddd:hh24:mi (24-часовой формат UTC). Минимальная длительность интервала технического обслуживания — 60 минут.

Допустимые значения для ddd:

  • sun
  • mon
  • tue
  • wed
  • thu
  • fri
  • sat

Пример: sun:23:00-mon:01:30

--sns-topic-arn (строка)

ARN темы SNS для обновления.

--sns-topic-status (строка)

Состояние темы уведомлений Amazon SNS. Уведомления отправляются только если состояние активное.

--parameter-group-name (строка)

Имя группы параметров для обновления.

--snapshot-window (строка)

Ежедневный временной интервал (в формате UTC), в течение которого MemoryDB создаёт ежедневную резервную копию вашего кластера.

--snapshot-retention-limit (целое число)

Количество дней, в течение которых MemoryDB сохраняет автоматические резервные копии кластера перед удалением. Например, если вы установите SnapshotRetentionLimit в 5, резервная копия, созданная сегодня, сохраняется в течение 5 дней, прежде чем будет удалена.

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

Допустимый тип узла, до которого вы хотите масштабировать этот кластер вверх или вниз.

--engine (строка)

Имя движка, используемого для кластера.

--engine-version (строка)

Обновлённая версия движка, которая будет запущена на узлах. Вы можете обновить до новой версии движка, но не можете перейти на более раннюю версию движка. Если вы хотите использовать более раннюю версию движка, вы должны удалить существующий кластер и создать его заново с более ранней версией движка.

--replica-configuration (структура)

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

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

Количество реплик для увеличения или уменьшения.

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

ReplicaCount=integer

Синтаксис JSON:

{
  "ReplicaCount": integer
}

--shard-configuration (структура)

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

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

Количество фрагментов в кластере

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

ShardCount=integer

Синтаксис JSON:

{
  "ShardCount": integer
}

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

Список управления доступом, связанный с кластером.

--ip-discovery (строка)

Механизм обнаружения IP-адресов для протокола обнаружения кластера. Допустимые значения — ‘ipv4’ или ‘ipv6’. При установке в ‘ipv4’ такие функции обнаружения кластера, как слоты кластера, фрагменты кластера и узлы кластера, будут возвращать IPv4-адреса для узлов кластера. При установке в ‘ipv6’ функции обнаружения кластера возвращают IPv6-адреса для узлов кластера. Значение должно быть совместимо с параметром NetworkType. Если не указано, значение по умолчанию — ‘ipv4’.

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

  • ipv4
  • ipv6

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

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

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

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

Примеры

Примечание

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

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

Для обновления кластера

Следующее обновление кластера `update-cluster` обновляет группу параметров кластера до `my-parameter-group`.

aws memorydb update-cluster \
    --cluster-name my-cluster \
    --parameter-group-name my-parameter-group

Вывод:

{
    "Cluster": {
        "Name": "my-cluster",
        "Status": "available",
        "NumberOfShards": 2,
        "AvailabilityMode": "MultiAZ",
        "ClusterEndpoint": {
            "Address": "clustercfg.my-cluster.llru6f.memorydb.us-east-1.amazonaws.com",
            "Port": 6379
        },
        "NodeType": "db.r6g.large",
        "EngineVersion": "6.2",
        "EnginePatchVersion": "6.2.6",
        "ParameterGroupName": "my-parameter-group",
        "ParameterGroupStatus": "in-sync",
        "SecurityGroups": [
            {
                "SecurityGroupId": "sg-0a143xxxxxc9fae",
                "Status": "active"
            }
        ],
        "SubnetGroupName": "pat-sg",
        "TLSEnabled": true,
        "ARN": "arn:aws:memorydb:us-east-1:491658xxxxxx:cluster/my-cluster",
        "SnapshotRetentionLimit": 0,
        "MaintenanceWindow": "wed:03:00-wed:04:00",
        "SnapshotWindow": "04:30-05:30",
        "ACLName": "my-acl",
        "AutoMinorVersionUpgrade": true
    }
}

Для получения дополнительной информации см. Раздел "Изменение параметров кластера" в Руководстве пользователя MemoryDB.

Вывод

Кластер -> (структура)

Обновленный кластер.

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

Имя кластера, предоставленное пользователем. Этот идентификатор является уникальным ключом, определяющим кластер.

Описание -> (строка)

Описание кластера

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

Статус кластера. Например, Доступен, Обновляется, Создается.

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

Группа настроек, которые в настоящее время применяются.

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

Статус операции онлайн-решардинга.

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

Статус онлайн-миграции слотов решардинга

ProgressPercentage -> (двойное)

Процент завершенной миграции слотов.

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

Список ACL, связанных с кластером, которые обновляются

ACLToApply -> (строка)

Список ACL, ожидающих применения.

ServiceUpdates -> (список)

Список обновлений служб, применяемых к кластеру

(структура)

Действие обновления, которое еще не обработано для соответствующего запроса применения/остановки

ServiceUpdateName -> (строка)

Уникальный идентификатор обновления службы

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

Статус обновления службы

MultiRegionClusterName -> (строка)

Имя многорегионального кластера, к которому принадлежит этот кластер.

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

Количество фрагментов в кластере

Shards -> (список)

Список фрагментов, являющихся членами кластера.

(структура)

Представляет собой набор узлов в кластере. Один узел в группе узлов является основным узлом чтения/записи. Все остальные узлы являются узлами-репликами для чтения.

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

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

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

Текущее состояние этой группы репликации - создание, доступен, изменение, удаление.

Slots -> (строка)

Пространство имен для этого фрагмента.

Nodes -> (список)

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

(структура)

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

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

Идентификатор узла. Имя узла — это числовой идентификатор (0001, 0002 и т. д.). Сочетание имени кластера, имени фрагмента и имени узла однозначно идентифицирует каждый узел, используемый в учетной записи Amazon клиента.

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

Статус обновления службы на узле

AvailabilityZone -> (строка)

Зона доступности, в которой находится узел

CreateTime -> (временная метка)

Дата и время создания узла.

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

Имя хоста для подключения к этому узлу.

Адрес -> (строка)

Имя хоста DNS узла.

Порт -> (целое число)

Номер порта, на котором работает движок.

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

Количество узлов во фрагменте

AvailabilityMode -> (строка)

Указывает, имеет ли кластер конфигурацию Multi-AZ (multiaz) или нет (singleaz).

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

Конфигурационный конечный пункт кластера

Адрес -> (строка)

Имя хоста DNS узла.

Порт -> (целое число)

Номер порта, на котором работает движок.

NodeType -> (строка)

Тип узла кластера

Engine -> (строка)

Имя движка, используемого кластером.

EngineVersion -> (строка)

Версия движка Redis OSS, используемого кластером

EnginePatchVersion -> (строка)

Версия исправления движка Redis OSS, используемого кластером

ParameterGroupName -> (строка)

Имя группы параметров, используемой кластером

ParameterGroupStatus -> (строка)

Статус группы параметров, используемой кластером, например, «активный» или «применяется».

SecurityGroups -> (список)

Список групп безопасности, используемых кластером

(структура)

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

SecurityGroupId -> (строка)

Идентификатор группы безопасности.

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

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

SubnetGroupName -> (строка)

Имя группы подсетей, используемой кластером

TLSEnabled -> (булево)

Флаг, указывающий, включена ли шифровка трафика в пути

KmsKeyId -> (строка)

Идентификатор ключа KMS, используемого для шифрования кластера

ARN -> (строка)

Amazon Resource Name (ARN) кластера.

SnsTopicArn -> (строка)

Amazon Resource Name (ARN) темы уведомлений SNS

SnsTopicStatus -> (строка)

Тема SNS должна быть в активном состоянии для получения уведомлений

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

Количество дней, в течение которых MemoryDB сохраняет автоматические снимки до их удаления. Например, если вы установили SnapshotRetentionLimit в 5, снимок, сделанный сегодня, сохраняется в течение 5 дней до удаления.

MaintenanceWindow -> (строка)

Указывает еженедельный временной интервал, в течение которого выполняется обслуживание кластера. Он задается как интервал в формате ddd:hh24:mi-ddd:hh24:mi (24-часовой формат UTC). Минимальный интервал обслуживания — 60 минут.

SnapshotWindow -> (строка)

Ежедневный временной интервал (в UTC), в течение которого MemoryDB начинает создание ежедневного снимка вашего фрагмента. Пример: 05:00-09:00. Если вы не укажете этот параметр, MemoryDB автоматически выберет подходящий временной интервал.

ACLName -> (строка)

Имя списка управления доступом, связанного с этим кластером.

AutoMinorVersionUpgrade -> (булево)

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

DataTiering -> (строка)

Включает тиерование данных. Тиерование данных поддерживается только для кластеров, использующих тип узла r6gd. Этот параметр должен быть установлен при использовании узлов r6gd. Дополнительная информация приведена в разделе «Тьерование данных».

NetworkType -> (строка)

Тип IP-адреса для кластера. Возвращает «ipv4» для только IPv4, «ipv6» для только IPv6 или «dual-stack», если кластер поддерживает адресацию IPv4 и IPv6.

IpDiscovery -> (строка)

Механизм, который кластер использует для обнаружения IP-адресов. Возвращает «ipv4», когда конечные точки DNS разрешаются до IP-адресов IPv4, или «ipv6», когда конечные точки DNS разрешаются до IP-адресов IPv6.

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

Spec-Zone.ru

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