Spec-Zone.ru › AWS CLI v2

[ aws . memorydb ]

delete-cluster

Описание

Удаляет кластер. Также удаляются все связанные узлы и узловые конечные точки.

Примечание

CreateSnapshot разрешение необходимо для создания конечного снимка. Без этого разрешения вызов API завершится с ошибкой Access Denied.

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

Синтаксис

  delete-cluster
--cluster-name <value>
[--multi-region-cluster-name <value>]
[--final-snapshot-name <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

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

Имя кластера, который необходимо удалить

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

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

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

Указанное пользователем имя конечного снимка кластера. Это уникальное имя, которое идентифицирует снимок. MemoryDB создает снимок, а затем немедленно удаляет кластер.

--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной строки JSON. Строка JSON следует формату, предоставленному --generate-cli-skeleton. Если другие аргументы предоставляются в командной строке, эти значения перепишут значения, предоставленные в JSON. Невозможно передавать произвольные двоичные значения с помощью значения, предоставленного в JSON, так как строка будет воспринята буквально. Это не может быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса API. При отсутствии значения или значении input выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, при указании yaml-input он выведет пример входного YAML, который можно использовать с --cli-input-yaml. При указании значения output он проверит входные данные команды и вернет пример выходного JSON для этой команды. Сгенерированный JSON-скелет нестабилен между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.

Глобальные параметры

--debug (логическое значение)

Включить отладочную запись журнала.

--endpoint-url (строка)

Переопределить URL по умолчанию команды указанным URL.

--no-verify-ssl (логическое значение)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет поведение проверки сертификатов SSL по умолчанию.

--no-paginate (логическое значение)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI сделает только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования для вывода команд.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

Запрос JMESPath для использования при фильтрации данных ответа.

--profile (строка)

Использовать определенный профиль из вашего файла учетных данных.

--region (строка)

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

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/отключить цветной вывод.

  • on
  • off
  • auto

--no-sign-request (логическое значение)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент указан.

--ca-bundle (строка)

Сборник сертификатов CA для использования при проверке сертификатов SSL. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (целое число)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.

--cli-connect-timeout (целое число)

Максимальное время подключения к сокету в секундах. Если значение установлено в 0, подключение к сокету будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.

--cli-binary-format (строка)

Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены как строка, закодированная в base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, которое соответствует двоичному блоку, fileb:// всегда будет обрабатываться как двоичное и будет использовать содержимое файла непосредственно независимо от параметра cli-binary-format. При использовании file:// содержимое файла должно быть правильно отформатировано для настроенного cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (логическое значение)

Отключить кли-пагинатор для вывода.

--cli-auto-prompt (логическое значение)

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

--no-cli-auto-prompt (логическое значение)

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

Примеры

Примечание

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

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

Для удаления кластера

Следующий delete-cluster пример удаляет кластер.

aws memorydb delete-cluster \
    --cluster-name my-new-cluster

Вывод:

{
    "Cluster": {
        "Name": "my-new-cluster",
        "Status": "deleting",
        "NumberOfShards": 1,
        "ClusterEndpoint": {
            "Address": "clustercfg.my-new-cluster.xxxxx.memorydb.us-east-1.amazonaws.com",
            "Port": 6379
        },
        "NodeType": "db.r6g.large",
        "EngineVersion": "6.2",
        "EnginePatchVersion": "6.2.6",
        "ParameterGroupName": "default.memorydb-redis6",
        "ParameterGroupStatus": "in-sync",
        "SubnetGroupName": "my-sg",
        "TLSEnabled": true,
        "ARN": "arn:aws:memorydb:us-east-1:491658xxxxxx:cluster/my-new-cluster",
        "SnapshotRetentionLimit": 0,
        "MaintenanceWindow": "sat:10:00-sat:11:00",
        "SnapshotWindow": "07:30-08:30",
        "AutoMinorVersionUpgrade": true
    }
}

Дополнительную информацию см. в разделе Удаление кластера в руководстве пользователя MemoryDB.

Вывод

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

Объект кластера, который был удалён.

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

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

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

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

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

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

ОжидаемыеОбновления -> (структура)

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

Перераспределение -> (структура)

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

ПеремещениеРазделов -> (структура)

Статус перемещения разделов онлайн-перераспределения

ПроцентВыполнения -> (двойное)

Процент завершённого перемещения разделов.

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

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

ACLПрименить -> (строка)

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

ОбновленияСервисов -> (список)

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

(структура)

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

ИмяОбновленияСервиса -> (строка)

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

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

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

ИмяМультрегиональногоКластера -> (строка)

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

КоличествоРазделов -> (целое число)

Количество разделов в кластере

Разделы -> (список)

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

(структура)

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

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

Имя раздела

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

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

Разделы -> (строка)

Пространство ключей для этого раздела.

Узлы -> (список)

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

(структура)

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

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

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

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

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

ЗонаДоступности -> (строка)

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

ВремяСоздание -> (метка времени)

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

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

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

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

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

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

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

КоличествоУзлов -> (целое число)

Количество узлов в разделе

РежимДоступности -> (строка)

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

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

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

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

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

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

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

ТипУзла -> (строка)

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

Движок -> (строка)

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

ВерсияДвижка -> (строка)

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

ВерсияОбновленияДвижка -> (строка)

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

ИмяГруппыПараметров -> (строка)

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

СтатусГруппыПараметров -> (строка)

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

ГруппыБезопасности -> (список)

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

(структура)

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

ИдентификаторГруппыБезопасности -> (строка)

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

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

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

ИмяГруппыПодсетей -> (строка)

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

TLSEnabled -> (булево)

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

KmsKeyId -> (строка)

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

ARN -> (строка)

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

SnsTopicArn -> (строка)

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

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

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

ПределСохраненияСнапшотов -> (целое число)

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

ОкноТехническогоОбслуживания -> (строка)

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

ОкноСнапшотов -> (строка)

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

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

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

АвтоматическоеОбновлениеНезначительныхВерсий -> (булево)

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

DataTiering -> (строка)

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

ТипСети -> (строка)

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

IpDiscovery -> (строка)

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

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

Spec-Zone.ru

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