modify-replication-group-shard-configuration

Описание

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

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

Синтаксис

  modify-replication-group-shard-configuration
--replication-group-id <value>
--node-group-count <value>
--apply-immediately | --no-apply-immediately
[--resharding-configuration <value>]
[--node-groups-to-remove <value>]
[--node-groups-to-retain <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]

Параметры

--replication-group-id (строка)

Имя кластера Valkey или Redis OSS (с включенным режимом кластера) (группы репликации), для которого необходимо настроить фрагменты.

--node-group-count (целое число)

Количество групп узлов (фрагментов), которые получаются в результате изменения конфигурации фрагмента.

--apply-immediately | --no-apply-immediately (булево)

Указывает, что процесс переконфигурации фрагментов начинается немедленно. В настоящее время единственное допустимое значение для этого параметра — true.

Значение: true

--resharding-configuration (список)

Указывает предпочтительные доступные зоны для каждой группы узлов в кластере. Если значение NodeGroupCount больше текущего количества групп узлов (фрагментов), вы можете использовать этот параметр для указания предпочтительных доступных зон фрагментов кластера. Если вы опустите этот параметр, ElastiCache выберет для вас доступные зоны.

Вы можете указать этот параметр только в том случае, если значение NodeGroupCount больше текущего количества групп узлов (фрагментов).

(структура)

Список объектов PreferredAvailabilityZones, которые задают конфигурацию группы узлов в реконфигурированном кластере.

NodeGroupId -> (строка)

Идентификатор группы узлов, предоставленный ElastiCache (4 цифры), или идентификатор, предоставленный пользователем, для которого применяются эти значения конфигурации.

PreferredAvailabilityZones -> (список)

Список предпочтительных доступных зон для узлов в этом кластере.

(строка)

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

NodeGroupId=string,PreferredAvailabilityZones=string,string ...

Синтаксис JSON:

[
  {
    "NodeGroupId": "string",
    "PreferredAvailabilityZones": ["string", ...]
  }
  ...
]

--node-groups-to-remove (список)

Если значение NodeGroupCount меньше текущего количества групп узлов (фрагментов), то требуется либо NodeGroupsToRemove, либо NodeGroupsToRetain. NodeGroupsToRemove — это список элементов NodeGroupId, которые необходимо удалить из кластера.

ElastiCache попытается удалить все группы узлов, указанные в NodeGroupsToRemove, из кластера.

(строка)

Синтаксис:

"string" "string" ...

--node-groups-to-retain (список)

Если значение NodeGroupCount меньше текущего количества групп узлов (фрагментов), то требуется либо NodeGroupsToRemove, либо NodeGroupsToRetain. NodeGroupsToRetain — это список элементов NodeGroupId, которые необходимо сохранить в кластере.

ElastiCache попытается удалить все группы узлов, кроме тех, которые указаны в NodeGroupsToRetain, из кластера.

(строка)

Синтаксис:

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

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

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

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

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

Примеры

Примечание

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

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

Изменение конфигурации фрагмента группы репликации

Следующий modify-replication-group-shard-configuration уменьшает количество групп узлов с использованием движка Redis.

aws elasticache modify-replication-group-shard-configuration \
    --replication-group-id mycluster \
    --node-group-count 3 \
    --apply-immediately \
    --node-groups-to-remove 0002

Вывод

