Spec-Zone.ru › AWS CLI v2

[ aws . docdb ]

delete-db-instance

Описание

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

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

Синтаксис

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

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

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

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

--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-instance пример удаляет экземпляр Amazon DocumentDB sample-cluster-instance-2.

aws docdb delete-db-instance \
    --db-instance-identifier sample-cluster-instance-2

Вывод:

{
    "DBInstance": {
        "DBSubnetGroup": {
            "Subnets": [
                {
                    "SubnetAvailabilityZone": {
                        "Name": "us-west-2a"
                    },
                    "SubnetStatus": "Active",
                    "SubnetIdentifier": "subnet-4e26d263"
                },
                {
                    "SubnetAvailabilityZone": {
                        "Name": "us-west-2c"
                    },
                    "SubnetStatus": "Active",
                    "SubnetIdentifier": "subnet-afc329f4"
                },
                {
                    "SubnetAvailabilityZone": {
                        "Name": "us-west-2d"
                    },
                    "SubnetStatus": "Active",
                    "SubnetIdentifier": "subnet-53ab3636"
                },
                {
                    "SubnetAvailabilityZone": {
                        "Name": "us-west-2b"
                    },
                    "SubnetStatus": "Active",
                    "SubnetIdentifier": "subnet-991cb8d0"
                }
            ],
            "DBSubnetGroupName": "default",
            "DBSubnetGroupDescription": "default",
            "VpcId": "vpc-91280df6",
            "SubnetGroupStatus": "Complete"
        },
        "PreferredBackupWindow": "00:00-00:30",
        "InstanceCreateTime": "2019-03-18T18:37:33.709Z",
        "DBInstanceClass": "db.r4.xlarge",
        "DbiResourceId": "db-XEKJLEMGRV5ZKCARUVA4HO3ITE",
        "BackupRetentionPeriod": 3,
        "Engine": "docdb",
        "VpcSecurityGroups": [
            {
                "Status": "active",
                "VpcSecurityGroupId": "sg-77186e0d"
            }
        ],
        "AutoMinorVersionUpgrade": true,
        "PromotionTier": 1,
        "EngineVersion": "3.6.0",
        "Endpoint": {
            "Address": "sample-cluster-instance-2.corcjozrlsfc.us-west-2.docdb.amazonaws.com",
            "HostedZoneId": "ZNKXH85TT8WVW",
            "Port": 27017
        },
        "DBInstanceIdentifier": "sample-cluster-instance-2",
        "PreferredMaintenanceWindow": "tue:10:28-tue:10:58",
        "EnabledCloudwatchLogsExports": [
            "audit"
        ],
        "PendingModifiedValues": {},
        "DBInstanceStatus": "deleting",
        "PubliclyAccessible": false,
        "DBInstanceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster-instance-2",
        "DBClusterIdentifier": "sample-cluster",
        "AvailabilityZone": "us-west-2c",
        "StorageEncrypted": false
    }
}

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

Вывод

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

Подробная информация об экземпляре.

DBInstanceIdentifier -> (строка)

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

DBInstanceClass -> (строка)

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

Engine -> (строка)

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

DBInstanceStatus -> (строка)

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

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

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

Address -> (строка)

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

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

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

HostedZoneId -> (строка)

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

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

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

PreferredBackupWindow -> (строка)

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

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

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

VpcSecurityGroups -> (список)

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

(структура)

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

VpcSecurityGroupId -> (строка)

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

Status -> (строка)

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

AvailabilityZone -> (строка)

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

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

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

DBSubnetGroupName -> (строка)

Имя группы подсетей.

DBSubnetGroupDescription -> (строка)

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

VpcId -> (строка)

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

SubnetGroupStatus -> (строка)

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

Subnets -> (список)

Подробная информация об одной или нескольких подсетях в группе подсетей.

(структура)

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

SubnetIdentifier -> (строка)

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

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

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

Name -> (строка)

Имя зоны доступности.

SubnetStatus -> (строка)

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

DBSubnetGroupArn -> (строка)

Amazon Resource Name (ARN) для группы подсетей DB.

PreferredMaintenanceWindow -> (строка)

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

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

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

DBInstanceClass -> (строка)

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

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

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

MasterUserPassword -> (строка)

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

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

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

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

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

MultiAZ -> (булево)

Указывает, что экземпляр Single-AZ должен быть переведён в многозонную (Multi-AZ) конфигурацию.

EngineVersion -> (строка)

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

LicenseModel -> (строка)

Модель лицензии для экземпляра.

Допустимые значения: license-included , bring-your-own-license , general-public-license

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

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

DBInstanceIdentifier -> (строка)

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

StorageType -> (строка)

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

CACertificateIdentifier -> (строка)

Указывает идентификатор сертификата центра сертификации (CA) для экземпляра DB.

DBSubnetGroupName -> (строка)

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

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

Список типов логов, конфигурация которых всё ещё ожидает обработки. Эти типы логов в процессе активации или деактивации.

LogTypesToEnable -> (список)

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

(строка)

LogTypesToDisable -> (список)

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

(строка)

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

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

EngineVersion -> (строка)

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

AutoMinorVersionUpgrade -> (булево)

Не применяется. Этот параметр не применяется к Amazon DocumentDB. Amazon DocumentDB не выполняет обновления до младших версий независимо от установленного значения.

PubliclyAccessible -> (булево)

Не поддерживается. Amazon DocumentDB в настоящее время не поддерживает публичные конечные точки. Значение PubliclyAccessible всегда false.

StatusInfos -> (список)

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

(структура)

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

StatusType -> (строка)

Это значение в настоящее время “read replication”.

Normal -> (булево)

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

Status -> (строка)

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

Message -> (строка)

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

DBClusterIdentifier -> (строка)

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

StorageEncrypted -> (булево)

Указывает, зашифрован ли экземпляр.

KmsKeyId -> (строка)

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

DbiResourceId -> (строка)

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

CACertificateIdentifier -> (строка)

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

CopyTagsToSnapshot -> (булево)

Значение, указывающее, нужно ли копировать метки из экземпляра DB в снимки экземпляра DB. По умолчанию метки не копируются.

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

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

DBInstanceArn -> (строка)

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

EnabledCloudwatchLogsExports -> (список)

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

(строка)

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

Детали серверного сертификата экземпляра DB.

CAIdentifier -> (строка)

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

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

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

PerformanceInsightsEnabled -> (булево)

Устанавливается в true, если Amazon RDS Performance Insights включены для экземпляра DB, и в противном случае в false.

PerformanceInsightsKMSKeyId -> (строка)

Идентификатор ключа KMS для шифрования данных Performance Insights. Идентификатор ключа KMS — это Amazon Resource Name (ARN), идентификатор ключа KMS или псевдоним ключа KMS для ключа KMS шифрования.

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

Spec-Zone.ru

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