Spec-Zone.ru › AWS CLI v2

[ aws . docdb ]

delete-db-cluster-snapshot

Описание

Удаляет моментальный снимок кластера. Если моментальный снимок копируется, операция копирования прерывается.

Примечание

Моментальный снимок кластера должен быть в состоянии available, чтобы его можно было удалить.

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

Синтаксис

  delete-db-cluster-snapshot
--db-cluster-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]

Параметры

--db-cluster-snapshot-identifier (строка)

Идентификатор моментального снимка кластера для удаления.

Ограничения: Должен быть именем существующего моментального снимка кластера в состоянии available.

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

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

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

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

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

Примеры

Примечание

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

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

Для удаления моментального снимка кластера Amazon DocumentDB

Следующий delete-db-cluster-snapshot пример удаляет моментальный снимок кластера Amazon DocumentDB sample-cluster-snapshot.

aws docdb delete-db-cluster-snapshot \
    --db-cluster-snapshot-identifier sample-cluster-snapshot

Вывод:

{
    "DBClusterSnapshot": {
        "DBClusterIdentifier": "sample-cluster",
        "AvailabilityZones": [
            "us-west-2a",
            "us-west-2b",
            "us-west-2c",
            "us-west-2d"
        ],
        "DBClusterSnapshotIdentifier": "sample-cluster-snapshot",
        "VpcId": "vpc-91280df6",
        "DBClusterSnapshotArn": "arn:aws:rds:us-west-2:123456789012:cluster-snapshot:sample-cluster-snapshot",
        "EngineVersion": "3.6.0",
        "Engine": "docdb",
        "SnapshotCreateTime": "2019-03-18T18:27:14.794Z",
        "Status": "available",
        "MasterUsername": "master-user",
        "ClusterCreateTime": "2019-03-15T20:29:58.836Z",
        "PercentProgress": 100,
        "StorageEncrypted": false,
        "SnapshotType": "manual",
        "Port": 0
    }
}

Для получения дополнительной информации см. Удаление моментального снимка кластера в Руководстве разработчика Amazon DocumentDB.

Вывод

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

Подробная информация о моментальном снимке кластера.

AvailabilityZones -> (список)

Предоставляет список зон доступности Amazon EC2, в которых можно восстановить экземпляры в моментальном снимке кластера.

(строка)

DBClusterSnapshotIdentifier -> (строка)

Указывает идентификатор моментального снимка кластера.

DBClusterIdentifier -> (строка)

Указывает идентификатор кластера, из которого был создан этот моментальный снимок кластера.

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

Предоставляет время создания моментального снимка в формате UTC.

Engine -> (строка)

Указывает имя базы данных.

Status -> (строка)

Указывает статус моментального снимка кластера.

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

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

VpcId -> (строка)

Предоставляет идентификатор виртуальной частной сети (VPC), связанной с моментальным снимком кластера.

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

Указывает время создания кластера в формате UTC.

MasterUsername -> (строка)

Предоставляет имя пользователя-администратора для моментального снимка кластера.

EngineVersion -> (строка)

Предоставляет версию базы данных для этого моментального снимка кластера.

SnapshotType -> (строка)

Предоставляет тип моментального снимка кластера.

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

Указывает процент данных, которые были переданы.

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

Указывает, зашифрован ли моментальный снимок кластера.

KmsKeyId -> (строка)

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

DBClusterSnapshotArn -> (строка)

Amazon Resource Name (ARN) моментального снимка кластера.

SourceDBClusterSnapshotArn -> (строка)

Если моментальный снимок кластера был скопирован из исходного моментального снимка кластера, ARN исходного моментального снимка кластера; в противном случае — значение null.

StorageType -> (строка)

Тип хранилища, связанный с вашим моментальным снимком кластера

Дополнительную информацию о типах хранилищ для кластеров Amazon DocumentDB см. в разделе Конфигурации хранилища кластеров в Руководстве разработчика Amazon DocumentDB.

Допустимые значения для типа хранилища - standard | iopt1

Значение по умолчанию - standard

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

Spec-Zone.ru

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