failover-db-cluster

Описание

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

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

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

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

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

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

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

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

Синтаксис

  failover-db-cluster
--db-cluster-identifier <value>
[--target-db-instance-identifier <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

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

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

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

Должен соответствовать идентификатору существующего кластера баз данных.

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

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

Укажите идентификатор экземпляра базы данных для реплики Aurora или читаемого резервного экземпляра Multi-AZ в кластере баз данных, например mydbcluster-replica1.

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

--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
table
yaml
yaml-stream

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

on
off
auto

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

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

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

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

Вывод

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 включен, идентификатор ключа KMS Amazon Web Services для зашифрованного кластера баз данных.

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

DbClusterResourceId -> (строка)

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

DBClusterArn -> (строка)

Amazon Resource Name (ARN) для кластера баз данных.

AssociatedRoles -> (список)

Список ролей управления доступом и идентификацией 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.

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

Для восстановления в определенный момент времени (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 User Guide.

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

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

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

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

AutoPause -> (булево)

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

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

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

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

TimeoutAction -> (строка)

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

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

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

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

Количество секунд до истечения времени ожидания при масштабировании. Действие при истечении времени ожидания определяется параметром TimeoutAction.

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

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

InterconnectSubnetId -> (строка)

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

TransitGatewayMulticastDomainId -> (строка)

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

ReplicaMode -> (строка)

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

DeletionProtection -> (булево)

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

HttpEndpointEnabled -> (булево)

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

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

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

ActivityStreamMode -> (строка)

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

ActivityStreamStatus -> (строка)

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

ActivityStreamKmsKeyId -> (строка)

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

Идентификатор ключа 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 -> (список)

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

(строка)

TagList -> (список)

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

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

(структура)

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

Key -> (строка)

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

Value -> (строка)

Значение — это необязательное значение тега. Строковое значение может иметь длину от 1 до 256 символов Юникода и не может начинаться с aws: или rds:. Строка может содержать только набор символов Юникода, цифр, пробелов, ‘_’, ‘.’, ‘:’, ‘/’, ‘=’, ‘+’, ‘-’, ‘@’ (регулярное выражение Java: “^([\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 (операций ввода/вывода в секунду). Этот параметр относится только к кластерам баз данных Multi-AZ, не являющимся Aurora.

StorageType -> (строка)

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

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

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

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

CAIdentifier -> (строка)

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

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

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

DBClusterInstanceClass -> (строка)

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

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

StorageType -> (строка)

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

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

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

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

PubliclyAccessible -> (булево)

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

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

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

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

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

AutoMinorVersionUpgrade -> (булево)

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

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

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

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

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

Эта настройка применяется только для кластеров БД Aurora и кластеров БД Multi-AZ.

MonitoringRoleArn -> (string)

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

Эта настройка применяется только для кластеров БД Aurora и кластеров БД Multi-AZ.

DatabaseInsightsMode -> (string)

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

PerformanceInsightsEnabled -> (boolean)

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

Эта настройка применяется только для кластеров БД Aurora и кластеров БД Multi-AZ.

PerformanceInsightsKMSKeyId -> (string)

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

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

Эта настройка применяется только для кластеров БД Aurora и кластеров БД Multi-AZ.

PerformanceInsightsRetentionPeriod -> (integer)

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

Эта настройка применяется только для кластеров БД Aurora и кластеров БД Multi-AZ.

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

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

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

ServerlessV2ScalingConfiguration -> (structure)

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

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

MinCapacity -> (double)

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

MaxCapacity -> (double)

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

SecondsUntilAutoPause -> (integer)

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

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

NetworkType -> (string)

Тип сети экземпляра БД.

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

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

Эта настройка применяется только для кластеров БД Aurora.

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

DBSystemId -> (string)

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

MasterUserSecret -> (structure)

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

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

SecretArn -> (string)

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

SecretStatus -> (string)

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

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

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

KmsKeyId -> (string)

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

IOOptimizedNextAllowedModificationTime -> (timestamp)

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

Эта настройка применяется только для кластеров БД Aurora.

LocalWriteForwardingStatus -> (string)

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

AwsBackupRecoveryPointArn -> (string)

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

LimitlessDatabase -> (structure)

Детали для Aurora Limitless Database.

Status -> (string)

Статус Aurora Limitless Database.

MinRequiredACU -> (double)

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

StorageThroughput -> (integer)

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

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

ClusterScalabilityType -> (string)

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

CertificateDetails -> (structure)

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

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

CAIdentifier -> (string)

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

ValidTill -> (timestamp)

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

EngineLifecycleSupport -> (string)

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

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