Spec-Zone.ru › AWS CLI v2

[ aws . rds ]

start-db-instance

Описание

Запускает экземпляр базы данных Amazon RDS, который был остановлен с помощью консоли Amazon Web Services, команды CLI stop-db-instance или операции StopDBInstance.

Дополнительную информацию см. в разделе «Запуск экземпляра базы данных Amazon RDS, ранее остановленного» в Руководстве пользователя Amazon RDS.

Примечание

Эта команда не применяется к RDS Custom, Aurora MySQL и Aurora PostgreSQL. Для кластеров Aurora DB используйте StartDBCluster.

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

Синтаксис

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

Параметры

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

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

--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.

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

Для запуска экземпляра базы данных

Следующий start-db-instance пример запускает указанный экземпляр базы данных.

aws rds start-db-instance \
    --db-instance-identifier test-instance

Вывод:

{
    "DBInstance": {
        "DBInstanceStatus": "starting",
        ...some output truncated...
    }
}

Вывод

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

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

Этот тип данных используется в качестве элемента ответа в операциях CreateDBInstance , CreateDBInstanceReadReplica , DeleteDBInstance , DescribeDBInstances , ModifyDBInstance , PromoteReadReplica , RebootDBInstance , RestoreDBInstanceFromDBSnapshot , RestoreDBInstanceFromS3 , RestoreDBInstanceToPointInTime , StartDBInstance и StopDBInstance .

DBInstanceIdentifier -> (строка)

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

DBInstanceClass -> (строка)

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

Engine -> (строка)

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

DBInstanceStatus -> (строка)

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

Дополнительную информацию о состояниях экземпляров баз данных см. в руководстве Amazon RDS User Guide, в разделе Просмотр состояния экземпляра базы данных.

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

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

MasterUsername -> (строка)

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

DBName -> (строка)

Изначальное имя базы данных, предоставленное при создании экземпляра базы данных (если требуется). Это имя возвращается на протяжении всего жизненного цикла экземпляра базы данных. Для экземпляра RDS for Oracle CDB имя идентифицирует PDB, а не CDB.

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

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

Примечание

Точка подключения может быть не отображена для экземпляров со статусом creating .

Address -> (строка)

Указывает DNS-адрес экземпляра базы данных.

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

Указывает порт, на котором работает движок базы данных.

HostedZoneId -> (строка)

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

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

Объем памяти в гигабайтах (GiB), выделенный для экземпляра базы данных.

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

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

PreferredBackupWindow -> (строка)

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

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

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

DBSecurityGroups -> (список)

Список элементов группы безопасности базы данных, содержащих подэлементы DBSecurityGroup.Name и DBSecurityGroup.Status .

(структура)

Этот тип данных используется в качестве элемента ответа в следующих действиях:

  • ModifyDBInstance
  • RebootDBInstance
  • RestoreDBInstanceFromDBSnapshot
  • RestoreDBInstanceToPointInTime

DBSecurityGroupName -> (строка)

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

Status -> (строка)

Состояние группы безопасности базы данных.

VpcSecurityGroups -> (список)

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

(структура)

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

VpcSecurityGroupId -> (строка)

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

Status -> (строка)

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

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

DBParameterGroups -> (список)

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

(структура)

Статус группы параметров базы данных.

Этот тип данных используется в качестве элемента ответа в следующих действиях:

  • CreateDBInstance
  • CreateDBInstanceReadReplica
  • DeleteDBInstance
  • ModifyDBInstance
  • RebootDBInstance
  • RestoreDBInstanceFromDBSnapshot

DBParameterGroupName -> (строка)

Имя группы параметров базы данных.

ParameterApplyStatus -> (строка)

Статус обновления параметров. Допустимые значения:

  • applying : изменение параметров группы применяется к базе данных.
  • failed-to-apply : группа параметров находится в недопустимом состоянии.
  • in-sync : изменение параметров группы синхронизировано с базой данных.
  • pending-database-upgrade : изменение параметров группы будет применено после обновления экземпляра базы данных.
  • pending-reboot : изменение параметров группы будет применено после перезагрузки экземпляра базы данных.

AvailabilityZone -> (строка)

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

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

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

DBSubnetGroupName -> (строка)

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

DBSubnetGroupDescription -> (строка)

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

VpcId -> (строка)

Предоставляет VpcId группы подсетей базы данных.

