modify-db-cluster

Описание

Изменяет параметры кластера Amazon Aurora DB или кластера DB с несколькими зонами доступности. Вы можете изменить один или несколько параметров, указав эти параметры и новые значения в запросе.

Дополнительную информацию о кластерах Amazon Aurora DB см. в разделе Что такое Amazon Aurora? в руководстве пользователя Amazon Aurora.

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

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

Синтаксис

  modify-db-cluster
--db-cluster-identifier <value>
[--new-db-cluster-identifier <value>]
[--apply-immediately | --no-apply-immediately]
[--backup-retention-period <value>]
[--db-cluster-parameter-group-name <value>]
[--vpc-security-group-ids <value>]
[--port <value>]
[--master-user-password <value>]
[--option-group-name <value>]
[--preferred-backup-window <value>]
[--preferred-maintenance-window <value>]
[--enable-iam-database-authentication | --no-enable-iam-database-authentication]
[--backtrack-window <value>]
[--cloudwatch-logs-export-configuration <value>]
[--engine-version <value>]
[--allow-major-version-upgrade | --no-allow-major-version-upgrade]
[--db-instance-parameter-group-name <value>]
[--domain <value>]
[--domain-iam-role-name <value>]
[--scaling-configuration <value>]
[--deletion-protection | --no-deletion-protection]
[--enable-http-endpoint | --no-enable-http-endpoint]
[--copy-tags-to-snapshot | --no-copy-tags-to-snapshot]
[--enable-global-write-forwarding | --no-enable-global-write-forwarding]
[--db-cluster-instance-class <value>]
[--allocated-storage <value>]
[--storage-type <value>]
[--iops <value>]
[--auto-minor-version-upgrade | --no-auto-minor-version-upgrade]
[--monitoring-interval <value>]
[--monitoring-role-arn <value>]
[--database-insights-mode <value>]
[--enable-performance-insights | --no-enable-performance-insights]
[--performance-insights-kms-key-id <value>]
[--performance-insights-retention-period <value>]
[--serverless-v2-scaling-configuration <value>]
[--network-type <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-mode <value>]
[--allow-engine-mode-change | --no-allow-engine-mode-change]
[--enable-local-write-forwarding | --no-enable-local-write-forwarding]
[--aws-backup-recovery-point-arn <value>]
[--enable-limitless-database | --no-enable-limitless-database]
[--ca-certificate-identifier <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

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

Идентификатор кластера DB для изменяемого кластера. Этот параметр не чувствителен к регистру.

Допустимо для типа кластера: кластеры Aurora DB и кластеры DB с несколькими зонами доступности

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

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

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

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

Допустимо для типа кластера: кластеры Aurora DB и кластеры DB с несколькими зонами доступности

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

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

Пример: my-cluster2

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

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

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

По умолчанию этот параметр отключен.

Допустимо для типа кластера: кластеры Aurora DB и кластеры DB с несколькими зонами доступности

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

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

Допустимо для типа кластера: кластеры Aurora DB и кластеры DB с несколькими зонами доступности

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

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

Должно быть значением от 1 до 35.

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

Имя параметрической группы кластера DB для использования в кластере DB.

Допустимо для типа кластера: кластеры Aurora DB и кластеры DB с несколькими зонами доступности

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

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

Допустимо для типа кластера: кластеры Aurora DB и кластеры DB с несколькими зонами доступности

(строка)

Синтаксис:

"string" "string" ...

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

Номер порта, на котором кластер DB принимает подключения.

Допустимо только для типа кластера: кластеры Aurora DB

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

Значение по умолчанию: тот же порт, что и у исходного кластера DB.

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

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

Допустимо для типа кластера: кластеры Aurora DB и кластеры DB с несколькими зонами доступности

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

Должен содержать от 8 до 41 символа.
Может содержать любые печатные символы ASCII, кроме «/», «"» или «@».
Не может быть указан, если ManageMasterUserPassword включен.

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

Группа опций для ассоциации с кластером DB.

Кластеры DB связаны с группой опций по умолчанию, которую нельзя изменить.

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

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

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

Допустимо для типа кластера: кластеры Aurora DB и кластеры DB с несколькими зонами доступности

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

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

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

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

Допустимо для типа кластера: кластеры Aurora DB и кластеры DB с несколькими зонами доступности

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

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

Должен быть в формате ddd:hh24:mi-ddd:hh24:mi.
Дни должны быть одним из Mon | Tue | Wed | Thu | Fri | Sat | Sun.
Должен быть в универсальном координированном времени (UTC).
Должен быть не менее 30 минут.

--enable-iam-database-authentication | --no-enable-iam-database-authentication (логическое значение)

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

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

Допустимо для типа кластера: кластеры Aurora DB и кластеры DB с несколькими зонами доступности

--backtrack-window (длинное целое число)

Целевое окно отката в секундах. Чтобы отключить откат, установите это значение в 0.

Допустимо только для типа кластера: кластеры Aurora MySQL DB.

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

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

При указании это значение должно быть числом от 0 до 259 200 (72 часа).

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

Настройка параметров для включения типов журналов для экспорта в CloudWatch Logs для определенного кластера DB.

Допустимо для типа кластера: кластеры Aurora DB и кластеры DB с несколькими зонами доступности

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

Aurora MySQL - audit | error | general | instance | slowquery | iam-db-auth-error
Aurora PostgreSQL - instance | 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", ...]
}

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

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

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

