Spec-Zone.ru › AWS CLI v2

[ aws . neptune ]

delete-db-instance

Описание

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

Если вы запросите окончательный снимок базы данных, статус экземпляра Amazon Neptune базы данных будет deleting до создания снимка базы данных. Для отслеживания статуса этой операции используется действие API DescribeDBInstance. После отправки действие нельзя отменить или пересмотреть.

Обратите внимание, что когда экземпляр базы данных находится в состоянии ошибки и имеет статус failed , incompatible-restore или incompatible-network, его можно удалить только при установке параметра SkipFinalSnapshot в значение true.

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

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

Синтаксис

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

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

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

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

--skip-final-snapshot | --no-skip-final-snapshot (булево)

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

Обратите внимание, что когда экземпляр базы данных находится в состоянии ошибки и имеет статус «failed», «incompatible-restore» или «incompatible-network», его можно удалить только при установке параметра SkipFinalSnapshot в значение «true».

Укажите true при удалении реплики чтения.

Примечание

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

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

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

DBSnapshotIdentifier нового снимка базы данных, созданного при установке 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.

Вывод

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

Содержит данные экземпляра базы данных Amazon Neptune.

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

DBInstanceIdentifier -> (строка)

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

DBInstanceClass -> (строка)

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

Engine -> (строка)

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

DBInstanceStatus -> (строка)

Указывает текущее состояние этой базы данных.

MasterUsername -> (строка)

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

DBName -> (строка)

Имя базы данных.

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

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

Address -> (строка)

Указывает DNS-адрес экземпляра базы данных.

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

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

HostedZoneId -> (строка)

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

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

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

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

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

PreferredBackupWindow -> (строка)

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

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

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

DBSecurityGroups -> (список)

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

(структура)

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

DBSecurityGroupName -> (строка)

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

Status -> (строка)

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

VpcSecurityGroups -> (список)

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

(структура)

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

VpcSecurityGroupId -> (строка)

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

Status -> (строка)

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

DBParameterGroups -> (список)

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

(структура)

Состояние группы параметров базы данных.

Этот тип данных используется в качестве элемента ответа в следующих действиях:

  • CreateDBInstance
  • DeleteDBInstance
  • ModifyDBInstance
  • RebootDBInstance

DBParameterGroupName -> (строка)

Имя группы параметров базы данных.

ParameterApplyStatus -> (строка)

Состояние обновления параметров.

AvailabilityZone -> (строка)

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

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

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

DBSubnetGroupName -> (строка)

Имя группы подсетей базы данных.

DBSubnetGroupDescription -> (строка)

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

VpcId -> (строка)

Предоставляет VpcId группы подсетей базы данных.

SubnetGroupStatus -> (строка)

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

Subnets -> (список)

Содержит список элементов Subnet.

(структура)

Указывает подсеть.

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

SubnetIdentifier -> (строка)

Указывает идентификатор подсети.

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

Указывает зону доступности EC2, в которой находится подсеть.

Name -> (строка)

Название зоны доступности.

SubnetStatus -> (строка)

Указывает состояние подсети.

DBSubnetGroupArn -> (строка)

Amazon Resource Name (ARN) для группы подсетей базы данных.

PreferredMaintenanceWindow -> (строка)

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

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

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

DBInstanceClass -> (строка)

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

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

Содержит новый AllocatedStorage размер для экземпляра базы данных, который будет применён или в настоящее время применяется.

MasterUserPassword -> (строка)

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

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

Указывает ожидающий порт для экземпляра базы данных.

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

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

MultiAZ -> (булево)

Указывает, что экземпляр базы данных Single-AZ должен перейти к многозонной конфигурации.

EngineVersion -> (строка)

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

LicenseModel -> (строка)

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

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

Указывает новое значение Provisioned IOPS для экземпляра базы данных, которое будет применено или в настоящее время применяется.

DBInstanceIdentifier -> (строка)

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

StorageType -> (строка)

Не применимо. В Neptune тип хранилища управляется на уровне кластера базы данных.

CACertificateIdentifier -> (строка)

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

DBSubnetGroupName -> (строка)

