Spec-Zone.ru › AWS CLI v2

[ aws . neptune ]

delete-db-cluster

Описание

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

Обратите внимание, что кластер баз данных не может быть удален, если защита от удаления включена. Чтобы удалить его, необходимо сначала установить поле DeletionProtection в значение False.

См. также: Документация 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, перед удалением кластера баз данных создается снимок кластера баз данных.

Примечание

Необходимо указать параметр FinalDBSnapshotIdentifier, если SkipFinalSnapshot равно false.

По умолчанию: 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.

Вывод

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

Содержит сведения об Amazon Neptune кластере БД.

Этот тип данных используется в качестве элемента ответа в операции DescribeDBClusters.

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

AllocatedStorage всегда возвращает 1, так как размер хранилища кластера Neptune БД не фиксирован, а автоматически изменяется по мере необходимости.

AvailabilityZones -> (список)

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

(строка)

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

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

CharacterSetName -> (строка)

Не поддерживается Neptune.

DatabaseName -> (строка)

Содержит имя начальной базы данных этого кластера БД, предоставленное во время создания, если оно было указано при создании кластера БД. Это же имя возвращается на протяжении всего жизненного цикла кластера БД.

DBClusterIdentifier -> (строка)

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

DBClusterParameterGroup -> (строка)

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

DBSubnetGroup -> (строка)

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

Status -> (строка)

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

PercentProgress -> (строка)

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

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

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

Endpoint -> (строка)

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

ReaderEndpoint -> (строка)

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

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

MultiAZ -> (булево)

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

Engine -> (строка)

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

EngineVersion -> (строка)

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

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

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

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

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

MasterUsername -> (строка)

Не поддерживается Neptune.

DBClusterOptionGroupMemberships -> (список)

Не поддерживается Neptune.

(структура)

Не поддерживается Neptune.

DBClusterOptionGroupName -> (строка)

Не поддерживается Neptune.

Status -> (строка)

Не поддерживается Neptune.

PreferredBackupWindow -> (строка)

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

PreferredMaintenanceWindow -> (строка)

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

ReplicationSourceIdentifier -> (строка)

Не поддерживается Neptune.

ReadReplicaIdentifiers -> (список)

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

(строка)

DBClusterMembers -> (список)

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

(структура)

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

DBInstanceIdentifier -> (строка)

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

IsClusterWriter -> (булево)

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

DBClusterParameterGroupStatus -> (строка)

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

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

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

VpcSecurityGroups -> (список)

Предоставляет список групп безопасности VPC, к которым принадлежит кластер БД.

(структура)

Этот тип данных используется в качестве элемента ответа для запросов о членстве в группе безопасности VPC.

VpcSecurityGroupId -> (строка)

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

Status -> (строка)

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

HostedZoneId -> (строка)

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

StorageEncrypted -> (булево)

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

KmsKeyId -> (строка)

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

DbClusterResourceId -> (строка)

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

DBClusterArn -> (строка)

Идентификатор ресурса Amazon (ARN) кластера БД.

AssociatedRoles -> (список)

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

(структура)

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

RoleArn -> (строка)

Идентификатор ресурса Amazon (ARN) роли IAM, связанной с кластером БД.

Status -> (строка)

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

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

FeatureName -> (строка)

Имя функции, связанной с ролью управления доступом и идентификацией Amazon (IAM). Список поддерживаемых имен функций см. в DescribeDBEngineVersions.

IAMDatabaseAuthenticationEnabled -> (булево)

Истинно, если отображение учетных записей Amazon Identity and Access Management (IAM) на учетные записи базы данных включено, и ложно в противном случае.

CloneGroupId -> (строка)

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

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

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

CopyTagsToSnapshot -> (булево)

Если установлено в ``true`` , теги копируются в любой снимок кластера БД, который создается.

EnabledCloudwatchLogsExports -> (список)