Чтобы перечислить все доступные версии движков для Aurora MySQL, используйте следующую команду:

aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"

Чтобы перечислить все доступные версии движков для Aurora PostgreSQL, используйте следующую команду:

aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"

Чтобы перечислить все доступные версии движков для RDS for MySQL, используйте следующую команду:

aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion"

Чтобы перечислить все доступные версии движков для RDS for PostgreSQL, используйте следующую команду:

aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"

Допустимо для типа кластера: кластеры Aurora DB и кластеры DB с несколькими зонами доступности

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

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

Допустимо для типа кластера: кластеры Aurora DB и кластеры DB с несколькими зонами доступности

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

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

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

Имя параметрической группы DB, применяемой ко всем экземплярам кластера DB.

Примечание

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

Допустимо только для типа кластера: кластеры Aurora DB

Значение по умолчанию: текущее имя

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

Параметрическая группа DB должна принадлежать тому же семейству параметрических групп DB, что и этот кластер DB.
Параметр DBInstanceParameterGroupName допустим в сочетании с параметром AllowMajorVersionUpgrade только для обновления основной версии.

--domain (строка)

Идентификатор каталога Active Directory, в который необходимо переместить кластер DB. Укажите none, чтобы удалить кластер из текущего домена. Домен должен быть создан до этой операции.

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

Допустимо только для типа кластера: кластеры Aurora DB

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

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

Допустимо только для типа кластера: кластеры Aurora DB

--scaling-configuration (структура)

Свойства масштабирования кластера БД. Вы можете изменять свойства масштабирования только для кластеров БД в режиме serverless движка БД.

Действительно для типа кластера: только кластеры Aurora DB

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

Минимальная емкость кластера Aurora DB в режиме serverless движка БД.

Для Aurora MySQL допустимые значения емкости — 1 , 2 , 4 , 8 , 16 , 32 , 64 , 128 и 256 .

Для Aurora PostgreSQL допустимые значения емкости — 2 , 4 , 8 , 16 , 32 , 64 , 192 и 384 .

Минимальная емкость должна быть меньше или равна максимальной емкости.

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

Максимальная емкость кластера Aurora DB в режиме serverless движка БД.

Для Aurora MySQL допустимые значения емкости — 1 , 2 , 4 , 8 , 16 , 32 , 64 , 128 и 256 .

Для Aurora PostgreSQL допустимые значения емкости — 2 , 4 , 8 , 16 , 32 , 64 , 192 и 384 .

Максимальная емкость должна быть больше или равна минимальной емкости.

AutoPause -> (булево)

Указывает, разрешено ли автоматическое приостановление работы кластера Aurora DB в режиме serverless движка БД. Кластер БД можно приостановить только в неактивном состоянии (нет подключений).

Примечание

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

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

Время в секундах, по истечении которого кластер Aurora DB в режиме serverless приостанавливается.

Укажите значение от 300 до 86 400 секунд.

TimeoutAction -> (строка)

Действие, выполняемое при достижении таймаута: ForceApplyCapacityChange или RollbackCapacityChange .

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

RollbackCapacityChange , значение по умолчанию, игнорирует изменение емкости, если в период таймаута не найдена точка масштабирования.

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

Если вы укажете ForceApplyCapacityChange , подключения, которые препятствуют поиску точки масштабирования Aurora Serverless v1, могут быть прерваны.

Дополнительную информацию см. в разделе Autoscaling for Aurora Serverless v1 в руководстве пользователя Amazon Aurora.

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

Время в секундах, в течение которого Aurora Serverless v1 пытается найти точку масштабирования для бесшовного масштабирования перед выполнением действия таймаута. Значение по умолчанию — 300.

Укажите значение от 60 до 600 секунд.

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

MinCapacity=integer,MaxCapacity=integer,AutoPause=boolean,SecondsUntilAutoPause=integer,TimeoutAction=string,SecondsBeforeTimeout=integer

Синтаксис JSON:

{
  "MinCapacity": integer,
  "MaxCapacity": integer,
  "AutoPause": true|false,
  "SecondsUntilAutoPause": integer,
  "TimeoutAction": "string",
  "SecondsBeforeTimeout": integer
}

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

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

Действительно для типа кластера: кластеры Aurora DB и Multi-AZ DB

