Spec-Zone.ru › AWS CLI v2

[ aws . rds ]

reboot-db-instance

Описание

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

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

Дополнительную информацию о перезагрузке см. в разделе Перезагрузка экземпляра БД в Руководстве пользователя Amazon RDS.

Эта команда не применяется к RDS Custom.

Если ваш экземпляр БД является частью кластера БД Multi-AZ, вы можете перезагрузить кластер БД с помощью операции RebootDBCluster.

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

Синтаксис

  reboot-db-instance
--db-instance-identifier <value>
[--force-failover | --no-force-failover]
[--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 (строка)

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

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

  • Должен соответствовать идентификатору существующего DBInstance.

--force-failover | --no-force-failover (логическое значение)

Указывает, выполняется ли перезагрузка через аварийное переключение Multi-AZ.

Ограничение: вы не можете включить принудительное аварийное переключение, если экземпляр не настроен для Multi-AZ.

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

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса API. Если предоставлено без значения или со значением input, выводит пример JSON-ввода, который может быть использован как аргумент для --cli-input-json. Аналогично, если предоставлено yaml-input, будет выведен пример YAML-ввода, который можно использовать с --cli-input-yaml. Если предоставлено значение output, оно проверяет входные данные команды и возвращает пример JSON-вывода для этой команды. Сгенерированный JSON-скелет нестабилен между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.

Глобальные параметры

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

Включить отладку регистрации.

--endpoint-url (строка)

Переопределить URL по умолчанию команды заданным URL.

--no-verify-ssl (логическое значение)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет поведение проверки SSL-сертификатов по умолчанию.

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

Отключить автоматическую постраничность. Если автоматическая постраничность отключена, AWS CLI будет выполнять только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования вывода команды.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • on
  • off
  • auto

--no-sign-request (логическое значение)

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

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

Набор сертификатов CA для использования при проверке SSL-сертификатов. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (целое число)

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

--cli-connect-timeout (целое число)

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

--cli-binary-format (строка)

Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены как строка, закодированная в base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, отображающего двоичный блок, fileb:// всегда будет обрабатываться как двоичный и будет использовать содержимое файла напрямую независимо от настроек cli-binary-format. При использовании file:// содержимое файла должно быть правильно отформатировано для настроенного cli-binary-format.

  • base64
  • raw-in-base64-out

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

Отключить вывод страницы CLI.

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

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

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

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

Примеры

Примечание

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

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

Для перезагрузки экземпляра БД

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

aws rds reboot-db-instance \
    --db-instance-identifier test-mysql-instance

Вывод:

{
    "DBInstance": {
        "DBInstanceIdentifier": "test-mysql-instance",
        "DBInstanceClass": "db.t3.micro",
        "Engine": "mysql",
        "DBInstanceStatus": "rebooting",
        "MasterUsername": "admin",
        "Endpoint": {
            "Address": "test-mysql-instance.############.us-west-2.rds.amazonaws.com",
            "Port": 3306,
            "HostedZoneId": "Z1PVIF0EXAMPLE"
        },

    ... output omitted...

    }
}

Дополнительную информацию см. в разделе Перезагрузка экземпляра БД в Руководстве пользователя Amazon RDS.

Вывод

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

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

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

DBInstanceIdentifier -> (строка)

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

DBInstanceClass -> (строка)

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

Engine -> (строка)

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

DBInstanceStatus -> (строка)

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

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

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

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

MasterUsername -> (строка)

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

DBName -> (строка)

Начальное имя базы данных, которое вы предоставили (если необходимо) при создании экземпляра базы данных. Это имя возвращается в течение всего срока службы экземпляра базы данных. Для экземпляра RDS для 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 -> (список)

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

(структура)

Этот тип данных используется в качестве элемента ответа для запросов о членстве в группах безопасности 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 в Руководстве пользователя Amazon RDS.

Arn -> (строка)

Amazon Resource Name (ARN) Outpost.

SubnetStatus -> (строка)

Статус подсети.

DBSubnetGroupArn -> (строка)

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

SupportedNetworkTypes -> (список)

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

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

  • IPV4
  • DUAL

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

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

(строка)

PreferredMaintenanceWindow -> (строка)

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

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

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

DBInstanceClass -> (строка)

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

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

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

MasterUserPassword -> (строка)

Основные учетные данные для экземпляра БД.

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

Порт для экземпляра БД.

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

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

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

Указывает, будет ли экземпляр БД Single-AZ изменен на развертывание Multi-AZ.

EngineVersion -> (строка)

Версия СУБД.

LicenseModel -> (строка)

Модель лицензии для экземпляра БД.

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

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

Значение Provisioned IOPS для экземпляра БД.

DBInstanceIdentifier -> (строка)

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

StorageType -> (строка)

Тип хранилища экземпляра БД.

CACertificateIdentifier -> (строка)

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

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

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 Identity and Access Management (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 -> (булево значение)

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

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

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

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

Указывает, является ли экземпляр БД развертыванием Multi-AZ. Это свойство не применяется к экземплярам RDS Custom DB.

EngineVersion -> (строка)

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

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

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

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

ReadReplicaSourceDBInstanceIdentifier -> (строка)

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

ReadReplicaDBInstanceIdentifiers -> (список)

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

(строка)

ReadReplicaDBClusterIdentifiers -> (список)

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

Примечание

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

(строка)

ReplicaMode -> (строка)

Режим открытого доступа реплики чтения Oracle. По умолчанию open-read-only. Дополнительная информация находится в разделе Работа с репликами чтения Oracle для Amazon RDS в Руководстве пользователя 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 -> (строка)

Если присутствует, указывает имя вторичной зоны доступности для экземпляра БД с поддержкой Multi-AZ.

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

Указывает, доступен ли экземпляр БД через Интернет.

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

Если экземпляр БД не доступен через Интернет, это внутренний экземпляр БД с DNS-именем, разрешающимся до частного IP-адреса.

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

StatusInfos -> (список)

Статус реплики чтения. Если экземпляр БД не является репликой чтения, значение пустое.

(структура)

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

StatusType -> (строка)

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

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

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

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

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

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

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.

(строка)

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

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

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

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

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

EnhancedMonitoringResourceArn -> (строка)

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

MonitoringRoleArn -> (строка)

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

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

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

DBInstanceArn -> (строка)

Amazon Resource Name (ARN) экземпляра базы данных.

Timezone -> (строка)

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

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

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

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

DatabaseInsightsMode -> (строка)

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

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

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

PerformanceInsightsKMSKeyId -> (строка)

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

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

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

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

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

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

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

EnabledCloudwatchLogsExports -> (список)

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

Типы журналов зависят от движка базы данных. Информацию о типах журналов для каждого движка базы данных см. в руководстве пользователя Amazon RDS.

(строка)

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

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

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

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

AssociatedRoles -> (список)

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

(структура)

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

RoleArn -> (строка)

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

FeatureName -> (строка)

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

Status -> (строка)

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

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

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

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

Address -> (строка)

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

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

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

HostedZoneId -> (строка)

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

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

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

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}_.:/=+\-@]*)$”).