{
    "ReplicationGroup": {
        "ReplicationGroupId": "mycluster",
        "Description": "mycluster",
        "GlobalReplicationGroupInfo": {},
        "Status": "modifying",
        "PendingModifiedValues": {},
        "MemberClusters": [
            "mycluster-0002-001",
            "mycluster-0002-002",
            "mycluster-0002-003",
            "mycluster-0003-001",
            "mycluster-0003-002",
            "mycluster-0003-003",
            "mycluster-0003-004",
            "mycluster-0004-001",
            "mycluster-0004-002",
            "mycluster-0004-003",
            "mycluster-0005-001",
            "mycluster-0005-002",
            "mycluster-0005-003"
        ],
        "NodeGroups": [
            {
                "NodeGroupId": "0002",
                "Status": "modifying",
                "Slots": "894-1767,3134-4443,5149-5461,6827-7332,12570-13662",
                "NodeGroupMembers": [
                    {
                        "CacheClusterId": "mycluster-0002-001",
                        "CacheNodeId": "0001",
                        "PreferredAvailabilityZone": "us-west-2c"
                    },
                    {
                        "CacheClusterId": "mycluster-0002-002",
                        "CacheNodeId": "0001",
                        "PreferredAvailabilityZone": "us-west-2a"
                    },
                    {
                        "CacheClusterId": "mycluster-0002-003",
                        "CacheNodeId": "0001",
                        "PreferredAvailabilityZone": "us-west-2b"
                    }
                ]
            },
            {
                "NodeGroupId": "0003",
                "Status": "modifying",
                "Slots": "0-324,5462-5692,6784-6826,7698-8191,10923-11075,12441-12569,13663-16383",
                "NodeGroupMembers": [
                    {
                        "CacheClusterId": "mycluster-0003-001",
                        "CacheNodeId": "0001",
                        "PreferredAvailabilityZone": "us-west-2c"
                    },
                    {
                        "CacheClusterId": "mycluster-0003-002",
                        "CacheNodeId": "0001",
                        "PreferredAvailabilityZone": "us-west-2b"
                    },
                    {
                        "CacheClusterId": "mycluster-0003-003",
                        "CacheNodeId": "0001",
                        "PreferredAvailabilityZone": "us-west-2a"
                    },
                    {
                        "CacheClusterId": "mycluster-0003-004",
                        "CacheNodeId": "0001",
                        "PreferredAvailabilityZone": "us-west-2c"
                    }
                ]
            },
            {
                "NodeGroupId": "0004",
                "Status": "modifying",
                "Slots": "325-336,4706-5148,7333-7697,9012-10922,11076-12440",
                "NodeGroupMembers": [
                    {
                        "CacheClusterId": "mycluster-0004-001",
                        "CacheNodeId": "0001",
                        "PreferredAvailabilityZone": "us-west-2b"
                    },
                    {
                        "CacheClusterId": "mycluster-0004-002",
                        "CacheNodeId": "0001",
                        "PreferredAvailabilityZone": "us-west-2a"
                    },
                    {
                        "CacheClusterId": "mycluster-0004-003",
                        "CacheNodeId": "0001",
                        "PreferredAvailabilityZone": "us-west-2c"
                    }
                ]
            },
            {
                "NodeGroupId": "0005",
                "Status": "modifying",
                "Slots": "337-893,1768-3133,4444-4705,5693-6783,8192-9011",
                "NodeGroupMembers": [
                    {
                        "CacheClusterId": "mycluster-0005-001",
                        "CacheNodeId": "0001",
                        "PreferredAvailabilityZone": "us-west-2a"
                    },
                    {
                        "CacheClusterId": "mycluster-0005-002",
                        "CacheNodeId": "0001",
                        "PreferredAvailabilityZone": "us-west-2c"
                    },
                    {
                        "CacheClusterId": "mycluster-0005-003",
                        "CacheNodeId": "0001",
                        "PreferredAvailabilityZone": "us-west-2b"
                    }
                ]
            }
        ],
        "AutomaticFailover": "enabled",
        "MultiAZ": "enabled",
        "ConfigurationEndpoint": {
            "Address": "mycluster.g2xbih.clustercfg.usw2.cache.amazonaws.com",
            "Port": 6379
        },
        "SnapshotRetentionLimit": 1,
        "SnapshotWindow": "13:00-14:00",
        "ClusterEnabled": true,
        "CacheNodeType": "cache.r5.xlarge",
        "TransitEncryptionEnabled": false,
        "AtRestEncryptionEnabled": false
    }
}

Дополнительную информацию см. в разделе Масштабирование ElastiCache для кластеров Redis в Руководстве пользователя Elasticache.

Вывод

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

Содержит все атрибуты конкретной группы репликации Valkey или Redis OSS.

ReplicationGroupId -> (строка)

Идентификатор группы репликации.

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

Описание группы репликации, введённое пользователем.

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

Имя глобального хранилища данных и роль этой группы репликации в глобальном хранилище данных.

GlobalReplicationGroupId -> (строка)

Имя глобального хранилища данных

GlobalReplicationGroupMemberRole -> (строка)

Роль группы репликации в глобальном хранилище данных. Может быть основной или вторичной.

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