--enable-http-endpoint | --no-enable-http-endpoint (булево)

Указывает, следует ли включить HTTP-точку входа для кластера Aurora Serverless v1 DB. По умолчанию HTTP-точка входа отключена.

При включении HTTP-точка входа предоставляет бессерверный API веб-службы (RDS Data API) для выполнения SQL-запросов в кластере Aurora Serverless v1 DB. Вы также можете запросить базу данных из консоли RDS с помощью редактора запросов RDS.

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

Примечание

Этот параметр применяется только к кластерам Aurora Serverless v1 DB. Для включения или отключения HTTP-точки входа для кластера Aurora Serverless v2 или выделенного кластера БД используйте операции EnableHttpEndpoint и DisableHttpEndpoint.

Действительно для типа кластера: только кластеры Aurora DB

--copy-tags-to-snapshot | --no-copy-tags-to-snapshot (булево)

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

Действительно для типа кластера: кластеры Aurora DB и Multi-AZ DB

--enable-global-write-forwarding | --no-enable-global-write-forwarding (булево)

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

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

Действительно для типа кластера: только кластеры Aurora DB

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

Вычислительная и емкость памяти каждого экземпляра БД в кластере Multi-AZ DB, например, db.m6gd.xlarge. Не все классы экземпляров БД доступны во всех регионах Amazon Web Services или для всех движков баз данных.

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

Действительно для типа кластера: только кластеры Multi-AZ DB

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

Объем памяти в гибибайтах (GiB), выделяемый каждому экземпляру БД в кластере Multi-AZ DB.

Действительно для типа кластера: только кластеры Multi-AZ DB

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

Тип хранилища, который следует связать с кластером БД.

Сведения о типах хранилища для кластеров Aurora DB см. в разделе Конфигурации хранилища для кластеров Amazon Aurora DB. Сведения о типах хранилища для кластеров Multi-AZ DB см. в разделе Параметры создания кластеров Multi-AZ DB.

При указании для кластера Multi-AZ DB требуется значение параметра Iops.

Действительно для типа кластера: кластеры Aurora DB и Multi-AZ DB

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

Кластеры Aurora DB - aurora | aurora-iopt1
Кластеры Multi-AZ DB - io1 | io2 | gp3

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

Кластеры Aurora DB - aurora
Кластеры Multi-AZ DB - io1

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

Объем Provisioned IOPS (ввод/вывод операций в секунду), который будет первоначально выделен для каждого экземпляра БД в кластере Multi-AZ DB.

Сведения о допустимых значениях IOPS см. в разделе Хранилище Amazon RDS Provisioned IOPS в руководстве пользователя Amazon RDS.

Действительно для типа кластера: только кластеры Multi-AZ DB

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

Должно быть кратным от .5 до 50 размера хранилища для кластера БД.

--auto-minor-version-upgrade | --no-auto-minor-version-upgrade (булево)

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

Действительно для типа кластера: кластеры Aurora DB и Multi-AZ DB.

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

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

Интервал в секундах между моментами сбора данных Enhanced Monitoring для кластера БД. Для отключения сбора данных Enhanced Monitoring укажите 0.

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

Действительно для типа кластера: только кластеры Multi-AZ DB

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

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

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

Amazon Resource Name (ARN) для роли IAM, разрешающей RDS отправлять данные Enhanced Monitoring в Amazon CloudWatch Logs. Пример: arn:aws:iam:123456789012:role/emaccess. Сведения о создании роли мониторинга см. в разделе Создание роли IAM для Amazon RDS Enhanced Monitoring в руководстве пользователя Amazon RDS.

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

Действительно для типа кластера: только кластеры Multi-AZ DB

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

Указывает режим включения Database Insights для кластера БД.

Если вы измените значение с standard на advanced , необходимо установить параметр PerformanceInsightsEnabled на true и параметр PerformanceInsightsRetentionPeriod на 465.

Если вы измените значение с advanced на standard , необходимо установить параметр PerformanceInsightsEnabled на false.

Действительно для типа кластера: кластеры Aurora DB и Multi-AZ DB

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

standard
advanced

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

Указывает, включить ли Performance Insights для кластера БД.

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

Действительно для типа кластера: кластеры Aurora DB и Multi-AZ DB

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

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

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

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

Действительно для типа кластера: кластеры Aurora DB и Multi-AZ DB

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

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

Допустимо для типов кластеров: кластеры Aurora DB и кластеры Multi-AZ DB

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

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

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

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

--serverless-v2-scaling-configuration (структура)

Содержит конфигурацию масштабирования кластера Aurora Serverless v2 DB.

Для получения дополнительной информации см. Использование Amazon Aurora Serverless v2 в руководстве Amazon Aurora User Guide.

MinCapacity -> (double)

