восстановление-кластера-баз-данных-в-точку-времени

Описание

Восстанавливает кластер баз данных в произвольную точку во времени. Пользователи могут восстановить до любой точки времени до LatestRestorableTime в течение максимум BackupRetentionPeriod дней. Целевой кластер баз данных создается из исходного кластера баз данных с такой же конфигурацией, как у исходного кластера баз данных, за исключением того, что новый кластер баз данных создается с группой безопасности по умолчанию для баз данных. Если RestoreType не установлено в copy-on-write , восстановление может произойти в другой зоне доступности (AZ) по сравнению с исходным кластером баз данных. AZ, в которой RDS восстанавливает кластер баз данных, зависит от AZ в указанной группе подсетей.

Примечание

Для Aurora эта операция восстанавливает только кластер баз данных, а не экземпляры баз данных для этого кластера баз данных. Вы должны вызвать операцию CreateDBInstance, чтобы создать экземпляры баз данных для восстановленного кластера баз данных, указав идентификатор восстановленного кластера баз данных в DBClusterIdentifier . Вы можете создать экземпляры баз данных только после завершения операции RestoreDBClusterToPointInTime и готовности кластера баз данных.

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

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

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

Синтаксис

  restore-db-cluster-to-point-in-time
--db-cluster-identifier <value>
[--restore-type <value>]
[--source-db-cluster-identifier <value>]
[--restore-to-time <value>]
[--use-latest-restorable-time | --no-use-latest-restorable-time]
[--port <value>]
[--db-subnet-group-name <value>]
[--option-group-name <value>]
[--vpc-security-group-ids <value>]
[--tags <value>]
[--kms-key-id <value>]
[--enable-iam-database-authentication | --no-enable-iam-database-authentication]
[--backtrack-window <value>]
[--enable-cloudwatch-logs-exports <value>]
[--db-cluster-parameter-group-name <value>]
[--deletion-protection | --no-deletion-protection]
[--copy-tags-to-snapshot | --no-copy-tags-to-snapshot]
[--domain <value>]
[--domain-iam-role-name <value>]
[--scaling-configuration <value>]
[--engine-mode <value>]
[--db-cluster-instance-class <value>]
[--storage-type <value>]
[--publicly-accessible | --no-publicly-accessible]
[--iops <value>]
[--serverless-v2-scaling-configuration <value>]
[--network-type <value>]
[--source-db-cluster-resource-id <value>]
[--rds-custom-cluster-configuration <value>]
[--monitoring-interval <value>]
[--monitoring-role-arn <value>]
[--enable-performance-insights | --no-enable-performance-insights]
[--performance-insights-kms-key-id <value>]
[--performance-insights-retention-period <value>]
[--engine-lifecycle-support <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 (строка)

Имя нового кластера БД, который будет создан.

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

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

Применимо к: кластерам БД Aurora и кластерам БД Multi-AZ

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

Тип операции восстановления. Можно указать одно из следующих значений:

full-copy - Новый кластер БД восстанавливается как полная копия исходного кластера БД.
copy-on-write - Новый кластер БД восстанавливается как клон исходного кластера БД.

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

Применимо к: кластерам БД Aurora и кластерам БД Multi-AZ

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

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

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

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

Применимо к: кластерам БД Aurora и кластерам БД Multi-AZ

--restore-to-time (метка времени)

Дата и время восстановления кластера БД.

Допустимые значения: значение должно быть временем в формате Всемирного координированного времени (UTC)

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

Должно быть раньше последнего восстановимого времени для экземпляра БД
Должно быть указано, если параметр UseLatestRestorableTime не указан
Не может быть указано, если параметр UseLatestRestorableTime включен
Не может быть указано, если параметр RestoreType равен copy-on-write

Пример: 2015-03-07T23:45:00Z

Применимо к: кластерам БД Aurora и кластерам БД Multi-AZ

--use-latest-restorable-time | --no-use-latest-restorable-time (логическое значение)

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

Ограничения: не может быть указано, если указан параметр RestoreToTime.

Применимо к: кластерам БД Aurora и кластерам БД Multi-AZ

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

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

Ограничения: значение от 1150-65535 .

По умолчанию: порт по умолчанию для движка.

Применимо к: кластерам БД Aurora и кластерам БД Multi-AZ

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

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

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

Пример: mydbsubnetgroup

Применимо к: кластерам БД Aurora и кластерам БД Multi-AZ

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

Имя группы параметров для нового кластера БД.

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

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

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

Применимо к: кластерам БД Aurora и кластерам БД Multi-AZ

(строка)

Синтаксис:

"string" "string" ...

--tags (список)

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

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

(структура)

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

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

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

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

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

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

Key=string,Value=string ...

JSON-синтаксис:

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

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

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

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

Вы можете восстановить кластер БД в новый кластер и зашифровать новый кластер БД с помощью ключа KMS, отличного от ключа KMS, используемого для шифрования исходного кластера БД. Новый кластер БД шифруется ключом KMS, идентифицируемым параметром KmsKeyId.

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

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

Если DBClusterIdentifier относится к кластеру БД, который не зашифрован, то запрос на восстановление отклоняется.

Применимо к: кластерам БД Aurora и кластерам БД Multi-AZ

--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 и кластерам БД Multi-AZ

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

Целевое время отката, в секундах. Для отключения отката установите это значение в 0.

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

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

Если указано, это значение должно быть числом от 0 до 259200 (72 часа).

Применимо к: кластерам БД Aurora MySQL только

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

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

RDS для MySQL

Возможные значения — error , general , slowquery и iam-db-auth-error .

RDS для PostgreSQL

Возможные значения — postgresql , upgrade и iam-db-auth-error .

Aurora MySQL

Возможные значения — audit , error , general , instance , slowquery и iam-db-auth-error .

Aurora PostgreSQL

Возможные значения — instance , postgresql и iam-db-auth-error .

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

Применимо к: кластерам БД Aurora и кластерам БД Multi-AZ

(строка)

Синтаксис:

"string" "string" ...

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

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

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

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

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

Применимо к: кластерам БД Aurora и кластерам БД Multi-AZ

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

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

Применимо к: кластерам БД Aurora и кластерам БД Multi-AZ

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

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

Применимо к: кластерам БД Aurora и кластерам БД Multi-AZ

--domain (строка)

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

Для кластеров БД Amazon Aurora Amazon RDS может использовать аутентификацию Kerberos для аутентификации пользователей, которые подключаются к кластеру БД. Дополнительная информация: Аутентификация Kerberos в Руководстве пользователя Amazon Aurora.

Применимо к: кластерам БД Aurora только

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

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

Применимо к: кластерам БД Aurora только

--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, могут быть прерваны.

Дополнительную информацию см. в разделе Автомасштабирование для 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
}

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