Новая группа подсетей базы данных для экземпляра базы данных.

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

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

LogTypesToEnable -> (список)

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

(строка)

LogTypesToDisable -> (список)

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

(строка)

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

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

MultiAZ -> (булево)

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

EngineVersion -> (строка)

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

AutoMinorVersionUpgrade -> (булево)

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

ReadReplicaSourceDBInstanceIdentifier -> (строка)

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

ReadReplicaDBInstanceIdentifiers -> (список)

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

(строка)

ReadReplicaDBClusterIdentifiers -> (список)

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

(строка)

LicenseModel -> (строка)

Информация о лицензионной модели для этого экземпляра базы данных.

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

Указывает значение Provisioned IOPS (операций ввода-вывода в секунду).

OptionGroupMemberships -> (список)

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

(структура)

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

OptionGroupName -> (строка)

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

Status -> (строка)

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

CharacterSetName -> (строка)

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

SecondaryAvailabilityZone -> (строка)

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

PubliclyAccessible -> (булево)

Этот флаг больше не должен использоваться.

StatusInfos -> (список)

Состояние реплики чтения. Если экземпляр не является репликой чтения, это пусто.

(структура)

Предоставляет список информации о состоянии экземпляра базы данных.

StatusType -> (строка)

Это значение в настоящее время «репликация чтения».

Normal -> (булево)

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

Status -> (строка)

Состояние экземпляра базы данных. Для StatusType «репликация чтения» значения могут быть «replicating», «error», «stopped» или «terminated».

Message -> (строка)

Подробности ошибки, если для экземпляра есть ошибка. Если экземпляр не находится в состоянии ошибки, это значение пусто.

StorageType -> (строка)

Указывает тип хранилища, связанный с экземпляром базы данных.

TdeCredentialArn -> (строка)

ARN из хранилища ключей, с которым связан экземпляр для шифрования TDE.

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

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

DBClusterIdentifier -> (строка)

Если экземпляр базы данных является членом кластера базы данных, содержит имя кластера базы данных, членом которого является экземпляр.

StorageEncrypted -> (булево)

Не поддерживается: шифрование экземпляров базы данных управляется кластером базы данных.

KmsKeyId -> (строка)

Не поддерживается: шифрование экземпляров базы данных управляется кластером базы данных.

DbiResourceId -> (строка)

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

CACertificateIdentifier -> (строка)

Идентификатор сертификата CA для этого экземпляра базы данных.

DomainMemberships -> (список)

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

(структура)

Запись членства в домене Active Directory, связанная с экземпляром базы данных.

Domain -> (строка)

Идентификатор домена Active Directory.

Status -> (строка)

Состояние членства экземпляра базы данных в домене Active Directory, например, joined, pending-join, failed и т. д.

FQDN -> (строка)

Полное доменное имя домена Active Directory.

IAMRoleName -> (строка)

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

CopyTagsToSnapshot -> (булево)

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

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

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

EnhancedMonitoringResourceArn -> (string)

Amazon Resource Name (ARN) потока журнала Amazon CloudWatch Logs, который получает данные метрик расширенного мониторинга для экземпляра базы данных.

MonitoringRoleArn -> (string)

ARN для роли IAM, которая разрешает Neptune отправлять метрики расширенного мониторинга в Amazon CloudWatch Logs.

PromotionTier -> (integer)

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

DBInstanceArn -> (string)

Amazon Resource Name (ARN) для экземпляра базы данных.

Timezone -> (string)

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

IAMDatabaseAuthenticationEnabled -> (boolean)

Истина, если аутентификация Amazon Identity and Access Management (IAM) включена, и ложь в противном случае.

PerformanceInsightsEnabled -> (boolean)

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

PerformanceInsightsKMSKeyId -> (string)

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

EnabledCloudwatchLogsExports -> (list)

Список типов журналов, которые этот экземпляр базы данных настроен на экспорт в CloudWatch Logs.

(string)

DeletionProtection -> (boolean)

Указывает, включена ли защита от удаления для экземпляра базы данных. При включенной защите от удаления экземпляр удалить нельзя. См. Удаление экземпляра базы данных.

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

Spec-Zone.ru

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