create-db-instance-read-replica

Описание

Создаёт новый экземпляр базы данных, который действует как реплику чтения для существующего исходного экземпляра базы данных или кластера базы данных Multi-AZ. Вы можете создать реплику чтения для экземпляра базы данных, работающего с Db2, MariaDB, MySQL, Oracle, PostgreSQL или SQL Server. Вы можете создать реплику чтения для кластера базы данных Multi-AZ, работающего с MySQL или PostgreSQL. Дополнительную информацию см. в разделе Работа с репликами чтения и Миграция из кластера базы данных Multi-AZ в экземпляр базы данных с использованием реплики чтения в Руководстве пользователя Amazon RDS.

Amazon Aurora не поддерживает эту операцию. Чтобы создать экземпляр базы данных для кластера Aurora DB, используйте операцию CreateDBInstance.

Все экземпляры баз данных реплики чтения создаются с отключёнными резервными копий. Все остальные атрибуты (включая группы безопасности БД и группы параметров БД) наследуются от исходного экземпляра базы данных или кластера, за исключением указанных.

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

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

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

Синтаксис

  create-db-instance-read-replica
--db-instance-identifier <value>
[--source-db-instance-identifier <value>]
[--db-instance-class <value>]
[--availability-zone <value>]
[--port <value>]
[--multi-az | --no-multi-az]
[--auto-minor-version-upgrade | --no-auto-minor-version-upgrade]
[--iops <value>]
[--option-group-name <value>]
[--db-parameter-group-name <value>]
[--publicly-accessible | --no-publicly-accessible]
[--tags <value>]
[--db-subnet-group-name <value>]
[--vpc-security-group-ids <value>]
[--storage-type <value>]
[--copy-tags-to-snapshot | --no-copy-tags-to-snapshot]
[--monitoring-interval <value>]
[--monitoring-role-arn <value>]
[--kms-key-id <value>]
[--pre-signed-url <value>]
[--enable-iam-database-authentication | --no-enable-iam-database-authentication]
[--database-insights-mode <value>]
[--enable-performance-insights | --no-enable-performance-insights]
[--performance-insights-kms-key-id <value>]
[--performance-insights-retention-period <value>]
[--enable-cloudwatch-logs-exports <value>]
[--processor-features <value>]
[--use-default-processor-features | --no-use-default-processor-features]
[--deletion-protection | --no-deletion-protection]
[--domain <value>]
[--domain-iam-role-name <value>]
[--domain-fqdn <value>]
[--domain-ou <value>]
[--domain-auth-secret-arn <value>]
[--domain-dns-ips <value>]
[--replica-mode <value>]
[--max-allocated-storage <value>]
[--custom-iam-instance-profile <value>]
[--network-type <value>]
[--storage-throughput <value>]
[--enable-customer-owned-ip | --no-enable-customer-owned-ip]
[--allocated-storage <value>]
[--source-db-cluster-identifier <value>]
[--dedicated-log-volume | --no-dedicated-log-volume]
[--upgrade-storage-config | --no-upgrade-storage-config]
[--ca-certificate-identifier <value>]
[--source-region <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 (строка)

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

--source-db-instance-identifier (строка)

Идентификатор экземпляра базы данных, который будет источником для реплики чтения. Каждый экземпляр базы данных может иметь до 15 реплик чтения, за исключением Oracle и SQL Server, которые могут иметь до пяти.

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

Должен быть идентификатором существующего экземпляра базы данных Db2, MariaDB, MySQL, Oracle, PostgreSQL или SQL Server.
Не может быть указан, если также указан параметр SourceDBClusterIdentifier.
Ограничения для реплик Oracle см. в разделе «Соображения по версиям и лицензированию для реплик RDS для Oracle» в руководстве Amazon RDS User Guide.
Ограничения для реплик SQL Server см. в разделе «Ограничения реплики чтения с SQL Server» в руководстве Amazon RDS User Guide.
Указанный экземпляр базы данных должен иметь включенные автоматические резервные копии, то есть его период удержания резервных копий должен быть больше 0.
Если источник экземпляра базы данных находится в той же области Amazon Web Services, что и реплика чтения, укажите допустимый идентификатор экземпляра базы данных.
Если источник экземпляра базы данных находится в другой области Amazon Web Services по сравнению с репликой чтения, укажите допустимый ARN экземпляра базы данных. Дополнительную информацию см. в руководстве Amazon RDS User Guide в разделе «Создание ARN для Amazon RDS». Это не относится к SQL Server или RDS Custom, которые не поддерживают межрегиональные реплики.

--db-instance-class (строка)

Вычислительная и оперативная мощность реплики чтения, например db.m4.large. Не все классы экземпляров баз данных доступны во всех регионах Amazon Web Services или для всех движков баз данных. Полный список классов экземпляров баз данных и доступность для вашего движка см. в руководстве Amazon RDS User Guide в разделе «Класс экземпляра базы данных».

Значение по умолчанию: наследуется из источника экземпляра базы данных.

--availability-zone (строка)

Зона доступности (AZ), в которой будет создана реплика чтения.

Значение по умолчанию: случайная, выбранная системой зона доступности в области Amazon Web Services конечной точки.

Пример: us-east-1d

--port (целое число)

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

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

Значение по умолчанию: наследуется из источника экземпляра базы данных.

--multi-az | --no-multi-az (логическое значение)

Указывает, находится ли реплика чтения в развертывании Multi-AZ.

Вы можете создать реплику чтения как экземпляр базы данных Multi-AZ. RDS создает резервный экземпляр вашей реплики в другой зоне доступности для поддержки восстановления работоспособности реплики. Создание реплики чтения как экземпляра базы данных Multi-AZ не зависит от того, является ли источник экземпляром базы данных Multi-AZ или кластером баз данных Multi-AZ.

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

--auto-minor-version-upgrade | --no-auto-minor-version-upgrade (логическое значение)

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

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

Значение по умолчанию: наследуется из источника экземпляра базы данных.

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

--iops (целое число)

Количество Provisioned IOPS (входных/выходных операций в секунду), которое необходимо изначально выделить для экземпляра базы данных.

--option-group-name (строка)

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

Примечание

Для SQL Server необходимо использовать группу опций, связанную с источником.

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

--db-parameter-group-name (строка)

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

Для экземпляров реплики чтения однозонных или многозонных экземпляров баз данных, если вы не указываете значение для DBParameterGroupName, Amazon RDS использует DBParameterGroup исходного экземпляра базы данных для реплики чтения в той же области или значение по умолчанию DBParameterGroup для указанного движка базы данных для межрегиональной реплики чтения.

Для экземпляров реплики чтения многозонных кластеров баз данных в той же области, если вы не указываете значение для DBParameterGroupName, Amazon RDS использует значение по умолчанию DBParameterGroup.

Указание группы параметров для этой операции поддерживается только для экземпляров баз данных MySQL для межрегиональных реплик чтения, для экземпляров реплик чтения многозонных кластеров баз данных и для экземпляров баз данных Oracle. Оно не поддерживается для экземпляров баз данных MySQL для реплик чтения в той же области или для RDS Custom.

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

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

--publicly-accessible | --no-publicly-accessible (логическое значение)

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

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

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

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

--tags (список)

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

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

(структура)

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

Ключ -> (строка)

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

Значение -> (строка)

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

Сокращенная синтаксическая запись:

Key=string,Value=string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--db-subnet-group-name (строка)

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

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

Если указано, должно совпадать с именем существующей группы подсетей базы данных.
Указанная группа подсетей базы данных должна находиться в той же области Amazon Web Services, в которой выполняется операция.
Все реплики чтения в одной области Amazon Web Services, созданные из одного исходного экземпляра базы данных, должны либо:
- Указать группы подсетей из одного VPC. Все эти реплики чтения создаются в одном VPC.
- Не указывать группу подсетей. Все эти реплики чтения создаются вне VPC.

Пример: mydbsubnetgroup

--vpc-security-group-ids (список)

Список групп безопасности VPC Amazon EC2, которые необходимо ассоциировать с репликой чтения.

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

Значение по умолчанию: группа безопасности VPC EC2 по умолчанию для VPC группы подсетей базы данных.

(строка)

--storage-type (строка)

Тип хранилища, который необходимо ассоциировать с репликой чтения.

Если вы указываете io1, io2 или gp3, вы также должны указать значение для параметра Iops.

Допустимые значения: gp2 | gp3 | io1 | io2 | standard

Значение по умолчанию: io1, если указан параметр Iops. В противном случае, gp3.

--copy-tags-to-snapshot | --no-copy-tags-to-snapshot (логическое значение)

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

--monitoring-interval (целое число)

Интервал в секундах между моментами, когда метрики мониторинга с расширенными возможностями собираются для реплики чтения. Для отключения сбора метрик мониторинга с расширенными возможностями укажите 0. Значение по умолчанию — 0.

Если указано MonitoringRoleArn, необходимо установить MonitoringInterval на значение, отличное от 0.

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

Допустимые значения: 0, 1, 5, 10, 15, 30, 60

Значение по умолчанию: 0

--monitoring-role-arn (строка)

ARN для роли IAM, которая разрешает RDS отправлять метрики расширенного мониторинга в Amazon CloudWatch Logs. Например, arn:aws:iam:123456789012:role/emaccess. Информацию о создании роли см. в руководстве Amazon RDS User Guide в разделе «Создание роли IAM для расширенного мониторинга Amazon RDS».

Если MonitoringInterval установлено на значение, отличное от 0, необходимо указать значение MonitoringRoleArn.

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

--kms-key-id (строка)

Идентификатор ключа Amazon Web Services KMS для зашифрованной читающей реплики.

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

Если вы создаёте зашифрованную читающую реплику в той же области Amazon Web Services, что и исходный экземпляр базы данных или кластер Multi-AZ базы данных, не указывайте значение для этого параметра. Читающая реплика в той же области Amazon Web Services всегда шифруется с помощью того же ключа KMS, что и исходный экземпляр базы данных или кластер.

Если вы создаёте зашифрованную читающую реплику в другой области Amazon Web Services, необходимо указать идентификатор ключа KMS для целевой области Amazon Web Services. Ключи KMS специфичны для области Amazon Web Services, в которой они созданы, и вы не можете использовать ключи KMS из одной области Amazon Web Services в другой.

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

Это настройка не применяется к RDS Custom, которая использует тот же ключ KMS, что и первичная реплика.

--pre-signed-url (строка)

Когда вы создаёте читающую реплику из одной области Amazon Web Services GovCloud (США) в другую или из одной китайской области Amazon Web Services в другую, URL, содержащий подписанный запрос Signature Version 4 для операции CreateDBInstanceReadReplica API в исходной области Amazon Web Services, содержащей исходный экземпляр базы данных.

Это ограничение применяется только к областям Amazon Web Services GovCloud (США) и областям Amazon Web Services в Китае. В других областях Amazon Web Services оно игнорируется.

Это ограничение применяется только при репликации из исходного экземпляра базы данных. Исходные кластеры баз данных не поддерживаются в областях Amazon Web Services GovCloud (США) и областей Amazon Web Services в Китае.

Этот параметр необходимо указать при создании зашифрованной читающей реплики из другой области Amazon Web Services с помощью API Amazon RDS. Не указывайте PreSignedUrl при создании зашифрованной читающей реплики в той же области Amazon Web Services.

Подписанный URL-адрес должен быть допустимым запросом для операции CreateDBInstanceReadReplica API, которая может выполняться в исходной области Amazon Web Services, содержащей зашифрованный исходный экземпляр базы данных. Запрос подписанного URL-адреса должен содержать следующие значения параметров:

DestinationRegion — область Amazon Web Services, в которой создаётся зашифрованная читающая реплика. Эта область Amazon Web Services совпадает с той, где вызывается операция CreateDBInstanceReadReplica, которая содержит этот подписанный URL-адрес. Например, если вы создаёте зашифрованный экземпляр базы данных в области us-west-1 Amazon Web Services из исходного экземпляра базы данных в области us-east-2 Amazon Web Services, то вызываете операцию CreateDBInstanceReadReplica в области us-east-1 Amazon Web Services и предоставляете подписанный URL-адрес, который содержит вызов операции CreateDBInstanceReadReplica в области us-west-2 Amazon Web Services. В этом примере DestinationRegion в подписанном URL-адресе должен быть установлен на область us-east-1 Amazon Web Services.
KmsKeyId — идентификатор ключа KMS для ключа, используемого для шифрования читающей реплики в целевой области Amazon Web Services. Это тот же идентификатор, что и для операции CreateDBInstanceReadReplica, вызываемой в целевой области Amazon Web Services, и операции, содержащейся в подписанном URL-адресе.
SourceDBInstanceIdentifier — идентификатор экземпляра базы данных для зашифрованного экземпляра базы данных, который будет реплицирован. Этот идентификатор должен быть в формате Amazon Resource Name (ARN) для исходной области Amazon Web Services. Например, если вы создаёте зашифрованную читающую реплику из экземпляра базы данных в области us-west-2 Amazon Web Services, то ваш SourceDBInstanceIdentifier выглядит следующим образом: arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115 .

Чтобы узнать, как сгенерировать подписанный запрос Signature Version 4, см. Авторизация запросов: использование параметров запроса (Amazon Web Services Signature Version 4) и Процесс подписи Signature Version 4.

Примечание

Если вы используете инструмент Amazon Web Services SDK или командную строку, вы можете указать SourceRegion (или --source-region для командной строки) вместо ручного указания PreSignedUrl. Указание SourceRegion автоматически генерирует подписанный URL-адрес, который является допустимым запросом для операции, которая может выполняться в исходной области Amazon Web Services.

Это ограничение не применяется к экземплярам баз данных RDS Custom.

--enable-iam-database-authentication | --no-enable-iam-database-authentication (булево)

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

Дополнительную информацию об аутентификации IAM для баз данных см. в разделе IAM Database Authentication for MySQL and PostgreSQL в руководстве пользователя Amazon RDS.

Это ограничение не применяется к экземплярам баз данных RDS Custom.

--database-insights-mode (строка)

Режим Database Insights, который нужно включить для читающей реплики.

Примечание

Это ограничение не поддерживается.

Возможные значения:

standard
advanced

--enable-performance-insights | --no-enable-performance-insights (булево)

Указывает, следует ли включить Performance Insights для читающей реплики.

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

Это ограничение не применяется к экземплярам баз данных RDS Custom.

--performance-insights-kms-key-id (строка)

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

Если вы не укажете значение для PerformanceInsightsKMSKeyId, Amazon RDS будет использовать ваш ключ KMS по умолчанию. У вашей учётной записи Amazon Web Services есть ключ KMS по умолчанию для каждой области Amazon Web Services.

Это ограничение не применяется к экземплярам баз данных RDS Custom.

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

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

Это ограничение не применяется к экземплярам баз данных RDS Custom.

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

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

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

Если вы укажете срок хранения, который не является допустимым, например 94, Amazon RDS вернёт ошибку.

--enable-cloudwatch-logs-exports (список)

Список журналов, которые новый экземпляр базы данных должен экспортировать в CloudWatch Logs. Значения в списке зависят от используемого движка базы данных. Дополнительную информацию см. в разделе Публикация журналов базы данных в Amazon CloudWatch Logs в руководстве пользователя Amazon RDS.

Это ограничение не применяется к экземплярам баз данных RDS Custom.

(строка)

Синтаксис:

"string" "string" ...

--processor-features (список)

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

Это ограничение не применяется к экземплярам баз данных RDS Custom.

(структура)

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

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

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

CreateDBInstance
ModifyDBInstance
RestoreDBInstanceFromDBSnapshot
RestoreDBInstanceFromS3
RestoreDBInstanceToPointInTime

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

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

DescribeDBInstances
DescribeDBSnapshots
DescribeValidDBInstanceModifications

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

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

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

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

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

Значение -> (строка)

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

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

Name=string,Value=string ...

Синтаксис JSON:

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

--use-default-processor-features | --no-use-default-processor-features (булево)

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

Это ограничение не применяется к экземплярам баз данных RDS Custom.

--deletion-protection | --no-deletion-protection (булево)

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

--domain (строка)

Идентификатор каталога Active Directory, в котором нужно создать экземпляр базы данных. В настоящее время экземпляры баз данных MySQL, Microsoft SQL Server, Oracle и PostgreSQL могут быть созданы в домене Active Directory.

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

Это ограничение не применяется к экземплярам баз данных RDS Custom.

--domain-iam-role-name (строка)

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

Это ограничение не применяется к экземплярам баз данных RDS Custom.

--domain-fqdn (строка)

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

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

Длина не должна превышать 64 символов.

Пример: mymanagedADtest.mymanagedAD.mydomain

--domain-ou (строка)

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

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

Должен быть в формате имени Distinguished Name.
Длина не должна превышать 64 символов.

Пример: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain

--domain-auth-secret-arn (строка)

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

Пример: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456

--domain-dns-ips (список)

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

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

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

Пример: 123.124.125.126,234.235.236.237

(строка)

Синтаксис:

"string" "string" ...

--replica-mode (строка)

Режим открытия реплики базы данных: подключенный или только для чтения.

Примечание

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

Подключенные реплики баз данных включены в Oracle Database Enterprise Edition. Основной случай использования подключенных реплик — это аварийное восстановление в другом регионе. Первичная база данных не использует Active Data Guard для передачи информации подключённой реплике. Поскольку она не принимает подключения пользователей, подключенная реплика не может обслуживать рабочую нагрузку только для чтения.

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

Для RDS Custom необходимо указать этот параметр и установить его значение в mounted. Значение по умолчанию не устанавливается. После создания реплики вы можете управлять режимом открытия вручную.

Возможные значения:

open-read-only
mounted

--max-allocated-storage (целое число)

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

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

--custom-iam-instance-profile (строка)

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

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

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

Этот параметр требуется для экземпляров RDS Custom.

--network-type (строка)

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

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

IPV4
DUAL

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

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

--storage-throughput (целое число)

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

Это значение не применяется к экземплярам RDS Custom или Amazon Aurora.

--enable-customer-owned-ip | --no-enable-customer-owned-ip (булево)

Указывает, следует ли включить IP-адрес, принадлежащий клиенту (CoIP), для реплики чтения RDS на Outposts.

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

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

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

--allocated-storage (целое число)

Количество хранилища (в гибибайтах), которое необходимо выделить для реплики чтения. Следуйте правилам выделения, указанным в CreateDBInstance.

Это значение недействительно для RDS for SQL Server.

Примечание

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

--source-db-cluster-identifier (строка)

Идентификатор кластера базы данных Multi-AZ, который будет выступать в качестве источника для реплики чтения. Каждый кластер базы данных может иметь до 15 реплик чтения.

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

Должен быть идентификатором существующего кластера базы данных Multi-AZ.
Не может быть указан, если также указан параметр SourceDBInstanceIdentifier.
Указанный кластер базы данных должен иметь включенные автоматические резервные копии, то есть период удержания резервных копий должен быть больше 0.
Источник кластера базы данных должен находиться в той же области Amazon Web Services, что и реплика чтения. Репликация между областями не поддерживается.

--dedicated-log-volume | --no-dedicated-log-volume (булево)

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

--upgrade-storage-config | --no-upgrade-storage-config (булево)

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

--ca-certificate-identifier (строка)

Идентификатор сертификата CA, который следует использовать для сертификата сервера реплики чтения.

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

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

--source-region (строка)

Идентификатор региона, содержащего источник для реплики чтения.

--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
текст
таблица
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 для вывода.

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

Автоматический запрос параметров CLI.

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

Отключение автоматического запроса параметров CLI.

Примеры

Примечание

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

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

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

В этом примере создаётся реплика чтения существующего экземпляра базы данных с именем test-instance. Реплика чтения называется test-instance-repl.

aws rds create-db-instance-read-replica \
    --db-instance-identifier test-instance-repl \
    --source-db-instance-identifier test-instance

Вывод:

{
    "DBInstance": {
        "IAMDatabaseAuthenticationEnabled": false,
        "MonitoringInterval": 0,
        "DBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:test-instance-repl",
        "ReadReplicaSourceDBInstanceIdentifier": "test-instance",
        "DBInstanceIdentifier": "test-instance-repl",
        ...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 на Outposts см. в руководстве пользователя Amazon RDS, в разделе 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, в разделе Работа с экземпляром базы данных в 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 возвращает значения, отличные от NULL, только если выполнены следующие условия:

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

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

Name -> (строка)

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

Value -> (строка)

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

IAMDatabaseAuthenticationEnabled -> (булево)

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

AutomationMode -> (строка)

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

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

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

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

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

Engine -> (строка)

СУБД экземпляра базы данных.

DedicatedLogVolume -> (булево)

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

MultiTenant -> (булево)

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

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

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

MultiAZ -> (булево)

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

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

DbiResourceId -> (строка)

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

CACertificateIdentifier -> (строка)

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

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

DomainMemberships -> (список)

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

(структура)

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

Domain -> (строка)

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

Status -> (строка)

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

FQDN -> (строка)

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

IAMRoleName -> (строка)

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

OU -> (строка)

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

AuthSecretArn -> (строка)

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

DnsIps -> (список)

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

(строка)

CopyTagsToSnapshot -> (логическое значение)

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

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

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

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

EnhancedMonitoringResourceArn -> (строка)

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

MonitoringRoleArn -> (строка)

ARN роли IAM, разрешающей RDS отправлять метрики Улучшенного мониторинга в Amazon CloudWatch Logs.

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

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

DBInstanceArn -> (строка)

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

Timezone -> (строка)

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

IAMDatabaseAuthenticationEnabled -> (логическое значение)

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

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

DatabaseInsightsMode -> (строка)

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

PerformanceInsightsEnabled -> (логическое значение)

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

PerformanceInsightsKMSKeyId -> (строка)

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

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

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

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

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

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

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

EnabledCloudwatchLogsExports -> (список)

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

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

(строка)

ProcessorFeatures -> (список)

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

(структура)

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

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

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

CreateDBInstance
ModifyDBInstance
RestoreDBInstanceFromDBSnapshot
RestoreDBInstanceFromS3
RestoreDBInstanceToPointInTime

DescribeDBInstances
DescribeDBSnapshots
DescribeValidDBInstanceModifications

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

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

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

TagList -> (список)

Список меток.

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

(структура)

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

Key -> (строка)

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

Value -> (строка)

Значение — это необязательное значение метки. Строковое значение может содержать от 1 до 256 символов Юникода и не может начинаться с aws: или rds:. Строка может содержать только набор символов Юникода, цифр, пробелов, «_», «.», «:», «/», «=», «+», «-», «@» (регулярное выражение Java: “^([\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 (ARN) точки восстановления в Amazon Web Services Backup.

ActivityStreamStatus -> (строка)

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

ActivityStreamKmsKeyId -> (строка)

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

ActivityStreamKinesisStreamName -> (строка)

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

ActivityStreamMode -> (строка)

Режим потока активности базы данных. События базы данных, такие как изменение или доступ, генерируют событие потока активности. RDS for 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 (SID Oracle) для контейнерной базы данных (CDB). SID Oracle также является именем CDB. Это значение допустимо только для экземпляров RDS Custom DB.

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

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

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

SecretArn -> (строка)

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

SecretStatus -> (строка)

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

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

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

KmsKeyId -> (строка)

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

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

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

CAIdentifier -> (строка)

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

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

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

ReadReplicaSourceDBClusterIdentifier -> (строка)

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

PercentProgress -> (строка)

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

DedicatedLogVolume -> (булево)

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

IsStorageConfigUpgradeAvailable -> (булево)

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

MultiTenant -> (булево)

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

EngineLifecycleSupport -> (строка)

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

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