Текущее состояние этой группы репликации - creating , available , modifying , deleting , create-failed , snapshotting .

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

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

PrimaryClusterId -> (строка)

Идентификатор основного кластера, который применяется сразу (если --apply-immediately был указан), или во время следующего окна обслуживания.

AutomaticFailoverStatus -> (строка)

Указывает статус автоматического переключения для этой группы репликации Valkey или Redis OSS.

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

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

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

Представляет ход операции онлайн-решардинга.

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

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

AuthTokenStatus -> (строка)

Статус маркера аутентификации

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

Изменяемая группа пользователей.

UserGroupIdsToAdd -> (список)

Идентификатор группы пользователей для добавления.

(строка)

UserGroupIdsToRemove -> (список)

Идентификатор группы пользователей для удаления.

(строка)

LogDeliveryConfigurations -> (список)

Изменяемые конфигурации доставки логов

(структура)

Изменяемые конфигурации доставки логов

LogType -> (строка)

Относится к slow-log или engine-log.

DestinationType -> (строка)

Возвращает тип назначения, CloudWatch Logs или Kinesis Data Firehose.

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

Подробная информация о назначении CloudWatch Logs или Kinesis Data Firehose.

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

Подробная информация о назначении CloudWatch Logs.

LogGroup -> (строка)

Имя группы журналов CloudWatch Logs.

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

Подробная информация о назначении Kinesis Data Firehose.

DeliveryStream -> (строка)

Имя потока доставки Kinesis Data Firehose.

LogFormat -> (строка)

Возвращает формат лога, JSON или TEXT

TransitEncryptionEnabled -> (булево)

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

TransitEncryptionMode -> (строка)

Настройка, которая позволяет мигрировать клиентов на использование шифрования трафика без простоев.

ClusterMode -> (строка)

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

MemberClusters -> (список)

Имена всех кеш-кластеров, которые входят в эту группу репликации.

(строка)

NodeGroups -> (список)

Список групп узлов в этой группе репликации. Для групп репликации Valkey или Redis OSS (режим кластера выключен), это список из одного элемента. Для групп репликации Valkey или Redis OSS (режим кластера включен), список содержит запись для каждой группы узлов (фрагмента).

(структура)

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

NodeGroupId -> (строка)

Идентификатор группы узлов (фрагмента). Группа репликации Valkey или Redis OSS (режим кластера выключен) содержит только 1 группу узлов; следовательно, идентификатор группы узлов — 0001. Группа репликации Valkey или Redis OSS (режим кластера включен) содержит от 1 до 90 групп узлов, пронумерованных от 0001 до 0090. Пользователь может указать идентификатор группы узлов.

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

Текущее состояние этой группы репликации - creating , available , modifying , deleting .

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

Адрес основного узла в этой группе узлов (фрагменте).

Address -> (строка)

DNS-имя хоста узла кэша.

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

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

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

Адрес узлов реплики в этой группе узлов (фрагменте). Это значение является только для чтения.

Address -> (строка)

DNS-имя хоста узла кэша.

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

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

Slots -> (строка)

Пространство имен ключей для этой группы узлов (фрагмента).

NodeGroupMembers -> (список)

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

(структура)

Представляет отдельный узел в группе узлов (фрагменте).

CacheClusterId -> (строка)

Идентификатор кластера, к которому принадлежит узел.

CacheNodeId -> (строка)

Идентификатор узла в его кластере. Идентификатор узла — это числовой идентификатор (0001, 0002 и т. д.).

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

Информация, необходимая программам-клиентам для подключения к узлу для операций чтения. Адрес чтения применим только к кластерам Valkey или Redis OSS (режим кластера выключен).

Address -> (строка)

DNS-имя хоста узла кэша.

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

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

PreferredAvailabilityZone -> (строка)

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

PreferredOutpostArn -> (строка)

ARN экспоста группы узлов.

CurrentRole -> (строка)

Роль, которая в настоящее время назначена узлу - primary или replica . Этот член применим только к группам репликации Valkey или Redis OSS (режим кластера выключен).

SnapshottingClusterId -> (строка)

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

AutomaticFailover -> (строка)

Указывает статус автоматического переключения для этой группы репликации Valkey или Redis OSS.

MultiAZ -> (строка)

Флаг, указывающий, включен ли Multi-AZ для повышения отказоустойчивости. Дополнительную информацию см. в Minimizing Downtime: Multi-AZ

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

