create-db-cluster
Описание
Создает новый кластер Amazon Aurora или кластер DB с Multi-AZ.
Если вы создаете кластер Aurora, запрос создает пустой кластер. Вы должны явно создать экземпляр записи для вашего кластера DB с помощью операции CreateDBInstance. Если вы создаете кластер DB с Multi-AZ, запрос создает для вас экземпляры записи и два экземпляра чтения DB, каждый в разных зонах доступности.
Вы можете использовать параметр ReplicationSourceIdentifier для создания кластера Amazon Aurora как реплики чтения другого кластера DB или экземпляра DB Amazon RDS для MySQL или PostgreSQL. Дополнительную информацию об Amazon Aurora см. в разделе Что такое Amazon Aurora? в Руководстве пользователя Amazon Aurora.
Вы также можете использовать параметр ReplicationSourceIdentifier для создания реплики чтения кластера DB с Multi-AZ с использованием экземпляра RDS для MySQL или PostgreSQL в качестве источника. Дополнительную информацию о кластерах DB с Multi-AZ см. в разделе Развертывания кластеров DB с Multi-AZ в Руководстве пользователя Amazon RDS.
См. также: Документацию API AWS
Синтаксис
create-db-cluster
[--availability-zones <value>]
[--backup-retention-period <value>]
[--character-set-name <value>]
[--database-name <value>]
--db-cluster-identifier <value>
[--db-cluster-parameter-group-name <value>]
[--vpc-security-group-ids <value>]
[--db-subnet-group-name <value>]
--engine <value>
[--engine-version <value>]
[--port <value>]
[--master-username <value>]
[--master-user-password <value>]
[--option-group-name <value>]
[--preferred-backup-window <value>]
[--preferred-maintenance-window <value>]
[--replication-source-identifier <value>]
[--tags <value>]
[--storage-encrypted | --no-storage-encrypted]
[--kms-key-id <value>]
[--pre-signed-url <value>]
[--enable-iam-database-authentication | --no-enable-iam-database-authentication]
[--backtrack-window <value>]
[--enable-cloudwatch-logs-exports <value>]
[--engine-mode <value>]
[--scaling-configuration <value>]
[--rds-custom-cluster-configuration <value>]
[--deletion-protection | --no-deletion-protection]
[--global-cluster-identifier <value>]
[--enable-http-endpoint | --no-enable-http-endpoint]
[--copy-tags-to-snapshot | --no-copy-tags-to-snapshot]
[--domain <value>]
[--domain-iam-role-name <value>]
[--enable-global-write-forwarding | --no-enable-global-write-forwarding]
[--db-cluster-instance-class <value>]
[--allocated-storage <value>]
[--storage-type <value>]
[--iops <value>]
[--publicly-accessible | --no-publicly-accessible]
[--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>]
[--enable-limitless-database | --no-enable-limitless-database]
[--serverless-v2-scaling-configuration <value>]
[--network-type <value>]
[--cluster-scalability-type <value>]
[--db-system-id <value>]
[--manage-master-user-password | --no-manage-master-user-password]
[--master-user-secret-kms-key-id <value>]
[--enable-local-write-forwarding | --no-enable-local-write-forwarding]
[--ca-certificate-identifier <value>]
[--engine-lifecycle-support <value>]
[--source-region <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
Параметры
--availability-zones (список)
Список зон доступности (AZ), в которых вы хотите создать экземпляры БД в кластере БД.
Для получения информации о зонах доступности см. Зоны доступности в руководстве Amazon Aurora User Guide.
Действительно для типа кластера: только кластеры БД Aurora
Ограничения:
- Нельзя указать более трех зон доступности.
(строка)
Синтаксис:
"string" "string" ...
--backup-retention-period (целое число)
Количество дней, в течение которых сохраняются автоматические резервные копии.
Действительно для типа кластера: кластеры БД Aurora и кластеры БД Multi-AZ
По умолчанию: 1
Ограничения:
- Значение должно быть от 1 до 35.
--character-set-name (строка)
Имя набора символов (CharacterSet ), которое следует связать с кластером БД.
Действительно только для кластеров БД Aurora
--database-name (строка)
Имя вашей базы данных, до 64 буквенно-цифровых символов. База данных с именем postgres всегда создается. Если этот параметр указан, создаётся дополнительная база данных с этим именем.
Действительно для типа кластера: кластеры БД Aurora и кластеры БД Multi-AZ
--db-cluster-identifier (строка)
Идентификатор этого кластера БД. Этот параметр хранится в виде строчных букв.
Действительно для типа кластера: кластеры БД Aurora и кластеры БД Multi-AZ
Ограничения:
- Должно содержать от 1 до 63 (для кластеров БД Aurora) или от 1 до 52 (для кластеров БД Multi-AZ) букв, цифр или дефисов.
- Первый символ должен быть буквой.
- Не может заканчиваться дефисом или содержать два дефиса подряд.
Пример: my-cluster1
--db-cluster-parameter-group-name (строка)
Имя группы параметров кластера БД для связывания с этим кластером БД. Если вы не укажете значение, то будет использоваться группа параметров кластера БД по умолчанию для указанного движка БД и версии.
Действительно для типа кластера: кластеры БД Aurora и кластеры БД Multi-AZ
Ограничения:
- При указании, должно совпадать с именем существующей группы параметров кластера БД.
--vpc-security-group-ids (список)
Список групп безопасности EC2 VPC для связывания с этим кластером БД.
Действительно для типа кластера: кластеры БД Aurora и кластеры БД Multi-AZ
(строка)
Синтаксис:
"string" "string" ...
--db-subnet-group-name (строка)
Группа подсетей БД для связывания с этим кластером БД.
Это значение требуется для создания кластера БД Multi-AZ.
Действительно для типа кластера: кластеры БД Aurora и кластеры БД Multi-AZ
Ограничения:
- Должно совпадать с именем существующей группы подсетей БД.
Пример: mydbsubnetgroup
--engine (строка)
Движок базы данных для использования в этом кластере БД.
Действительно для типа кластера: кластеры БД Aurora и кластеры БД Multi-AZ
Допустимые значения:
aurora-mysqlaurora-postgresqlmysqlpostgres-
neptune- Для получения информации об использовании Amazon Neptune, см. ` Руководство пользователя Amazon Neptune https://docs.aws.amazon.com/neptune/latest/userguide/intro.html`__ .
--engine-version (строка)
Номер версии движка базы данных для использования.
Для просмотра всех доступных версий движков для Aurora MySQL версии 2 (совместимой с 5.7) и версии 3 (совместимой с MySQL 8.0) используйте следующую команду:
aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"Вы можете указать либо 5.7, либо 8.0, чтобы использовать версию движка по умолчанию для Aurora MySQL версии 2 или версии 3 соответственно.
Для просмотра всех доступных версий движков для Aurora PostgreSQL используйте следующую команду:
aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"Для просмотра всех доступных версий движков для RDS для MySQL используйте следующую команду:
aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion"Для просмотра всех доступных версий движков для RDS для PostgreSQL используйте следующую команду:
aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"Для получения информации о конкретном движке, см. следующие разделы:
- Aurora MySQL - см. Обновления движка базы данных для Amazon Aurora MySQL в руководстве Amazon Aurora User Guide.
- Aurora PostgreSQL - см. Релизы и версии движков Amazon Aurora PostgreSQL в руководстве Amazon Aurora User Guide.
- RDS для MySQL - см. Amazon RDS для MySQL в руководстве Amazon RDS User Guide.
- RDS для PostgreSQL - см. Amazon RDS для PostgreSQL в руководстве Amazon RDS User Guide.
Действительно для типа кластера: кластеры БД Aurora и кластеры БД Multi-AZ
--port (целое число)
Номер порта, на котором экземпляры в кластере БД принимают подключения.
Действительно для типа кластера: кластеры БД Aurora и кластеры БД Multi-AZ
Допустимые значения: 1150-65535
По умолчанию:
- RDS для MySQL и Aurora MySQL -
3306 - RDS для PostgreSQL и Aurora PostgreSQL -
5432
--master-username (строка)
Имя пользователя мастера для кластера БД.
Действительно для типа кластера: кластеры БД Aurora и кластеры БД Multi-AZ
Ограничения:
- Должно содержать от 1 до 16 букв или цифр.
- Первый символ должен быть буквой.
- Не может быть зарезервированным словом для выбранного движка базы данных.
--master-user-password (строка)
Пароль для пользователя мастера базы данных.
Действительно для типа кластера: кластеры БД Aurora и кластеры БД Multi-AZ
Ограничения:
- Должно содержать от 8 до 41 символа.
- Может содержать любые печатные ASCII-символы, кроме «/», «"», или «@».
- Не может быть указан, если
ManageMasterUserPasswordвключён.
--option-group-name (строка)
Группа опций для связывания с кластером БД.
Кластеры БД связаны с группой опций по умолчанию, которую нельзя изменить.
--preferred-backup-window (строка)
Суточный интервал времени для создания автоматических резервных копий, если автоматические резервные копии включены с помощью параметра BackupRetentionPeriod.
Действительно для типа кластера: кластеры БД Aurora и кластеры БД Multi-AZ
По умолчанию — 30-минутный интервал, выбранный случайным образом из 8-часового периода для каждой области Amazon Web Services. Чтобы просмотреть доступные временные интервалы, см. Временной интервал резервного копирования в руководстве Amazon Aurora User Guide.
Ограничения:
- Должно быть в формате
hh24:mi-hh24:mi. - Должно быть в формате универсального времени координации (UTC).
- Не должно конфликтовать с предпочтительным интервалом обслуживания.
- Должно быть не менее 30 минут.
--preferred-maintenance-window (строка)
Еженедельный интервал времени, в течение которого может происходить техническое обслуживание системы.
Действительно для типа кластера: кластеры БД Aurora и кластеры БД Multi-AZ
По умолчанию — 30-минутный интервал, выбранный случайным образом из 8-часового периода для каждой области Amazon Web Services, происходящий в произвольный день недели. Чтобы увидеть доступные временные интервалы, см. Настройка предпочтительного интервала обслуживания кластера БД в руководстве Amazon Aurora User Guide.
Ограничения:
- Должно быть в формате
ddd:hh24:mi-ddd:hh24:mi. - Дни должны быть одним из
Mon | Tue | Wed | Thu | Fri | Sat | Sun. - Должно быть в формате универсального времени координации (UTC).
- Должно быть не менее 30 минут.
--replication-source-identifier (строка)
Amazon Resource Name (ARN) исходного экземпляра БД или кластера БД, если этот кластер БД создаётся как реплика чтения.
Действительно для типа кластера: кластеры БД Aurora и кластеры БД Multi-AZ
--tags (список)
Теги для назначения кластеру БД.
Действительно для типа кластера: кластеры БД Aurora и кластеры БД Multi-AZ
(структура)
Метаданные, назначенные ресурсу Amazon RDS, представляющие собой пару ключ-значение.
Для получения дополнительной информации, см. Пометка ресурсов Amazon RDS в руководстве Amazon RDS User Guide или Пометка ресурсов Amazon Aurora и Amazon RDS в руководстве Amazon Aurora User Guide.
Ключ -> (строка)
aws: или rds:. Строка может содержать только набор символов Юникода, цифр, пробелов, «_», «.», «:», «/», «=», «+», «-», «@» (регулярное выражение Java: “^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$”).Значение -> (строка)
aws: или rds:. Строка может содержать только набор символов Юникода, цифр, пробелов, «_», «.», «:», «/», «=», «+», «-», «@» (регулярное выражение Java: “^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$”).Краткая форма синтаксиса:
Key=string,Value=string ...
Синтаксис JSON:
[
{
"Key": "string",
"Value": "string"
}
...
]
--storage-encrypted | --no-storage-encrypted (логическое значение)
Указывает, зашифрован ли кластер БД.
Действительно для типа кластера: кластеры БД Aurora и кластеры БД Multi-AZ
--kms-key-id (строка)
Идентификатор ключа KMS Amazon Web Services для зашифрованного кластера БД.
Идентификатор ключа KMS Amazon Web Services — это ARN ключа, ID ключа, ARN псевдонима или имя псевдонима для ключа KMS. Для использования ключа KMS в другом аккаунте Amazon Web Services укажите ARN ключа или ARN псевдонима.
Когда в KmsKeyId не указан идентификатор ключа KMS:
- Если
ReplicationSourceIdentifierидентифицирует зашифрованный источник, тогда Amazon RDS использует ключ KMS, используемый для шифрования источника. В противном случае Amazon RDS использует ваш ключ KMS по умолчанию. - Если параметр
StorageEncryptedвключён иReplicationSourceIdentifierне указан, тогда Amazon RDS использует ваш ключ KMS по умолчанию.
Для вашей учетной записи Amazon Web Services существует ключ KMS по умолчанию. У вашей учетной записи Amazon Web Services есть другой ключ KMS по умолчанию для каждой области Amazon Web Services.
Если вы создаёте реплику чтения зашифрованного кластера БД в другой области Amazon Web Services, убедитесь, что вы установили KmsKeyId на идентификатор ключа KMS, который действителен в целевой области Amazon Web Services. Этот ключ KMS используется для шифрования реплики чтения в этой области Amazon Web Services.
Действительно для типа кластера: кластеры БД Aurora и кластеры БД Multi-AZ
--pre-signed-url (строка)
При копировании кластера БД из одной региона Amazon Web Services GovCloud (US) в другую, требуется URL, содержащий подписанный запрос Signature Version 4 для вызова операции CreateDBCluster в исходном регионе Amazon Web Services, откуда копируется кластер БД. Укажите PreSignedUrl только при выполнении межрегиональной репликации из зашифрованного кластера БД.
Предзаписанный URL-адрес должен быть корректным запросом для API-операции CreateDBCluster, которая может выполняться в исходном регионе Amazon Web Services, содержащем зашифрованный кластер БД для копирования.
Предзаписанный URL-запрос должен содержать следующие значения параметров:
-
KmsKeyId— идентификатор ключа KMS для ключа KMS, который будет использоваться для шифрования копии кластера БД в целевом регионе Amazon Web Services. Он должен ссылаться на тот же ключ KMS, что и для операцииCreateDBCluster, которая вызывается в целевом регионе Amazon Web Services, и для операции, содержащейся в предзаписанном URL-адресе. -
DestinationRegion— имя региона Amazon Web Services, в котором будет создана реплика чтения Aurora. -
ReplicationSourceIdentifier— идентификатор кластера БД для зашифрованного кластера БД, который требуется скопировать. Этот идентификатор должен быть в формате Amazon Resource Name (ARN) для исходного региона Amazon Web Services. Например, если вы копируете зашифрованный кластер БД из региона Amazon Web Services us-west-2, то вашReplicationSourceIdentifierбудет выглядеть следующим образом: Пример:arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1.
Чтобы узнать, как сгенерировать подписанный запрос Signature Version 4, см. Авторизация запросов: использование параметров запроса (Amazon Web Services Signature Version 4) и Процесс подписи Signature Version 4.
Примечание
Если вы используете инструмент SDK Amazon Web Services или командную строку CLI, вы можете указатьSourceRegion (или --source-region для CLI) вместо ручного указания PreSignedUrl. Указание SourceRegion автоматически генерирует предзаписанный URL, который является корректным запросом для операции, которая может выполняться в исходном регионе Amazon Web Services.Допустимые типы кластеров: только кластеры БД Aurora
--enable-iam-database-authentication | --no-enable-iam-database-authentication (boolean)
Определяет, нужно ли включить отображение учетных записей Amazon Web Services Identity and Access Management (IAM) в учетные записи базы данных. По умолчанию отображение не включено.
Дополнительную информацию см. в разделе Авторизация IAM в базе данных в руководстве пользователя Amazon Aurora или Авторизация IAM в базе данных для MariaDB, MySQL и PostgreSQL в руководстве пользователя Amazon RDS.
Допустимые типы кластеров: кластеры БД Aurora и кластеры БД Multi-AZ
--backtrack-window (long)
Целевое окно отката в секундах. Чтобы отключить откат, установите это значение в 0.
Допустимые типы кластеров: только кластеры БД Aurora MySQL
По умолчанию: 0
Ограничения:
- Если указано, это значение должно быть числом от 0 до 259 200 (72 часа).
--enable-cloudwatch-logs-exports (список)
Список типов логов, которые необходимо включить для экспорта в CloudWatch Logs.
Допустимые типы кластеров: кластеры БД Aurora и кластеры БД Multi-AZ
Следующие значения допустимы для каждого движка БД:
- 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 RDS в разделе Опубликование журналов базы данных в Amazon CloudWatch Logs.
Дополнительную информацию об экспорте журналов CloudWatch Logs для Amazon Aurora см. в руководстве пользователя Amazon Aurora в разделе Опубликование журналов базы данных в Amazon CloudWatch Logs.
(строка)
Синтаксис:
"string" "string" ...
--engine-mode (строка)
Режим движка БД кластера БД, либо provisioned, либо serverless.
Режим движка serverless применим только для кластеров БД Aurora Serverless v1. Кластеры БД Aurora Serverless v2 используют режим движка provisioned.
Дополнительную информацию об ограничениях и требованиях для кластеров Serverless БД см. в следующих разделах руководства пользователя Amazon Aurora:
- Ограничения Aurora Serverless v1
- Требования к Aurora Serverless v2
Допустимые типы кластеров: только кластеры БД Aurora
--scaling-configuration (структура)
Для кластеров БД в режиме движка БД serverless — свойства масштабирования кластера БД.
Допустимые типы кластеров: только кластеры БД Aurora
MinCapacity -> (целое число)
Минимальная емкость кластера БД Aurora в режиме движка БД serverless.
Для Aurora MySQL допустимые значения емкости — 1, 2, 4, 8, 16, 32, 64, 128 и 256.
Для Aurora PostgreSQL допустимые значения емкости — 2, 4, 8, 16, 32, 64, 192 и 384.
Минимальная емкость должна быть меньше или равна максимальной емкости.
MaxCapacity -> (целое число)
Максимальная емкость кластера БД Aurora в режиме движка БД serverless.
Для Aurora MySQL допустимые значения емкости — 1, 2, 4, 8, 16, 32, 64, 128 и 256.
Для Aurora PostgreSQL допустимые значения емкости — 2, 4, 8, 16, 32, 64, 192 и 384.
Максимальная емкость должна быть больше или равна минимальной емкости.
AutoPause -> (boolean)
Указывает, разрешено или запрещено автоматическое приостановление работы кластера БД Aurora в режиме движка БД serverless. Кластер БД может быть приостановлен только при его бездействии (нет подключений).
Примечание
Если кластер БД приостановлен более семи дней, кластер БД может быть резервно скопирован со снимком. В этом случае кластер БД восстанавливается при запросе подключения к нему.SecondsUntilAutoPause -> (целое число)
Время в секундах, прежде чем кластер БД Aurora в режиме serverless будет приостановлен.
Укажите значение от 300 до 86 400 секунд.
TimeoutAction -> (строка)
Действие, которое нужно выполнить при достижении таймаута, либо ForceApplyCapacityChange, либо RollbackCapacityChange.
ForceApplyCapacityChange устанавливает емкость на указанное значение как можно скорее.
RollbackCapacityChange, по умолчанию, игнорирует изменение емкости, если точка масштабирования не найдена в период таймаута.
Предупреждение
Если вы укажетеForceApplyCapacityChange, соединения, которые не позволяют Aurora Serverless v1 найти точку масштабирования, могут быть прерваны.Дополнительную информацию см. в разделе Автомасштабирование для 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
}
--rds-custom-cluster-configuration (структура)
Зарезервировано для будущего использования.
InterconnectSubnetId -> (строка)
TransitGatewayMulticastDomainId -> (строка)
ReplicaMode -> (строка)
Упрощённый синтаксис:
InterconnectSubnetId=string,TransitGatewayMulticastDomainId=string,ReplicaMode=string
Синтаксис JSON:
{
"InterconnectSubnetId": "string",
"TransitGatewayMulticastDomainId": "string",
"ReplicaMode": "open-read-only"|"mounted"
}
--deletion-protection | --no-deletion-protection (boolean)
Указывает, включена ли защита от удаления для кластера БД. При включенной защите от удаления базу данных нельзя удалить. По умолчанию защита от удаления не включена.
Допустимые типы кластеров: кластеры БД Aurora и кластеры БД Multi-AZ
--global-cluster-identifier (строка)
Идентификатор глобального кластера Aurora, который становится основным кластером в новом глобальном кластере баз данных.
Допустимые типы кластеров: только кластеры БД Aurora
--enable-http-endpoint | --no-enable-http-endpoint (boolean)
Указывает, нужно ли включить HTTP-точку входа для кластера БД. По умолчанию HTTP-точка входа не включена.
При включении HTTP-точка входа предоставляет API веб-службы без подключения (RDS Data API) для выполнения SQL-запросов в кластере БД. Вы также можете запросить вашу базу данных внутри консоли RDS с помощью редактора запросов RDS.
Дополнительную информацию см. в разделе Использование RDS Data API в руководстве пользователя Amazon Aurora.
Допустимые типы кластеров: только кластеры БД Aurora
--copy-tags-to-snapshot | --no-copy-tags-to-snapshot (boolean)
Указывает, нужно ли копировать все теги из кластера БД в снимки кластера БД. По умолчанию теги не копируются.
Допустимые типы кластеров: кластеры БД Aurora и кластеры БД Multi-AZ
--domain (строка)
Идентификатор каталога Active Directory, в котором нужно создать кластер БД.
Для кластеров БД Amazon Aurora Amazon RDS может использовать аутентификацию Kerberos для аутентификации пользователей, которые подключаются к кластеру БД.
Дополнительную информацию см. в разделе Аутентификация Kerberos в руководстве пользователя Amazon Aurora.
Допустимые типы кластеров: только кластеры БД Aurora
--domain-iam-role-name (строка)
Имя роли IAM, используемой при выполнении вызовов API к службе каталогов.
Допустимые типы кластеров: только кластеры БД Aurora
--enable-global-write-forwarding | --no-enable-global-write-forwarding (boolean)
Указывает, следует ли разрешить этому кластеру баз данных пересылать операции записи в первичный кластер глобального кластера (глобальная база данных Aurora). По умолчанию операции записи не разрешены для кластеров баз данных Aurora, являющихся вторичными кластерами в глобальной базе данных Aurora.
Вы можете установить это значение только для кластеров баз данных Aurora, которые являются участниками глобальной базы данных Aurora. При включении этого параметра вторичный кластер может пересылать записи в текущий первичный кластер, а внесенные изменения дублируются обратно в этот кластер. Для первичного кластера базы данных Aurora в глобальной базе данных это значение используется немедленно, если первичный кластер понижается операцией API глобального кластера, но в противном случае ничего не происходит.
Допустимо для типа кластера: только кластеры баз данных Aurora
--db-cluster-instance-class (строка)
Вычислительная и емкость памяти каждого экземпляра БД в многозонном кластере БД, например db.m6gd.xlarge. Не все классы экземпляров БД доступны во всех регионах Amazon Web Services или для всех движков баз данных.
Полный список классов экземпляров БД и их доступность для вашего движка см. в руководстве пользователя Amazon RDS в разделе «Класс экземпляра БД».
Этот параметр необходим для создания многозонного кластера БД.
Допустимо для типа кластера: только многозонные кластеры БД
--allocated-storage (целое число)
Объем памяти в гигабайтах (GiB), который необходимо выделить каждому экземпляру БД в многозонном кластере БД.
Допустимо для типа кластера: только многозонные кластеры БД
Этот параметр необходим для создания многозонного кластера БД.
--storage-type (строка)
Тип памяти, который необходимо связать с кластером баз данных.
Сведения о типах памяти для кластеров баз данных Aurora см. в разделе «Конфигурации памяти для кластеров баз данных Amazon Aurora». Сведения о типах памяти для многозонных кластеров БД см. в разделе «Параметры для создания многозонных кластеров БД».
Этот параметр необходим для создания многозонного кластера БД.
При указании для многозонного кластера БД требуется значение параметра Iops.
Допустимо для типа кластера: кластеры баз данных Aurora и многозонные кластеры БД
Допустимые значения:
- Кластеры баз данных Aurora -
aurora | aurora-iopt1 - Многозонные кластеры БД -
io1 | io2 | gp3
По умолчанию:
- Кластеры баз данных Aurora -
aurora - Многозонные кластеры БД -
io1
Примечание
При создании кластера баз данных Aurora с типом памяти, установленным наaurora-iopt1, тип памяти возвращается в ответе. Тип памяти не возвращается при установке значения aurora.--iops (целое число)
Количество Provisioned IOPS (операций ввода/вывода в секунду), которое необходимо первоначально выделить для каждого экземпляра БД в многозонном кластере БД.
Сведения о допустимых значениях IOPS см. в разделе «Память с Provisioned IOPS» в руководстве пользователя Amazon RDS.
Этот параметр необходим для создания многозонного кластера БД.
Допустимо для типа кластера: только многозонные кластеры БД
Ограничения:
- Должно быть кратным значению между 0,5 и 50 от объема памяти для кластера БД.
--publicly-accessible | --no-publicly-accessible (логическое значение)
Указывает, доступен ли кластер БД публично.
Если кластер БД публично доступен и вы подключаетесь извне виртуальной частной сети (VPC) кластера БД, его конечная точка DNS отображается по публичному IP-адресу. При подключении из той же VPC, что и кластер БД, конечная точка отображается по частному IP-адресу. Доступ к кластеру БД в конечном итоге контролируется используемой им группой безопасности. Публичный доступ запрещен, если назначенная кластеру БД группа безопасности его не допускает.
Если кластер БД не публично доступен, это внутренний кластер БД с именем DNS, которое отображается по частному IP-адресу.
Допустимо для типа кластера: только многозонные кластеры БД
По умолчанию: поведение по умолчанию зависит от того, указан ли параметр DBSubnetGroupName.
Если DBSubnetGroupName не указан и PubliclyAccessible не указан, применяется следующее:
- Если в целевом регионе нет интернет-шлюза, подключенного к основной VPC, кластер БД является закрытым.
- Если в целевом регионе есть интернет-шлюз, подключенный к основной VPC, кластер БД является открытым.
Если DBSubnetGroupName указан, а PubliclyAccessible не указан, применяется следующее:
- Если подсети являются частью VPC, к которой не подключен интернет-шлюз, кластер БД является закрытым.
- Если подсети являются частью VPC, к которой подключен интернет-шлюз, кластер БД является открытым.
--auto-minor-version-upgrade | --no-auto-minor-version-upgrade (логическое значение)
Указывает, применяются ли автоматические обновления младших версий движка к кластеру БД в период обслуживания. По умолчанию обновления младших версий движка применяются автоматически.
Допустимо для типа кластера: кластеры баз данных Aurora и многозонные кластеры БД.
Дополнительную информацию об автоматическом обновлении до младшей версии см. в разделе «Автоматическое обновление младшей версии движка».
--monitoring-interval (целое число)
Интервал в секундах между моментами, когда для кластера БД собираются метрики расширенного мониторинга. Чтобы отключить сбор метрик расширенного мониторинга, укажите 0.
Если указано MonitoringRoleArn, также установите MonitoringInterval на значение, отличное от 0.
Допустимо для типа кластера: кластеры баз данных Aurora и многозонные кластеры БД
Допустимые значения: 0 | 1 | 5 | 10 | 15 | 30 | 60
По умолчанию: 0
--monitoring-role-arn (строка)
Amazon Resource Name (ARN) для роли IAM, которая разрешает RDS отправлять метрики расширенного мониторинга в Amazon CloudWatch Logs. Пример: arn:aws:iam:123456789012:role/emaccess. Сведения о создании роли мониторинга см. в разделе «Настройка и включение расширенного мониторинга» в руководстве пользователя Amazon RDS.
Если MonitoringInterval имеет значение, отличное от 0, укажите значение MonitoringRoleArn.
Допустимо для типа кластера: кластеры баз данных Aurora и многозонные кластеры БД
--database-insights-mode (строка)
Режим Database Insights для включения в кластере БД.
Если вы устанавливаете это значение в advanced, вы также должны установить параметр PerformanceInsightsEnabled в true и параметр PerformanceInsightsRetentionPeriod в 465.
Допустимо для типа кластера: кластеры баз данных Aurora и многозонные кластеры БД
Возможные значения:
standardadvanced
--enable-performance-insights | --no-enable-performance-insights (логическое значение)
Указывает, следует ли включить Performance Insights для кластера БД.
Дополнительную информацию см. в разделе «Использование Amazon Performance Insights» в руководстве пользователя Amazon RDS.
Допустимо для типа кластера: кластеры баз данных Aurora и многозонные кластеры БД
--performance-insights-kms-key-id (строка)
Идентификатор ключа KMS Amazon Web Services для шифрования данных Performance Insights.
Идентификатор ключа KMS Amazon Web Services представляет собой ARN ключа, ID ключа, ARN псевдонима или имя псевдонима для ключа KMS.
Если вы не укажете значение для PerformanceInsightsKMSKeyId, Amazon RDS использует ваш ключ KMS по умолчанию. Для вашей учетной записи Amazon Web Services есть ключ KMS по умолчанию. У вашей учетной записи Amazon Web Services есть другой ключ KMS по умолчанию для каждого региона Amazon Web Services.
Допустимо для типа кластера: кластеры баз данных Aurora и многозонные кластеры БД
--performance-insights-retention-period (целое число)
Количество дней для хранения данных Performance Insights.
Допустимо для типа кластера: кластеры баз данных Aurora и многозонные кластеры БД
Допустимые значения:
7-
месяц * 31, где месяц — число месяцев от 1 до 23. Примеры:
93(3 месяца * 31),341(11 месяцев * 31),589(19 месяцев * 31) 731
По умолчанию: 7 дней
Если вы укажете период хранения, который не является допустимым, например, 94, Amazon RDS выдаст ошибку.
--enable-limitless-database | --no-enable-limitless-database (логическое значение)
Указывает, следует ли включить базу данных Aurora Limitless. Для создания группы фрагментов БД необходимо включить базу данных Aurora Limitless.
Допустимо для: только кластеры баз данных Aurora
Примечание
Это значение больше не используется. Вместо этого используйте значениеClusterScalabilityType.--serverless-v2-scaling-configuration (структура)
Содержит конфигурацию масштабирования кластера баз данных Aurora Serverless v2.
Дополнительную информацию см. в разделе «Использование Amazon Aurora Serverless v2» в руководстве пользователя Amazon Aurora.
MinCapacity -> (двойное значение)
MaxCapacity -> (двойное значение)
SecondsUntilAutoPause -> (целое число)
Указывает количество секунд, в течение которого экземпляр БД Aurora Serverless v2 должен быть бездействующим, прежде чем Aurora попытается автоматически приостановить его.
Укажите значение от 300 секунд (пять минут) до 86400 секунд (один день). По умолчанию используется 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.
Допустимо для типа кластера: только кластеры баз данных Aurora
Допустимые значения: IPV4 | DUAL
--cluster-scalability-type (строка)
Указывает режим масштабируемости кластера баз данных Aurora. При установке в значение limitless, кластер работает как база данных Aurora Limitless. При установке в значение standard (значение по умолчанию), кластер использует обычное создание экземпляров баз данных.
Действительно для: только кластеров баз данных Aurora
Примечание
Вы не можете изменить это значение после создания кластера баз данных.Возможные значения:
standardlimitless
--db-system-id (строка)
--manage-master-user-password | --no-manage-master-user-password (булево)
Указывает, нужно ли управлять паролем пользователя master с помощью Amazon Web Services Secrets Manager.
Дополнительную информацию см. в разделе Управление паролями с помощью Amazon Web Services Secrets Manager в руководстве Amazon RDS User Guide и Управление паролями с помощью Amazon Web Services Secrets Manager в руководстве Amazon Aurora User Guide.
Действительно для типа кластера: кластеры баз данных Aurora и кластеры баз данных Multi-AZ
Ограничения:
- Нельзя управлять паролем пользователя master с помощью Amazon Web Services Secrets Manager, если задано
MasterUserPassword.
--master-user-secret-kms-key-id (строка)
Идентификатор ключа Amazon Web Services KMS для шифрования секрета, который автоматически генерируется и управляется в Amazon Web Services Secrets Manager.
Это значение действительно только в том случае, если пароль пользователя master управляется RDS в Amazon Web Services Secrets Manager для кластера баз данных.
Идентификатор ключа Amazon Web Services KMS — это ARN ключа, идентификатор ключа, ARN псевдонима или имя псевдонима для ключа KMS. Чтобы использовать ключ KMS в другом аккаунте Amazon Web Services, укажите ARN ключа или ARN псевдонима.
Если вы не укажете MasterUserSecretKmsKeyId, то используется aws/secretsmanager ключ KMS для шифрования секрета. Если секрет находится в другом аккаунте Amazon Web Services, то вы не можете использовать aws/secretsmanager ключ KMS для шифрования секрета, и должны использовать управляемый пользователем ключ KMS.
Для вашего аккаунта Amazon Web Services существует ключ KMS по умолчанию. Для каждого региона Amazon Web Services у вашего аккаунта Amazon Web Services есть отдельный ключ KMS по умолчанию.
Действительно для типа кластера: кластеры баз данных Aurora и кластеры баз данных Multi-AZ
--enable-local-write-forwarding | --no-enable-local-write-forwarding (булево)
Указывает, могут ли чтецкие реплики пересылать операции записи экземпляру базы данных-писателю в кластере баз данных. По умолчанию операции записи не разрешены на экземплярах баз данных-читателях.
Действительно для: только кластеров баз данных Aurora
--ca-certificate-identifier (строка)
Идентификатор сертификата CA для использования в качестве сертификата сервера кластера баз данных.
Дополнительную информацию см. в разделе Использование SSL/TLS для шифрования подключения к экземпляру базы данных в руководстве Amazon RDS User Guide.
Действительно для типа кластера: кластеры баз данных Multi-AZ
--engine-lifecycle-support (строка)
Тип жизненного цикла для этого кластера баз данных.
Примечание
По умолчанию это значение установлено вopen-source-rds-extended-support, что подключает ваш кластер баз данных к расширенной поддержке Amazon RDS. По окончании стандартной поддержки вы можете избежать платы за расширенную поддержку, установив значение в open-source-rds-extended-support-disabled. В этом случае создание кластера баз данных завершится ошибкой, если основная версия базы данных прошла срок окончания стандартной поддержки.Вы можете использовать это значение для подключения вашего кластера баз данных к расширенной поддержке Amazon RDS. С расширенной поддержкой RDS вы можете запустить выбранную основную версию движка на вашем кластере баз данных после окончания стандартной поддержки для этой версии движка. Дополнительную информацию см. в следующих разделах:
- Amazon Aurora — Расширенная поддержка Amazon RDS с Amazon Aurora в руководстве Amazon Aurora User Guide
- Amazon RDS — Расширенная поддержка Amazon RDS с Amazon RDS в руководстве Amazon RDS User Guide
Действительно для типа кластера: кластеры баз данных Aurora и кластеры баз данных Multi-AZ
Допустимые значения: open-source-rds-extended-support | open-source-rds-extended-support-disabled
По умолчанию: open-source-rds-extended-support
--source-region (строка)
--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной строки JSON. Строка JSON следует формату, предоставленному --generate-cli-skeleton. Если на командной строке предоставлены другие аргументы, эти значения переопределят значения, предоставленные в JSON. Невозможно передать произвольные двоичные значения с помощью значения, предоставленного в JSON, так как строка будет воспринята буквально. Это может не быть указано вместе с --cli-input-yaml.
--generate-cli-skeleton (строка) Выводит каркас JSON в стандартный вывод без отправки запроса API. Если не указано значение или значение input, выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если указано yaml-input, он выведет пример входного YAML, который можно использовать с --cli-input-yaml. Если указано значение output, он валидирует входные данные команды и возвращает пример выходного JSON для этой команды. Сгенерированный каркас JSON не является стабильным между версиями AWS CLI, и нет гарантии обратной совместимости в сгенерированном каркасе JSON.
Глобальные параметры
--debug (булево)
Включить отладку протоколирования.
--endpoint-url (строка)
Переопределить URL по умолчанию команды указанным URL.
--no-verify-ssl (булево)
По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого подключения SSL AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет стандартное поведение проверки сертификатов SSL.
--no-paginate (булево)
Отключить автоматическую постраничность. Если автоматическая постраничность отключена, AWS CLI будет выполнять только один вызов для первой страницы результатов.
--output (строка)
Стиль форматирования для вывода команды.
- json
- текст
- таблица
- yaml
- yaml-поток
--query (строка)
Запрос JMESPath для фильтрации данных ответа.
--profile (строка)
Использовать определенный профиль из файла аутентификации.
--region (строка)
Используемый регион. Переопределяет настройки конфигурации/среды.
--version (строка)
Отобразить версию этого инструмента.
--color (строка)
Включить/выключить цветной вывод.
- включено
- выключено
- автоматически
--no-sign-request (булево)
Не подписывать запросы. Кредиты не будут загружены, если этот аргумент предоставлен.
--ca-bundle (строка)
Набор сертификатов CA для использования при проверке сертификатов SSL. Переопределяет настройки конфигурации/среды.
--cli-read-timeout (целое число)
Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.
--cli-connect-timeout (целое число)
Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.
--cli-binary-format (строка)
Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены как закодированная в base64 строка. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, которое отображается как двоичный блок, fileb:// всегда будет обрабатываться как двоичный и будет использовать содержимое файла напрямую независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть правильно отформатировано для настроенного cli-binary-format.
- base64
- raw-in-base64-out
--no-cli-pager (булево)
Отключить пейджер CLI для вывода.
--cli-auto-prompt (булево)
Автоматически запросить параметры ввода CLI.
--no-cli-auto-prompt (булево)
Отключить автоматический запрос параметров ввода CLI.
Примеры
Примечание
Для использования следующих примеров вам необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве «Начало работы» в руководстве пользователя AWS CLI.
Если не указано иное, во всех примерах используются правила цитирования Unix-подобных систем. Эти примеры необходимо адаптировать к правилам цитирования вашей консоли. См. раздел Использование кавычек со строками в руководстве пользователя AWS CLI.
Пример 1: Создание кластера баз данных MySQL, совместимого с версией 5.7
Следующий create-db-cluster пример создаёт кластер баз данных MySQL, совместимый с версией 5.7, используя версию движка по умолчанию. Замените примерный пароль secret99 на безопасный пароль. При использовании консоли для создания кластера баз данных Amazon RDS автоматически создает экземпляр базы данных-писателя для вашего кластера баз данных. Однако при использовании AWS CLI для создания кластера баз данных вам необходимо явно создать экземпляр базы данных-писателя для вашего кластера баз данных, используя команду AWS CLI create-db-instance.
aws rds create-db-cluster \
--db-cluster-identifier sample-cluster \
--engine aurora-mysql \
--engine-version 5.7 \
--master-username admin \
--master-user-password secret99 \
--db-subnet-group-name default \
--vpc-security-group-ids sg-0b9130572daf3dc16
Вывод:
{
"DBCluster": {
"DBSubnetGroup": "default",
"VpcSecurityGroups": [
{
"VpcSecurityGroupId": "sg-0b9130572daf3dc16",
"Status": "active"
}
],
"AllocatedStorage": 1,
"AssociatedRoles": [],
"PreferredBackupWindow": "09:12-09:42",
"ClusterCreateTime": "2023-02-27T23:21:33.048Z",
"DeletionProtection": false,
"IAMDatabaseAuthenticationEnabled": false,
"ReadReplicaIdentifiers": [],
"EngineMode": "provisioned",
"Engine": "aurora-mysql",
"StorageEncrypted": false,
"MultiAZ": false,
"PreferredMaintenanceWindow": "mon:04:31-mon:05:01",
"HttpEndpointEnabled": false,
"BackupRetentionPeriod": 1,
"DbClusterResourceId": "cluster-ANPAJ4AE5446DAEXAMPLE",
"DBClusterIdentifier": "sample-cluster",
"AvailabilityZones": [
"us-east-1a",
"us-east-1b",
"us-east-1e"
],
"MasterUsername": "master",
"EngineVersion": "5.7.mysql_aurora.2.11.1",
"DBClusterArn": "arn:aws:rds:us-east-1:123456789012:cluster:sample-cluster",
"DBClusterMembers": [],
"Port": 3306,
"Status": "creating",
"Endpoint": "sample-cluster.cluster-cnpexample.us-east-1.rds.amazonaws.com",
"DBClusterParameterGroup": "default.aurora-mysql5.7",
"HostedZoneId": "Z2R2ITUGPM61AM",
"ReaderEndpoint": "sample-cluster.cluster-ro-cnpexample.us-east-1.rds.amazonaws.com",
"CopyTagsToSnapshot": false
}
}
Пример 2: Создание кластера баз данных PostgreSQL
Следующий create-db-cluster пример создаёт кластер баз данных PostgreSQL, используя версию движка по умолчанию. Замените примерный пароль secret99 на безопасный пароль. При использовании консоли для создания кластера баз данных Amazon RDS автоматически создает экземпляр базы данных-писателя для вашего кластера баз данных. Однако при использовании AWS CLI для создания кластера баз данных вам необходимо явно создать экземпляр базы данных-писателя для вашего кластера баз данных, используя команду AWS CLI create-db-instance.
aws rds create-db-cluster \
--db-cluster-identifier sample-pg-cluster \
--engine aurora-postgresql \
--master-username master \
--master-user-password secret99 \
--db-subnet-group-name default \
--vpc-security-group-ids sg-0b9130572daf3dc16
Вывод:
{
"DBCluster": {
"Endpoint": "sample-pg-cluster.cluster-cnpexample.us-east-1.rds.amazonaws.com",
"HttpEndpointEnabled": false,
"DBClusterMembers": [],
"EngineMode": "provisioned",
"CopyTagsToSnapshot": false,
"HostedZoneId": "Z2R2ITUGPM61AM",
"IAMDatabaseAuthenticationEnabled": false,
"AllocatedStorage": 1,
"VpcSecurityGroups": [
{
"VpcSecurityGroupId": "sg-0b9130572daf3dc16",
"Status": "active"
}
],
"DeletionProtection": false,
"StorageEncrypted": false,
"BackupRetentionPeriod": 1,
"PreferredBackupWindow": "09:56-10:26",
"ClusterCreateTime": "2023-02-27T23:26:08.371Z",
"DBClusterParameterGroup": "default.aurora-postgresql13",
"EngineVersion": "13.7",
"Engine": "aurora-postgresql",
"Status": "creating",
"DBClusterIdentifier": "sample-pg-cluster",
"MultiAZ": false,
"Port": 5432,
"DBClusterArn": "arn:aws:rds:us-east-1:123456789012:cluster:sample-pg-cluster",
"AssociatedRoles": [],
"DbClusterResourceId": "cluster-ANPAJ4AE5446DAEXAMPLE",
"PreferredMaintenanceWindow": "wed:03:33-wed:04:03",
"ReaderEndpoint": "sample-pg-cluster.cluster-ro-cnpexample.us-east-1.rds.amazonaws.com",
"MasterUsername": "master",
"AvailabilityZones": [
"us-east-1a",
"us-east-1b",
"us-east-1c"
],
"ReadReplicaIdentifiers": [],
"DBSubnetGroup": "default"
}
}
Дополнительную информацию см. в разделе Создание кластера баз данных Amazon Aurora в руководстве Amazon Aurora User Guide.
Вывод
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 см. в разделе Многозонные развертывания с двумя резервными экземплярами базы данных с возможностью чтения в руководстве пользователя Amazon RDS.
AllocatedStorage -> (целое число)
AllocatedStorage указывает размер выделенного хранилища в гигабайтах (GiB). Для Aurora, AllocatedStorage может меняться, так как размер хранилища кластера баз данных Aurora корректируется по мере необходимости.AvailabilityZones -> (список)
Список зон доступности (AZ), где можно создать экземпляры в кластере баз данных.
(строка)
BackupRetentionPeriod -> (целое число)
CharacterSetName -> (строка)
DatabaseName -> (строка)
DBClusterIdentifier -> (строка)
DBClusterParameterGroup -> (строка)
DBSubnetGroup -> (строка)
Status -> (строка)
AutomaticRestartTime -> (метка времени)
PercentProgress -> (строка)
EarliestRestorableTime -> (метка времени)
Endpoint -> (строка)
ReaderEndpoint -> (строка)
Точка подключения для чтения для кластера баз данных. Точка подключения для чтения кластера баз данных распределяет подключения по репликам Aurora, доступным в кластере баз данных. При запросе новых подключений клиентами Aurora распределяет запросы подключения между репликами Aurora в кластере баз данных. Это может помочь сбалансировать вашу рабочую нагрузку чтения по нескольким репликам Aurora в вашем кластере баз данных.
Если происходит сбой, и реплика Aurora, к которой вы подключены, повышается до первичного экземпляра, ваше подключение прерывается. Чтобы продолжить отправку рабочей нагрузки чтения на другие реплики Aurora в кластере, вы можете снова подключиться к точке подключения для чтения.
CustomEndpoints -> (список)
Настраиваемые точки подключения, связанные с кластером баз данных.
(строка)
MultiAZ -> (булево значение)
Engine -> (строка)
EngineVersion -> (строка)
LatestRestorableTime -> (метка времени)
Port -> (целое число)
MasterUsername -> (строка)
DBClusterOptionGroupMemberships -> (список)
Список членств в группах параметров для этого кластера баз данных.
(структура)
Содержит информацию о состоянии группы параметров кластера баз данных.
DBClusterOptionGroupName -> (строка)
Status -> (строка)
PreferredBackupWindow -> (строка)
BackupRetentionPeriod .PreferredMaintenanceWindow -> (строка)
ReplicationSourceIdentifier -> (строка)
ReadReplicaIdentifiers -> (список)
Содержит один или несколько идентификаторов реплик чтения, связанных с этим кластером баз данных.
(строка)
StatusInfos -> (список)
Зарезервировано для будущего использования.
(структура)
Зарезервировано для будущего использования.
StatusType -> (строка)
Normal -> (булево значение)
Status -> (строка)
Message -> (строка)
DBClusterMembers -> (список)
Список экземпляров баз данных, составляющих кластер баз данных.
(структура)
Содержит информацию об экземпляре, входящем в состав кластера баз данных.
DBInstanceIdentifier -> (строка)
IsClusterWriter -> (булево значение)
DBClusterParameterGroupStatus -> (строка)
PromotionTier -> (целое число)
VpcSecurityGroups -> (список)
Список групп безопасности VPC, к которым принадлежит кластер баз данных.
(структура)
Этот тип данных используется в качестве элемента ответа для запросов о членстве в группе безопасности VPC.
VpcSecurityGroupId -> (строка)
Status -> (строка)
Статус членства в группе безопасности VPC.
В настоящее время единственный допустимый статус — active .
HostedZoneId -> (строка)
StorageEncrypted -> (булево значение)
KmsKeyId -> (строка)
Если StorageEncrypted включен, идентификатор ключа KMS Amazon Web Services для зашифрованного кластера баз данных.
Идентификатор ключа KMS Amazon Web Services — это ARN ключа, идентификатор ключа, ARN псевдонима или имя псевдонима для ключа KMS.
DbClusterResourceId -> (строка)
DBClusterArn -> (строка)
AssociatedRoles -> (список)
Список ролей управления доступом и идентификацией (IAM) Amazon Web Services, связанных с кластером баз данных. Роли IAM, связанные с кластером баз данных, предоставляют разрешения кластеру баз данных для доступа к другим службам Amazon Web Services от вашего имени.
(структура)
Описание роли управления доступом и идентификацией (IAM) Amazon Web Services, связанной с кластером баз данных.
RoleArn -> (строка)
Status -> (строка)
Описание состояния связи между ролью IAM и кластером баз данных. Свойство Status возвращает одно из следующих значений:
-
ACTIVE— ARN роли IAM связан с кластером баз данных и может использоваться для доступа к другим службам Amazon Web Services от вашего имени. -
PENDING— ARN роли IAM связывается с кластером баз данных. -
INVALID— ARN роли IAM связан с кластером баз данных, но кластер баз данных не может принять роль IAM для доступа к другим службам Amazon Web Services от вашего имени.
FeatureName -> (строка)
IAMDatabaseAuthenticationEnabled -> (булево значение)
CloneGroupId -> (строка)
Идентификатор группы клонов, с которой связан кластер баз данных. Для вновь созданных кластеров идентификатор, как правило, равен null.
Если вы клонируете кластер баз данных, когда идентификатор равен null, операция заполняет значение идентификатора для исходного кластера и клона, поскольку оба кластера становятся частью одной группы клонов. Даже если вы удалите клонированный кластер, идентификатор группы клонов остается на протяжении всего жизненного цикла исходного кластера, чтобы показать, что он использовался в операции клонирования.
Для восстановления по состоянию на определенный момент времени идентификатор группы клонов наследуется от исходного кластера. Для операций восстановления по снимку идентификатор группы клонов не наследуется от исходного кластера.
ClusterCreateTime -> (метка времени)
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 -> (целое число)
serverless.MaxCapacity -> (целое число)
serverless.AutoPause -> (булево)
Указывает, разрешено ли автоматическое приостановление работы кластера баз данных Aurora в режиме работы serverless.
Если значение установлено в false для кластера баз данных Aurora Serverless v1, кластер автоматически возобновляет работу.
SecondsUntilAutoPause -> (целое число)
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, используемый для шифрования сообщений в потоке событий активности базы данных.
Идентификатор ключа KMS Amazon Web Services — это ARN ключа, идентификатор ключа, ARN псевдонима или имя псевдонима для ключа KMS.
ActivityStreamKinesisStreamName -> (строка)
CopyTagsToSnapshot -> (булево)
CrossAccountClone -> (булево)
DomainMemberships -> (список)
Записи членства в домене Active Directory, связанные с кластером баз данных.
(структура)
Запись членства в домене Active Directory, связанная с экземпляром или кластером баз данных.
Domain -> (строка)
Status -> (строка)
joined, pending-join, failed и т.д.FQDN -> (строка)
IAMRoleName -> (строка)
OU -> (строка)
AuthSecretArn -> (строка)
DnsIps -> (список)
IP-адреса IPv4 DNS первичных и вторичных контроллеров домена Active Directory.
(строка)
TagList -> (список)
Список меток.
Дополнительную информацию см. в разделе Оснащение ресурсов Amazon RDS метками в руководстве Amazon RDS User Guide или Оснащение ресурсов Amazon Aurora и Amazon RDS метками в руководстве Amazon Aurora User Guide.
(структура)
Метки, назначенные ресурсу Amazon RDS, представляющие собой пару ключ-значение.
Дополнительную информацию см. в разделе Оснащение ресурсов Amazon RDS метками в руководстве Amazon RDS User Guide или Оснащение ресурсов Amazon Aurora и Amazon RDS метками в руководстве Amazon Aurora User Guide.
Key -> (строка)
aws: или rds:. Строка может содержать только набор символов Юникода, цифр, пробелов, ‘_’, ‘.’, ‘:’, ‘/’, ‘=’, ‘+’, ‘-’, ‘@’ (регулярное выражение Java: “^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$”).Value -> (строка)
aws: или rds:. Строка может содержать только набор символов Юникода, цифр, пробелов, ‘_’, ‘.’, ‘:’, ‘/’, ‘=’, ‘+’, ‘-’, ‘@’ (регулярное выражение Java: “^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$”).GlobalWriteForwardingStatus -> (строка)
GlobalWriteForwardingRequested -> (булево)
GlobalWriteForwardingStatus, чтобы убедиться, что запрос завершен, прежде чем использовать функцию перенаправления записи для этого кластера.PendingModifiedValues -> (структура)
Информация о предстоящих изменениях в кластере баз данных. Эта информация возвращается только при наличии ожидающих изменений. Конкретные изменения определяются подэлементами.
PendingCloudwatchLogsExports -> (структура)
Список типов логов, конфигурация которых все еще находится в ожидании. Другими словами, эти типы логов находятся в процессе активации или деактивации.
LogTypesToEnable -> (список)
Типы логов, которые находятся в процессе деактивации. После деактивации эти типы логов не экспортируются в CloudWatch Logs.
(строка)
LogTypesToDisable -> (список)
Типы логов, которые находятся в процессе активации. После активации эти типы логов экспортируются в CloudWatch Logs.
(строка)
DBClusterIdentifier -> (строка)
MasterUserPassword -> (строка)
IAMDatabaseAuthenticationEnabled -> (булево)
EngineVersion -> (строка)
BackupRetentionPeriod -> (целое число)
AllocatedStorage -> (целое число)
AllocatedStorage всегда возвращает 1, потому что размер хранилища кластера Aurora DB не фиксирован, а автоматически настраивается по мере необходимости.RdsCustomClusterConfiguration -> (структура)
Зарезервировано для будущего использования.
InterconnectSubnetId -> (строка)
TransitGatewayMulticastDomainId -> (строка)
ReplicaMode -> (строка)
Iops -> (целое число)
StorageType -> (строка)
CertificateDetails -> (структура)
Подробная информация о сертификате сервера экземпляра базы данных.
Дополнительную информацию см. в разделе Использование SSL/TLS для шифрования подключения к экземпляру базы данных в руководстве Amazon RDS User Guide и Использование SSL/TLS для шифрования подключения к кластеру баз данных в руководстве Amazon Aurora User Guide.
CAIdentifier -> (строка)
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 и многозонных кластеров баз данных.
Дополнительную информацию об автоматическом обновлении дополнительных версий см. в разделе Автоматическое обновление дополнительной версии движка .
MonitoringInterval -> (integer)
Интервал в секундах между точками, в которых собираются метрики мониторинга с расширенной функциональностью для кластера баз данных.
Эта настройка предназначена только для кластеров баз данных Aurora и многозонных кластеров баз данных.
MonitoringRoleArn -> (string)
ARN для роли IAM, которая разрешает RDS отправлять метрики расширенного мониторинга в Amazon CloudWatch Logs.
Эта настройка предназначена только для кластеров баз данных Aurora и многозонных кластеров баз данных.
DatabaseInsightsMode -> (string)
PerformanceInsightsEnabled -> (boolean)
Указывает, включен ли Performance Insights для кластера баз данных.
Эта настройка предназначена только для кластеров баз данных Aurora и многозонных кластеров баз данных.
PerformanceInsightsKMSKeyId -> (string)
Идентификатор ключа Amazon Web Services KMS для шифрования данных Performance Insights.
Идентификатор ключа Amazon Web Services KMS — это ARN ключа, идентификатор ключа, ARN псевдонима или имя псевдонима для ключа KMS.
Эта настройка предназначена только для кластеров баз данных Aurora и многозонных кластеров баз данных.
PerformanceInsightsRetentionPeriod -> (integer)
Количество дней для сохранения данных Performance Insights.
Эта настройка предназначена только для кластеров баз данных Aurora и многозонных кластеров баз данных.
Допустимые значения:
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)
MaxCapacity -> (double)
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)
SecretStatus -> (string)
Состояние секрета.
Возможные значения состояний включают следующие:
-
creating— секрет создается. -
active— секрет доступен для обычного использования и ротации. -
rotating— секрет ротируется. -
impaired— секрет может использоваться для доступа к учетным данным базы данных, но его нельзя ротировать. Секрет может иметь это состояние, например, если права изменены таким образом, что RDS больше не может получить доступ ни к секрету, ни к ключу KMS для секрета. Когда у секрета есть это состояние, вы можете исправить условие, которое вызвало это состояние. В качестве альтернативы, измените экземпляр базы данных, чтобы отключить автоматическое управление учетными данными базы данных, а затем измените экземпляр базы данных еще раз, чтобы включить автоматическое управление учетными данными базы данных.
KmsKeyId -> (string)
IOOptimizedNextAllowedModificationTime -> (timestamp)
Следующее время, когда вы можете изменить кластер баз данных для использования типа хранилища aurora-iopt1.
Эта настройка предназначена только для кластеров баз данных Aurora.
LocalWriteForwardingStatus -> (string)
AwsBackupRecoveryPointArn -> (string)
LimitlessDatabase -> (structure)
Детали для Aurora Limitless Database.
Status -> (string)
MinRequiredACU -> (double)
StorageThroughput -> (integer)
Пропускная способность хранилища для кластера баз данных. Пропускная способность автоматически настраивается на основе предоставляемых IOPS и не является настраиваемой.
Эта настройка предназначена только для многозонных кластеров баз данных, не являющихся Aurora.
ClusterScalabilityType -> (string)
limitless кластер работает как Aurora Limitless Database. При установке значения standard (значение по умолчанию) кластер использует обычное создание экземпляров баз данных.CertificateDetails -> (structure)
Сведения о сертификате сервера экземпляра базы данных.
Дополнительную информацию см. в разделах Использование SSL/TLS для шифрования подключения к экземпляру базы данных в руководстве пользователя Amazon RDS и Использование SSL/TLS для шифрования подключения к кластеру баз данных в руководстве пользователя Amazon Aurora.
CAIdentifier -> (string)
ValidTill -> (timestamp)
EngineLifecycleSupport -> (string)
Тип жизненного цикла для кластера баз данных.
Дополнительную информацию см. в CreateDBCluster.
© Copyright 2025, Amazon Web Services. Created using Sphinx.