delete-db-cluster

Описание

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

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

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

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

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

Синтаксис

  delete-db-cluster
--db-cluster-identifier <value>
[--skip-final-snapshot | --no-skip-final-snapshot]
[--final-db-snapshot-identifier <value>]
[--delete-automated-backups | --no-delete-automated-backups]
[--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 (строка)

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

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

Должен соответствовать существующему DBClusterIdentifier.

--skip-final-snapshot | --no-skip-final-snapshot (логическое значение)

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

Примечание

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

--final-db-snapshot-identifier (строка)

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

Примечание

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

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

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

--delete-automated-backups | --no-delete-automated-backups (логическое значение)

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

--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 для вывода.

--cli-auto-prompt (логическое значение)

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

--no-cli-auto-prompt (логическое значение)

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

Примеры

Примечание

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

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

Пример 1: Удаление экземпляра базы данных в кластере баз данных

Следующий delete-db-instance пример удаляет последний экземпляр базы данных в кластере баз данных. Нельзя удалить кластер баз данных, если он содержит экземпляры баз данных, которые не находятся в состоянии удаления. Нельзя создавать окончательный снимок при удалении экземпляра базы данных в кластере баз данных.

aws rds delete-db-instance \
    --db-instance-identifier database-3

Вывод:

{
    "DBInstance": {
        "DBInstanceIdentifier": "database-3",
        "DBInstanceClass": "db.r4.large",
        "Engine": "aurora-postgresql",
        "DBInstanceStatus": "deleting",

    ...output omitted...

    }
}

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

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

Следующий delete-db-cluster пример удаляет кластер баз данных под названием mycluster и создает окончательный снимок под названием mycluster-final-snapshot. Состояние кластера баз данных — доступно, пока создается снимок. Чтобы отследить процесс удаления, используйте команду describe-db-clusters CLI.

aws rds delete-db-cluster \
    --db-cluster-identifier mycluster \
    --no-skip-final-snapshot \
    --final-db-snapshot-identifier mycluster-final-snapshot

Вывод:

{
    "DBCluster": {
        "AllocatedStorage": 20,
        "AvailabilityZones": [
            "eu-central-1b",
            "eu-central-1c",
            "eu-central-1a"
        ],
        "BackupRetentionPeriod": 7,
        "DBClusterIdentifier": "mycluster",
        "DBClusterParameterGroup": "default.aurora-postgresql10",
        "DBSubnetGroup": "default-vpc-aa11bb22",
        "Status": "available",

    ...output omitted...

    }
}

Дополнительную информацию см. в разделе Aurora Clusters с одним экземпляром базы данных в Руководстве пользователя 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 ключа, идентификатор ключа, ARN псевдонима или имя псевдонима для ключа KMS.

DbClusterResourceId -> (строка)

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

DBClusterArn -> (строка)

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

AssociatedRoles -> (список)

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

(структура)

Описание роли Amazon Web Services Identity and Access Management (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 Identity and Access Management (IAM). Сведения о поддерживаемых именах функций см. в разделе DBEngineVersion .

IAMDatabaseAuthenticationEnabled -> (булево)

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

CloneGroupId -> (строка)

Идентификатор группы клонирования, с которой связан кластер БД. Для вновь созданных кластеров ID обычно равен 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 -> (строка)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

TimeoutAction -> (строка)

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

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

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

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

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

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

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

InterconnectSubnetId -> (строка)

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

TransitGatewayMulticastDomainId -> (строка)

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

ReplicaMode -> (строка)

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

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

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

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

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

При включении 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: “^([\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 DB не фиксирован, а автоматически настраивается по мере необходимости.

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

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

InterconnectSubnetId -> (строка)

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

TransitGatewayMulticastDomainId -> (строка)

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

ReplicaMode -> (строка)

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

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

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

StorageType -> (строка)

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

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

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

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

CAIdentifier -> (строка)

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

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

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

DBClusterInstanceClass -> (строка)

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

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

StorageType -> (строка)

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

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

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

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

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

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

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

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

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

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

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

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

Это значение относится к кластерам Aurora DB и кластерам DB с несколькими зонами доступности.

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

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 ключа, ID ключа, ARN псевдонима или имя псевдонима для ключа KMS.

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

PerformanceInsightsRetentionPeriod -> (integer)

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

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

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

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

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

ServerlessV2ScalingConfiguration -> (structure)

Конфигурация масштабирования для кластера БД Aurora Serverless v2.

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

MinCapacity -> (double)

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

MaxCapacity -> (double)

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

SecondsUntilAutoPause -> (integer)

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

Это значение находится в диапазоне от 300 секунд (пять минут) до 86400 секунд (один день). По умолчанию — 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)

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

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

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.