describe-db-clusters

Описание

Описывает существующие кластеры баз данных Amazon Aurora и кластеры баз данных Multi-AZ. Данный API поддерживает пагинацию.

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

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

Данная операция также может возвращать информацию о экземплярах баз данных Amazon Neptune и Amazon DocumentDB.

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

describe-db-clusters является операцией с пагинацией. Для получения всего набора результатов может потребоваться несколько вызовов API. Вы можете отключить пагинацию, предоставив аргумент --no-paginate. При использовании --output text и аргумента --query для ответа с пагинацией, аргумент --query должен извлекать данные из результатов следующих выражений запросов: DBClusters

Синтаксис

  describe-db-clusters
[--db-cluster-identifier <value>]
[--filters <value>]
[--include-shared | --no-include-shared]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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 (строка)

Идентификатор кластера базы данных, предоставленный пользователем, или Amazon Resource Name (ARN) кластера базы данных. Если этот параметр указан, возвращается информация только для указанного кластера базы данных. Этот параметр нечувствителен к регистру.

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

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

--filters (список)

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

Поддерживаемые фильтры:

clone-group-id — Принимает идентификаторы групп клонов. В списке результатов будет отображаться только информация о кластерах баз данных, связанных с этими группами клонов.
db-cluster-id — Принимает идентификаторы кластеров баз данных и Amazon Resource Names (ARN) кластеров баз данных. В списке результатов будет отображаться только информация о кластерах баз данных, идентифицированных этими ARN.
db-cluster-resource-id — Принимает идентификаторы ресурсов кластера базы данных. В списке результатов будут отображаться только сведения о кластерах баз данных, идентифицированных по этим идентификаторам ресурсов кластера базы данных.
domain — Принимает идентификаторы каталогов Active Directory. В списке результатов будет отображаться только информация о кластерах баз данных, связанных с этими доменами.
engine — Принимает имена движков. В списке результатов отображается информация только о кластерах баз данных для этих движков.

(структура)

Пара имя-значение фильтра, используемая для возврата более конкретного списка результатов из операции describe. Фильтры могут использоваться для сопоставления набора ресурсов по определённым критериям, таким как идентификаторы. Поддерживаемые фильтры операции describe документированы в описании операции.

Примечание

В настоящее время в фильтрах не поддерживаются подстановочные знаки.

Можно фильтровать следующие действия:

DescribeDBClusterBacktracks
DescribeDBClusterEndpoints
DescribeDBClusters
DescribeDBInstances
DescribeDBRecommendations
DescribeDBShardGroups
DescribePendingMaintenanceActions

Имя -> (строка)

Имя фильтра. Имена фильтров чувствительны к регистру.

Значения -> (список)

Одно или несколько значений фильтра. Значения фильтров чувствительны к регистру.

(строка)

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

Name=string,Values=string,string ...

Синтаксис JSON:

[
  {
    "Name": "string",
    "Values": ["string", ...]
  }
  ...
]

--include-shared | --no-include-shared (булево)

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

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

--starting-token (строка)

Маркер для указания точки начала пагинации. Это NextToken из ранее усечённого ответа.

Примеры использования см. в разделе Пагинация в Руководстве пользователя AWS Command Line Interface.

--page-size (целое число)

Размер каждой страницы для получения данных в вызове службы AWS. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов службы AWS, получая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов службы AWS.

Примеры использования см. в разделе Пагинация в Руководстве пользователя AWS Command Line Interface.

--max-items (целое число)

Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов превышает указанное значение, в выводе команды предоставляется NextToken. Для продолжения пагинации предоставьте значение NextToken в аргументе starting-token последующей команды. **Не** используйте элемент ответа NextToken непосредственно вне AWS CLI.

Примеры использования см. в разделе Пагинация в Руководстве пользователя AWS Command Line Interface.

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

Регион для использования. Переопределяет настройки config/env.

--version (строка)

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

--color (строка)

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

on
off
auto

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

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

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

Файл сертификатов CA для использования при проверке сертификатов SSL. Переопределяет настройки config/env.

--cli-read-timeout (int)

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

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение установлено в 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.

Примеры

Примечание

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

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

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