SubnetGroupStatus -> (строка)

Предоставляет статус группы подсетей базы данных.

Subnets -> (список)

Содержит список элементов Subnet .

(структура)

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

SubnetIdentifier -> (строка)

Идентификатор подсети.

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

Содержит информацию о зоне доступности.

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

Name -> (строка)

Название зоны доступности.

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

Если подсеть связана с узлом Outpost, это значение указывает на Outpost.

Дополнительную информацию об RDS на Outposts см. в руководстве Amazon RDS на Amazon Web Services Outposts.

Arn -> (строка)

Amazon Resource Name (ARN) узла Outpost.

SubnetStatus -> (строка)

Состояние подсети.

DBSubnetGroupArn -> (строка)

Amazon Resource Name (ARN) группы подсетей базы данных.

SupportedNetworkTypes -> (список)

Тип сети группы подсетей базы данных.

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

  • IPV4
  • DUAL

Группа подсетей может поддерживать только протокол IPv4 или протоколы IPv4 и IPv6 (DUAL).

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

(строка)

PreferredMaintenanceWindow -> (строка)

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

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

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

DBInstanceClass -> (строка)

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

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

Размер выделенного хранилища для экземпляра базы данных, указанный в гигабайтах (GiB).

MasterUserPassword -> (строка)

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

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

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

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

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

MultiAZ -> (логическое значение)

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

EngineVersion -> (строка)

Версия движка базы данных.

LicenseModel -> (строка)

Модель лицензии для экземпляра базы данных.

Допустимые значения: license-included | bring-your-own-license | general-public-license

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

Значение Provisioned IOPS для экземпляра базы данных.

DBInstanceIdentifier -> (строка)

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

StorageType -> (строка)

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

CACertificateIdentifier -> (строка)

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

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

DBSubnetGroupName -> (строка)

Группа подсетей базы данных для экземпляра базы данных.

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

Список типов логов, конфигурация которых все еще ожидает обработки. Другими словами, эти типы логов находятся в процессе активации или деактивации.

LogTypesToEnable -> (список)

Типы логов, которые находятся в процессе деактивации. После деактивации эти типы логов не экспортируются в CloudWatch Logs.

(строка)

LogTypesToDisable -> (список)

Типы логов, которые находятся в процессе активации. После активации эти типы логов экспортируются в CloudWatch Logs.

(строка)

ProcessorFeatures -> (список)

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

(структура)

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

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

Вы можете задать характеристики процессора класса экземпляра базы данных для экземпляра базы данных, вызвав одно из следующих действий:

  • CreateDBInstance
  • ModifyDBInstance
  • RestoreDBInstanceFromDBSnapshot
  • RestoreDBInstanceFromS3
  • RestoreDBInstanceToPointInTime

Вы можете просмотреть допустимые значения процессора для определенного класса экземпляра, вызвав действие DescribeOrderableDBInstanceOptions и указав класс экземпляра для параметра DBInstanceClass.

Кроме того, вы можете использовать следующие действия для получения информации о процессоре класса экземпляра базы данных:

  • DescribeDBInstances
  • DescribeDBSnapshots
  • DescribeValidDBInstanceModifications

Если вы вызываете DescribeDBInstances, ProcessorFeature возвращает ненулевые значения только в следующих случаях:

  • Вы обращаетесь к экземпляру базы данных Oracle.
  • Ваш экземпляр базы данных Oracle поддерживает настройку количества ядер процессора и потоков на ядро.
  • Текущее количество ядер процессора и потоков на ядро установлено не по умолчанию.

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

Name -> (строка)

Название функции процессора. Допустимые имена - coreCount и threadsPerCore.

Value -> (строка)

Значение функции процессора.

IAMDatabaseAuthenticationEnabled -> (логическое значение)

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

AutomationMode -> (строка)

Режим автоматизации экземпляра RDS Custom DB: full или all-paused. Если full, экземпляр базы данных автоматизирует мониторинг и восстановление экземпляра. Если all-paused, экземпляр приостанавливает автоматизацию на срок, установленный --resume-full-automation-mode-minutes.

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

Количество минут для приостановки автоматизации. По окончании этого периода RDS Custom возобновляет полную автоматизацию. Минимальное значение - 60 (по умолчанию). Максимальное значение - 1440.

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

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

Engine -> (строка)

Движок базы данных экземпляра базы данных.

