Spec-Zone.ru › AWS CLI v2

[ aws . rds ]

promote-read-replica

Описание

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

Примечание

  • Продолжительность резервного копирования зависит от количества изменений в базе данных с момента предыдущего резервного копирования. Если вы планируете преобразовать реплику чтения в автономный экземпляр, рекомендуется включить резервное копирование и выполнить по крайней мере одну резервную копию перед преобразованием. Кроме того, реплика чтения не может быть преобразована в автономный экземпляр, когда она находится в состоянии backing-up. Если вы включили резервное копирование на своей реплике чтения, настройте автоматическое окно резервного копирования таким образом, чтобы ежедневные резервные копии не мешали преобразованию реплики чтения.
  • Эта команда не применяется к Aurora MySQL, Aurora PostgreSQL или RDS Custom.

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

Синтаксис

  promote-read-replica
--db-instance-identifier <value>
[--backup-retention-period <value>]
[--preferred-backup-window <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 (строка)

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

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

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

Пример: mydbinstance

--backup-retention-period (целое число)

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

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

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

  • Должно быть значение от 0 до 35.
  • Не может быть установлено в 0, если экземпляр БД является источником для реплик чтения.

--preferred-backup-window (строка)

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

По умолчанию используется 30-минутное окно, выбранное случайным образом из 8-часового блока времени для каждого региона Amazon Web Services. Чтобы увидеть доступные временные блоки, см. Настройка предпочтительного окна обслуживания в Руководстве пользователя Amazon RDS.

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

  • Должно быть в формате hh24:mi-hh24:mi.
  • Должно быть в универсальном координированном времени (UTC).
  • Не должно конфликтовать с предпочтительным окном обслуживания.
  • Должно быть не менее 30 минут.

--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
  • таблица
  • 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 (булево)

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

--no-cli-auto-prompt (булево)

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

Примеры

Примечание

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

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

Для преобразования реплики чтения

Следующий promote-read-replica пример преобразует указанную реплику чтения в автономный экземпляр базы данных.

aws rds promote-read-replica \
    --db-instance-identifier test-instance-repl

Вывод:

{
    "DBInstance": {
        "DBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:test-instance-repl",
        "StorageType": "standard",
        "ReadReplicaSourceDBInstanceIdentifier": "test-instance",
        "DBInstanceStatus": "modifying",
        ...some output truncated...
    }
}

Вывод

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

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

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

DBInstanceIdentifier -> (строка)

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

DBInstanceClass -> (строка)

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

Engine -> (строка)

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

DBInstanceStatus -> (строка)

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

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

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 на узлах Outpost см. в руководстве Amazon RDS User Guide в разделе Amazon RDS на узлах Amazon Web Services Outposts.

Arn -> (строка)

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

SubnetStatus -> (строка)

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

DBSubnetGroupArn -> (строка)

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

SupportedNetworkTypes -> (список)

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

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

  • IPV4
  • DUAL

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

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

(строка)

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

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

Дополнительную информацию см. в разделе Настройка процессора для класса экземпляра базы данных в RDS for 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 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, что и экземпляр базы данных, имя домена DNS разрешается до частного IP-адреса. Доступ к кластеру баз данных в конечном итоге регулируется используемой им группой безопасности. Такой публичный доступ не допускается, если назначенная кластеру группа безопасности его не разрешает.

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

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

StatusInfos -> (список)

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

(структура)

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

StatusType -> (строка)

В настоящее время это значение равно «read replication».

Normal -> (булево)

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

Status -> (строка)

Состояние экземпляра базы данных. Для StatusType «read replica» допустимые значения — 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 User Guide и Использование SSL/TLS для шифрования подключения к кластеру баз данных в руководстве Amazon Aurora User Guide.

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

DBInstanceArn -> (строка)

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

Timezone -> (строка)

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

IAMDatabaseAuthenticationEnabled -> (булево)

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

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

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

(строка)

ProcessorFeatures -> (список)

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

(структура)

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

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

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

  • CreateDBInstance
  • ModifyDBInstance
  • RestoreDBInstanceFromDBSnapshot
  • RestoreDBInstanceFromS3
  • RestoreDBInstanceToPointInTime

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

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

  • DescribeDBInstances
  • DescribeDBSnapshots
  • DescribeValidDBInstanceModifications

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

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

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

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 User Guide или Назначение тегов ресурсам Amazon Aurora и Amazon RDS в руководстве Amazon Aurora User Guide.

(структура)

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

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

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

Идентификатор Amazon Resource Name (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, см. в разделе Настройка IAM и вашей VPC в Руководстве пользователя Amazon RDS.

BackupTarget -> (строка)

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

NetworkType -> (строка)

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

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

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

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

ActivityStreamPolicyStatus -> (строка)

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

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

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

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

DBSystemId -> (строка)

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

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

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

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

SecretArn -> (строка)

Идентификатор Amazon Resource Name (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