Минимальное количество единиц емкости Aurora (ACU) для экземпляра базы данных в кластере Aurora Serverless v2. Вы можете указывать значения ACU с шагом 0,5, например, 8, 8,5, 9 и т. д. Для версий Aurora, поддерживающих функцию автоматической паузы Aurora Serverless v2, наименьшее значение, которое можно использовать, равно 0. Для версий, не поддерживающих функцию автоматической паузы Aurora Serverless v2, наименьшее значение равно 0,5.

MaxCapacity -> (double)

Максимальное количество единиц емкости Aurora (ACU) для экземпляра базы данных в кластере Aurora Serverless v2. Вы можете указывать значения ACU с шагом 0,5, например, 32, 32,5, 33 и т. д. Наибольшее значение, которое можно использовать, составляет 256 для последних версий Aurora или 128 для более старых версий.

SecondsUntilAutoPause -> (integer)

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

Укажите значение от 300 секунд (пять минут) до 86 400 секунд (один день). По умолчанию значение равно 300 секундам.

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

MinCapacity=double,MaxCapacity=double,SecondsUntilAutoPause=integer

Синтаксис JSON:

{
  "MinCapacity": double,
  "MaxCapacity": double,
  "SecondsUntilAutoPause": integer
}

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

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

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

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

Допустимо для типов кластеров: только кластеры Aurora DB

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

--manage-master-user-password | --no-manage-master-user-password (boolean)

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

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

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

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

Допустимо для типов кластеров: кластеры Aurora DB и кластеры Multi-AZ DB

--rotate-master-user-password | --no-rotate-master-user-password (boolean)

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

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

Допустимо для типов кластеров: кластеры Aurora DB и кластеры Multi-AZ DB

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

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

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

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

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

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

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

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

Допустимо для типов кластеров: кластеры Aurora DB и кластеры Multi-AZ DB

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

Режим работы базы данных для кластера базы данных, либо provisioned, либо serverless.

Примечание

Режим работы базы данных можно изменить только с serverless на provisioned.

Для получения дополнительной информации см. CreateDBCluster .

Допустимо для типов кластеров: только кластеры Aurora DB

--allow-engine-mode-change | --no-allow-engine-mode-change (boolean)

Указывает, разрешены ли изменения режима работы от serverless до provisioned.

Допустимо для типов кластеров: только кластеры Aurora Serverless v1 DB

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

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

--enable-local-write-forwarding | --no-enable-local-write-forwarding (boolean)

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

Допустимо для: только кластеры Aurora DB

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

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

--enable-limitless-database | --no-enable-limitless-database (boolean)

Указывает, нужно ли включить Aurora Limitless Database. Необходимо включить Aurora Limitless Database для создания группы фрагментов базы данных.

Допустимо для: только кластеры Aurora DB

Примечание

Это значение больше не используется. Вместо этого используйте значение ClusterScalabilityType при создании кластера базы данных Aurora Limitless Database.

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

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

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

Допустимо для типов кластеров: кластеры Multi-AZ DB

--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 (boolean)

Включить отладовую запись журнала.

--endpoint-url (string)

Переопределить стандартный URL команды заданным URL.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет стандартное поведение проверки SSL-сертификатов.

--no-paginate (boolean)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (string)

Стиль форматирования вывода команды.

json
text
table
yaml
yaml-stream

--query (string)

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

--profile (string)

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

--region (string)

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

--version (string)

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

--color (string)

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

on
off
auto

--no-sign-request (boolean)

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

--ca-bundle (string)

Файл сертификатов CA для проверки SSL-сертификатов. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение равно 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение равно 0, подключение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.

--cli-binary-format (string)

Стиль форматирования, используемый для двоичных блоков. По умолчанию используется формат base64. Формат base64 ожидает, что двоичные блоки будут предоставлены как строка, закодированная в base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI версии 1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, которое отображается как двоичный блок fileb:// всегда будет обрабатываться как двоичный и использовать содержимое файла напрямую независимо от параметра cli-binary-format. При использовании file:// содержимое файла должно быть правильно отформатировано для настроенного параметра cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Отключить вывод страниц CLI.

--cli-auto-prompt (boolean)

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

--no-cli-auto-prompt (boolean)

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

Примеры

Примечание

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

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

Пример 1: Изменение кластера баз данных

Следующий modify-db-cluster пример изменяет пароль пользователя master для кластера баз данных с именем cluster-2 и устанавливает период хранения резервных копий на 14 дней. Параметр --apply-immediately заставляет изменения вступить в силу немедленно вместо ожидания следующего окна обслуживания.

aws rds modify-db-cluster \
    --db-cluster-identifier cluster-2 \
    --backup-retention-period 14 \
    --master-user-password newpassword99 \
    --apply-immediately

Вывод:

