Spec-Zone.ru › AWS CLI v2

[ aws . rds ]

stop-db-cluster

Описание

Останавливает кластер баз данных Amazon Aurora. При остановке кластера баз данных Aurora сохраняются метаданные кластера, включая его конечные точки и группы параметров БД. Aurora также сохраняет журналы транзакций, чтобы при необходимости можно было выполнить восстановление по состоянию на определённую точку времени.

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

Примечание

Данная операция применяется только к кластерам баз данных Aurora.

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

Синтаксис

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

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

--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 версии 1, и двоичные значения должны передаваться буквально. При передаче содержимого из файла, соответствующего двоичным данным, fileb:// всегда будет обрабатываться как двоичный, и будет использоваться содержимое файла напрямую независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть правильно отформатировано для заданной настройки cli-binary-format.

  • base64
  • raw-in-base64-out

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

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

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

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

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

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

Примеры

Примечание

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

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

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

Следующий stop-db-cluster пример останавливает кластер БД и его экземпляры БД.

aws rds stop-db-cluster \
    --db-cluster-identifier mydbcluster

Вывод:

{
    "DBCluster": {
        "AllocatedStorage": 1,
        "AvailabilityZones": [
            "us-east-1a",
            "us-east-1e",
            "us-east-1b"
        ],
        "BackupRetentionPeriod": 1,
        "DatabaseName": "mydb",
        "DBClusterIdentifier": "mydbcluster",
        ...some output truncated...
    }
}

Дополнительную информацию см. в разделе Остановка и запуск кластера Amazon Aurora DB в руководстве пользователя 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 размер хранилища кластера баз данных Aurora может изменяться по мере необходимости.

AvailabilityZones -> (список)

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

(строка)

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

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

CharacterSetName -> (строка)

При наличии указывает имя набора символов, связанного с этим кластером.

DatabaseName -> (строка)

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

DBClusterIdentifier -> (строка)

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

DBClusterParameterGroup -> (строка)

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

DBSubnetGroup -> (строка)

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

Status -> (строка)

Текущее состояние этого кластера баз данных.

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

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

PercentProgress -> (строка)

Прогресс операции в процентах.

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

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

Endpoint -> (строка)

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

ReaderEndpoint -> (строка)

Точка подключения для чтения для кластера баз данных. Точка подключения для чтения для кластера баз данных распределяет подключения между репликами Aurora, доступными в кластере баз данных. По мере запроса клиентами новых подключений к точке подключения для чтения Aurora распределяет запросы подключений среди реплик Aurora в кластере баз данных. Эта функция может помочь сбалансировать рабочую нагрузку чтения по нескольким репликам Aurora в вашем кластере баз данных.

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

CustomEndpoints -> (список)

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

(строка)

MultiAZ -> (булево)

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

Engine -> (строка)

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

EngineVersion -> (строка)

Версия системы управления базами данных.

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

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

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

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

MasterUsername -> (строка)

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

DBClusterOptionGroupMemberships -> (список)

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

(структура)

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

DBClusterOptionGroupName -> (строка)

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

Status -> (строка)

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

PreferredBackupWindow -> (строка)

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

PreferredMaintenanceWindow -> (строка)

Еженедельный диапазон времени, в течение которого может выполняться техническое обслуживание системы, в универсальном координированном времени (UTC).

ReplicationSourceIdentifier -> (строка)

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

ReadReplicaIdentifiers -> (список)

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

(строка)

StatusInfos -> (список)

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

(структура)

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

StatusType -> (строка)

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

Normal -> (булево)

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

Status -> (строка)

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

Message -> (строка)

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

DBClusterMembers -> (список)

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

(структура)

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

DBInstanceIdentifier -> (строка)

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

IsClusterWriter -> (булево)

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

DBClusterParameterGroupStatus -> (строка)

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

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

Значение, определяющее порядок, в котором реплика Aurora повышается до основного экземпляра после сбоя существующего основного экземпляра. Дополнительную информацию см. в разделе Устойчивость к отказам для кластера баз данных Aurora в руководстве пользователя Amazon Aurora.

VpcSecurityGroups -> (список)

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

(структура)

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

VpcSecurityGroupId -> (строка)

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

Status -> (строка)

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

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

HostedZoneId -> (строка)

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

StorageEncrypted -> (булево)

Указывает, зашифрован ли кластер баз данных.

KmsKeyId -> (строка)

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

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

DbClusterResourceId -> (строка)

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

DBClusterArn -> (строка)

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

AssociatedRoles -> (список)

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

(структура)

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

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

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

IAMDatabaseAuthenticationEnabled -> (булево)

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

CloneGroupId -> (строка)

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

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

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

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

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

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

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

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

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

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

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

EnabledCloudwatchLogsExports -> (список)

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

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

(строка)

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

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

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

EngineMode -> (строка)

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

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

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

Конфигурация масштабирования для кластера Aurora 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 -> (строка)

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

(строка)

TagList -> (список)

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

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

(структура)

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

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

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

StorageType -> (строка)

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

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

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

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

CAIdentifier -> (строка)

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

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

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

DBClusterInstanceClass -> (строка)

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

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

StorageType -> (строка)

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

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

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

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

PubliclyAccessible -> (булево)

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

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

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

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

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

AutoMinorVersionUpgrade -> (булево)

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

Это значение относится к кластерам Aurora DB и кластерам баз данных 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 ключа, 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 с шагом в половину единицы, например, 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.

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API