modify-db-instance
Описание
Изменяет настройки экземпляра. Вы можете изменить один или несколько параметров конфигурации базы данных, указав эти параметры и новые значения в запросе.
См. также: Документация AWS API
Синтаксис
modify-db-instance
--db-instance-identifier <value>
[--db-instance-class <value>]
[--apply-immediately | --no-apply-immediately]
[--preferred-maintenance-window <value>]
[--auto-minor-version-upgrade | --no-auto-minor-version-upgrade]
[--new-db-instance-identifier <value>]
[--ca-certificate-identifier <value>]
[--copy-tags-to-snapshot | --no-copy-tags-to-snapshot]
[--promotion-tier <value>]
[--enable-performance-insights | --no-enable-performance-insights]
[--performance-insights-kms-key-id <value>]
[--certificate-rotation-restart | --no-certificate-rotation-restart]
[--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.
--db-instance-class (строка)
Новая вычислительная и емкостная мощность экземпляра; например, db.r5.large. Не все классы экземпляров доступны во всех регионах Amazon Web Services.
Если вы измените класс экземпляра, во время изменения произойдет перерыв в работе. Изменение будет применено в следующий период технического обслуживания, если ApplyImmediately не указан как true для этого запроса.
По умолчанию: используется существующее значение.
--apply-immediately | --no-apply-immediately (логическое значение)
Указывает, будут ли изменения в этом запросе и любые ожидающие изменения применяться асинхронно как можно скорее, независимо от настроек PreferredMaintenanceWindow для экземпляра.
Если этот параметр установлен в значение false, изменения в экземпляре будут применены в следующий период технического обслуживания. Некоторые изменения параметров могут привести к перерыву в работе и применяются при следующем перезапуске.
По умолчанию: false
--preferred-maintenance-window (строка)
Недельный интервал времени (в UTC), в течение которого может выполняться техническое обслуживание системы, что может привести к перерыву в работе. Изменение этого параметра не приводит к перерыву в работе, за исключением следующих случаев, и изменение применяется асинхронно как можно скорее. Если существуют ожидающие действия, которые приводят к перезагрузке, и интервал технического обслуживания изменен так, чтобы включать текущее время, изменение этого параметра приводит к перезагрузке экземпляра. Если вы перемещаете этот интервал к текущему времени, должно пройти не менее 30 минут между текущим временем и концом интервала, чтобы гарантировать применение ожидающих изменений.
По умолчанию: используется существующее значение.
Формат: ddd:hh24:mi-ddd:hh24:mi
Допустимые дни: Пн, Вт, Ср, Чт, Пт, Сб, Вс
Ограничения: Должно быть не менее 30 минут.
--auto-minor-version-upgrade | --no-auto-minor-version-upgrade (логическое значение)
--new-db-instance-identifier (строка)
Новый идентификатор экземпляра для экземпляра при переименовании экземпляра. При изменении идентификатора экземпляра, перезагрузка экземпляра происходит немедленно, если вы установили Apply Immediately в значение true. Она происходит в следующий период технического обслуживания, если вы установили Apply Immediately в значение false. Это значение хранится как строка в нижнем регистре.
Ограничения:
- Должен содержать от 1 до 63 букв, цифр или дефисов.
- Первый символ должен быть буквой.
- Не может заканчиваться дефисом или содержать два дефиса подряд.
Пример: mydbinstance
--ca-certificate-identifier (строка)
--copy-tags-to-snapshot | --no-copy-tags-to-snapshot (логическое значение)
--promotion-tier (целое число)
Значение, которое определяет порядок, в котором реплика Amazon DocumentDB повышается до основного экземпляра после сбоя существующего основного экземпляра.
По умолчанию: 1
Допустимые значения: 0-15
--enable-performance-insights | --no-enable-performance-insights (логическое значение)
--performance-insights-kms-key-id (строка)
Идентификатор ключа KMS для шифрования данных Performance Insights.
Идентификатор ключа KMS — это ARN ключа, ID ключа, ARN псевдонима или имя псевдонима для ключа KMS.
Если вы не укажете значение для PerformanceInsightsKMSKeyId, Amazon DocumentDB использует ваш ключ KMS по умолчанию. Для вашей учетной записи Amazon Web Services существует ключ KMS по умолчанию. Для каждой области Amazon Web Services у вашей учетной записи Amazon Web Services есть другой ключ KMS по умолчанию.
--certificate-rotation-restart | --no-certificate-rotation-restart (логическое значение)
Указывает, будет ли экземпляр БД перезапущен при вращении сертификата SSL/TLS.
По умолчанию экземпляр БД перезапускается при вращении сертификата SSL/TLS. Сертификат не обновляется до перезапуска экземпляра БД.
Предупреждение
Устанавливайте этот параметр только если вы не используете SSL/TLS для подключения к экземпляру БД.Если вы используете SSL/TLS для подключения к экземпляру БД, см. Обновление сертификатов TLS Amazon DocumentDB и Шифрование данных в процессе передачи в Руководстве разработчика Amazon DocumentDB.
--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.
Для изменения экземпляра Amazon DocumentDB
Следующий modify-db-instance пример изменяет экземпляр Amazon DocumentDB sample-cluster2, изменяя его класс экземпляра на db.r4.4xlarge и уровень повышения на 5. Изменения применяются немедленно, но могут быть видны только после того, как статус экземпляра будет доступен.
aws docdb modify-db-instance \
--db-instance-identifier sample-cluster2 \
--apply-immediately \
--db-instance-classdb.r4.4xlarge \
--promotion-tier 5
Вывод:
{
"DBInstance": {
"EngineVersion": "3.6.0",
"StorageEncrypted": false,
"DBInstanceClass": "db.r4.large",
"PreferredMaintenanceWindow": "mon:08:39-mon:09:09",
"AutoMinorVersionUpgrade": true,
"VpcSecurityGroups": [
{
"VpcSecurityGroupId": "sg-77186e0d",
"Status": "active"
}
],
"PreferredBackupWindow": "18:00-18:30",
"EnabledCloudwatchLogsExports": [
"audit"
],
"AvailabilityZone": "us-west-2f",
"DBInstanceIdentifier": "sample-cluster2",
"InstanceCreateTime": "2019-03-15T20:36:06.338Z",
"Engine": "docdb",
"BackupRetentionPeriod": 7,
"DBSubnetGroup": {
"DBSubnetGroupName": "default",
"DBSubnetGroupDescription": "default",
"SubnetGroupStatus": "Complete",
"Subnets": [
{
"SubnetIdentifier": "subnet-4e26d263",
"SubnetAvailabilityZone": {
"Name": "us-west-2a"
},
"SubnetStatus": "Active"
},
{
"SubnetIdentifier": "subnet-afc329f4",
"SubnetAvailabilityZone": {
"Name": "us-west-2c"
},
"SubnetStatus": "Active"
},
{
"SubnetIdentifier": "subnet-53ab3636",
"SubnetAvailabilityZone": {
"Name": "us-west-2d"
},
"SubnetStatus": "Active"
},
{
"SubnetIdentifier": "subnet-991cb8d0",
"SubnetAvailabilityZone": {
"Name": "us-west-2b"
},
"SubnetStatus": "Active"
}
],
"VpcId": "vpc-91280df6"
},
"PromotionTier": 2,
"Endpoint": {
"Address": "sample-cluster2.corcjozrlsfc.us-west-2.docdb.amazonaws.com",
"HostedZoneId": "ZNKXH85TT8WVW",
"Port": 27017
},
"DbiResourceId": "db-A2GIKUV6KPOHITGGKI2NHVISZA",
"DBClusterIdentifier": "sample-cluster",
"DBInstanceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster2",
"PendingModifiedValues": {
"DBInstanceClass": "db.r4.4xlarge"
},
"PubliclyAccessible": false,
"DBInstanceStatus": "available"
}
}
Дополнительную информацию см. в разделе Изменение экземпляра Amazon DocumentDB в Руководстве разработчика Amazon DocumentDB.
Вывод
DBInstance -> (структура)
Подробная информация об экземпляре.
DBInstanceIdentifier -> (строка)
DBInstanceClass -> (строка)
Engine -> (строка)
DBInstanceStatus -> (строка)
Endpoint -> (структура)
Указывает конечную точку подключения.
Address -> (строка)
Port -> (целое число)
HostedZoneId -> (строка)
InstanceCreateTime -> (временная метка)
PreferredBackupWindow -> (строка)
BackupRetentionPeriod.BackupRetentionPeriod -> (целое число)
VpcSecurityGroups -> (список)
Предоставляет список элементов группы безопасности VPC, к которой принадлежит экземпляр.
(структура)
Используется как элемент ответа для запросов о членстве в группе безопасности виртуальной частной сети (VPC).
VpcSecurityGroupId -> (строка)
Status -> (строка)
AvailabilityZone -> (строка)
DBSubnetGroup -> (структура)
Указывает информацию о группе подсетей, связанной с экземпляром, включая имя, описание и подсети в группе подсетей.
DBSubnetGroupName -> (строка)
DBSubnetGroupDescription -> (строка)
VpcId -> (строка)
SubnetGroupStatus -> (строка)
Subnets -> (список)
Подробная информация об одной или нескольких подсетях в группе подсетей.
(структура)
Подробная информация о подсети.
SubnetIdentifier -> (строка)
SubnetAvailabilityZone -> (структура)
Указывает зону доступности для подсети.
Name -> (строка)
SubnetStatus -> (строка)
DBSubnetGroupArn -> (строка)
PreferredMaintenanceWindow -> (строка)
PendingModifiedValues -> (структура)
Указывает, что изменения в экземпляре находятся в ожидании. Этот элемент включается только при наличии ожидающих изменений. Конкретные изменения определяются вложенными элементами.
DBInstanceClass -> (строка)
DBInstanceClass для экземпляра, которое будет применено или в настоящее время применяется.AllocatedStorage -> (целое число)
AllocatedStorage для экземпляра, который будет применён или в настоящее время применяется.MasterUserPassword -> (строка)
Port -> (целое число)
BackupRetentionPeriod -> (целое число)
MultiAZ -> (булево)
EngineVersion -> (строка)
LicenseModel -> (строка)
Модель лицензии для экземпляра.
Допустимые значения: license-included , bring-your-own-license , general-public-license
Iops -> (целое число)
DBInstanceIdentifier -> (строка)
DBInstanceIdentifier для экземпляра, которое будет применено или в настоящее время применяется.StorageType -> (строка)
CACertificateIdentifier -> (строка)
DBSubnetGroupName -> (строка)
PendingCloudwatchLogsExports -> (структура)
Список типов журналов, чья конфигурация всё ещё ожидает обработки. Эти типы журналов находятся в процессе активации или деактивации.
LogTypesToEnable -> (список)
Типы журналов, которые находятся в процессе деактивации. После деактивации эти типы журналов не экспортируются в CloudWatch Logs.
(строка)
LogTypesToDisable -> (список)
Типы журналов, которые находятся в процессе активации. После активации эти типы журналов экспортируются в Amazon CloudWatch Logs.
(строка)
LatestRestorableTime -> (временная метка)
EngineVersion -> (строка)
AutoMinorVersionUpgrade -> (булево)
PubliclyAccessible -> (булево)
PubliclyAccessible всегда равно false.StatusInfos -> (список)
Состояние реплики чтения. Если экземпляр не является репликой чтения, это пусто.
(структура)
Предоставляет список информации о состоянии экземпляра.
StatusType -> (строка)
read replication”.Normal -> (булево)
true, если экземпляр работает нормально, или false, если экземпляр находится в состоянии ошибки.Status -> (строка)
replicating, ошибка, stopped или terminated.Message -> (строка)
DBClusterIdentifier -> (строка)
StorageEncrypted -> (булево)
KmsKeyId -> (строка)
StorageEncrypted равно true, идентификатор ключа KMS для зашифрованного экземпляра.DbiResourceId -> (строка)
CACertificateIdentifier -> (строка)
CopyTagsToSnapshot -> (булево)
PromotionTier -> (целое число)
DBInstanceArn -> (строка)
EnabledCloudwatchLogsExports -> (список)
Список типов журналов, которые настроен этот экземпляр экспортировать в CloudWatch Logs.
(строка)
CertificateDetails -> (структура)
Подробности серверного сертификата экземпляра DB.
CAIdentifier -> (строка)
ValidTill -> (временная метка)
PerformanceInsightsEnabled -> (булево)
true, если Amazon RDS Performance Insights включён для экземпляра DB, и в противном случае false.PerformanceInsightsKMSKeyId -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.