DedicatedLogVolume -> (логическое значение)

Указывает, включен ли для экземпляра базы данных выделенный объем журнала (DLV).

MultiTenant -> (логическое значение)

Указывает, изменится ли экземпляр базы данных на многопользовательскую конфигурацию (ИСТИНА) или однопользовательскую конфигурацию (ЛОЖЬ).

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

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

MultiAZ -> (логическое значение)

Указывает, является ли экземпляр базы данных многозонным развертыванием. Эта настройка не применяется к экземплярам RDS Custom DB.

EngineVersion -> (строка)

Версия движка базы данных.

AutoMinorVersionUpgrade -> (логическое значение)

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

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

ReadReplicaSourceDBInstanceIdentifier -> (строка)

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

ReadReplicaDBInstanceIdentifiers -> (список)

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

(строка)

ReadReplicaDBClusterIdentifiers -> (список)

Идентификаторы кластеров Aurora базы данных, в которые экземпляр базы данных RDS реплицируется как реплика чтения. Например, при создании реплики чтения Aurora для экземпляра базы данных RDS для MySQL отображается кластер базы данных Aurora MySQL для реплики чтения Aurora. Этот вывод не содержит информацию о репликах чтения Aurora между регионами.

Примечание

В настоящее время каждый экземпляр базы данных RDS может иметь только одну реплику чтения Aurora.

(строка)

ReplicaMode -> (строка)

Открытый режим реплики чтения Oracle. По умолчанию - open-read-only. Дополнительную информацию см. в руководстве пользователя Amazon RDS в разделе Работа с репликами чтения Oracle для Amazon RDS.

Примечание

Этот атрибут поддерживается только в RDS для Oracle.

LicenseModel -> (строка)

Информация о модели лицензии для этого экземпляра базы данных. Эта настройка не применяется к экземплярам Amazon Aurora или RDS Custom DB.

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

Значение Provisioned IOPS (операций ввода/вывода в секунду) для экземпляра базы данных.

OptionGroupMemberships -> (список)

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

(структура)

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

OptionGroupName -> (строка)

Название группы параметров, к которой принадлежит экземпляр.

Status -> (строка)

Статус членства экземпляра базы данных в группе параметров. Допустимые значения: in-sync, pending-apply, pending-removal, pending-maintenance-apply, pending-maintenance-removal, applying, removing и failed.

CharacterSetName -> (строка)

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

NcharCharacterSetName -> (строка)

Имя набора символов NCHAR для экземпляра базы данных Oracle. Этот набор символов определяет кодировку Unicode для данных, хранящихся в столбцах таблиц типа NCHAR, NCLOB или NVARCHAR2.

SecondaryAvailabilityZone -> (строка)

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

PubliclyAccessible -> (логическое значение)

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

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

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

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

StatusInfos -> (список)

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

(структура)

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

StatusType -> (строка)

Это значение в настоящее время равно «репликация чтения».

Normal -> (логическое значение)

Указывает, работает ли экземпляр нормально (ИСТИНА) или находится в состоянии ошибки (ЛОЖЬ).

Status -> (строка)

Статус экземпляра базы данных. Для StatusType, равного реплике чтения, значения могут быть replicating, replication stop point set, replication stop point reached, error, stopped или terminated.

Message -> (строка)

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

StorageType -> (строка)

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

TdeCredentialArn -> (строка)

ARN из хранилища ключей, с которым связан экземпляр для шифрования TDE.

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

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

DBClusterIdentifier -> (строка)

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

StorageEncrypted -> (логическое значение)

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

KmsKeyId -> (строка)

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

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

DbiResourceId -> (строка)

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

CACertificateIdentifier -> (string)

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

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

DomainMemberships -> (list)

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

(структура)

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

Domain -> (string)

Идентификатор домена Active Directory.

Status -> (string)

Состояние членства в домене Active Directory для экземпляра базы данных или кластера. Значения включают joined, pending-join, failed и так далее.

FQDN -> (string)

Полное доменное имя (FQDN) домена Active Directory.

IAMRoleName -> (string)

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

OU -> (string)

Организационная единица Active Directory для экземпляра базы данных или кластера.

AuthSecretArn -> (string)

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

DnsIps -> (list)

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

(string)

CopyTagsToSnapshot -> (boolean)

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

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

MonitoringInterval -> (integer)

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