DBInstanceAutomatedBackupsReplications -> (список)

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

(структура)

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

DBInstanceAutomatedBackupsArn -> (строка)

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

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

Указывает, включен ли для экземпляра базы данных 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 -> (строка)

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

ActivityStreamStatus -> (строка)

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

ActivityStreamKmsKeyId -> (строка)

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

ActivityStreamKinesisStreamName -> (строка)

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

ActivityStreamMode -> (строка)

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

ActivityStreamEngineNativeAuditFieldsIncluded -> (булево)

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

AutomationMode -> (строка)

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

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

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

CustomIamInstanceProfile -> (строка)

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

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

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

BackupTarget -> (строка)

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

NetworkType -> (строка)

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

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

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

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

ActivityStreamPolicyStatus -> (строка)

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

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

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

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

DBSystemId -> (строка)

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

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

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

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

SecretArn -> (строка)

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

SecretStatus -> (строка)

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

Возможные значения состояния:

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

KmsKeyId -> (строка)

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

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

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

CAIdentifier -> (строка)

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

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

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

ReadReplicaSourceDBClusterIdentifier -> (строка)

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

PercentProgress -> (строка)

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

DedicatedLogVolume -> (булево)

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

IsStorageConfigUpgradeAvailable -> (булево)

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

MultiTenant -> (булево)

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

EngineLifecycleSupport -> (строка)

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

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

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

Spec-Zone.ru

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