Следующий пример describe-db-clusters извлекает подробные сведения об указанном кластере базы данных.

aws rds describe-db-clusters \
    --db-cluster-identifier mydbcluster

Вывод:

{
    "DBClusters": [
        {
            "AllocatedStorage": 1,
            "AvailabilityZones": [
                "us-east-1a",
                "us-east-1b",
                "us-east-1e"
            ],
            "BackupRetentionPeriod": 1,
            "DatabaseName": "mydbcluster",
            "DBClusterIdentifier": "mydbcluster",
            "DBClusterParameterGroup": "default.aurora-mysql5.7",
            "DBSubnetGroup": "default",
            "Status": "available",
            "EarliestRestorableTime": "2019-06-19T09:16:28.210Z",
            "Endpoint": "mydbcluster.cluster-cnpexample.us-east-1.rds.amazonaws.com",
            "ReaderEndpoint": "mydbcluster.cluster-ro-cnpexample.us-east-1.rds.amazonaws.com",
            "MultiAZ": true,
            "Engine": "aurora-mysql",
            "EngineVersion": "5.7.mysql_aurora.2.04.2",
            "LatestRestorableTime": "2019-06-20T22:38:14.908Z",
            "Port": 3306,
            "MasterUsername": "myadmin",
            "PreferredBackupWindow": "09:09-09:39",
            "PreferredMaintenanceWindow": "sat:04:09-sat:04:39",
            "ReadReplicaIdentifiers": [],
            "DBClusterMembers": [
                {
                    "DBInstanceIdentifier": "dbinstance3",
                    "IsClusterWriter": false,
                    "DBClusterParameterGroupStatus": "in-sync",
                    "PromotionTier": 1
                },
                {
                    "DBInstanceIdentifier": "dbinstance1",
                    "IsClusterWriter": false,
                    "DBClusterParameterGroupStatus": "in-sync",
                    "PromotionTier": 1
                },
                {
                    "DBInstanceIdentifier": "dbinstance2",
                    "IsClusterWriter": false,
                    "DBClusterParameterGroupStatus": "in-sync",
                    "PromotionTier": 1
                },
                {
                    "DBInstanceIdentifier": "mydbcluster",
                    "IsClusterWriter": false,
                    "DBClusterParameterGroupStatus": "in-sync",
                    "PromotionTier": 1
                },
                {
                    "DBInstanceIdentifier": "mydbcluster-us-east-1b",
                    "IsClusterWriter": false,
                    "DBClusterParameterGroupStatus": "in-sync",
                    "PromotionTier": 1
                },
                {
                    "DBInstanceIdentifier": "mydbcluster",
                    "IsClusterWriter": true,
                    "DBClusterParameterGroupStatus": "in-sync",
                    "PromotionTier": 1
                }
            ],
            "VpcSecurityGroups": [
                {
                    "VpcSecurityGroupId": "sg-0b9130572daf3dc16",
                    "Status": "active"
                }
            ],
            "HostedZoneId": "Z2R2ITUGPM61AM",
            "StorageEncrypted": true,
            "KmsKeyId": "arn:aws:kms:us-east-1:814387698303:key/AKIAIOSFODNN7EXAMPLE",
            "DbClusterResourceId": "cluster-AKIAIOSFODNN7EXAMPLE",
            "DBClusterArn": "arn:aws:rds:us-east-1:123456789012:cluster:mydbcluster",
            "AssociatedRoles": [],
            "IAMDatabaseAuthenticationEnabled": false,
            "ClusterCreateTime": "2019-04-15T14:18:42.785Z",
            "EngineMode": "provisioned",
            "DeletionProtection": false,
            "HttpEndpointEnabled": false
        }
    ]
}

Пример 2: Вывод определенных атрибутов всех кластеров баз данных

Следующий пример describe-db-clusters извлекает только атрибуты DBClusterIdentifier, Endpoint и ReaderEndpoint всех ваших кластеров баз данных в текущем регионе AWS.

aws rds describe-db-clusters \
    --query 'DBClusters[].{DBClusterIdentifier:DBClusterIdentifier,Endpoint:Endpoint,ReaderEndpoint:ReaderEndpoint}'

Вывод:

