describe-db-instances

Описание

Описывает предоставленные экземпляры RDS. Этот API поддерживает постраничный вывод.

Примечание

Данная операция также может возвращать информацию об экземплярах Amazon Neptune DB и Amazon DocumentDB.

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

describe-db-instances является постраничной операцией. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничный вывод, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничным выводом, аргумент --query должен извлечь данные из результатов следующих выражений запроса: DBInstances

Синтаксис

  describe-db-instances
[--db-instance-identifier <value>]
[--filters <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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 (строка)

Идентификатор экземпляра, предоставленный пользователем, или Amazon Resource Name (ARN) экземпляра DB. Если этот параметр указан, возвращается информация только об указанном экземпляре DB. Этот параметр нечувствителен к регистру.

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

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

--filters (список)

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

Поддерживаемые фильтры:

db-cluster-id - Принимает идентификаторы кластеров баз данных и Amazon Resource Names (ARN) кластеров баз данных. Список результатов включает только информацию об экземплярах DB, связанных с кластерами баз данных, идентифицируемыми этими ARN.
db-instance-id - Принимает идентификаторы экземпляров баз данных и Amazon Resource Names (ARN) экземпляров баз данных. Список результатов включает только информацию об экземплярах баз данных, идентифицируемых этими ARN.
dbi-resource-id - Принимает идентификаторы ресурсов экземпляров баз данных. Список результатов включает только информацию об экземплярах баз данных, идентифицируемых этими идентификаторами ресурсов экземпляров баз данных.
domain - Принимает идентификаторы каталогов Active Directory. Список результатов включает только информацию об экземплярах DB, связанных с этими доменными именами.
engine - Принимает имена движков. Список результатов включает только информацию об экземплярах DB для этих движков.

(структура)

Пара имя-значение фильтра, который используется для возврата более конкретного списка результатов из операции describe. Фильтры могут использоваться для сопоставления набора ресурсов по определенным критериям, таким как идентификаторы. Фильтры, поддерживаемые операцией describe, документированы вместе с операцией describe.

Примечание

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

Следующие действия могут быть отфильтрованы:

DescribeDBClusterBacktracks
DescribeDBClusterEndpoints
DescribeDBClusters
DescribeDBInstances
DescribeDBRecommendations
DescribeDBShardGroups
DescribePendingMaintenanceActions

Имя -> (строка)

Имя фильтра. Имена фильтров чувствительны к регистру.

Значения -> (список)

Одно или несколько значений фильтра. Значения фильтров чувствительны к регистру.

(строка)

Сокращенный синтаксис:

Name=string,Values=string,string ...

Синтаксис JSON:

[
  {
    "Name": "string",
    "Values": ["string", ...]
  }
  ...
]

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной строки JSON. Строка JSON следует формату, предоставленному --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения переопределят значения, предоставленные в JSON. Невозможно передать произвольные двоичные значения с помощью предоставленного значения JSON, так как строка будет принята буквально. Это не может быть указано вместе с --cli-input-yaml.

--starting-token (строка)

Токен для указания точки начала постраничного вывода. Это NextToken из ранее обрубленного ответа.

Примеры использования см. в разделе Постраничный вывод в Руководстве пользователя AWS Command Line Interface.

--page-size (целое число)

Размер каждой страницы для получения в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, извлекая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS-сервиса.

Примеры использования см. в разделе Постраничный вывод в Руководстве пользователя AWS Command Line Interface.

--max-items (целое число)

Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов больше указанного значения, в выводе команды предоставляется NextToken. Для возобновления постраничного вывода укажите значение NextToken в аргументе starting-token последующей команды. **Не** используйте элемент ответа NextToken напрямую за пределами AWS CLI.

Примеры использования см. в разделе Постраничный вывод в Руководстве пользователя AWS Command Line Interface.

--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
таблица
yaml
yaml-потоковый

--query (строка)

Запрос JMESPath для использования в фильтрации данных ответа.

--profile (строка)

Использовать конкретный профиль из вашего файла учетных данных.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/выключить цветной вывод.

вкл
выкл
авто

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

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

Для описания экземпляра DB

Следующий пример describe-db-instances получает подробности об указанном экземпляре DB.

aws rds describe-db-instances \
    --db-instance-identifier mydbinstancecf

Вывод:

{
    "DBInstances": [
        {
            "DBInstanceIdentifier": "mydbinstancecf",
            "DBInstanceClass": "db.t3.small",
            "Engine": "mysql",
            "DBInstanceStatus": "available",
            "MasterUsername": "masterawsuser",
            "Endpoint": {
                "Address": "mydbinstancecf.abcexample.us-east-1.rds.amazonaws.com",
                "Port": 3306,
                "HostedZoneId": "Z2R2ITUGPM61AM"
            },
            ...some output truncated...
        }
    ]
}

Вывод

Маркер -> (строка)

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

DBInstances -> (список)

Список экземпляров 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 для 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 -> (список)

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

(структура)

Этот тип данных используется в качестве элемента ответа для запросов о членстве в группе безопасности 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 в 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 -> (логическое значение)

Указывает, будет ли экземпляр базы данных 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 (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 -> (логическое значение)

Указывает, является ли экземпляр базы данных многозонным развертыванием. Это свойство не применимо к экземплярам 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 -> (логическое значение)

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

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-адреса 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 ключа, идентификатор ключа, 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 возвращает ненулевые значения только в том случае, если выполнены следующие условия:

Вы обращаетесь к экземпляру базы данных 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 -> (строка)

Указывает идентификатор, присвоенный 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)

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

ActivityStreamKinesisStreamName -> (string)

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

ActivityStreamMode -> (string)

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

ActivityStreamEngineNativeAuditFieldsIncluded -> (boolean)

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

AutomationMode -> (string)

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

ResumeFullAutomationModeTime -> (timestamp)

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

CustomIamInstanceProfile -> (string)

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

Профиль должен существовать в вашей учётной записи.
Профиль должен иметь роль 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 (Oracle SID) для контейнерной базы данных (CDB). Oracle SID также является именем CDB. Это значение применимо только для экземпляров пользовательской базы данных RDS.

MasterUserSecret -> (structure)

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

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

SecretArn -> (string)

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

SecretStatus -> (string)

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

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

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

KmsKeyId -> (string)

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

CertificateDetails -> (structure)

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

CAIdentifier -> (string)

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

ValidTill -> (timestamp)

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

ReadReplicaSourceDBClusterIdentifier -> (string)

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

PercentProgress -> (string)

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

DedicatedLogVolume -> (boolean)

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

IsStorageConfigUpgradeAvailable -> (boolean)

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

MultiTenant -> (boolean)

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

EngineLifecycleSupport -> (string)

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

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