Режим движка нового кластера. Укажите provisioned или serverless в зависимости от типа создаваемого кластера. Вы можете создать клон Aurora Serverless v1 из запрограммированного кластера или запрограммированный клон из кластера Aurora Serverless v1. Чтобы создать клон, который является кластером Aurora Serverless v1, исходный кластер должен быть кластером Aurora Serverless v1 или зашифрованным запрограммированным кластером. Чтобы создать полную копию, которая является кластером Aurora Serverless v1, укажите режим движка serverless .

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

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

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

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

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

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

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

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

Допустимые значения: aurora , aurora-iopt1 (кластеры Aurora DB); io1 (кластеры Multi-AZ DB)

Значение по умолчанию: aurora (кластеры Aurora DB); io1 (кластеры Multi-AZ DB)

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

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

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

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

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

Значение по умолчанию: поведение по умолчанию зависит от того, указано ли DBSubnetGroupName.

Если DBSubnetGroupName не указано, и PubliclyAccessible не указано, действует следующее:

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

Если DBSubnetGroupName указано, и PubliclyAccessible не указано, действует следующее:

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

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

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

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

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

Ограничения: Должно быть кратно от 0,5 до 50 хранилища для экземпляра БД.

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

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

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

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

MinCapacity -> (двойное число)

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

MaxCapacity -> (двойное число)

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

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

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

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

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

MinCapacity=double,MaxCapacity=double,SecondsUntilAutoPause=integer

Синтаксис JSON:

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

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

Тип сети кластера БД.

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

IPV4
DUAL

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

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

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

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

Идентификатор ресурса исходного кластера БД для восстановления.

--rds-custom-cluster-configuration (структура)

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

InterconnectSubnetId -> (строка)

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

