modify-db-instance

Описание

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

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

Синтаксис

  modify-db-instance
--db-instance-identifier <value>
[--allocated-storage <value>]
[--db-instance-class <value>]
[--db-subnet-group-name <value>]
[--db-security-groups <value>]
[--vpc-security-group-ids <value>]
[--apply-immediately | --no-apply-immediately]
[--master-user-password <value>]
[--db-parameter-group-name <value>]
[--backup-retention-period <value>]
[--preferred-backup-window <value>]
[--preferred-maintenance-window <value>]
[--multi-az | --no-multi-az]
[--engine-version <value>]
[--allow-major-version-upgrade | --no-allow-major-version-upgrade]
[--auto-minor-version-upgrade | --no-auto-minor-version-upgrade]
[--license-model <value>]
[--iops <value>]
[--option-group-name <value>]
[--new-db-instance-identifier <value>]
[--storage-type <value>]
[--tde-credential-arn <value>]
[--tde-credential-password <value>]
[--ca-certificate-identifier <value>]
[--domain <value>]
[--domain-fqdn <value>]
[--domain-ou <value>]
[--domain-auth-secret-arn <value>]
[--domain-dns-ips <value>]
[--copy-tags-to-snapshot | --no-copy-tags-to-snapshot]
[--monitoring-interval <value>]
[--db-port-number <value>]
[--publicly-accessible | --no-publicly-accessible]
[--monitoring-role-arn <value>]
[--domain-iam-role-name <value>]
[--disable-domain | --no-disable-domain]
[--promotion-tier <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>]
[--cloudwatch-logs-export-configuration <value>]
[--processor-features <value>]
[--use-default-processor-features | --no-use-default-processor-features]
[--deletion-protection | --no-deletion-protection]
[--max-allocated-storage <value>]
[--certificate-rotation-restart | --no-certificate-rotation-restart]
[--replica-mode <value>]
[--enable-customer-owned-ip | --no-enable-customer-owned-ip]
[--aws-backup-recovery-point-arn <value>]
[--automation-mode <value>]
[--resume-full-automation-mode-minutes <value>]
[--network-type <value>]
[--storage-throughput <value>]
[--manage-master-user-password | --no-manage-master-user-password]
[--rotate-master-user-password | --no-rotate-master-user-password]
[--master-user-secret-kms-key-id <value>]
[--engine <value>]
[--dedicated-log-volume | --no-dedicated-log-volume]
[--multi-tenant | --no-multi-tenant]
[--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 (строка)

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

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

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

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

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

Для RDS для Db2, MariaDB, RDS для MySQL, RDS для Oracle и RDS для PostgreSQL, предоставленное значение должно быть как минимум на 10% больше текущего значения. Значения, которые не на 10% больше существующего значения, округляются вверх до 10% больше текущего значения.

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

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

При увеличении выделенного хранилища для экземпляра БД, использующего Provisioned IOPS (gp3 , io1 или io2 тип хранилища), необходимо также указать параметр Iops. Можно использовать текущее значение для Iops.

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

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

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

По умолчанию: используется существующее значение

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

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

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

Новая группа подсетей БД для экземпляра БД. С помощью этого параметра можно переместить экземпляр БД в другую VPC. Если ваш экземпляр БД не находится в VPC, этот параметр также можно использовать для перемещения экземпляра БД в VPC. Дополнительные сведения см. в разделе «Работа с экземпляром БД в VPC» в руководстве пользователя Amazon RDS.

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

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

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

При указании должно совпадать с существующей группой подсетей БД.

Пример: mydbsubnetgroup

--db-security-groups (список)

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

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

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

При указании должно совпадать с существующими группами безопасности БД.

(строка)

Синтаксис:

"string" "string" ...

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

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

Это значение не относится к следующим экземплярам БД:

Amazon Aurora (Связанный список групп безопасности EC2 VPC управляется кластером БД. Дополнительные сведения см. в ModifyDBCluster.)
RDS Custom

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

При указании должны совпадать с существующими идентификаторами групп безопасности VPC.

(строка)

Синтаксис:

"string" "string" ...

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

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

Если этот параметр отключен, изменения в экземпляре БД применяются во время следующего окна технического обслуживания. Некоторые изменения параметров могут привести к перерыву и применяются при следующем вызове RebootDBInstance или при следующем сбою перезагрузки. Ознакомьтесь с таблицей параметров в разделе «Изменение экземпляра БД» в руководстве пользователя Amazon RDS, чтобы увидеть влияние включения или отключения ApplyImmediately для каждого измененного параметра и определить, когда изменения будут применены.

--master-user-password (строка)

Новый пароль для пользователя master.

Изменение этого параметра не приводит к перерыву, и изменение применяется асинхронно как можно скорее. В промежутке между запросом и завершением запроса элемент MasterUserPassword существует в элементе PendingModifiedValues ответа операции.

Примечание

Операции Amazon RDS API никогда не возвращают пароль, поэтому эта операция предоставляет способ повторного доступа к пользователю основного экземпляра, если пароль утерян. Это включает восстановление привилегий, которые могли быть случайно отозваны.

Это значение не относится к следующим экземплярам БД:

Amazon Aurora Пароль для пользователя master управляется кластером БД. Дополнительные сведения см. в ModifyDBCluster.
RDS Custom
RDS для Oracle CDB в конфигурации с несколькими арендаторами Укажите пароль master в ModifyTenantDatabase вместо этого.

По умолчанию: используется существующее значение

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

Не может быть указан, если ManageMasterUserPassword включен.
Может включать любые печатные ASCII-символы, кроме «/», «» или «@». Для RDS для Oracle не может включать символ «&» (амперсанд) или «'» (одинарные кавычки).

Ограничения длины:

RDS для Db2 - Должно содержать от 8 до 255 символов.
RDS для MariaDB - Должно содержать от 8 до 41 символа.
RDS для Microsoft SQL Server - Должно содержать от 8 до 128 символов.
RDS для MySQL - Должно содержать от 8 до 41 символа.
RDS для Oracle - Должно содержать от 8 до 30 символов.
RDS для PostgreSQL - Должно содержать от 8 до 128 символов.

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

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

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

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

По умолчанию: используется существующее значение

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

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

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

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

Примечание

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

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

Это значение не относится к экземплярам БД Amazon Aurora. Срок хранения автоматических резервных копий управляется кластером БД. Дополнительные сведения см. в ModifyDBCluster.

По умолчанию: используется существующее значение

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

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

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

Ежедневный диапазон времени, в течение которого создаются автоматические резервные копии, если автоматические резервные копии включены, как определено параметром BackupRetentionPeriod. Изменение этого параметра не приводит к перерыву, и изменение применяется асинхронно как можно скорее. По умолчанию устанавливается 30-минутное окно, случайно выбранное из 8-часового интервала для каждого региона Amazon Web Services. Дополнительные сведения см. в разделе «Окно резервного копирования» в руководстве пользователя Amazon RDS.

Это значение не относится к экземплярам БД Amazon Aurora. Ежедневный диапазон времени для создания автоматических резервных копий управляется кластером БД. Дополнительные сведения см. в ModifyDBCluster.

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

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

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

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

Дополнительные сведения см. в разделе «Окно технического обслуживания Amazon RDS» в руководстве пользователя Amazon RDS.

По умолчанию: используется существующее значение

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

Должен быть в формате ddd:hh24:mi-ddd:hh24:mi.
Значения дней должны быть mon | tue | wed | thu | fri | sat | sun.
Должен быть в формате UTC (всемирное координированное время).
Не должен конфликтовать с предпочтительным окном резервного копирования.
Должен быть не менее 30 минут.

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

Указывает, является ли экземпляр БД развертыванием Multi-AZ. Изменение этого параметра не приводит к перерыву. Изменение применяется во время следующего окна технического обслуживания, если параметр ApplyImmediately включен для этого запроса.

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

--engine-version (строка)

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

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

Если вы указываете только основную версию, Amazon RDS обновляет экземпляр базы данных до стандартной дополнительной версии, если текущая дополнительная версия меньше. Сведения о допустимых версиях движка см. в разделе CreateDBInstance или вызовите DescribeDBEngineVersions.

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

В RDS Custom для Oracle этот параметр поддерживается только для реплик чтения, если они находятся в состоянии PATCH_DB_FAILURE.

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

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

--allow-major-version-upgrade | --no-allow-major-version-upgrade (boolean)

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

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

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

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

--auto-minor-version-upgrade | --no-auto-minor-version-upgrade (boolean)

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

Автоматическое обновление включено для окна обслуживания.
Доступна более новая дополнительная версия.
Amazon RDS включил автоматическое исправление для версии движка.

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

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

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

--license-model (string)

Модель лицензии для экземпляра базы данных.

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

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

RDS for Db2 - bring-your-own-license
RDS for MariaDB - general-public-license
RDS for Microsoft SQL Server - license-included
RDS for MySQL - general-public-license
RDS for Oracle - bring-your-own-license | license-included
RDS for PostgreSQL - postgresql-license

--iops (integer)

Новое значение Provisioned IOPS (I/O operations per second) для экземпляра RDS.

Изменение этого параметра не приводит к перерыву в работе, и изменение применяется в течение следующего окна обслуживания, если параметр ApplyImmediately не включен для данного запроса. Если вы мигрируете со Storage Provisioned IOPS на стандартное хранилище, установите это значение в 0. Экземпляр базы данных потребует перезагрузки для вступления в силу изменения типа хранилища.

Если вы решите перенести свой экземпляр базы данных со стандартного хранилища на хранилище Provisioned IOPS (io1) или с Provisioned IOPS на стандартное хранилище, этот процесс может занять время. Продолжительность миграции зависит от нескольких факторов, таких как нагрузка базы данных, размер хранилища, тип хранилища (стандартное или Provisioned IOPS), количество предоставленных IOPS (если есть) и количество предыдущих операций масштабирования хранилища. Типичные сроки миграции составляют менее 24 часов, но в некоторых случаях процесс может занять до нескольких дней. Во время миграции экземпляр базы данных доступен для использования, но может наблюдаться ухудшение производительности. Во время миграции ежедневные резервные копии экземпляра приостанавливаются. Другие операции Amazon RDS не могут быть выполнены для экземпляра, включая изменение экземпляра, перезагрузку экземпляра, удаление экземпляра, создание реплики чтения для экземпляра и создание снимка базы данных экземпляра.

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

Для RDS for MariaDB, RDS for MySQL, RDS for Oracle и RDS for PostgreSQL – указанное значение должно быть как минимум на 10% больше текущего значения. Значения, которые не на 10% больше существующего значения, округляются до значений, которые на 10% больше текущего значения.
При увеличении Provisioned IOPS необходимо также указать параметр AllocatedStorage. Вы можете использовать текущее значение для AllocatedStorage.

По умолчанию: Используется существующее значение

--option-group-name (string)

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

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

Изменение применяется во время следующего окна обслуживания, если параметр ApplyImmediately не включен для данного запроса.

Постоянные параметры, такие как параметр TDE для Oracle Advanced Security TDE, не могут быть удалены из группы параметров, и эта группа параметров не может быть удалена из экземпляра базы данных после ее связывания с экземпляром базы данных.

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

--new-db-instance-identifier (string)

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

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

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

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

Пример: mydbinstance

--storage-type (string)

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

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

Если вы решите перенести свой экземпляр базы данных со стандартного хранилища на хранилище gp2 (General Purpose SSD), gp3 или Provisioned IOPS (io1), или с этих типов хранилищ на стандартное хранилище, этот процесс может занять время. Продолжительность миграции зависит от нескольких факторов, таких как нагрузка базы данных, размер хранилища, тип хранилища (стандартное или Provisioned IOPS), количество предоставленных IOPS (если есть) и количество предыдущих операций масштабирования хранилища. Типичные сроки миграции составляют менее 24 часов, но в некоторых случаях процесс может занять до нескольких дней. Во время миграции экземпляр базы данных доступен для использования, но может наблюдаться ухудшение производительности. Во время миграции ежедневные резервные копии экземпляра приостанавливаются. Другие операции Amazon RDS не могут быть выполнены для экземпляра, включая изменение экземпляра, перезагрузку экземпляра, удаление экземпляра, создание реплики чтения для экземпляра и создание снимка базы данных экземпляра.

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

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

--tde-credential-arn (string)

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

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

--tde-credential-password (string)

Пароль для данного ARN из хранилища ключей для доступа к устройству.

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

--ca-certificate-identifier (string)

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

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

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

--domain (string)

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

Дополнительные сведения см. в разделе Проверка подлинности Kerberos в руководстве Amazon RDS User Guide.

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

--domain-fqdn (string)

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

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

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

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

--domain-ou (string)

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

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

Должен быть в формате имени различающегося имени.
Длина не может превышать 64 символа.

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

--domain-auth-secret-arn (string)

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

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

--domain-dns-ips (list)

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

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

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

Пример: 123.124.125.126,234.235.236.237

(string)

Синтаксис:

"string" "string" ...

--copy-tags-to-snapshot | --no-copy-tags-to-snapshot (boolean)

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

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

--monitoring-interval (integer)

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

Если указано MonitoringRoleArn, установите MonitoringInterval на значение, отличное от 0.

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

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

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

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

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

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

Если вы измените значение DBPortNumber, ваша база данных перезапустится независимо от значения параметра ApplyImmediately.

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

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

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

Amazon Aurora - 3306
RDS for Db2 - 50000
RDS for MariaDB - 3306
RDS for Microsoft SQL Server - 1433
RDS for MySQL - 3306
RDS for Oracle - 1521
RDS for PostgreSQL - 5432

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

Для RDS for Microsoft SQL Server значение не может быть 1234, 1434, 3260, 3343, 3389, 47001 или 49152-49156.

--publicly-accessible | --no-publicly-accessible (булево)

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

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

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

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

Изменения параметра PubliclyAccessible применяются немедленно независимо от значения параметра ApplyImmediately.

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

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

Если MonitoringInterval установлено на значение, отличное от 0, укажите значение MonitoringRoleArn.

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

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

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

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

--disable-domain | --no-disable-domain (булево)

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

--promotion-tier (целое число)

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

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

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

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

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

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

Это свойство не применяется к Amazon Aurora. Сопоставление учетных записей Amazon Web Services IAM с учетными записями баз данных управляется кластером базы данных.

Дополнительные сведения об аутентификации баз данных IAM см. в разделе «Аутентификация баз данных IAM для MySQL и PostgreSQL» в руководстве пользователя Amazon RDS.

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

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

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

Примечание

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

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

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.

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

Если вы не укажете значение для PerformanceInsightsKMSKeyId, Amazon RDS использует ваш ключ KMS по умолчанию. Для вашей учетной записи Amazon Web Services существует ключ 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 вернет ошибку.

--cloudwatch-logs-export-configuration (структура)

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

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

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

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

Aurora MySQL - audit | error | general | slowquery | iam-db-auth-error
Aurora PostgreSQL - postgresql | iam-db-auth-error
RDS for MySQL - error | general | slowquery | iam-db-auth-error
RDS for PostgreSQL - postgresql | upgrade | iam-db-auth-error

Дополнительные сведения об экспорте журналов CloudWatch Logs для Amazon RDS см. в разделе «Публикация журналов базы данных в Amazon CloudWatch Logs» в руководстве пользователя Amazon RDS.

Дополнительные сведения об экспорте журналов CloudWatch Logs для Amazon Aurora см. в разделе «Публикация журналов базы данных в Amazon CloudWatch Logs» в руководстве пользователя Amazon Aurora.

EnableLogTypes -> (список)

Список типов журналов для включения.

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

Aurora MySQL - audit | error | general | slowquery
Aurora PostgreSQL - postgresql
RDS for MySQL - error | general | slowquery
RDS for PostgreSQL - postgresql | upgrade

(строка)

DisableLogTypes -> (список)

Список типов журналов для отключения.

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

Aurora MySQL - audit | error | general | slowquery
Aurora PostgreSQL - postgresql
RDS for MySQL - error | general | slowquery
RDS for PostgreSQL - postgresql | upgrade

(строка)

Краткая запись:

EnableLogTypes=string,string,DisableLogTypes=string,string

Формат JSON:

{
  "EnableLogTypes": ["string", ...],
  "DisableLogTypes": ["string", ...]
}

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

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

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

(структура)

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

Для указания количества ядер процессора используйте имя функции 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 -> (строка)

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

Краткая запись:

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

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

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

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

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

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

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

--certificate-rotation-restart | --no-certificate-rotation-restart (логическое значение)

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

По умолчанию экземпляр базы данных перезапускается при обновлении сертификата SSL/TLS. Сертификат не обновляется до перезапуска экземпляра базы данных.

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

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

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

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

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

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

Значение, которое устанавливает режим открытия реплики базы данных на «подготовленный» или «только чтение».

Примечание

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

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

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

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

open-read-only
mounted

--enable-customer-owned-ip | --no-enable-customer-owned-ip (логическое значение)

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

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

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

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

--aws-backup-recovery-point-arn (строка)

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

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

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

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

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

full
all-paused

--resume-full-automation-mode-minutes (целое число)

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

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

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

Значение должно быть не меньше 60.
Значение должно быть не больше 1440.

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

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

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

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

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

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

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

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

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

--manage-master-user-password | --no-manage-master-user-password (логическое значение)

Указывает, нужно ли управлять паролем пользователя master с помощью Amazon Web Services Secrets Manager.

Если экземпляр базы данных не управляет паролем пользователя master с помощью Amazon Web Services Secrets Manager, вы можете включить это управление. В этом случае вы не можете указать MasterUserPassword .

Если экземпляр базы данных уже управляет паролем пользователя master с помощью Amazon Web Services Secrets Manager, и вы укажите, что пароль пользователя master не управляется с помощью Amazon Web Services Secrets Manager, то вы должны указать MasterUserPassword . В этом случае Amazon RDS удаляет секрет и использует новый пароль для пользователя master, указанный параметром MasterUserPassword .

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

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

Нельзя управлять паролем пользователя master с помощью Amazon Web Services Secrets Manager, если указан параметр MasterUserPassword .
Нельзя указать для экземпляров RDS for Oracle CDB в многопользовательской конфигурации. Используйте ModifyTenantDatabase.
Нельзя указать параметры ManageMasterUserPassword и MultiTenant в одной операции.

--rotate-master-user-password | --no-rotate-master-user-password (логическое значение)

Указывает, нужно ли обновить секрет, управляемый Amazon Web Services Secrets Manager, для пароля пользователя master.

Это свойство применимо только в том случае, если пароль пользователя master управляется RDS в Amazon Web Services Secrets Manager для экземпляра базы данных. Значение секрета содержит обновленный пароль.

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

При обновлении пароля пользователя master изменения должны быть применены немедленно.

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

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

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

Экземпляр базы данных не управляет паролем пользователя master в Amazon Web Services Secrets Manager. Если экземпляр базы данных уже управляет паролем пользователя master в Amazon Web Services Secrets Manager, вы не можете изменить ключ KMS, используемый для шифрования секрета.
Вы включаете ManageMasterUserPassword для управления паролем пользователя master в Amazon Web Services Secrets Manager. Если вы включаете ManageMasterUserPassword и не указываете MasterUserSecretKmsKeyId , для шифрования секрета используется ключ KMS aws/secretsmanager . Если секрет находится в другом аккаунте Amazon Web Services, то вы не можете использовать ключ KMS aws/secretsmanager для шифрования секрета, и вы должны использовать управляемый клиентом ключ KMS.

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

Для вашего аккаунта Amazon Web Services существует ключ KMS по умолчанию. У вашего аккаунта Amazon Web Services есть другой ключ KMS по умолчанию для каждой области Amazon Web Services.

--engine (строка)

Целевой движок Oracle DB при преобразовании не-CDB в CDB. Этот промежуточный шаг необходим для обновления не-CDB Oracle Database 19c до CDB Oracle Database 21c.

Обратите внимание на следующие требования:

Убедитесь, что вы указали oracle-ee-cdb или oracle-se2-cdb .
Убедитесь, что ваш движок базы данных работает под Oracle Database 19c с RU от апреля 2021 года или новее.

Обратите внимание на следующие ограничения:

Вы не можете преобразовать CDB в не-CDB.
Вы не можете преобразовать реплику базы данных.
Вы не можете преобразовать не-CDB в CDB и обновить версию движка в одной команде.
Вы не можете преобразовать существующую настраиваемую группу параметров или опций, если она содержит постоянные или перманентные параметры или опции. В этой ситуации экземпляр базы данных вернется к группе параметров и опций по умолчанию. Чтобы избежать возврата к значениям по умолчанию, укажите новую группу параметров с --db-parameter-group-name и новую группу опций с --option-group-name .

--dedicated-log-volume | --no-dedicated-log-volume (логическое значение)

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

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

Указывает, нужно ли преобразовать экземпляр базы данных из однопользовательской конфигурации в многопользовательскую конфигурацию. Этот параметр поддерживается только для экземпляров RDS for Oracle CDB.

Во время преобразования RDS создает базу данных-арендатора и связывает с ней метаданные имени базы данных, имени пользователя master, кодировки символов и национальной кодировки. Теги, связанные с экземпляром, также распространяются на базу данных-арендатора. Вы можете добавить дополнительные базы данных-арендаторов к своему экземпляру базы данных, используя операцию CreateTenantDatabase .

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

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

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

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

--cli-connect-timeout (строка)

Файл с пакетом сертификатов 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.

Пример 1: Изменение экземпляра базы данных

В следующем modify-db-instance примере группа параметров и параметр группируются с совместимым экземпляром базы данных Microsoft SQL Server. Параметр --apply-immediately заставляет группы параметров и параметров быть ассоциированными немедленно, а не ожидать следующего окна технического обслуживания.

aws rds modify-db-instance \
    --db-instance-identifier database-2 \
    --option-group-name test-se-2017 \
    --db-parameter-group-name test-sqlserver-se-2017 \
    --apply-immediately

Вывод:

{
    "DBInstance": {
        "DBInstanceIdentifier": "database-2",
        "DBInstanceClass": "db.r4.large",
        "Engine": "sqlserver-se",
        "DBInstanceStatus": "available",

        ...output omitted...

        "DBParameterGroups": [
            {
                "DBParameterGroupName": "test-sqlserver-se-2017",
                "ParameterApplyStatus": "applying"
            }
        ],
        "AvailabilityZone": "us-west-2d",

        ...output omitted...

        "MultiAZ": true,
        "EngineVersion": "14.00.3281.6.v1",
        "AutoMinorVersionUpgrade": false,
        "ReadReplicaDBInstanceIdentifiers": [],
        "LicenseModel": "license-included",
        "OptionGroupMemberships": [
            {
                "OptionGroupName": "test-se-2017",
                "Status": "pending-apply"
            }
        ],
        "CharacterSetName": "SQL_Latin1_General_CP1_CI_AS",
        "SecondaryAvailabilityZone": "us-west-2c",
        "PubliclyAccessible": true,
        "StorageType": "gp2",

        ...output omitted...

        "DeletionProtection": false,
        "AssociatedRoles": [],
        "MaxAllocatedStorage": 1000
    }
}

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

Пример 2: Сопоставление группы безопасности VPC с экземпляром базы данных

В следующем modify-db-instance примере группа безопасности VPC сопоставляется и удаляются группы безопасности базы данных из экземпляра базы данных:

aws rds modify-db-instance \
    --db-instance-identifier dbName \
    --vpc-security-group-ids sg-ID

Вывод:

{
"DBInstance": {
    "DBInstanceIdentifier": "dbName",
    "DBInstanceClass": "db.t3.micro",
    "Engine": "mysql",
    "DBInstanceStatus": "available",
    "MasterUsername": "admin",
    "Endpoint": {
        "Address": "dbName.abcdefghijk.us-west-2.rds.amazonaws.com",
        "Port": 3306,
        "HostedZoneId": "ABCDEFGHIJK1234"
    },
    "AllocatedStorage": 20,
    "InstanceCreateTime": "2024-02-15T00:37:58.793000+00:00",
    "PreferredBackupWindow": "11:57-12:27",
    "BackupRetentionPeriod": 7,
    "DBSecurityGroups": [],
    "VpcSecurityGroups": [
        {
            "VpcSecurityGroupId": "sg-ID",
            "Status": "active"
        }
    ],
    ... output omitted ...
    "MultiAZ": false,
    "EngineVersion": "8.0.35",
    "AutoMinorVersionUpgrade": true,
    "ReadReplicaDBInstanceIdentifiers": [],
    "LicenseModel": "general-public-license",

    ... output ommited ...
    }
}

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

Вывод

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

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

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

DBInstanceIdentifier -> (строка)

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

DBInstanceClass -> (строка)

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

Engine -> (строка)

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

DBInstanceStatus -> (строка)

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

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

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

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

MasterUsername -> (строка)

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

DBName -> (строка)

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

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

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

Примечание

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

Address -> (строка)

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

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

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

HostedZoneId -> (строка)

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

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

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

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

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

PreferredBackupWindow -> (строка)

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

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

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

DBSecurityGroups -> (список)

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

(структура)

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

ModifyDBInstance
RebootDBInstance
RestoreDBInstanceFromDBSnapshot
RestoreDBInstanceToPointInTime

DBSecurityGroupName -> (строка)

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

Status -> (строка)

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

VpcSecurityGroups -> (список)

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

(структура)

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

VpcSecurityGroupId -> (строка)

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

Status -> (строка)

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

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

DBParameterGroups -> (список)

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

(структура)

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

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

CreateDBInstance
CreateDBInstanceReadReplica
DeleteDBInstance
ModifyDBInstance
RebootDBInstance
RestoreDBInstanceFromDBSnapshot

DBParameterGroupName -> (строка)

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

ParameterApplyStatus -> (строка)

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

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

AvailabilityZone -> (строка)

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

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

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

DBSubnetGroupName -> (строка)

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

DBSubnetGroupDescription -> (строка)

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

VpcId -> (строка)

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

SubnetGroupStatus -> (строка)

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

Subnets -> (список)

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

(структура)

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

SubnetIdentifier -> (строка)

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

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

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

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

Name -> (строка)

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

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

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

Дополнительные сведения об RDS на Outpost см. в разделе «Amazon RDS на Amazon Web Services Outposts» в руководстве пользователя Amazon RDS.

Arn -> (строка)

Amazon Resource Name (ARN) Outpost.

SubnetStatus -> (строка)

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

DBSubnetGroupArn -> (строка)

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

SupportedNetworkTypes -> (список)

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

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

IPV4
DUAL

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

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

(строка)

PreferredMaintenanceWindow -> (строка)

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

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

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

DBInstanceClass -> (строка)

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

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

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

MasterUserPassword -> (строка)

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

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

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

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

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

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

Указывает, будет ли экземпляр базы данных Single-AZ переведен на многозонную конфигурацию Multi-AZ.

EngineVersion -> (строка)

Версия СУБД.

LicenseModel -> (строка)

Модель лицензии для экземпляра базы данных.

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

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

Значение Provisioned IOPS для экземпляра базы данных.

DBInstanceIdentifier -> (строка)

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

StorageType -> (строка)

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

CACertificateIdentifier -> (строка)

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

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

DBSubnetGroupName -> (строка)

Группа подсетей базы данных для экземпляра.

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

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

LogTypesToEnable -> (список)

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

(строка)

LogTypesToDisable -> (список)

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

(строка)

ProcessorFeatures -> (список)

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

(структура)

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

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

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

CreateDBInstance
ModifyDBInstance
RestoreDBInstanceFromDBSnapshot
RestoreDBInstanceFromS3
RestoreDBInstanceToPointInTime

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

DescribeDBInstances
DescribeDBSnapshots
DescribeValidDBInstanceModifications

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

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

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

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

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

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

Указывает, является ли экземпляр базы данных многозонным (Multi-AZ). Это свойство не применимо к экземплярам RDS Custom DB.

EngineVersion -> (строка)

Версия СУБД.

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

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

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

ReadReplicaSourceDBInstanceIdentifier -> (строка)

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

ReadReplicaDBInstanceIdentifiers -> (список)

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

(строка)

ReadReplicaDBClusterIdentifiers -> (список)

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

Примечание

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

(строка)

ReplicaMode -> (строка)

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

Примечание

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

LicenseModel -> (строка)

Информация о модели лицензии для этого экземпляра базы данных. Это свойство не применимо к Amazon Aurora или экземплярам RDS Custom DB.

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

Значение Provisioned IOPS (ввода-вывода в секунду) для экземпляра базы данных.

OptionGroupMemberships -> (список)

Список принадлежностей к группам параметров для этого экземпляра.

(структура)

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

OptionGroupName -> (строка)

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

Status -> (строка)

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

CharacterSetName -> (строка)

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

NcharCharacterSetName -> (строка)

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

SecondaryAvailabilityZone -> (строка)

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

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

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

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

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

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

StatusInfos -> (список)

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

(структура)

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

StatusType -> (строка)

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

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

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

Status -> (строка)

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

Message -> (строка)

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

StorageType -> (строка)

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

TdeCredentialArn -> (строка)

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

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

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

DBClusterIdentifier -> (строка)

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

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

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

KmsKeyId -> (строка)

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

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

DbiResourceId -> (строка)

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

CACertificateIdentifier -> (строка)

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

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

DomainMemberships -> (список)

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

(структура)

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

Domain -> (строка)

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

Status -> (строка)

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

FQDN -> (строка)

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

IAMRoleName -> (строка)

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

OU -> (строка)

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

AuthSecretArn -> (строка)

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

DnsIps -> (список)

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

(строка)

CopyTagsToSnapshot -> (булево)

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

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

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

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

EnhancedMonitoringResourceArn -> (строка)

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

MonitoringRoleArn -> (строка)

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

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

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

DBInstanceArn -> (строка)

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

Timezone -> (строка)

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

IAMDatabaseAuthenticationEnabled -> (булево)

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

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

DatabaseInsightsMode -> (строка)

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

PerformanceInsightsEnabled -> (булево)

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

PerformanceInsightsKMSKeyId -> (строка)

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

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

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

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

Name -> (строка)

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

Value -> (строка)

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

DeletionProtection -> (булево)

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

AssociatedRoles -> (список)

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

(структура)

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

RoleArn -> (строка)

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

FeatureName -> (строка)

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

Status -> (строка)

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

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

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

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

Address -> (строка)

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

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

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

HostedZoneId -> (строка)

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

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

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

TagList -> (список)

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

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

(структура)

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

Key -> (строка)

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

Value -> (строка)

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

DBInstanceAutomatedBackupsReplications -> (список)

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

(структура)

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

DBInstanceAutomatedBackupsArn -> (строка)

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

CustomerOwnedIpEnabled -> (булево)

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

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

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

AwsBackupRecoveryPointArn -> (строка)

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

ActivityStreamStatus -> (строка)

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

ActivityStreamKmsKeyId -> (строка)

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

ActivityStreamKinesisStreamName -> (строка)

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

ActivityStreamMode -> (строка)

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

ActivityStreamEngineNativeAuditFieldsIncluded -> (булево)

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

AutomationMode -> (строка)

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

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

CustomIamInstanceProfile -> (строка)

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

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

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

BackupTarget -> (строка)

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

NetworkType -> (строка)

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

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

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

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

ActivityStreamPolicyStatus -> (строка)

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

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

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

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

DBSystemId -> (строка)

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

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

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

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

SecretArn -> (строка)

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

SecretStatus -> (строка)

Состояние секрета.

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

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

KmsKeyId -> (строка)

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

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

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

CAIdentifier -> (строка)

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

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

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

ReadReplicaSourceDBClusterIdentifier -> (строка)

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

PercentProgress -> (строка)

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

DedicatedLogVolume -> (булево)

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

IsStorageConfigUpgradeAvailable -> (булево)

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

MultiTenant -> (булево)

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

EngineLifecycleSupport -> (строка)

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

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