{
    "DBCluster": {
        "AllocatedStorage": 1,
        "AvailabilityZones": [
            "eu-central-1b",
            "eu-central-1c",
            "eu-central-1a"
        ],
        "BackupRetentionPeriod": 14,
        "DatabaseName": "",
        "DBClusterIdentifier": "cluster-2",
        "DBClusterParameterGroup": "default.aurora5.6",
        "DBSubnetGroup": "default-vpc-2305ca49",
        "Status": "available",
        "EarliestRestorableTime": "2020-06-03T02:07:29.637Z",
        "Endpoint": "cluster-2.cluster-############.eu-central-1.rds.amazonaws.com",
        "ReaderEndpoint": "cluster-2.cluster-ro-############.eu-central-1.rds.amazonaws.com",
        "MultiAZ": false,
        "Engine": "aurora",
        "EngineVersion": "5.6.10a",
        "LatestRestorableTime": "2020-06-04T15:11:25.748Z",
        "Port": 3306,
        "MasterUsername": "admin",
        "PreferredBackupWindow": "01:55-02:25",
        "PreferredMaintenanceWindow": "thu:21:14-thu:21:44",
        "ReadReplicaIdentifiers": [],
        "DBClusterMembers": [
            {
                "DBInstanceIdentifier": "cluster-2-instance-1",
                "IsClusterWriter": true,
                "DBClusterParameterGroupStatus": "in-sync",
                "PromotionTier": 1
            }
        ],
        "VpcSecurityGroups": [
            {
                "VpcSecurityGroupId": "sg-20a5c047",
                "Status": "active"
            }
        ],
        "HostedZoneId": "Z1RLNU0EXAMPLE",
        "StorageEncrypted": true,
        "KmsKeyId": "arn:aws:kms:eu-central-1:123456789012:key/d1bd7c8f-5cdb-49ca-8a62-a1b2c3d4e5f6",
        "DbClusterResourceId": "cluster-AGJ7XI77XVIS6FUXHU1EXAMPLE",
        "DBClusterArn": "arn:aws:rds:eu-central-1:123456789012:cluster:cluster-2",
        "AssociatedRoles": [],
        "IAMDatabaseAuthenticationEnabled": false,
        "ClusterCreateTime": "2020-04-03T14:44:02.764Z",
        "EngineMode": "provisioned",
        "DeletionProtection": false,
        "HttpEndpointEnabled": false,
        "CopyTagsToSnapshot": true,
        "CrossAccountClone": false,
        "DomainMemberships": []
    }
}

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

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

Следующий modify-db-instance пример ассоциирует определённую группу безопасности VPC и удаляет группы безопасности баз данных из кластера баз данных.

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

Вывод:

{
    "DBCluster": {
        "AllocatedStorage": 1,
        "AvailabilityZones": [
            "us-west-2c",
            "us-west-2b",
            "us-west-2a"
        ],
        "BackupRetentionPeriod": 1,
        "DBClusterIdentifier": "dbName",
        "DBClusterParameterGroup": "default.aurora-mysql8.0",
        "DBSubnetGroup": "default",
        "Status": "available",
        "EarliestRestorableTime": "2024-02-15T01:12:13.966000+00:00",
        "Endpoint": "dbName.cluster-abcdefghji.us-west-2.rds.amazonaws.com",
        "ReaderEndpoint": "dbName.cluster-ro-abcdefghji.us-west-2.rds.amazonaws.com",
        "MultiAZ": false,
        "Engine": "aurora-mysql",
        "EngineVersion": "8.0.mysql_aurora.3.04.1",
        "LatestRestorableTime": "2024-02-15T02:25:33.696000+00:00",
        "Port": 3306,
        "MasterUsername": "admin",
        "PreferredBackupWindow": "10:59-11:29",
        "PreferredMaintenanceWindow": "thu:08:54-thu:09:24",
        "ReadReplicaIdentifiers": [],
        "DBClusterMembers": [
            {
                "DBInstanceIdentifier": "dbName-instance-1",
                "IsClusterWriter": true,
                "DBClusterParameterGroupStatus": "in-sync",
                "PromotionTier": 1
            }
        ],
        "VpcSecurityGroups": [
            {
                "VpcSecurityGroupId": "sg-ID",
                "Status": "active"
            }
        ],
        ...output omitted...
    }
}

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

Вывод

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

Содержит данные об Amazon Aurora кластере БД или кластере БД Multi-AZ.

Для кластера Amazon Aurora БД этот тип данных используется в качестве элемента ответа в операциях CreateDBCluster , DeleteDBCluster , DescribeDBClusters , FailoverDBCluster , ModifyDBCluster , PromoteReadReplicaDBCluster , RestoreDBClusterFromS3 , RestoreDBClusterFromSnapshot , RestoreDBClusterToPointInTime , StartDBCluster и StopDBCluster .

