Spec-Zone.ru › AWS CLI v2

[ aws . elasticache ]

уменьшение-количества-реплик

Описание

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

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

Синтаксис

  decrease-replica-count
--replication-group-id <value>
[--new-replica-count <value>]
[--replica-configuration <value>]
[--replicas-to-remove <value>]
--apply-immediately | --no-apply-immediately
[--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 (строка)

Идентификатор группы репликации, из которой необходимо удалить узлы-реплики.

--new-replica-count (целое число)

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

Минимальное количество реплик в фрагменте или группе репликации:

  • Valkey или Redis OSS (режим кластера отключен)
    • Если Multi-AZ включен: 1
    • Если Multi-AZ не включен: 0
  • Valkey или Redis OSS (режим кластера включен): 0 (хотя вы не сможете переключиться на реплику, если ваш основной узел выйдет из строя)

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

Список объектов ConfigureShard, которые могут быть использованы для конфигурации каждого фрагмента в группе репликации Valkey или Redis OSS. Объект ConfigureShard содержит три члена: NewReplicaCount, NodeGroupId и PreferredAvailabilityZones.

(структура)

Параметры конфигурации группы узлов (фрагмента) при добавлении или удалении реплик. Каждая конфигурация группы узлов (фрагмента) имеет следующие члены: NodeGroupId, NewReplicaCount и PreferredAvailabilityZones.

NodeGroupId -> (строка)

4-значный идентификатор группы узлов, которую вы настраиваете. Для групп репликации Valkey или Redis OSS (режим кластера отключен), идентификатор группы узлов всегда равен 0001. Чтобы найти идентификатор группы узлов (фрагмента) Valkey или Redis OSS (режим кластера включен), см. Нахождение ID фрагмента.

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

Количество реплик, которые вы хотите в этой группе узлов по окончании данной операции. Максимальное значение для NewReplicaCount равно 5. Минимальное значение зависит от типа группы репликации Valkey или Redis OSS, с которой вы работаете.

Минимальное количество реплик в фрагменте или группе репликации:

  • Valkey или Redis OSS (режим кластера отключен)
    • Если Multi-AZ: 1
    • Если Multi-AZ: 0
  • Valkey или Redis OSS (режим кластера включен): 0 (хотя вы не сможете переключиться на реплику, если ваш основной узел выйдет из строя)

PreferredAvailabilityZones -> (список)

Список PreferredAvailabilityZone строк, которые указывают, в каких зонах доступности должны находиться узлы группы репликации. Количество PreferredAvailabilityZone значений должно быть равно значению NewReplicaCount плюс 1 для учета узла-лидера. Если этот член ReplicaConfiguration опущен, ElastiCache выбирает зону доступности для каждой из реплик.

(строка)

PreferredOutpostArns -> (список)

ARN-адреса аутпостов, в которых создается кластер кэша.

(строка)

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

NodeGroupId=string,NewReplicaCount=integer,PreferredAvailabilityZones=string,string,PreferredOutpostArns=string,string ...

Синтаксис JSON:

[
  {
    "NodeGroupId": "string",
    "NewReplicaCount": integer,
    "PreferredAvailabilityZones": ["string", ...],
    "PreferredOutpostArns": ["string", ...]
  }
  ...
]

--replicas-to-remove (список)

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

(строка)

Синтаксис:

"string" "string" ...

--apply-immediately | --no-apply-immediately (логическое значение)

Если True, количество узлов-реплик уменьшается немедленно. ApplyImmediately=False в настоящее время не поддерживается.

--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 для получения дополнительной информации.

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

Для уменьшения количества реплик

Следующий пример decrease-replica-count динамически уменьшает количество реплик в группе репликации Redis (режим кластера отключен) или количество узлов-реплик в одной или нескольких группах узлов (фрагментах) группы репликации Redis (режим кластера включен). Данная операция выполняется без остановки кластера.

aws elasticache decrease-replica-count \
    --replication-group-id my-cluster \
    --apply-immediately  \
    --new-replica-count 2

Вывод:

{
    "ReplicationGroup": {
        "ReplicationGroupId": "my-cluster",
        "Description": " ",
        "Status": "modifying",
        "PendingModifiedValues": {},
        "MemberClusters": [
            "myrepliace",
            "my-cluster-001",
            "my-cluster-002",
            "my-cluster-003"
        ],
        "NodeGroups": [
            {
                "NodeGroupId": "0001",
                "Status": "modifying",
                "PrimaryEndpoint": {
                    "Address": "my-cluster.xxxxx.ng.0001.usw2.cache.amazonaws.com",
                    "Port": 6379
                },
                "ReaderEndpoint": {
                    "Address": "my-cluster-ro.xxxxx.ng.0001.usw2.cache.amazonaws.com",
                    "Port": 6379
                },
                "NodeGroupMembers": [
                    {
                        "CacheClusterId": "myrepliace",
                        "CacheNodeId": "0001",
                        "ReadEndpoint": {
                            "Address": "myrepliace.xxxxx.0001.usw2.cache.amazonaws.com",
                            "Port": 6379
                        },
                        "PreferredAvailabilityZone": "us-west-2a",
                        "CurrentRole": "replica"
                    },
                    {
                        "CacheClusterId": "my-cluster-001",
                        "CacheNodeId": "0001",
                        "ReadEndpoint": {
                            "Address": "my-cluster-001.xxxxx.0001.usw2.cache.amazonaws.com",
                            "Port": 6379
                        },
                        "PreferredAvailabilityZone": "us-west-2a",
                        "CurrentRole": "primary"
                    },
                    {
                        "CacheClusterId": "my-cluster-002",
                        "CacheNodeId": "0001",
                        "ReadEndpoint": {
                            "Address": "my-cluster-002.xxxxx.0001.usw2.cache.amazonaws.com",
                            "Port": 6379
                        },
                        "PreferredAvailabilityZone": "us-west-2a",
                        "CurrentRole": "replica"
                    },
                    {
                        "CacheClusterId": "my-cluster-003",
                        "CacheNodeId": "0001",
                        "ReadEndpoint": {
                            "Address": "my-cluster-003.xxxxx.0001.usw2.cache.amazonaws.com",
                            "Port": 6379
                        },
                        "PreferredAvailabilityZone": "us-west-2a",
                        "CurrentRole": "replica"
                    }
                ]
            }
        ],
        "AutomaticFailover": "disabled",
        "SnapshotRetentionLimit": 0,
        "SnapshotWindow": "07:30-08:30",
        "ClusterEnabled": false,
        "CacheNodeType": "cache.r5.xlarge",
        "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 -> (строка)

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

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

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

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

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

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

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

AuthTokenStatus -> (строка)

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

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

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

UserGroupIdsToAdd -> (список)

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

(строка)

UserGroupIdsToRemove -> (список)

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

(строка)

LogDeliveryConfigurations -> (список)

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

(структура)

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

LogType -> (строка)

Относится к медленным журналам или журналам двигателя.

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. Пользователь может, по желанию, предоставить идентификатор группы узлов.

Status -> (строка)

Текущее состояние этой группы репликации - 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 для повышения отказоустойчивости. Для получения дополнительной информации см. Минимизация простоев: 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 при создании кластера.

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

По умолчанию: 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. Подробнее см. Data tiering.

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.

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

Spec-Zone.ru

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