[
    {
        "Endpoint": "cluster-57-2020-05-01-2270.cluster-cnpexample.us-east-1.rds.amazonaws.com",
        "ReaderEndpoint": "cluster-57-2020-05-01-2270.cluster-ro-cnpexample.us-east-1.rds.amazonaws.com",
        "DBClusterIdentifier": "cluster-57-2020-05-01-2270"
    },
    {
        "Endpoint": "cluster-57-2020-05-01-4615.cluster-cnpexample.us-east-1.rds.amazonaws.com",
        "ReaderEndpoint": "cluster-57-2020-05-01-4615.cluster-ro-cnpexample.us-east-1.rds.amazonaws.com",
        "DBClusterIdentifier": "cluster-57-2020-05-01-4615"
    },
    {
        "Endpoint": "pg2-cluster.cluster-cnpexample.us-east-1.rds.amazonaws.com",
        "ReaderEndpoint": "pg2-cluster.cluster-ro-cnpexample.us-east-1.rds.amazonaws.com",
        "DBClusterIdentifier": "pg2-cluster"
    },
    ...output omitted...
    }
]

Пример 3: Вывод кластеров баз данных с определенным атрибутом

Следующий пример describe-db-clusters извлекает только атрибуты DBClusterIdentifier и Engine ваших кластеров баз данных, использующих движок базы данных aurora-postgresql.

aws rds describe-db-clusters \
    --query 'DBClusters[].{DBClusterIdentifier:DBClusterIdentifier,Engine:Engine} | [?Engine == `aurora-postgresql`]'

Вывод:

[
    {
        "Engine": "aurora-postgresql",
        "DBClusterIdentifier": "pg2-cluster"
    }
]

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

Выходные данные

Маркер -> (строка)

Токен постраничной навигации, который может быть использован в последующем запросе.

DBClusters -> (список)

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

(структура)

Содержит сведения о кластере баз данных 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 -> (строка)

Точка подключения для чтения (reader endpoint) для кластера баз данных. Точка подключения для чтения для кластера баз данных распределяет подключения между репликами 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 всякий раз, когда к ключу шифрования для кластера баз данных осуществляется доступ.

DBClusterArn -> (строка)

Идентификатор ресурса Amazon (ARN) для кластера баз данных.

AssociatedRoles -> (список)

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

(структура)

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

RoleArn -> (строка)

Идентификатор ресурса Amazon (ARN) роли IAM, связанной с кластером баз данных.

Status -> (строка)

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

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

FeatureName -> (строка)

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

IAMDatabaseAuthenticationEnabled -> (булево)

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

CloneGroupId -> (строка)

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

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

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

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

Время создания кластера баз данных во всемирном координированном времени (UTC).

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

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

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

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

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

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

EnabledCloudwatchLogsExports -> (список)

Список типов журналов, которые этот кластер баз данных настроен на экспорт в CloudWatch Logs.

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

(строка)

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

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

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

EngineMode -> (строка)

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

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

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

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

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

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

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

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

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

AutoPause -> (булево)

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

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

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

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

TimeoutAction -> (строка)

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

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

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

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

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

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

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

InterconnectSubnetId -> (строка)

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

TransitGatewayMulticastDomainId -> (строка)

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

ReplicaMode -> (строка)

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

DeletionProtection -> (булево)

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

HttpEndpointEnabled -> (булево)

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

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

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

ActivityStreamMode -> (строка)

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

ActivityStreamStatus -> (строка)

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

ActivityStreamKmsKeyId -> (строка)

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

Идентификатор ключа Amazon Web Services KMS — это ARN ключа, ID ключа, 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-адреса DNS IPv4 первичных и вторичных контроллеров домена Active Directory.

(строка)

TagList -> (список)

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

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

(структура)

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

Key -> (строка)

Ключ — это требуемое имя тега. Строковое значение может иметь длину от 1 до 128 символов Юникода и не может начинаться с aws: или rds:. Строка может содержать только набор символов Юникода, цифр, пробелов, «_», «.», «:», «/», «=», «+», «-», «@» (регулярное выражение Java: “^([\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 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 -> (строка)

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. Для версий, не поддерживающих автоматическую паузу, минимальное значение равно 0,5.

MaxCapacity -> (вещественное число)

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