Spec-Zone.ru › AWS CLI v2

[ aws . docdb ]

удаление-кластера-db

Описание

Удаляет предварительно настроенный кластер. При удалении кластера все автоматические резервные копии этого кластера удаляются и их нельзя восстановить. Ручные снимки кластера DB указанного кластера не удаляются.

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

Синтаксис

  delete-db-cluster
--db-cluster-identifier <value>
[--skip-final-snapshot | --no-skip-final-snapshot]
[--final-db-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-identifier (строка)

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

Ограничения:

  • Должен соответствовать существующему DBClusterIdentifier .

--skip-final-snapshot | --no-skip-final-snapshot (логическое значение)

Определяет, создается ли конечный снимок кластера перед удалением кластера. Если true указано, снимок кластера не создается. Если false указано, снимок кластера создается перед удалением кластера DB.

Примечание

Если SkipFinalSnapshot равно false, вы должны указать параметр FinalDBSnapshotIdentifier.

По умолчанию: false

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

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

Примечание

Указание этого параметра и установка параметра SkipFinalShapshot в значение true приведет к ошибке.

Ограничения:

  • Должно содержать от 1 до 255 букв, цифр или дефисов.
  • Первый символ должен быть буквой.
  • Не может оканчиваться дефисом или содержать два дефиса подряд.

--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 примере удаляется кластер Amazon DocumentDB с именем sample-cluster. Резервная копия кластера не создается перед его удалением. ПРИМЕЧАНИЕ: Необходимо удалить все экземпляры, связанные с кластером, прежде чем можно будет удалить кластер.

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

Вывод:

{
    "DBCluster": {
        "DBClusterIdentifier": "sample-cluster",
        "DBSubnetGroup": "default",
        "EngineVersion": "3.6.0",
        "Engine": "docdb",
        "LatestRestorableTime": "2019-03-18T18:07:24.610Z",
        "PreferredMaintenanceWindow": "sun:20:30-sun:21:00",
        "StorageEncrypted": false,
        "EarliestRestorableTime": "2019-03-18T18:07:24.610Z",
        "Port": 27017,
        "VpcSecurityGroups": [
            {
                "Status": "active",
                "VpcSecurityGroupId": "sg-77186e0d"
            }
        ],
        "MultiAZ": false,
        "MasterUsername": "master-user",
        "DBClusterArn": "arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster",
        "Status": "available",
        "PreferredBackupWindow": "10:12-10:42",
        "ReaderEndpoint": "sample-cluster.cluster-ro-corcjozrlsfc.us-west-2.docdb.amazonaws.com",
        "AvailabilityZones": [
            "us-west-2c",
            "us-west-2b",
            "us-west-2a"
        ],
        "Endpoint": "sample-cluster.cluster-corcjozrlsfc.us-west-2.docdb.amazonaws.com",
        "DbClusterResourceId": "cluster-L3R4YRSBUYDP4GLMTJ2WF5GH5Q",
        "ClusterCreateTime": "2019-03-18T18:06:34.616Z",
        "AssociatedRoles": [],
        "DBClusterParameterGroup": "default.docdb3.6",
        "HostedZoneId": "ZNKXH85TT8WVW",
        "BackupRetentionPeriod": 1,
        "DBClusterMembers": []
    }
}

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

Вывод

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

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

AvailabilityZones -> (список)

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

(строка)

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

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

DBClusterIdentifier -> (строка)

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

DBClusterParameterGroup -> (строка)

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

DBSubnetGroup -> (строка)

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

Status -> (строка)

Указывает текущее состояние кластера.

PercentProgress -> (строка)

Указывает процент выполнения операции.

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

Наиболее ранняя точка времени для восстановления базы данных с точечным восстановлением.

Endpoint -> (строка)

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

ReaderEndpoint -> (строка)

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

Если произошел сбой, и реплика Amazon DocumentDB, с которой вы подключены, была назначена первичным экземпляром, ваше соединение прервётся. Чтобы продолжить отправку рабочей нагрузки чтения другим репликам Amazon DocumentDB в кластере, вы можете подключиться к конечной точке чтения.

MultiAZ -> (булево значение)

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

Engine -> (строка)

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

EngineVersion -> (строка)

Указывает версию движка базы данных.

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

Указывает последнюю точку времени для восстановления базы данных с точечным восстановлением.

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

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

MasterUsername -> (строка)

Содержит имя пользователя мастера для кластера.

PreferredBackupWindow -> (строка)

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

PreferredMaintenanceWindow -> (строка)

Указывает еженедельный диапазон времени, в который может происходить техническое обслуживание системы в формате универсального координированного времени (UTC).

ReplicationSourceIdentifier -> (строка)

Содержит идентификатор исходного кластера, если этот кластер является вторичным.

ReadReplicaIdentifiers -> (список)

Содержит один или несколько идентификаторов вторичных кластеров, связанных с этим кластером.

(строка)

DBClusterMembers -> (список)

Предоставляет список экземпляров, составляющих кластер.

(структура)

Содержит информацию об экземпляре, являющемся частью кластера.

DBInstanceIdentifier -> (строка)

Указывает идентификатор экземпляра для этого члена кластера.

IsClusterWriter -> (булево значение)

Значение, которое является true, если член кластера является основным экземпляром для кластера, и false в противном случае.

DBClusterParameterGroupStatus -> (строка)

Указывает статус группы параметров кластера для этого члена кластера DB.

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

Значение, определяющее порядок, в котором реплика Amazon DocumentDB повышается до первичного экземпляра после отказа существующего первичного экземпляра.

VpcSecurityGroups -> (список)

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

(структура)

Используется как элемент ответа для запросов о членстве в группе безопасности виртуальной частной сети (VPC).

VpcSecurityGroupId -> (строка)

Имя группы безопасности VPC.

Status -> (строка)

Состояние группы безопасности VPC.

HostedZoneId -> (строка)

Указывает ID, назначенный Amazon Route 53 при создании зоны размещения.

StorageEncrypted -> (булево значение)

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

KmsKeyId -> (строка)

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

DbClusterResourceId -> (строка)

Уникальный, неизменяемый идентификатор кластера, специфичный для региона Amazon Web Services. Этот идентификатор можно найти в записях журналов CloudTrail всякий раз, когда к ключу KMS для кластера осуществляется доступ.

DBClusterArn -> (строка)

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

AssociatedRoles -> (список)

Предоставляет список ролей управления доступом и идентификацией (IAM), связанных с кластером. (IAM) роли, связанные с кластером, предоставляют разрешения кластеру для доступа к другим службам Amazon Web Services от вашего имени.

(структура)

Описание роли управления доступом и идентификацией (IAM), связанной с кластером.

RoleArn -> (строка)

Amazon Resource Name (ARN) IAM-роли, связанной с кластером DB.

Status -> (строка)

Описание состояния связи между IAM-ролью и кластером. Свойство Status возвращает одно из следующих значений:

  • ACTIVE - IAM-роль ARN связана с кластером и может быть использована для доступа к другим службам Amazon Web Services от вашего имени.
  • PENDING - IAM-роль ARN связывается с кластером.
  • INVALID - IAM-роль ARN связана с кластером, но кластер не может принять IAM-роль для доступа к другим службам Amazon Web Services от вашего имени.

CloneGroupId -> (строка)

Идентифицирует группу клонов, к которой связан кластер DB.

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

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

EnabledCloudwatchLogsExports -> (список)

Список типов логов, которые этот кластер настроен на экспорт в Amazon CloudWatch Logs.

(строка)

DeletionProtection -> (булево значение)

Указывает, может ли этот кластер быть удален. Если DeletionProtection включен, кластер не может быть удален, если он не будет изменен, и DeletionProtection выключен. DeletionProtection защищает кластеры от случайного удаления.

StorageType -> (строка)

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

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

Сведения о типах хранилища для кластеров Amazon DocumentDB см. в руководстве разработчика Amazon DocumentDB: Настройки хранилища кластера.

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

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

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

Секрет, управляемый Amazon DocumentDB в Amazon Web Services Secrets Manager для пароля пользователя-мастера.

SecretArn -> (строка)

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

SecretStatus -> (строка)

Состояние секрета.

Возможные значения состояния включают:

  • creating - Секрет создается.
  • active - Секрет доступен для обычного использования и вращения.
  • rotating - Секрет вращается.
  • impaired - Секрет может быть использован для доступа к учетным данным базы данных, но не может быть повернут. Секрет может иметь такое состояние, например, если права изменены таким образом, что Amazon DocumentDB больше не может получить доступ ни к секрету, ни к ключу KMS для секрета. Когда у секрета такое состояние, вы можете исправить условие, вызвавшее это состояние. В качестве альтернативы, измените экземпляр, чтобы отключить автоматическое управление учетными данными базы данных, а затем измените экземпляр снова, чтобы включить автоматическое управление учетными данными базы данных.

KmsKeyId -> (строка)

Идентификатор ключа KMS Amazon Web Services, используемый для шифрования секрета.

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

Spec-Zone.ru

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