EnhancedMonitoringResourceArn -> (string)

Идентификатор ресурса Amazon (ARN) потока журналов Amazon CloudWatch Logs, который получает данные метрик Улучшенного мониторинга для экземпляра базы данных.

MonitoringRoleArn -> (string)

ARN роли IAM, которая разрешает RDS отправлять метрики Улучшенного мониторинга в Amazon CloudWatch Logs.

PromotionTier -> (integer)

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

DBInstanceArn -> (string)

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

Timezone -> (string)

Временная зона экземпляра базы данных. В большинстве случаев элемент Timezone пуст. Содержимое Timezone появляется только для экземпляров RDS for Db2 и RDS for SQL Server, созданных со значением временной зоны.

IAMDatabaseAuthenticationEnabled -> (boolean)

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

Список версий движков, поддерживающих аутентификацию баз данных IAM, см. в разделе Аутентификация баз данных IAM в руководстве Amazon RDS User Guide и разделе Аутентификация баз данных IAM в Aurora в руководстве Amazon Aurora User Guide.

DatabaseInsightsMode -> (string)

Режим Database Insights, включенный для экземпляра.

PerformanceInsightsEnabled -> (boolean)

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

PerformanceInsightsKMSKeyId -> (string)

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

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

PerformanceInsightsRetentionPeriod -> (integer)

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

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

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

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

EnabledCloudwatchLogsExports -> (list)

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

Типы журналов различаются в зависимости от движка БД. Сведения о типах журналов для каждого движка БД см. в разделе Мониторинг файлов журналов Amazon RDS в руководстве Amazon RDS User Guide.

(string)

ProcessorFeatures -> (list)

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

(структура)

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

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

Вы можете установить характеристики процессора класса экземпляра для экземпляра базы данных при вызове одного из следующих действий:

  • CreateDBInstance
  • ModifyDBInstance
  • RestoreDBInstanceFromDBSnapshot
  • RestoreDBInstanceFromS3
  • RestoreDBInstanceToPointInTime

Вы можете просмотреть допустимые значения процессора для определенного класса экземпляра, вызвав действие DescribeOrderableDBInstanceOptions и указав класс экземпляра для параметра DBInstanceClass.

Кроме того, вы можете использовать следующие действия для получения информации о процессоре класса экземпляра базы данных:

  • DescribeDBInstances
  • DescribeDBSnapshots
  • DescribeValidDBInstanceModifications

Если вы вызываете DescribeDBInstances, то ProcessorFeature возвращает значения, отличные от null, только если выполняются следующие условия:

  • Вы обращаетесь к экземпляру Oracle DB.
  • Ваш экземпляр Oracle DB поддерживает настройку количества ядер процессора и потоков на ядро.
  • Текущее количество ядер процессора и потоков на ядро установлено не по умолчанию.

Дополнительную информацию можно найти в разделе Настройка процессора для класса экземпляра базы данных в RDS для Oracle в руководстве Amazon RDS User Guide.

Name -> (string)

Имя характеристики процессора. Допустимые имена — coreCount и threadsPerCore.

Value -> (string)

Значение характеристики процессора.

DeletionProtection -> (boolean)

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

AssociatedRoles -> (list)

Роли Amazon Web Services Identity and Access Management (IAM), связанные с экземпляром базы данных.

(структура)

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

RoleArn -> (string)

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

FeatureName -> (string)

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

Status -> (string)

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

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

ListenerEndpoint -> (structure)

Точка подключения слушателя для SQL Server Always On.

Address -> (string)

Указывает DNS-адрес экземпляра базы данных.

Port -> (integer)

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

HostedZoneId -> (string)

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

MaxAllocatedStorage -> (integer)

Максимальный объем в гигабайтах (GiB), до которого Amazon RDS может автоматически увеличить объем хранилища экземпляра базы данных.

TagList -> (list)

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

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

(структура)

Метаданные, назначенные ресурсу Amazon RDS, представленные в виде пары «ключ-значение».

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

Key -> (string)

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

Value -> (string)

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

DBInstanceAutomatedBackupsReplications -> (list)

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

(структура)

Автоматические резервные копии экземпляра базы данных, реплицированные в другой регион Amazon Web Services. Они состоят из системных резервных копий, журналов транзакций и свойств экземпляра базы данных.

DBInstanceAutomatedBackupsArn -> (string)