Конфигурационный адрес для этой группы репликации. Используйте конфигурационный адрес для подключения к этой группе репликации.

Address -> (строка)

DNS-имя хоста узла кэша.

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

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

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

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

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

Если значение SnapshotRetentionLimit установлено в ноль (0), резервные копии отключены.

SnapshotWindow -> (строка)

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

Пример: 05:00-09:00

Если вы не укажете этот параметр, ElastiCache автоматически выберет соответствующий интервал времени.

Примечание

Этот параметр действителен только в том случае, если параметр Engine равен redis .

ClusterEnabled -> (булево)

Флаг, указывающий, включена ли для этой группы репликации функция работы в кластере; т. е., можно ли разделить данные по нескольким фрагментам (API/CLI: группы узлов).

Допустимые значения: true | false

CacheNodeType -> (строка)

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

AuthTokenEnabled -> (булево)

Флаг, который включает использование AuthToken (пароль) при выполнении команд Valkey или Redis OSS.

По умолчанию: false

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

Дата последнего изменения маркера аутентификации

TransitEncryptionEnabled -> (булево)

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

Необходимо: Доступно только при создании группы репликации в Amazon VPC с использованием версии Redis OSS 3.2.6 , 4.x или более поздней.

По умолчанию: false

AtRestEncryptionEnabled -> (булево)

Флаг, который включает шифрование при хранении, при установке в true .

Нельзя изменить значение AtRestEncryptionEnabled после создания кластера. Чтобы включить шифрование при хранении для кластера, вы должны установить AtRestEncryptionEnabled в true при создании кластера.

По умолчанию: false

MemberClustersOutpostArns -> (список)

ARN экспостов для кластеров-участников группы репликации.

(строка)

KmsKeyId -> (строка)

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

ARN -> (строка)

ARN (Amazon Resource Name) группы репликации.

UserGroupIds -> (список)

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

(строка)

LogDeliveryConfigurations -> (список)

Возвращает место назначения, формат и тип журналов.

(структура)

Возвращает место назначения, формат и тип журналов.

LogType -> (строка)

Относится к slow-log или engine-log.

DestinationType -> (строка)

Возвращает тип назначения, либо cloudwatch-logs, либо kinesis-firehose.

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

Детали конфигурации места назначения CloudWatch Logs или Kinesis Data Firehose.

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

Детали конфигурации места назначения CloudWatch Logs.

LogGroup -> (строка)

Имя группы журналов CloudWatch Logs.

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

Детали конфигурации места назначения Kinesis Data Firehose.

DeliveryStream -> (строка)

Имя потока доставки Kinesis Data Firehose.

LogFormat -> (строка)

Возвращает формат журнала, либо JSON, либо TEXT.

Status -> (строка)

Возвращает состояние конфигурации доставки журналов. Значения — одно из enabling | disabling | modifying | active | error

Message -> (строка)

Возвращает сообщение об ошибке для конфигурации доставки журнала.

ReplicationGroupCreateTime -> (метка времени)

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

DataTiering -> (строка)

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

AutoMinorVersionUpgrade -> (булево)

Если вы используете Valkey 7.2 и выше или движок Redis OSS версии 6.0 и выше, установите этот параметр в значение yes, если хотите принять участие в следующем автоматическом обновлении. Этот параметр отключен для предыдущих версий.

NetworkType -> (строка)

Должно быть либо ipv4 | ipv6 | dual_stack. IPv6 поддерживается для рабочих нагрузок, использующих Valkey 7.2 и выше, движок Redis OSS версии 6.2 до 7.1 или движок Memcached версии 1.6.6 и выше на всех экземплярах, созданных на системе Nitro.

IpDiscovery -> (строка)

Тип сети, который вы выбираете при изменении кластера, либо ipv4 | ipv6. IPv6 поддерживается для рабочих нагрузок, использующих Valkey 7.2 и выше, движок Redis OSS версии 6.2 до 7.1 или движок Memcached версии 1.6.6 и выше на всех экземплярах, созданных на системе Nitro.

TransitEncryptionMode -> (строка)

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

ClusterMode -> (строка)

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

Engine -> (строка)

Движок, используемый в группе репликации. Доступные варианты: redis, memcached или valkey.