TransitGatewayMulticastDomainId -> (строка)

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

ReplicaMode -> (строка)

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

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

InterconnectSubnetId=string,TransitGatewayMulticastDomainId=string,ReplicaMode=string

Синтаксис JSON:

{
  "InterconnectSubnetId": "string",
  "TransitGatewayMulticastDomainId": "string",
  "ReplicaMode": "open-read-only"|"mounted"
}

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

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

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

Допустимые значения: 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 .

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

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

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

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

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

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

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

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

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

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

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

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

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

--engine-lifecycle-support (строка)

Тип жизненного цикла для этого кластера БД.

Примечание

По умолчанию это значение установлено в open-source-rds-extended-support, что подключает ваш кластер БД к расширенной поддержке Amazon RDS. В конце стандартной поддержки вы можете избежать платы за расширенную поддержку, установив значение в open-source-rds-extended-support-disabled. В этом случае RDS автоматически повысит версию восстановленного кластера БД до более новой, если основная версия движка прошла дату окончания стандартной поддержки.

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

Amazon Aurora — Расширенная поддержка Amazon RDS с Amazon Aurora в руководстве пользователя Amazon Aurora
Amazon RDS — Расширенная поддержка Amazon RDS с Amazon RDS в руководстве пользователя Amazon RDS

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

Допустимые значения: open-source-rds-extended-support | open-source-rds-extended-support-disabled

По умолчанию: open-source-rds-extended-support

--cli-input-json | --cli-input-yaml (строка) Чтение аргументов из предоставленной строки JSON. Строка JSON следует формату, предоставленному --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения переопределят значения, предоставленные JSON. Невозможно передать произвольные двоичные значения с помощью предоставленного JSON-значения, так как строка будет взята буквально. Это может не быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса API. При отсутствии значения или значении input выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, при предоставлении yaml-input он выведет пример входного YAML, который можно использовать с --cli-input-yaml. При предоставлении значения output он валидирует входные данные команды и возвращает пример выходного JSON для этой команды. Сгенерированный JSON-скелет не стабилен между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.

Глобальные параметры

--debug (булево)

Включить отладку.

--endpoint-url (строка)

Переопределить URL по умолчанию команды заданным URL.

--no-verify-ssl (булево)

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

--no-paginate (булево)

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

--output (строка)

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

json
text
таблица
yaml
yaml-поток

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

включено
выключено
автоматически

--no-sign-request (булево)

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

--ca-bundle (строка)

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

--cli-read-timeout (целое число)

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

--cli-connect-timeout (целое число)

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

--cli-binary-format (строка)

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

base64
raw-in-base64-out

--no-cli-pager (булево)

Отключить пейджер CLI для вывода.

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

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

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

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

Примеры

Примечание

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

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

Восстановление кластера БД до указанного момента времени

Следующий restore-db-cluster-to-point-in-time пример восстанавливает кластер БД с именем database-4 до последнего возможного момента времени. Использование copy-on-write в качестве типа восстановления восстанавливает новый кластер БД как клон исходного кластера БД.

aws rds restore-db-cluster-to-point-in-time \
    --source-db-cluster-identifier database-4 \
    --db-cluster-identifier sample-cluster-clone \
    --restore-type copy-on-write \
    --use-latest-restorable-time

Вывод:

