Spec-Zone.ru › AWS CLI v2

[ aws . rds ]

удалить-базу-данных

Описание

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

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

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

Если указанный экземпляр базы данных является частью кластера базы данных Amazon Aurora, вы не можете удалить экземпляр базы данных, если оба следующих условия верны:

  • Кластер базы данных является репликой чтения другого кластера базы данных Amazon Aurora.
  • Экземпляр базы данных является единственным экземпляром в кластере базы данных.

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

Предупреждение

Для экземпляров RDS Custom базы данных удаление экземпляра базы данных постоянно удаляет экземпляр EC2 и связанные тома EBS. Убедитесь, что вы не завершаете или не удаляете эти ресурсы до удаления экземпляра базы данных. В противном случае удаление экземпляра базы данных и создание окончательного снимка могут завершиться сбоем.

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

Синтаксис

  delete-db-instance
--db-instance-identifier <value>
[--skip-final-snapshot | --no-skip-final-snapshot]
[--final-db-snapshot-identifier <value>]
[--delete-automated-backups | --no-delete-automated-backups]
[--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 (логическое значение)

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

Примечание

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

Если экземпляр базы данных находится в состоянии сбоя и имеет статус failed , incompatible-restore или incompatible-network , RDS может удалить экземпляр только если вы включите этот параметр.

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

Этот параметр обязателен для RDS Custom.

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

DBSnapshotIdentifier нового DBSnapshot созданного, когда параметр SkipFinalSnapshot отключен.

Примечание

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

Этот параметр не применяется к RDS Custom.

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

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

--delete-automated-backups | --no-delete-automated-backups (логическое значение)

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

--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.

Для удаления экземпляра базы данных

Следующий пример удаляет указанный экземпляр базы данных после создания окончательного снимка базы данных с именем test-instance-final-snap.

aws rds delete-db-instance \
    --db-instance-identifier test-instance \
    --final-db-snapshot-identifier test-instance-final-snap

Вывод:

{
    "DBInstance": {
        "DBInstanceIdentifier": "test-instance",
        "DBInstanceStatus": "deleting",
        ...some output truncated...
    }
}

Вывод

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

Содержит подробности о экземпляре Amazon RDS DB.

Этот тип данных используется в качестве элемента ответа в операциях CreateDBInstance , CreateDBInstanceReadReplica , DeleteDBInstance , DescribeDBInstances , ModifyDBInstance , PromoteReadReplica , RebootDBInstance , RestoreDBInstanceFromDBSnapshot , RestoreDBInstanceFromS3 , RestoreDBInstanceToPointInTime , StartDBInstance и StopDBInstance .

DBInstanceIdentifier -> (строка)

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

DBInstanceClass -> (строка)

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

Engine -> (строка)

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

DBInstanceStatus -> (строка)

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

Дополнительную информацию о статусах экземпляров базы данных см. в Руководстве пользователя Amazon RDS.

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

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

MasterUsername -> (строка)

Имя пользователя владельца для экземпляра базы данных.

DBName -> (строка)

Изначальное имя базы данных, которое вы предоставили (если требуется) при создании экземпляра базы данных. Это имя возвращается на протяжении всего существования экземпляра базы данных. Для экземпляра RDS для Oracle CDB имя идентифицирует PDB, а не CDB.

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

Точка подключения для экземпляра базы данных.

Примечание

Точка подключения может не отображаться для экземпляров со статусом creating .

Address -> (строка)

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

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

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

HostedZoneId -> (строка)

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

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

Объем памяти в гигабайтах (GiB), выделенный для экземпляра базы данных.

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

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

PreferredBackupWindow -> (строка)

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

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

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

DBSecurityGroups -> (список)

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

(структура)

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

  • ModifyDBInstance
  • RebootDBInstance
  • RestoreDBInstanceFromDBSnapshot
  • RestoreDBInstanceToPointInTime

DBSecurityGroupName -> (строка)

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

Status -> (строка)

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

VpcSecurityGroups -> (список)

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

(структура)

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

VpcSecurityGroupId -> (строка)

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

Status -> (строка)

Статус членства в группе безопасности VPC.

В настоящее время единственный допустимый статус — active .

DBParameterGroups -> (список)

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

(структура)

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

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

  • CreateDBInstance
  • CreateDBInstanceReadReplica
  • DeleteDBInstance
  • ModifyDBInstance
  • RebootDBInstance
  • RestoreDBInstanceFromDBSnapshot

DBParameterGroupName -> (строка)

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

ParameterApplyStatus -> (строка)

Статус обновлений параметров. Допустимые значения:

  • applying : Изменение группы параметров применяется к базе данных.
  • failed-to-apply : Группа параметров находится в недопустимом состоянии.
  • in-sync : Изменение группы параметров синхронизировано с базой данных.
  • pending-database-upgrade : Изменение группы параметров будет применено после обновления экземпляра базы данных.
  • pending-reboot : Изменение группы параметров будет применено после перезагрузки экземпляра базы данных.

AvailabilityZone -> (строка)

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

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

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

DBSubnetGroupName -> (строка)

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

DBSubnetGroupDescription -> (строка)

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

VpcId -> (строка)

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

SubnetGroupStatus -> (строка)

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

Subnets -> (список)

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

(структура)

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

SubnetIdentifier -> (строка)

Идентификатор подсети.

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

Содержит информацию о зоне доступности.

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

Name -> (строка)

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

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

Если подсеть связана с узлом Outpost, это значение указывает на Outpost.

Дополнительную информацию об RDS на узлах Outposts см. в Руководстве пользователя Amazon RDS.

Arn -> (строка)

Amazon Resource Name (ARN) узла Outpost.

SubnetStatus -> (строка)

Статус подсети.

DBSubnetGroupArn -> (строка)

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

SupportedNetworkTypes -> (список)

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

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

  • IPV4
  • DUAL

DBSubnetGroup может поддерживать только протокол IPv4 или протоколы IPv4 и IPv6 (DUAL ).

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

(строка)

PreferredMaintenanceWindow -> (строка)

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

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

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

DBInstanceClass -> (строка)

Имя класса вычислительной и емкостной мощности экземпляра БД.

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

Размер выделенного хранилища для экземпляра БД, указанный в гигабайтах (GiB).

MasterUserPassword -> (строка)

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

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

Порт для экземпляра БД.

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

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

MultiAZ -> (булево)

Указывает, будет ли экземпляр БД Single-AZ изменен на развертывание Multi-AZ.

EngineVersion -> (строка)

Версия СУБД.

LicenseModel -> (строка)

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

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

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

Значение Provisioned IOPS для экземпляра БД.

DBInstanceIdentifier -> (строка)

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

StorageType -> (строка)

Тип хранилища экземпляра БД.

CACertificateIdentifier -> (строка)

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

Дополнительную информацию см. в разделе Использование SSL/TLS для шифрования соединения с экземпляром БД в руководстве пользователя Amazon RDS и Использование SSL/TLS для шифрования соединения с кластером БД в руководстве пользователя Amazon Aurora.

DBSubnetGroupName -> (строка)

Группа подсетей БД для экземпляра БД.

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

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

LogTypesToEnable -> (список)

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

(строка)

LogTypesToDisable -> (список)

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

(строка)

ProcessorFeatures -> (список)

Количество ядер процессора и количество потоков на ядро для класса экземпляра БД.

(структура)

Содержит характеристики процессора класса экземпляра БД.

Чтобы указать количество ядер процессора, используйте имя функции coreCount для параметра Name. Чтобы указать количество потоков на ядро, используйте имя функции threadsPerCore для параметра Name.

Вы можете установить характеристики процессора класса экземпляра БД для экземпляра БД, вызвав одно из следующих действий:

  • CreateDBInstance
  • ModifyDBInstance
  • RestoreDBInstanceFromDBSnapshot
  • RestoreDBInstanceFromS3
  • RestoreDBInstanceToPointInTime

Вы можете просмотреть допустимые значения процессора для определенного класса экземпляра, вызвав действие DescribeOrderableDBInstanceOptions и указав класс экземпляра для параметра DBInstanceClass.

Кроме того, вы можете использовать следующие действия для информации о процессоре класса экземпляра БД:

  • DescribeDBInstances
  • DescribeDBSnapshots
  • DescribeValidDBInstanceModifications

Если вы вызываете DescribeDBInstances , ProcessorFeature возвращает значения, отличные от null, только если выполняются следующие условия:

  • Вы получаете доступ к экземпляру БД Oracle.
  • Ваш экземпляр БД Oracle поддерживает настройку количества ядер процессора и потоков на ядро.
  • Текущее количество ядер процессора и потоков на ядро установлено не по умолчанию.

Дополнительную информацию см. в разделе Настройка процессора для класса экземпляра БД в RDS для Oracle в руководстве пользователя Amazon RDS.

Name -> (строка)

Имя характеристики процессора. Допустимые имена: coreCount и threadsPerCore.

Value -> (строка)

Значение характеристики процессора.

IAMDatabaseAuthenticationEnabled -> (булево)

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

AutomationMode -> (строка)

Режим автоматизации экземпляра RDS Custom DB: full или all-paused. Если full, экземпляр БД автоматизирует мониторинг и восстановление экземпляра. Если all-paused, экземпляр приостанавливает автоматизацию на срок, установленный параметром --resume-full-automation-mode-minutes.

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

Количество минут для приостановки автоматизации. По истечении этого периода RDS Custom возобновляет полную автоматизацию. Минимальное значение — 60 (по умолчанию). Максимальное значение — 1440.

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

Пропускная способность хранилища экземпляра БД.

Engine -> (строка)

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

DedicatedLogVolume -> (булево)

Указывает, включен ли для экземпляра БД выделенный том журнала (DLV).

MultiTenant -> (булево)

Указывает, будет ли экземпляр БД изменен на многопользовательскую конфигурацию (TRUE) или однопользовательскую конфигурацию (FALSE).

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

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

MultiAZ -> (булево)

Указывает, является ли экземпляр БД развертыванием Multi-AZ. Это значение не применяется к экземплярам RDS Custom DB.

EngineVersion -> (строка)

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

AutoMinorVersionUpgrade -> (булево)

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

Дополнительную информацию об автоматическом обновлении незначительных версий см. в разделе Автоматическое обновление незначительной версии.

ReadReplicaSourceDBInstanceIdentifier -> (строка)

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

ReadReplicaDBInstanceIdentifiers -> (список)

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

(строка)

ReadReplicaDBClusterIdentifiers -> (список)

Идентификаторы кластеров БД Aurora, в которые экземпляр БД RDS дублируется как реплика чтения. Например, при создании реплики чтения Aurora для экземпляра БД RDS for MySQL отображается кластер БД Aurora MySQL для реплики чтения Aurora. Этот вывод не содержит информации о репликах чтения Aurora между регионами.

Примечание

В настоящее время каждый экземпляр БД RDS может иметь только одну реплику чтения Aurora.

(строка)

ReplicaMode -> (строка)

Открытый режим реплики чтения Oracle. По умолчанию — open-read-only. Дополнительную информацию см. в разделе Работа с репликами чтения Oracle для Amazon RDS в руководстве пользователя Amazon RDS.

Примечание

Этот атрибут поддерживается только в RDS for Oracle.

LicenseModel -> (строка)

Информация о модели лицензии для этого экземпляра БД. Это значение не применяется к Amazon Aurora или экземплярам RDS Custom DB.

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

Значение Provisioned IOPS (операций ввода/вывода в секунду) для экземпляра БД.

OptionGroupMemberships -> (список)

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

(структура)

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

OptionGroupName -> (строка)

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

Status -> (строка)

Состояние членства экземпляра БД в группе параметров. Допустимые значения: in-sync , pending-apply , pending-removal , pending-maintenance-apply , pending-maintenance-removal , applying , removing и failed .

CharacterSetName -> (строка)

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

NcharCharacterSetName -> (строка)

Имя набора символов NCHAR для экземпляра БД Oracle. Этот набор символов определяет кодировку Unicode для данных, хранящихся в столбцах таблиц типа NCHAR, NCLOB или NVARCHAR2.

SecondaryAvailabilityZone -> (строка)

Если присутствует, указывает имя вторичной зоны доступности для экземпляра БД с поддержкой Multi-AZ.

PubliclyAccessible -> (булево)

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

Если экземпляр БД доступен для общего доступа и вы подключаетесь извне виртуальной частной сети (VPC) экземпляра БД, его конечная точка доменного имени системы (DNS) разрешается до публичного IP-адреса. При подключении внутри той же VPC, что и экземпляр БД, конечная точка разрешается до частного IP-адреса. Доступ к кластеру БД в конечном итоге контролируется используемой группой безопасности. Такой общедоступный доступ не разрешен, если группа безопасности, назначенная кластеру БД, не разрешает его.

Если экземпляр БД не доступен для общего доступа, это внутренний экземпляр БД с именем DNS, разрешающим частный IP-адрес.

Дополнительную информацию см. в разделе CreateDBInstance .

StatusInfos -> (список)

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

(структура)

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

StatusType -> (строка)

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

Normal -> (булево)

Указывает, работает ли экземпляр нормально (TRUE) или находится в состоянии ошибки (FALSE).

Status -> (строка)

Состояние экземпляра БД. Для типа состояния реплики чтения допустимые значения могут быть replicating, replication stop point set, replication stop point reached, error, stopped или terminated.

Message -> (строка)

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

StorageType -> (строка)

Тип хранилища, связанный с экземпляром БД.

TdeCredentialArn -> (строка)

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

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

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

DBClusterIdentifier -> (строка)

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

StorageEncrypted -> (булево)

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

KmsKeyId -> (строка)

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

Идентификатор ключа Amazon Web Services KMS — это ARN ключа, ID ключа, ARN псевдонима или имя псевдонима для ключа KMS.

DbiResourceId -> (строка)

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

CACertificateIdentifier -> (строка)

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

Дополнительную информацию см. в разделе Использование SSL/TLS для шифрования соединения с экземпляром базы данных в руководстве пользователя Amazon RDS и Использование SSL/TLS для шифрования соединения с кластером баз данных в руководстве пользователя Amazon Aurora.

DomainMemberships -> (список)

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

(структура)

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

Domain -> (строка)

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

Status -> (строка)

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

FQDN -> (строка)

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

IAMRoleName -> (строка)

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

OU -> (строка)

Организационная единица Active Directory для экземпляра базы данных или кластера.

AuthSecretArn -> (строка)

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

DnsIps -> (список)

IP-адреса DNS IPv4 первичных и вторичных контроллеров домена Active Directory.

(строка)

CopyTagsToSnapshot -> (булево)

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

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

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

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

EnhancedMonitoringResourceArn -> (строка)

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

MonitoringRoleArn -> (строка)

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

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

Порядок приоритета, в котором реплику Aurora повышают до первичного экземпляра после отказа существующего первичного экземпляра. Дополнительную информацию см. в разделе Избыточность для кластера баз данных Aurora в руководстве пользователя Amazon Aurora.

DBInstanceArn -> (строка)

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

Timezone -> (строка)

Временная зона экземпляра базы данных. В большинстве случаев элемент Timezone пустой. Timezone содержимое появляется только для экземпляров RDS для Db2 и RDS для SQL Server, созданных с указанной временной зоной.

IAMDatabaseAuthenticationEnabled -> (булево)

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

Список версий движков, поддерживающих аутентификацию баз данных IAM, см. в разделе Аутентификация баз данных IAM в руководстве пользователя Amazon RDS и Аутентификация баз данных IAM в Aurora в руководстве пользователя Amazon Aurora.

DatabaseInsightsMode -> (строка)

Режим Database Insights, включенный для экземпляра.

PerformanceInsightsEnabled -> (булево)

Указывает, включен ли Performance Insights для экземпляра базы данных.

PerformanceInsightsKMSKeyId -> (строка)

Идентификатор ключа Amazon Web Services KMS для шифрования данных Performance Insights.

Идентификатор ключа Amazon Web Services KMS — это ARN ключа, ID ключа, ARN псевдонима или имя псевдонима для ключа KMS.

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

Количество дней хранения данных Performance Insights.

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

  • 7
  • месяц * 31, где месяц — число месяцев от 1 до 23. Примеры: 93 (3 месяца * 31), 341 (11 месяцев * 31), 589 (19 месяцев * 31)
  • 731

По умолчанию: 7 дней

EnabledCloudwatchLogsExports -> (список)

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

Типы журналов различаются в зависимости от движка базы данных. Сведения о типах журналов для каждого движка базы данных см. в разделе Мониторинг журналов Amazon RDS в руководстве пользователя Amazon RDS.

(строка)

ProcessorFeatures -> (список)

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

(структура)

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

Для указания количества ядер процессора используйте имя функции coreCount для параметра Name. Для указания количества потоков на ядро используйте имя функции threadsPerCore для параметра Name.

Вы можете установить характеристики процессора класса экземпляра базы данных для экземпляра базы данных, вызвав одно из следующих действий:

  • CreateDBInstance
  • ModifyDBInstance
  • RestoreDBInstanceFromDBSnapshot
  • RestoreDBInstanceFromS3
  • RestoreDBInstanceToPointInTime

Вы можете просмотреть допустимые значения процессора для определенного класса экземпляра, вызвав действие DescribeOrderableDBInstanceOptions и указав класс экземпляра для параметра DBInstanceClass.

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

  • DescribeDBInstances
  • DescribeDBSnapshots
  • DescribeValidDBInstanceModifications

Если вы вызываете DescribeDBInstances, ProcessorFeature возвращает значения, отличные от null, только если выполнены следующие условия:

  • Вы обращаетесь к экземпляру базы данных Oracle.
  • Ваш экземпляр базы данных Oracle поддерживает настройку количества ядер процессора и потоков на ядро.
  • Текущее количество ядер процессора и потоков на ядро установлено в значение, отличное от значения по умолчанию.

Дополнительную информацию см. в разделе Настройка процессора для класса экземпляра базы данных в RDS для Oracle в руководстве пользователя Amazon RDS.

Name -> (строка)

Имя характеристики процессора. Допустимые имена — coreCount и threadsPerCore.

Value -> (строка)

Значение характеристики процессора.

DeletionProtection -> (булево)

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

AssociatedRoles -> (список)

Роли Amazon Web Services Identity and Access Management (IAM), связанные с экземпляром базы данных.

(структура)

Сведения о роли Amazon Web Services Identity and Access Management (IAM), связанной с экземпляром базы данных.

RoleArn -> (строка)

Amazon Resource Name (ARN) роли IAM, связанной с экземпляром базы данных.

FeatureName -> (строка)

Имя функции, связанной с ролью Amazon Web Services Identity and Access Management (IAM). Сведения о поддерживаемых именах функций см. в разделе DBEngineVersion.

Status -> (строка)

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

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

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

Конечная точка подключения прослушивателя для SQL Server Always On.

Address -> (строка)

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

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

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

HostedZoneId -> (строка)

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

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

Максимальный предел в гибибайтах (GiB), до которого Amazon RDS может автоматически масштабировать хранилище экземпляра базы данных.

TagList -> (список)

Список тегов.

Дополнительную информацию см. в разделе Тегирование ресурсов Amazon RDS в руководстве пользователя Amazon RDS или Тегирование ресурсов Amazon Aurora и Amazon RDS в руководстве пользователя Amazon Aurora.

(структура)

Метаданные, назначенные ресурсу Amazon RDS, представляющие собой пару «ключ-значение».

Дополнительную информацию см. в разделе Тегирование ресурсов Amazon RDS в руководстве пользователя Amazon RDS или Тегирование ресурсов Amazon Aurora и Amazon RDS в руководстве пользователя Amazon Aurora.

Key -> (строка)

Ключ — это обязательное имя тега. Строковое значение может иметь длину от 1 до 128 символов Юникода и не может начинаться с aws: или rds:. Строка может содержать только набор символов Юникода, цифр, пробелов, «_», «.», «:», «/», «=», «+», «-», «@» (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$”).

Value -> (строка)

Значение — это необязательное значение тега. Строковое значение может иметь длину от 1 до 256 символов Юникода и не может начинаться с aws: или rds:. Строка может содержать только набор символов Юникода, цифр, пробелов, «_», «.», «:», «/», «=», «+», «-», «@» (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$”).

DBInstanceAutomatedBackupsReplications -> (список)

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

(структура)

Автоматические резервные копии экземпляра базы данных, реплицированные в другой регион Amazon Web Services. Они включают системные резервные копии, журналы транзакций и свойства экземпляра базы данных.

DBInstanceAutomatedBackupsArn -> (строка)

Amazon Resource Name (ARN) реплицированных автоматических резервных копий.

CustomerOwnedIpEnabled -> (булево)

Указывает, включен ли для экземпляра базы данных RDS на Outposts клиентский IP-адрес (CoIP).

CoIP обеспечивает локальное или внешнее подключение к ресурсам в подсетях Outpost через вашу локальную сеть. В некоторых случаях CoIP может обеспечить более низкую задержку для подключений к экземпляру базы данных извне его виртуальной частной сети (VPC) в вашей локальной сети.

Дополнительную информацию о RDS на Outposts см. в руководстве пользователя Amazon RDS в разделе Работа с Amazon RDS на Amazon Web Services Outposts.

Дополнительную информацию о CoIP см. в руководстве пользователя Amazon Web Services Outposts в разделе Клиентские IP-адреса.

AwsBackupRecoveryPointArn -> (строка)

Идентификатор ресурса Amazon (ARN) точки восстановления в Amazon Web Services Backup.

ActivityStreamStatus -> (строка)

Статус потока событий активности базы данных.

ActivityStreamKmsKeyId -> (строка)

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

ActivityStreamKinesisStreamName -> (строка)

Имя потока данных Amazon Kinesis, используемого для потока событий активности базы данных.

ActivityStreamMode -> (строка)

Режим потока событий активности базы данных. События базы данных, такие как изменение или доступ, генерируют событие потока событий активности. RDS для Oracle всегда обрабатывает эти события асинхронно.

ActivityStreamEngineNativeAuditFieldsIncluded -> (булево)

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

AutomationMode -> (строка)

Режим автоматизации экземпляра RDS Custom DB: full или all paused. Если full, экземпляр базы данных автоматизирует мониторинг и восстановление экземпляра. Если all paused, экземпляр приостанавливает автоматизацию на период, заданный --resume-full-automation-mode-minutes.

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

Количество минут для приостановки автоматизации. По истечении этого периода RDS Custom возобновляет полную автоматизацию. Минимальное значение — 60 (по умолчанию). Максимальное значение — 1440.

CustomIamInstanceProfile -> (строка)

Профиль экземпляра, связанный с базовым экземпляром Amazon EC2 базы данных RDS Custom DB. Профиль экземпляра должен удовлетворять следующим требованиям:

  • Профиль должен существовать в вашем аккаунте.
  • Профиль должен иметь роль IAM, которую у Amazon EC2 есть разрешения принять.
  • Имя профиля экземпляра и имя связанной роли IAM должны начинаться с префикса AWSRDSCustom.

Список разрешений, необходимых для роли IAM, см. в руководстве пользователя Amazon RDS в разделе Настройка IAM и вашей VPC.

BackupTarget -> (строка)

Место хранения автоматических резервных копий и ручных снимков: Amazon Web Services Outposts или регион Amazon Web Services.

NetworkType -> (строка)

Тип сети экземпляра базы данных.

Тип сети определяется DBSubnetGroup, указанным для экземпляра базы данных. DBSubnetGroup может поддерживать только протокол IPv4 или протоколы IPv4 и IPv6 (DUAL).

Дополнительную информацию см. в руководстве пользователя Amazon RDS в разделе Работа с экземпляром базы данных в VPC и в руководстве пользователя Amazon Aurora в разделе Работа с экземпляром базы данных в VPC.

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

ActivityStreamPolicyStatus -> (строка)

Статус состояния политики потока событий активности.

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

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

Это значение применяется только к типу хранилища gp3.

DBSystemId -> (строка)

Идентификатор системы Oracle (SID Oracle) для контейнерной базы данных (CDB). SID Oracle также является именем CDB. Это значение применимо только для экземпляров RDS Custom DB.

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

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

Дополнительную информацию см. в руководстве пользователя Amazon RDS в разделе Управление паролями с помощью Amazon Web Services Secrets Manager.

SecretArn -> (строка)

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

SecretStatus -> (строка)

Статус секрета.

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

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

KmsKeyId -> (строка)

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

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

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

CAIdentifier -> (строка)

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

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

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

ReadReplicaSourceDBClusterIdentifier -> (строка)

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

PercentProgress -> (строка)

Прогресс операции оптимизации хранилища в процентах.

DedicatedLogVolume -> (булево)

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

IsStorageConfigUpgradeAvailable -> (булево)

Указывает, рекомендуется ли обновление конфигурации файловой системы хранилища на экземпляре базы данных. Для миграции к предпочтительной конфигурации можно либо создать развертывание типа «синий/зеленый», либо создать реплику чтения из экземпляра базы данных. Дополнительную информацию см. в разделе Обновление файловой системы хранилища для экземпляра базы данных.

MultiTenant -> (булево)

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

EngineLifecycleSupport -> (строка)

Тип жизненного цикла для экземпляра базы данных.

Дополнительную информацию см. в CreateDBInstance.

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

Spec-Zone.ru

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