[ aws . elasticache ]
modify-replication-group
Описание
Изменяет параметры реплицируемой группы. Ограничено Valkey и Redis OSS 7 и выше.
- Масштабирование для Valkey или Redis OSS (режим кластера включен) в руководстве пользователя ElastiCache
- ModifyReplicationGroupShardConfiguration в справке API ElastiCache
Примечание
Данная операция действительна только для Valkey или Redis OSS.См. также: Документацию AWS API
Синтаксис
modify-replication-group
--replication-group-id <value>
[--replication-group-description <value>]
[--primary-cluster-id <value>]
[--snapshotting-cluster-id <value>]
[--automatic-failover-enabled | --no-automatic-failover-enabled]
[--multi-az-enabled | --no-multi-az-enabled]
[--node-group-id <value>]
[--cache-security-group-names <value>]
[--security-group-ids <value>]
[--preferred-maintenance-window <value>]
[--notification-topic-arn <value>]
[--cache-parameter-group-name <value>]
[--notification-topic-status <value>]
[--apply-immediately | --no-apply-immediately]
[--engine <value>]
[--engine-version <value>]
[--auto-minor-version-upgrade | --no-auto-minor-version-upgrade]
[--snapshot-retention-limit <value>]
[--snapshot-window <value>]
[--cache-node-type <value>]
[--auth-token <value>]
[--auth-token-update-strategy <value>]
[--user-group-ids-to-add <value>]
[--user-group-ids-to-remove <value>]
[--remove-user-groups | --no-remove-user-groups]
[--log-delivery-configurations <value>]
[--ip-discovery <value>]
[--transit-encryption-enabled | --no-transit-encryption-enabled]
[--transit-encryption-mode <value>]
[--cluster-mode <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 (строка)
--replication-group-description (строка)
--primary-cluster-id (строка)
--snapshotting-cluster-id (строка)
--automatic-failover-enabled | --no-automatic-failover-enabled (логическое значение)
Определяет, будет ли реплика чтения автоматически повышена до первичного чтения/записи, если существующий первичный узел выйдет из строя.
Допустимые значения: true | false
--multi-az-enabled | --no-multi-az-enabled (логическое значение)
--node-group-id (строка)
--cache-security-group-names (список)
Список имен групп безопасности кэша для авторизации кластеров в этой группе репликации. Это изменение применяется асинхронно в максимально короткие сроки.
Этот параметр можно использовать только с группами репликации, содержащими кластеры, работающие вне Amazon Virtual Private Cloud (Amazon VPC).
Ограничения: Должен содержать не более 255 символов. Не должен быть Default .
(строка)
Синтаксис:
"string" "string" ...
--security-group-ids (список)
Указывает группы безопасности VPC, связанные с кластерами в группе репликации.
Этот параметр можно использовать только с группами репликации, содержащими кластеры, работающие в Amazon Virtual Private Cloud (Amazon VPC).
(строка)
Синтаксис:
"string" "string" ...
--preferred-maintenance-window (строка)
Указывает еженедельный интервал времени, в течение которого выполняется техническое обслуживание кластера. Указывается как диапазон в формате ddd:hh24:mi-ddd:hh24:mi (24-часовой формат времени UTC). Минимальный интервал технического обслуживания составляет 60 минут.
Допустимые значения для ddd:
sunmontuewedthufrisat
Пример: sun:23:00-mon:01:30
--notification-topic-arn (строка)
Amazon Resource Name (ARN) темы Amazon SNS, в которую отправляются уведомления.
Примечание
Владелец темы Amazon SNS должен совпадать с владельцем группы репликации.--cache-parameter-group-name (строка)
ApplyImmediately указан как true для этого запроса.--notification-topic-status (строка)
Статус темы уведомлений Amazon SNS для группы репликации. Уведомления отправляются только в том случае, если статус active .
Допустимые значения: active | inactive
--apply-immediately | --no-apply-immediately (логическое значение)
Если true , этот параметр заставляет изменения в этом запросе и любые ожидающие изменения применяться асинхронно и в максимально короткие сроки независимо от значения PreferredMaintenanceWindow для группы репликации.
Если false , изменения узлов в группе репликации применяются при следующем перезапуске технического обслуживания или при следующем перезапуске из-за сбоя, что произойдет раньше.
Допустимые значения: true | false
По умолчанию: false
--engine (строка)
--engine-version (строка)
Обновленная версия движка кэша, которая будет запущена на кластерах в группе репликации.
--auto-minor-version-upgrade | --no-auto-minor-version-upgrade (логическое значение)
--snapshot-retention-limit (целое число)
Количество дней, в течение которых ElastiCache сохраняет автоматические снимки группы узлов (разделов), прежде чем удалить их. Например, если вы установите SnapshotRetentionLimit в 5, снимок, сделанный сегодня, сохраняется в течение 5 дней, прежде чем быть удаленным.
--snapshot-window (строка)
Ежедневный интервал времени (в формате UTC), в течение которого ElastiCache начинает создавать ежедневный снимок группы узлов (разделов), указанный параметром SnapshottingClusterId .
Пример: 05:00-09:00
Если вы не укажете этот параметр, ElastiCache автоматически выберет подходящий интервал.
--cache-node-type (строка)
--auth-token (строка)
Зарезервированный параметр. Пароль для доступа к защищенному паролем серверу. Этот параметр должен быть указан с параметром auth-token-update-strategy . Ограничения пароля:
- Должны содержать только печатаемые символы ASCII.
- Длина должна быть не менее 16 и не более 128 символов.
- Не может содержать следующие символы: ‘/’, ‘”’, или ‘@’, ‘%’
Дополнительная информация см. в разделе AUTH password в AUTH.
--auth-token-update-strategy (строка)
Указывает стратегию обновления маркера AUTH. Этот параметр должен быть указан с параметром auth-token. Возможные значения:
- ROTATE — по умолчанию, если стратегия обновления не указана
- SET — разрешено только после ROTATE
- DELETE — разрешено только при переходе на RBAC
Дополнительная информация см. в разделе Авторизация пользователей с помощью AUTH
Возможные значения:
SETROTATEDELETE
--user-group-ids-to-add (список)
Идентификатор группы пользователей, которую вы связываете с группой репликации.
(строка)
Синтаксис:
"string" "string" ...
--user-group-ids-to-remove (список)
Идентификатор группы пользователей, которую необходимо отсоединить от группы репликации, что означает, что пользователи в группе больше не могут получить доступ к группе репликации.
(строка)
Синтаксис:
"string" "string" ...
--remove-user-groups | --no-remove-user-groups (логическое значение)
--log-delivery-configurations (список)
Указывает пункт назначения, формат и тип журналов.
(структура)
Указывает пункт назначения, формат и тип журналов.
LogType -> (строка)
DestinationType -> (строка)
cloudwatch-logs либо kinesis-firehose в качестве типа пункта назначения.DestinationDetails -> (структура)
Сведения о конфигурации пункта назначения CloudWatch Logs или Kinesis Data Firehose.
CloudWatchLogsDetails -> (структура)
Сведения о конфигурации пункта назначения CloudWatch Logs.
LogGroup -> (строка)
KinesisFirehoseDetails -> (структура)
Сведения о конфигурации пункта назначения Kinesis Data Firehose.
DeliveryStream -> (строка)
LogFormat -> (строка)
Enabled -> (логическое значение)
true .Краткая форма синтаксиса:
LogType=string,DestinationType=string,DestinationDetails={CloudWatchLogsDetails={LogGroup=string},KinesisFirehoseDetails={DeliveryStream=string}},LogFormat=string,Enabled=boolean ...
Синтаксис JSON:
[
{
"LogType": "slow-log"|"engine-log",
"DestinationType": "cloudwatch-logs"|"kinesis-firehose",
"DestinationDetails": {
"CloudWatchLogsDetails": {
"LogGroup": "string"
},
"KinesisFirehoseDetails": {
"DeliveryStream": "string"
}
},
"LogFormat": "text"|"json",
"Enabled": true|false
}
...
]
--ip-discovery (строка)
Тип сети, который вы выбираете при изменении кластера, либо ipv4 | ipv6 . IPv6 поддерживается для рабочих нагрузок, использующих Valkey 7.2 и выше, Redis OSS версии 6.2 до 7.1 и Memcached версии 1.6.6 и выше на всех экземплярах, созданных на платформе Nitro.
Возможные значения:
ipv4ipv6
--transit-encryption-enabled | --no-transit-encryption-enabled (логическое значение)
TransitEncryptionMode в preferred .--transit-encryption-mode (строка)
Настройка, которая позволяет мигрировать клиентов для использования шифрования в процессе передачи без простоев.
Вы должны установить TransitEncryptionEnabled в true для существующего кластера и установить TransitEncryptionMode в preferred в том же запросе, чтобы разрешить как зашифрованные, так и незашифрованные соединения одновременно. После миграции всех клиентов Valkey или Redis OSS на использование зашифрованных соединений вы можете установить значение в required, чтобы разрешить только зашифрованные соединения.
Установка TransitEncryptionMode в required — это двухэтапный процесс, который требует предварительной установки TransitEncryptionMode в preferred, а затем установки TransitEncryptionMode в required.
Возможные значения:
preferredrequired
--cluster-mode (строка)
Включено или Выключено. Чтобы изменить режим кластера с «Выключено» на «Включено», вы сначала должны установить режим кластера в «Совместимо». Режим «Совместимо» позволяет вашим клиентам Valkey или Redis OSS подключаться как с включенным режимом кластера, так и с отключенным. После миграции всех клиентов Valkey или Redis OSS на использование режима кластера с включением вы можете завершить настройку режима кластера и установить режим кластера в «Включено».
Возможные значения:
enableddisabledcompatible
--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
- таблица
- 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.
Если не указано иное, все примеры используют правила цитирования Unix-подобных систем. Эти примеры необходимо адаптировать к правилам цитирования вашей терминальной оболочки. Дополнительную информацию см. в разделе Использование кавычек со строками в Руководстве пользователя AWS CLI.
Для изменения группы репликации
Следующий modify-replication-group отключает Multi-AZ с использованием движка Redis.
aws elasticache modify-replication-group \
--replication-group-id test-cluster \
--no-multi-az-enabled \
--apply-immediately
Вывод
{
"ReplicationGroup": {
"ReplicationGroupId": "test-cluster",
"Description": "test-cluster",
"GlobalReplicationGroupInfo": {
"GlobalReplicationGroupId": "sgaui-pat-group",
"GlobalReplicationGroupMemberRole": "PRIMARY"
},
"Status": "available",
"PendingModifiedValues": {},
"MemberClusters": [
"test-cluster-001",
"test-cluster-002",
"test-cluster-003"
],
"NodeGroups": [
{
"NodeGroupId": "0001",
"Status": "available",
"PrimaryEndpoint": {
"Address": "test-cluster.g2xbih.ng.0001.usw2.cache.amazonaws.com",
"Port": 6379
},
"ReaderEndpoint": {
"Address": "test-cluster-ro.g2xbih.ng.0001.usw2.cache.amazonaws.com",
"Port": 6379
},
"NodeGroupMembers": [
{
"CacheClusterId": "test-cluster-001",
"CacheNodeId": "0001",
"ReadEndpoint": {
"Address": "test-cluster-001.g2xbih.0001.usw2.cache.amazonaws.com",
"Port": 6379
},
"PreferredAvailabilityZone": "us-west-2c",
"CurrentRole": "primary"
},
{
"CacheClusterId": "test-cluster-002",
"CacheNodeId": "0001",
"ReadEndpoint": {
"Address": "test-cluster-002.g2xbih.0001.usw2.cache.amazonaws.com",
"Port": 6379
},
"PreferredAvailabilityZone": "us-west-2b",
"CurrentRole": "replica"
},
{
"CacheClusterId": "test-cluster-003",
"CacheNodeId": "0001",
"ReadEndpoint": {
"Address": "test-cluster-003.g2xbih.0001.usw2.cache.amazonaws.com",
"Port": 6379
},
"PreferredAvailabilityZone": "us-west-2a",
"CurrentRole": "replica"
}
]
}
],
"SnapshottingClusterId": "test-cluster-002",
"AutomaticFailover": "enabled",
"MultiAZ": "disabled",
"SnapshotRetentionLimit": 1,
"SnapshotWindow": "08:00-09:00",
"ClusterEnabled": false,
"CacheNodeType": "cache.r5.large",
"TransitEncryptionEnabled": false,
"AtRestEncryptionEnabled": false
}
}
Дополнительную информацию см. в разделе Изменение группы репликации в Руководстве пользователя Elasticache.
Вывод
ReplicationGroup -> (структура)
Содержит все атрибуты конкретной группы репликации Valkey или Redis OSS.
ReplicationGroupId -> (строка)
Description -> (строка)
GlobalReplicationGroupInfo -> (структура)
Имя глобального хранилища данных и роль этой группы репликации в глобальном хранилище данных.
GlobalReplicationGroupId -> (строка)
GlobalReplicationGroupMemberRole -> (строка)
Status -> (строка)
creating , available , modifying , deleting , create-failed , snapshotting .PendingModifiedValues -> (структура)
Группа параметров, которые будут применены к группе репликации, либо сразу, либо во время следующего окна обслуживания.
PrimaryClusterId -> (строка)
--apply-immediately был указан), или во время следующего окна обслуживания.AutomaticFailoverStatus -> (строка)
Resharding -> (структура)
Статус операции онлайн решардинга.
SlotMigration -> (структура)
Представляет прогресс операции онлайн решардинга.
ProgressPercentage -> (двойное)
AuthTokenStatus -> (строка)
UserGroups -> (структура)
Изменяемая группа пользователей.
UserGroupIdsToAdd -> (список)
Идентификатор группы пользователей для добавления.
(строка)
UserGroupIdsToRemove -> (список)
Идентификатор группы пользователей для удаления.
(строка)
LogDeliveryConfigurations -> (список)
Настройки доставки логов, которые изменяются
(структура)
Настройки доставки логов, которые изменяются
LogType -> (строка)
DestinationType -> (строка)
DestinationDetails -> (структура)
Детали конфигурации назначения CloudWatch Logs или Kinesis Data Firehose.
CloudWatchLogsDetails -> (структура)
Детали конфигурации назначения CloudWatch Logs.
LogGroup -> (строка)
KinesisFirehoseDetails -> (структура)
Детали конфигурации назначения Kinesis Data Firehose.
DeliveryStream -> (строка)
LogFormat -> (строка)
TransitEncryptionEnabled -> (булево)
TransitEncryptionMode -> (строка)
ClusterMode -> (строка)
MemberClusters -> (список)
Имена всех кластеров кэша, которые являются частью этой группы репликации.
(строка)
NodeGroups -> (список)
Список групп узлов в этой группе репликации. Для Valkey или Redis OSS (режим кластера выключен) группы репликации, это список с одним элементом. Для Valkey или Redis OSS (режим кластера включен) группы репликации, список содержит запись для каждой группы узлов (фрагмента).
(структура)
Представляет собой набор узлов кэша в группе репликации. Один узел в группе узлов является узлом чтения/записи (первичным). Все остальные узлы являются узлами чтения только (репликами).
NodeGroupId -> (строка)
Status -> (строка)
creating , available , modifying , deleting .PrimaryEndpoint -> (структура)
Адрес первичного узла в этой группе узлов (фрагменте).
Address -> (строка)
Port -> (целое)
ReaderEndpoint -> (структура)
Адрес узлов реплик в этой группе узлов (фрагменте). Это значение является только для чтения.
Address -> (строка)
Port -> (целое)
Slots -> (строка)
NodeGroupMembers -> (список)
Список, содержащий информацию об отдельных узлах в группе узлов (фрагменте).
(структура)
Представляет собой отдельный узел в группе узлов (фрагменте).
CacheClusterId -> (строка)
CacheNodeId -> (строка)
ReadEndpoint -> (структура)
Информация, необходимая клиентским программам для подключения к узлу для операций чтения. Адрес чтения применимо только для кластеров Valkey или Redis OSS (режим кластера выключен).
Address -> (строка)
Port -> (целое)
PreferredAvailabilityZone -> (строка)
PreferredOutpostArn -> (строка)
CurrentRole -> (строка)
primary или replica . Этот член применим только для групп репликации Valkey или Redis OSS (режим кластера выключен).SnapshottingClusterId -> (строка)
AutomaticFailover -> (строка)
MultiAZ -> (строка)
ConfigurationEndpoint -> (структура)
Конфигурационный адрес для этой группы репликации. Используйте конфигурационный адрес для подключения к этой группе репликации.
Address -> (строка)
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 .
3.2.6 , 4.x или более поздней.По умолчанию: false
AtRestEncryptionEnabled -> (булево)
Флаг, который включает шифрование в состоянии покоя, если установлено в true .
Вы не можете изменить значение AtRestEncryptionEnabled после создания кластера. Чтобы включить шифрование в состоянии покоя для кластера, необходимо установить AtRestEncryptionEnabled в true при создании кластера.
3.2.6 , 4.x или более поздней.По умолчанию: false
MemberClustersOutpostArns -> (список)
ARN узлов группы репликации.
(строка)
KmsKeyId -> (строка)
ARN -> (строка)
UserGroupIds -> (список)
Идентификатор группы пользователей, связанной с группой репликации.
(строка)
LogDeliveryConfigurations -> (список)
Возвращает пункт назначения, формат и тип логов.
(структура)
Возвращает пункт назначения, формат и тип логов.
LogType -> (строка)
DestinationType -> (строка)
cloudwatch-logs, либо kinesis-firehose.DestinationDetails -> (структура)
Детали конфигурации пункта назначения CloudWatch Logs или Kinesis Data Firehose.
CloudWatchLogsDetails -> (структура)
Детали конфигурации пункта назначения CloudWatch Logs.
LogGroup -> (строка)
KinesisFirehoseDetails -> (структура)
Детали конфигурации пункта назначения Kinesis Data Firehose.
DeliveryStream -> (строка)
LogFormat -> (строка)
Status -> (строка)
enabling | disabling | modifying | active | errorMessage -> (строка)
ReplicationGroupCreateTime -> (временная метка)
DataTiering -> (строка)
AutoMinorVersionUpgrade -> (логическое значение)
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 -> (строка)
Engine -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.