Spec-Zone.ru › AWS CLI v2

[ aws . elasticache ]

удаление-группы-репликации

Описание

Удаляет существующую группу репликации. По умолчанию эта операция удаляет всю группу репликации, включая первичный/первичные узлы и все реплики чтения. Если группа репликации имеет только один первичный узел, вы можете выборочно удалить только реплики чтения, сохранив первичный узел, установив RetainPrimaryCluster=true .

Когда вы получаете успешный ответ от этой операции, Amazon ElastiCache немедленно начинает удаление выбранных ресурсов; вы не можете отменить или восстановить эту операцию.

Примечание

  • CreateSnapshot разрешение необходимо для создания окончательного снимка. Без этого разрешения вызов API завершится с ошибкой Access Denied.
  • Эта операция допустима только для Redis OSS.

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

Синтаксис

  delete-replication-group
--replication-group-id <value>
[--retain-primary-cluster | --no-retain-primary-cluster]
[--final-snapshot-identifier <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 (строка)

Идентификатор удаляемого кластера. Этот параметр нечувствителен к регистру.

--retain-primary-cluster | --no-retain-primary-cluster (логическое значение)

Если установлено значение true , все реплики чтения удаляются, но первичный узел сохраняется.

--final-snapshot-identifier (строка)

Название окончательного снимка группы узлов (раздела). ElastiCache создаёт снимок с первичного узла в кластере, а не с одного из реплик; это делается для гарантии захвата самых свежих данных. После создания окончательного снимка группа репликации немедленно удаляется.

--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.

Для удаления группы репликации

Следующий delete-replication-group пример удаляет существующую группу репликации. По умолчанию эта операция удаляет всю группу репликации, включая первичный/первичные узлы и все реплики чтения. Если группа репликации имеет только один первичный узел, вы можете выборочно удалить только реплики чтения, сохранив первичный узел, установив RetainPrimaryCluster=true .

Когда вы получаете успешный ответ от этой операции, Amazon ElastiCache немедленно начинает удаление выбранных ресурсов; вы не можете отменить или восстановить эту операцию. Действительно только для Redis.

aws elasticache delete-replication-group \
    --replication-group-id "mygroup"

Вывод:

{
     "ReplicationGroup": {
         "ReplicationGroupId": "mygroup",
         "Description": "my group",
         "Status": "deleting",
         "PendingModifiedValues": {},
         "AutomaticFailover": "disabled",
         "SnapshotRetentionLimit": 0,
         "SnapshotWindow": "06:00-07:00",
         "TransitEncryptionEnabled": false,
         "AtRestEncryptionEnabled": false
     }
 }

Вывод

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

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 -> (строка)

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

AutoMinorVersionUpgrade -> (булево)

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

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