stop-db-instance

Описание

Временно останавливает экземпляр базы данных Amazon RDS. При остановке экземпляра базы данных Amazon RDS сохраняет метаданные экземпляра базы данных, включая его конечную точку, группу параметров базы данных и членство в группе опций. Amazon RDS также сохраняет журналы транзакций, что позволяет выполнить восстановление по состоянию на определённый момент времени при необходимости. Экземпляр автоматически перезапускается через 7 дней.

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

Примечание

Данная команда не применяется к RDS Custom, Aurora MySQL и Aurora PostgreSQL. Для кластеров Aurora используйте StopDBCluster вместо этого.

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

Синтаксис

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

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

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

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

--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-auto-prompt (логическое значение)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (логическое значение)

Отключить автоматическое запросы параметров ввода CLI.

Примеры

Примечание

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

Если не указано иное, во всех примерах используются правила цитирования, подобные unix-подобным. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. См. Использование кавычек со строками в руководстве пользователя AWS CLI.

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

Следующий stop-db-instance пример останавливает указанный экземпляр базы данных.

aws rds stop-db-instance \
    --db-instance-identifier test-instance

Вывод:

{
    "DBInstance": {
        "DBInstanceStatus": "stopping",
        ...some output truncated...
    }
}

Вывод

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

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

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

DBInstanceIdentifier -> (строка)

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

DBInstanceClass -> (строка)

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

Engine -> (строка)

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

DBInstanceStatus -> (строка)

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

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

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

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

MasterUsername -> (строка)

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

DBName -> (строка)

Изначальное имя базы данных, предоставленное вами при создании экземпляра базы данных (если требуется). Это имя возвращается на протяжении всего существования экземпляра базы данных. Для экземпляра RDS for 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 на узлах Outpost см. в разделе Amazon RDS на узлах Amazon Web Services Outposts в Руководстве пользователя Amazon RDS.

Arn -> (строка)

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

SubnetStatus -> (строка)

Состояние подсети.

DBSubnetGroupArn -> (строка)

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

SupportedNetworkTypes -> (список)

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

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

IPV4
DUAL

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

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

(строка)

PreferredMaintenanceWindow -> (строка)

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

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

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

DBInstanceClass -> (строка)

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

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

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

MasterUserPassword -> (строка)

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

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

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

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

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

MultiAZ -> (булево)

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

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 -> (булево)

Указывает, будет ли экземпляр БД изменен на многопользовательскую конфигурацию (ИСТИНА) или однопользовательскую конфигурацию (ЛОЖЬ).

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

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

MultiAZ -> (булево)

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

EngineVersion -> (строка)

Версия СУБД.

AutoMinorVersionUpgrade -> (булево)

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

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

ReadReplicaSourceDBInstanceIdentifier -> (строка)

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

ReadReplicaDBInstanceIdentifiers -> (список)

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

(строка)

ReadReplicaDBClusterIdentifiers -> (список)

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

Примечание

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

(строка)

ReplicaMode -> (строка)

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

Примечание

Это атрибут поддерживается только в RDS для 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 -> (строка)

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

PubliclyAccessible -> (булево)

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

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

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

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

StatusInfos -> (список)

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

(структура)

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

StatusType -> (строка)

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

Normal -> (булево)

Указывает, работает ли экземпляр в нормальном режиме (ИСТИНА) или находится в состоянии ошибки (ЛОЖЬ).

Status -> (строка)

Состояние экземпляра БД. Для StatusType, равного реплике чтения, значения могут быть 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-адреса IPv4 DNS первичных и вторичных контроллеров домена 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 -> (список)

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

(структура)

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

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

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, состоящие из пары ключ-значение.

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 Web Services Outposts» в Руководстве пользователя Amazon RDS.

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

AwsBackupRecoveryPointArn -> (string)

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

ActivityStreamStatus -> (string)

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

ActivityStreamKmsKeyId -> (string)

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

ActivityStreamKinesisStreamName -> (string)

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

ActivityStreamMode -> (string)

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

ActivityStreamEngineNativeAuditFieldsIncluded -> (boolean)

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

AutomationMode -> (string)

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

ResumeFullAutomationModeTime -> (timestamp)

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

CustomIamInstanceProfile -> (string)

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

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

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

BackupTarget -> (string)

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

NetworkType -> (string)

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

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

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

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

ActivityStreamPolicyStatus -> (string)

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

StorageThroughput -> (integer)

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

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

DBSystemId -> (string)

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

MasterUserSecret -> (structure)

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

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

SecretArn -> (string)

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

SecretStatus -> (string)

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

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

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

KmsKeyId -> (string)

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

CertificateDetails -> (structure)

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

CAIdentifier -> (string)

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

ValidTill -> (timestamp)

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

ReadReplicaSourceDBClusterIdentifier -> (string)

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

PercentProgress -> (string)

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

DedicatedLogVolume -> (boolean)

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

IsStorageConfigUpgradeAvailable -> (boolean)

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

MultiTenant -> (boolean)

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

EngineLifecycleSupport -> (string)

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

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