Идентификатор ресурса Amazon (ARN) реплицированных автоматических резервных копий.

CustomerOwnedIpEnabled -> (boolean)

Указывает, включён ли для экземпляра базы данных RDS на Outposts собственый IP-адрес клиента (CoIP).

CoIP обеспечивает локальное или внешнее подключение к ресурсам в подсетях вашего Outpost через вашу локальную сеть. В некоторых случаях CoIP может обеспечить более низкую задержку для подключений к экземпляру базы данных извне его виртуальной частной облачной сети (VPC) в вашей локальной сети.

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

Дополнительную информацию о CoIP см. в разделе Собственные IP-адреса клиента в Руководстве пользователя Amazon Web Services Outposts.

AwsBackupRecoveryPointArn -> (string)

Идентификатор ресурса Amazon (ARN) точки восстановления в Amazon Web Services Backup.

ActivityStreamStatus -> (string)

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

ActivityStreamKmsKeyId -> (string)

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

ActivityStreamKinesisStreamName -> (string)

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

ActivityStreamMode -> (string)

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

ActivityStreamEngineNativeAuditFieldsIncluded -> (boolean)

Указывает, включаются ли в поток активности базы данных поля аудита, специфичные для движка.

AutomationMode -> (string)

Режим автоматизации экземпляра базы данных RDS Custom: full или all paused. Если full, экземпляр базы данных автоматизирует мониторинг и восстановление экземпляра. Если all paused, экземпляр приостанавливает автоматизацию на срок, установленный --resume-full-automation-mode-minutes.

ResumeFullAutomationModeTime -> (timestamp)

Количество минут для приостановки автоматизации. По завершении периода времени RDS Custom возобновляет полную автоматизацию. Минимальное значение — 60 (по умолчанию). Максимальное значение — 1440.

CustomIamInstanceProfile -> (string)

Профиль экземпляра, связанный с базовым экземпляром Amazon EC2 экземпляра базы данных RDS Custom. Профиль экземпляра должен соответствовать следующим требованиям:

  • Профиль должен существовать в вашей учетной записи.
  • Профиль должен иметь роль IAM, которой Amazon EC2 имеет разрешения для принятия.
  • Имя профиля экземпляра и имя связанной роли IAM должны начинаться с префикса AWSRDSCustom.

Список разрешений, необходимых для роли IAM, см. в разделе Настройка IAM и вашей VPC в Руководстве пользователя Amazon RDS.

BackupTarget -> (string)

Место хранения автоматических резервных копий и ручных снимков: Amazon Web Services Outposts или регион Amazon Web Services.

NetworkType -> (string)

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

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

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

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

ActivityStreamPolicyStatus -> (string)

Состояние политики потока активности.

StorageThroughput -> (integer)

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

Это значение применяется только к типу хранилища gp3.

DBSystemId -> (string)

Идентификатор системы Oracle (Oracle SID) для базы данных контейнера (CDB). Oracle SID также является именем CDB. Это значение применимо только для экземпляров базы данных RDS Custom.

MasterUserSecret -> (structure)

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

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

SecretArn -> (string)

Идентификатор ресурса Amazon (ARN) секрета.

SecretStatus -> (string)

Состояние секрета.

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

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

KmsKeyId -> (string)

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

CertificateDetails -> (structure)

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

CAIdentifier -> (string)

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

ValidTill -> (timestamp)

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

ReadReplicaSourceDBClusterIdentifier -> (string)

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

PercentProgress -> (string)

Прогресс операции оптимизации хранилища в процентах.

DedicatedLogVolume -> (boolean)

Указывает, включён ли для экземпляра базы данных выделенный том журнала (DLV).

IsStorageConfigUpgradeAvailable -> (boolean)

Указывает, рекомендуется ли обновление конфигурации файловой системы хранилища на экземпляре базы данных. Чтобы перейти к предпочтительной конфигурации, можно выполнить развертывание по принципу «синий-зелёный» или создать реплику чтения из экземпляра базы данных. Дополнительную информацию см. в разделе Обновление файловой системы хранилища экземпляра базы данных.

MultiTenant -> (boolean)

Указывает, находится ли экземпляр базы данных в конфигурации многопользовательской (TRUE) или однопользовательской (FALSE).

EngineLifecycleSupport -> (string)

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

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

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

Spec-Zone.ru

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