Для кластера БД Multi-AZ этот тип данных используется в качестве элемента ответа в операциях CreateDBCluster , DeleteDBCluster , DescribeDBClusters , FailoverDBCluster , ModifyDBCluster , RebootDBCluster , RestoreDBClusterFromSnapshot и RestoreDBClusterToPointInTime .

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

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

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

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

AvailabilityZones -> (список)

Список зон доступности (AZ), в которых можно создавать экземпляры в кластере БД.

(строка)

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

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

CharacterSetName -> (строка)

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

DatabaseName -> (строка)

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

DBClusterIdentifier -> (строка)

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

DBClusterParameterGroup -> (строка)

Имя параметрической группы кластера БД.

DBSubnetGroup -> (строка)

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

Status -> (строка)

Текущее состояние этого кластера БД.

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

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

PercentProgress -> (строка)

Прогресс операции в процентах.

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

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

Endpoint -> (строка)

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

ReaderEndpoint -> (строка)

Точка подключения для чтения кластера БД. Точка подключения для чтения кластера БД распределяет подключения по Aurora Replicas, которые доступны в кластере БД. По мере запроса клиентами новых подключений к точке подключения для чтения Aurora распределяет запросы на подключение среди Aurora Replicas в кластере БД. Эта функция может помочь сбалансировать рабочую нагрузку на чтение по нескольким Aurora Replicas в вашем кластере БД.

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

CustomEndpoints -> (список)

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

(строка)

MultiAZ -> (булево значение)

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

Engine -> (строка)

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

EngineVersion -> (строка)

Версия используемого движка базы данных.

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

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

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

Порт, на котором работает движок базы данных.

MasterUsername -> (строка)

Имя пользователя мастера для кластера БД.

DBClusterOptionGroupMemberships -> (список)

Список членств в группах параметров для этого кластера БД.

(структура)

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

DBClusterOptionGroupName -> (строка)

Указывает имя группы параметров кластера БД.

Status -> (строка)

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

PreferredBackupWindow -> (строка)

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

PreferredMaintenanceWindow -> (строка)

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

ReplicationSourceIdentifier -> (строка)

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

ReadReplicaIdentifiers -> (список)

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

(строка)

StatusInfos -> (список)

Зарезервировано для будущих применений.

(структура)

Зарезервировано для будущих применений.

StatusType -> (строка)

Зарезервировано для будущих применений.

Normal -> (булево значение)

Зарезервировано для будущих применений.

Status -> (строка)

Зарезервировано для будущих применений.

Message -> (строка)

Зарезервировано для будущих применений.

DBClusterMembers -> (список)

Список экземпляров БД, составляющих кластер БД.

(структура)

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

DBInstanceIdentifier -> (строка)

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

IsClusterWriter -> (булево значение)

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

DBClusterParameterGroupStatus -> (строка)

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

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

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

VpcSecurityGroups -> (список)

Список групп безопасности VPC, к которым принадлежит кластер БД.

(структура)

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

VpcSecurityGroupId -> (строка)

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

Status -> (строка)

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

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

HostedZoneId -> (строка)

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

StorageEncrypted -> (булево значение)

Указывает, зашифрован ли кластер БД.

KmsKeyId -> (строка)

Если StorageEncrypted включен, идентификатор ключа KMS Amazon Web Services для зашифрованного кластера БД.

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

DbClusterResourceId -> (строка)

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

DBClusterArn -> (строка)

Amazon Resource Name (ARN) для кластера БД.

AssociatedRoles -> (список)

Список ролей управления доступом и идентификацией (IAM) Amazon Web Services, связанных с кластером БД. Роли IAM, связанные с кластером БД, предоставляют разрешения кластеру БД на доступ к другим службам Amazon Web Services от вашего имени.

(структура)

Описание роли управления доступом и идентификацией (IAM) Amazon Web Services, связанной с кластером БД.

RoleArn -> (строка)

Amazon Resource Name (ARN) роли IAM, связанной с кластером БД.

Status -> (строка)

Описание состояния ассоциации между ролью IAM и кластером БД. Свойство Status возвращает одно из следующих значений:

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

FeatureName -> (строка)

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

IAMDatabaseAuthenticationEnabled -> (булево значение)

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

CloneGroupId -> (строка)

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

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

Для точечного восстановления (PITR) идентификатор группы клонов наследуется от исходного кластера. Для операций восстановления по снимку идентификатор группы клонов не наследуется от исходного кластера.

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

Время создания кластера БД по всемирному координированному времени (UTC).

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

Самое раннее время, к которому можно выполнить обратное отслеживание кластера БД.

BacktrackWindow -> (длинное целое число)

Целевой интервал обратного отслеживания в секундах. Если это значение установлено в 0, обратное отслеживание для кластера БД отключено. В противном случае обратное отслеживание включено.

BacktrackConsumedChangeRecords -> (длинное целое число)

Количество записей изменений, хранящихся для обратного отслеживания.