{
    "DBCluster": {
        "AllocatedStorage": 1,
        "AvailabilityZones": [
            "us-west-2c",
            "us-west-2a",
            "us-west-2b"
        ],
        "BackupRetentionPeriod": 7,
        "DatabaseName": "",
        "DBClusterIdentifier": "sample-cluster-clone",
        "DBClusterParameterGroup": "default.aurora-postgresql10",
        "DBSubnetGroup": "default",
        "Status": "creating",
        "Endpoint": "sample-cluster-clone.cluster-############.us-west-2.rds.amazonaws.com",
        "ReaderEndpoint": "sample-cluster-clone.cluster-ro-############.us-west-2.rds.amazonaws.com",
        "MultiAZ": false,
        "Engine": "aurora-postgresql",
        "EngineVersion": "10.7",
        "Port": 5432,
        "MasterUsername": "postgres",
        "PreferredBackupWindow": "09:33-10:03",
        "PreferredMaintenanceWindow": "sun:12:22-sun:12:52",
        "ReadReplicaIdentifiers": [],
        "DBClusterMembers": [],
        "VpcSecurityGroups": [
            {
                "VpcSecurityGroupId": "sg-########",
                "Status": "active"
            }
        ],
        "HostedZoneId": "Z1PVIF0EXAMPLE",
        "StorageEncrypted": true,
        "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/287364e4-33e3-4755-a3b0-a1b2c3d4e5f6",
        "DbClusterResourceId": "cluster-BIZ77GDSA2XBSTNPFW1EXAMPLE",
        "DBClusterArn": "arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster-clone",
        "AssociatedRoles": [],
        "IAMDatabaseAuthenticationEnabled": false,
        "CloneGroupId": "8d19331a-099a-45a4-b4aa-11aa22bb33cc44dd",
        "ClusterCreateTime": "2020-03-10T19:57:38.967Z",
        "EngineMode": "provisioned",
        "DeletionProtection": false,
        "HttpEndpointEnabled": false,
        "CopyTagsToSnapshot": false,
        "CrossAccountClone": false
    }
}

Дополнительную информацию см. в разделе Восстановление кластера БД до указанного момента времени в руководстве пользователя 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 Репликами, доступными в кластере БД. Когда клиенты запрашивают новые подключения к конечной точке чтения, Aurora распределяет запросы подключения среди Aurora Реплик в кластере БД. Эта функция может помочь сбалансировать рабочую нагрузку чтения между несколькими Aurora Репликами в вашем кластере БД.

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

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 Реплики до первичного экземпляра после сбоя существующего первичного экземпляра. Дополнительную информацию см. в разделе Сбойной толерантности для кластера Aurora БД в Руководстве пользователя Amazon Aurora.

VpcSecurityGroups -> (список)

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

(структура)

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

VpcSecurityGroupId -> (строка)

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

Status -> (строка)

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

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

HostedZoneId -> (строка)

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

StorageEncrypted -> (булево)

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

KmsKeyId -> (строка)

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

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

DbClusterResourceId -> (строка)

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

DBClusterArn -> (строка)

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

AssociatedRoles -> (список)

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

(структура)

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

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

Имя функции, связанной с ролью управления доступом и идентификацией Amazon Web Services (IAM). Дополнительную информацию о поддерживаемых именах функций см. в 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.

EngineMode -> (строка)

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

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

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

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

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

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.

ActivityStreamMode -> (строка)

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

ActivityStreamStatus -> (строка)

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

ActivityStreamKmsKeyId -> (строка)

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

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

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-адреса IPv4 DNS первичных и вторичных контроллеров домена Active Directory.

(строка)

TagList -> (список)

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

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

(структура)

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

Key -> (строка)

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

Value -> (строка)

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

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 (операций ввода-вывода в секунду). Эта настройка предназначена только для не-Aurora кластеров баз данных Multi-AZ.

StorageType -> (строка)

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

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

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

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

CAIdentifier -> (строка)

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

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

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

DBClusterInstanceClass -> (строка)

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

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

StorageType -> (строка)

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

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

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

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

PubliclyAccessible -> (булево)

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

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

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

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

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

AutoMinorVersionUpgrade -> (булево)

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

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

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

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

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

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

MonitoringRoleArn -> (строка)

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

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

DatabaseInsightsMode -> (строка)

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

PerformanceInsightsEnabled -> (булево)

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

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

PerformanceInsightsKMSKeyId -> (строка)

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

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

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

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

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

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

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

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

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

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

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

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

MinCapacity -> (двойное число)

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

MaxCapacity -> (двойное число)

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

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

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

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

NetworkType -> (строка)

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

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

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

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

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

DBSystemId -> (строка)

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

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

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

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

SecretArn -> (строка)

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

SecretStatus -> (строка)

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

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

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

KmsKeyId -> (строка)

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

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

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

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

LocalWriteForwardingStatus -> (строка)

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

AwsBackupRecoveryPointArn -> (строка)

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

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

Подробная информация о базе данных Aurora Limitless.

Status -> (строка)

Статус базы данных Aurora Limitless.

MinRequiredACU -> (двойное число)

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

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

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

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

ClusterScalabilityType -> (строка)

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

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

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

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

CAIdentifier -> (строка)

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

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

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

EngineLifecycleSupport -> (строка)

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

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