Список типов журналов, которые этот кластер БД настроен на экспорт в CloudWatch Logs. Допустимые типы журналов: audit (для публикации аудиторских журналов в CloudWatch) и slowquery (для публикации журналов медленных запросов в CloudWatch). См. Опубликование журналов Neptune в Amazon CloudWatch logs.

(строка)

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

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

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

Эта PendingCloudwatchLogsExports структура указывает ожидаемые изменения, для которых включены и отключены журналы CloudWatch.

LogTypesToEnable -> (список)

Типы журналов, которые находятся в процессе отключения. После их отключения эти типы журналов не экспортируются в CloudWatch Logs.

(строка)

LogTypesToDisable -> (список)

Типы журналов, которые находятся в процессе включения. После их включения эти типы журналов экспортируются в CloudWatch Logs.

(строка)

DBClusterIdentifier -> (строка)

Значение DBClusterIdentifier для кластера БД.

IAMDatabaseAuthenticationEnabled -> (булево)

Значение, указывающее, включено ли отображение учетных записей Amazon Web Services Identity and Access Management (IAM) на учетные записи базы данных.

EngineVersion -> (строка)

Версия движка базы данных.

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

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

StorageType -> (строка)

Ожидаемое изменение типа хранилища для кластера БД. Допустимые значения:

  • **standard ** – ( по умолчанию ) Настраивает экономичное хранилище базы данных для приложений с умеренным или небольшим использованием ввода-вывода.
  • **iopt1 ** – Включает хранилище с оптимизацией ввода-вывода, которое разработано для удовлетворения потребностей ресурсоемких рабочих нагрузок графов, требующих прогнозируемой стоимости с низкой задержкой ввода-вывода и постоянной пропускной способностью ввода-вывода. Оптимизированное хранилище ввода-вывода Neptune доступно только начиная с версии движка 1.3.0.0.

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

Размер выделенного хранилища в гигабайтах (GiB) для движков базы данных. Для Neptune AllocatedStorage всегда возвращает 1, так как размер хранилища кластера Neptune БД не фиксирован, а автоматически изменяется по мере необходимости.

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

Значение Provisioned IOPS (операций ввода-вывода в секунду). Это значение задается только для кластеров БД Multi-AZ.

DeletionProtection -> (булево)

Указывает, включена ли защита от удаления для кластера БД. База данных не может быть удалена, когда защита от удаления включена.

CrossAccountClone -> (булево)

Если установлено в true , кластер БД может быть клонирован между учетными записями.

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

Время, когда кластер БД будет автоматически перезапущен.

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

Отображает конфигурацию масштабирования кластера серверного БД Neptune.

Дополнительную информацию см. в разделе Использование Amazon Neptune Serverless в руководстве пользователя Amazon Neptune .

MinCapacity -> (double)

Минимальное количество единиц мощности Neptune (NCU) для экземпляра базы данных в кластере Neptune Serverless. Значения NCU можно указывать с шагом 0,5, например, 8, 8,5, 9 и т. д.

MaxCapacity -> (double)

Максимальное количество единиц мощности Neptune (NCU) для экземпляра базы данных в кластере Neptune Serverless. Значения NCU можно указывать с шагом 0,5, например, 40, 40,5, 41 и т. д.

GlobalClusterIdentifier -> (string)

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

IOOptimizedNextAllowedModificationTime -> (timestamp)

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

StorageType -> (string)

Тип хранилища, используемый кластером БД.

Допустимые значения:

  • **standard ** – ( по умолчанию ) Предоставляет экономичное хранилище базы данных для приложений с умеренным или небольшим использованием ввода/вывода.
  • **iopt1 ** – Включает оптимизированное хранилище ввода/вывода, которое разработано для удовлетворения потребностей ресурсоемких графовых рабочих нагрузок, требующих прогнозируемой стоимости с низкой задержкой ввода/вывода и согласованной пропускной способностью ввода/вывода. Оптимизированное хранилище ввода/вывода Neptune доступно только начиная с версии 1.3.0.0 движка.

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

Spec-Zone.ru

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