EnabledCloudwatchLogsExports -> (список)

Список типов журналов, которые этот кластер БД настроен экспортировать в CloudWatch Logs.

Типы журналов зависят от движка базы данных. Сведения о типах журналов для каждого движка базы данных см. в разделе Файлы журналов базы данных Amazon RDS в Руководстве пользователя Amazon Aurora.

(строка)

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

Текущая емкость кластера баз данных Aurora Serverless v1. Емкость равна 0 (ноль), когда кластер приостановлен.

Для получения дополнительной информации об Aurora Serverless v1, см. раздел Использование Amazon Aurora Serverless v1 в руководстве Amazon Aurora User Guide .

EngineMode -> (строка)

Режим работы базы данных кластера, либо provisioned, либо serverless.

Для получения дополнительной информации, см. CreateDBCluster.

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

Конфигурация масштабирования для кластера баз данных Aurora в режиме работы serverless.

Для получения дополнительной информации, см. Использование Amazon Aurora Serverless v1 в руководстве Amazon Aurora User Guide .

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

Минимальная емкость для кластера баз данных Aurora в режиме работы serverless.

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

Максимальная емкость для кластера баз данных Aurora в режиме работы serverless.

AutoPause -> (булево)

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

Если значение установлено в false для кластера баз данных Aurora Serverless v1, кластер автоматически возобновляет работу.

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

Остаток времени в секундах, прежде чем кластер баз данных Aurora в режиме serverless будет приостановлен. Приостановление кластера возможно только когда он бездействует (нет подключений).

TimeoutAction -> (строка)

Действие, которое выполняется, когда Aurora завершает работу по попытке изменения емкости кластера Aurora Serverless v1. Значение может быть либо ForceApplyCapacityChange, либо RollbackCapacityChange.

ForceApplyCapacityChange, значение по умолчанию, устанавливает емкость к указанному значению как можно скорее.

RollbackCapacityChange игнорирует изменение емкости, если точка масштабирования не найдена в течение заданного таймаута.

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

Количество секунд до истечения времени ожидания масштабирования. То, что происходит при истечении времени ожидания масштабирования, определяется значением TimeoutAction.

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

Зарезервировано для будущего использования.

InterconnectSubnetId -> (строка)

Зарезервировано для будущего использования.

TransitGatewayMulticastDomainId -> (строка)

Зарезервировано для будущего использования.

ReplicaMode -> (строка)

Зарезервировано для будущего использования.

DeletionProtection -> (булево)

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

HttpEndpointEnabled -> (булево)

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

При включении HTTP-точка входа предоставляет API без подключения (RDS Data API) для выполнения SQL-запросов в кластере баз данных. Вы также можете выполнять запросы к базе данных из консоли RDS с помощью редактора запросов RDS.

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

ActivityStreamMode -> (строка)

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

ActivityStreamStatus -> (строка)

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

ActivityStreamKmsKeyId -> (строка)

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

ActivityStreamKinesisStreamName -> (строка)

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

CopyTagsToSnapshot -> (булево)

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

CrossAccountClone -> (булево)

Указывает, является ли кластер баз данных клоном кластера баз данных, принадлежащего другому аккаунту Amazon Web Services.

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.

(строка)

TagList -> (список)

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

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

(структура)

Метаданные, назначенные ресурсу 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}_.:/=+\-@]*)$”).

GlobalWriteForwardingStatus -> (строка)

Состояние перенаправления записей для вторичного кластера в глобальной базе данных Aurora.

GlobalWriteForwardingRequested -> (булево)

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

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

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

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

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

LogTypesToEnable -> (список)

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

(строка)

LogTypesToDisable -> (список)

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

(строка)

DBClusterIdentifier -> (строка)

Значение DBClusterIdentifier для кластера баз данных.

MasterUserPassword -> (строка)

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

IAMDatabaseAuthenticationEnabled -> (булево)

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

EngineVersion -> (строка)

Версия СУБД.

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

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

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

Размер выделенного хранилища в гигабайтах (GiB) для всех баз данных, кроме Amazon Aurora. Для Aurora, AllocatedStorage всегда возвращает 1, так как размер хранилища кластера баз данных Aurora не фиксирован, а автоматически подстраивается по мере необходимости.

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

Зарезервировано для будущего использования.

InterconnectSubnetId -> (строка)

Зарезервировано для будущего использования.

TransitGatewayMulticastDomainId -> (строка)

Зарезервировано для будущего использования.

ReplicaMode -> (строка)

Зарезервировано для будущего использования.

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

Значение Provisioned IOPS (I/O операций в секунду). Это значение используется только для кластеров баз данных Multi-AZ, не являющихся Aurora.

StorageType -> (строка)

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

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

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

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

CAIdentifier -> (строка)

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

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

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

DBClusterInstanceClass -> (строка)

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

Это значение используется только для кластеров баз данных Multi-AZ, не являющихся Aurora.

StorageType -> (строка)

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

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

Значение Provisioned IOPS (I/O операций в секунду).

Это значение используется только для кластеров баз данных Multi-AZ, не являющихся Aurora.

PubliclyAccessible -> (булево)

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

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

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

Для получения дополнительной информации см. CreateDBCluster.

Это значение используется только для кластеров баз данных Multi-AZ, не являющихся Aurora.

AutoMinorVersionUpgrade -> (булево)

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

Эта настройка предназначена для кластеров баз данных Aurora и кластеров баз данных Multi-AZ.

MonitoringInterval -> (integer)

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

Эта настройка предназначена только для кластеров баз данных Aurora и кластеров баз данных Multi-AZ.

MonitoringRoleArn -> (string)

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

Эта настройка предназначена только для кластеров баз данных Aurora и кластеров баз данных Multi-AZ.

DatabaseInsightsMode -> (string)

Режим Database Insights, включенный для кластера баз данных.

PerformanceInsightsEnabled -> (boolean)

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

Эта настройка предназначена только для кластеров баз данных Aurora и кластеров баз данных Multi-AZ.

PerformanceInsightsKMSKeyId -> (string)

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

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

Эта настройка предназначена только для кластеров баз данных Aurora и кластеров баз данных Multi-AZ.

PerformanceInsightsRetentionPeriod -> (integer)

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

Эта настройка предназначена только для кластеров баз данных Aurora и кластеров баз данных Multi-AZ.

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

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

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

ServerlessV2ScalingConfiguration -> (structure)

Настройка масштабирования для кластера баз данных Aurora Serverless v2.

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

MinCapacity -> (double)

Минимальное количество единиц емкости Aurora (ACU) для экземпляра базы данных в кластере Aurora Serverless v2. Вы можете указывать значения ACU с приращениями в половину шага, например, 8, 8,5, 9 и так далее. Для версий Aurora, поддерживающих функцию автоматической приостановки Aurora Serverless v2, наименьшее значение, которое вы можете использовать, равно 0. Для версий, не поддерживающих автоматическую приостановку Aurora Serverless v2, наименьшее значение, которое вы можете использовать, равно 0,5.

MaxCapacity -> (double)

Максимальное количество единиц емкости Aurora (ACU) для экземпляра базы данных в кластере Aurora Serverless v2. Вы можете указывать значения ACU с приращениями в половину шага, например, 32, 32,5, 33 и так далее. Наибольшее значение, которое вы можете использовать, равно 256 для последних версий Aurora или 128 для более старых версий.

SecondsUntilAutoPause -> (integer)

Количество секунд, в течение которых экземпляр базы данных Aurora Serverless v2 должен быть бездействующим, прежде чем Aurora попытается автоматически приостановить его. Это свойство отображается только при установке минимальной емкости кластера в 0 ACU. Изменение минимальной емкости на ненулевое значение удаляет это свойство. Если вы позже измените минимальную емкость обратно на 0 ACU, это свойство сбросится до своего значения по умолчанию, если вы его не укажете заново.

Это значение находится в диапазоне от 300 секунд (пять минут) до 86 400 секунд (один день). По умолчанию — 300 секунд.

NetworkType -> (string)

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

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

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

Эта настройка предназначена только для кластеров баз данных Aurora.

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

DBSystemId -> (string)

Зарезервировано для будущего использования.

MasterUserSecret -> (structure)

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

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

SecretArn -> (string)

Amazon Resource Name (ARN) секрета.

SecretStatus -> (string)

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

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

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

KmsKeyId -> (string)

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

IOOptimizedNextAllowedModificationTime -> (timestamp)

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

Эта настройка предназначена только для кластеров баз данных Aurora.

LocalWriteForwardingStatus -> (string)

Указывает, включена ли в кластере Aurora функция переадресации записи, не включена, запрошена или включена.

AwsBackupRecoveryPointArn -> (string)

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

LimitlessDatabase -> (structure)

Подробности для Aurora Limitless Database.

Status -> (string)

Статус Aurora Limitless Database.

MinRequiredACU -> (double)

Минимальная требуемая емкость Aurora Limitless Database в единицах емкости Aurora (ACU).

StorageThroughput -> (integer)

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

Эта настройка предназначена только для кластеров баз данных Multi-AZ, не являющихся кластерами Aurora.

ClusterScalabilityType -> (string)

Режим масштабируемости кластера баз данных Aurora. При установке в значение limitless кластер работает как Aurora Limitless Database. При установке в значение standard (по умолчанию) кластер использует обычное создание экземпляра базы данных.

CertificateDetails -> (structure)

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

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

CAIdentifier -> (string)

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

ValidTill -> (timestamp)

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

EngineLifecycleSupport -> (string)

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

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