modify-db-instance
Описание
Изменяет настройки экземпляра базы данных. Вы можете изменить один или несколько параметров конфигурации базы данных, указав эти параметры и новые значения в запросе. Чтобы узнать, какие изменения вы можете внести в свой экземпляр базы данных, вызовите DescribeValidDBInstanceModifications перед вызовом ModifyDBInstance.
См. также: Документацию API AWS
Синтаксис
modify-db-instance
--db-instance-identifier <value>
[--allocated-storage <value>]
[--db-instance-class <value>]
[--db-subnet-group-name <value>]
[--db-security-groups <value>]
[--vpc-security-group-ids <value>]
[--apply-immediately | --no-apply-immediately]
[--master-user-password <value>]
[--db-parameter-group-name <value>]
[--backup-retention-period <value>]
[--preferred-backup-window <value>]
[--preferred-maintenance-window <value>]
[--multi-az | --no-multi-az]
[--engine-version <value>]
[--allow-major-version-upgrade | --no-allow-major-version-upgrade]
[--auto-minor-version-upgrade | --no-auto-minor-version-upgrade]
[--license-model <value>]
[--iops <value>]
[--option-group-name <value>]
[--new-db-instance-identifier <value>]
[--storage-type <value>]
[--tde-credential-arn <value>]
[--tde-credential-password <value>]
[--ca-certificate-identifier <value>]
[--domain <value>]
[--copy-tags-to-snapshot | --no-copy-tags-to-snapshot]
[--monitoring-interval <value>]
[--db-port-number <value>]
[--publicly-accessible | --no-publicly-accessible]
[--monitoring-role-arn <value>]
[--domain-iam-role-name <value>]
[--promotion-tier <value>]
[--enable-iam-database-authentication | --no-enable-iam-database-authentication]
[--enable-performance-insights | --no-enable-performance-insights]
[--performance-insights-kms-key-id <value>]
[--cloudwatch-logs-export-configuration <value>]
[--deletion-protection | --no-deletion-protection]
[--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 (строка)
Идентификатор экземпляра базы данных. Это значение хранится как строка в нижнем регистре.
Ограничения:
- Должен совпадать с идентификатором существующего экземпляра базы данных.
--allocated-storage (целое число)
--db-instance-class (строка)
Новая вычислительная и емкость памяти экземпляра базы данных, например, db.m4.large. Не все классы экземпляров баз данных доступны во всех регионах Amazon.
При изменении класса экземпляра базы данных происходит перерыв во время изменения. Изменение применяется во время следующего окна технического обслуживания, если ApplyImmediately не указан как true для данного запроса.
По умолчанию: Используется существующее значение
--db-subnet-group-name (строка)
Новая группа подсетей базы данных для экземпляра базы данных. Вы можете использовать этот параметр, чтобы перенести свой экземпляр базы данных в другую VPC.
Изменение группы подсетей приводит к перерыву во время изменения. Изменение применяется во время следующего окна технического обслуживания, если вы не укажете true для параметра ApplyImmediately.
Ограничения: Если указано, должно совпадать с именем существующей группы подсетей DBSubnetGroup.
Пример: mySubnetGroup
--db-security-groups (список)
Список групп безопасности базы данных для авторизации на этом экземпляре базы данных. Изменение этого параметра не приводит к перерыву, и изменение применяется асинхронно как можно скорее.
Ограничения:
- Если указано, должно совпадать с существующими DBSecurityGroups.
(строка)
Синтаксис:
"string" "string" ...
--vpc-security-group-ids (список)
Список групп безопасности EC2 VPC для авторизации на этом экземпляре базы данных. Это изменение применяется асинхронно как можно скорее.
Не применимо. Связанный список групп безопасности EC2 VPC управляется кластером базы данных. Дополнительные сведения см. в разделе ModifyDBCluster .
Ограничения:
- Если указано, должно совпадать с существующими VpcSecurityGroupIds.
(строка)
Синтаксис:
"string" "string" ...
--apply-immediately | --no-apply-immediately (логическое значение)
Указывает, применяются ли изменения в этом запросе и любые ожидающие изменения асинхронно как можно скорее, независимо от параметра PreferredMaintenanceWindow для экземпляра базы данных.
Если этот параметр установлен в значение false, изменения экземпляра базы данных применяются во время следующего окна технического обслуживания. Некоторые изменения параметров могут привести к перерыву и применяются при следующем вызове RebootDBInstance или при следующем сбою перезагрузки.
По умолчанию: false
--master-user-password (строка)
--db-parameter-group-name (строка)
Имя группы параметров базы данных, которую нужно применить к экземпляру базы данных. Изменение этого параметра не приводит к перерыву. Само имя группы параметров изменяется немедленно, но фактические изменения параметров не применяются до перезагрузки экземпляра без переключения. Экземпляр базы данных НЕ будет перезагружен автоматически, и изменения параметров НЕ будут применены во время следующего окна технического обслуживания.
По умолчанию: Используется существующее значение
Ограничения: Группа параметров базы данных должна принадлежать тому же семейству, что и этот экземпляр базы данных.
--backup-retention-period (целое число)
Не применимо. Срок хранения автоматических резервных копий управляется кластером базы данных. Дополнительные сведения см. в разделе ModifyDBCluster .
По умолчанию: Используется существующее значение
--preferred-backup-window (строка)
Диапазон времени в течение дня, в который создаются автоматические резервные копии, если автоматические резервные копии включены.
Не применимо. Диапазон времени в течение дня для создания автоматических резервных копий управляется кластером базы данных. Дополнительные сведения см. в разделе ModifyDBCluster .
Ограничения:
- Должен иметь формат hh24:mi-hh24:mi
- Должен быть в координированном всемирном времени (UTC)
- Не должен конфликтовать с предпочтительным окном технического обслуживания
- Должен быть не менее 30 минут
--preferred-maintenance-window (строка)
Еженедельный диапазон времени (в UTC), в течение которого может происходить техническое обслуживание системы, что может привести к перерыву. Изменение этого параметра не приводит к перерыву, за исключением следующей ситуации, и изменение применяется асинхронно как можно скорее. Если существуют ожидающие действия, которые вызывают перезагрузку, и окно технического обслуживания изменено так, чтобы включать текущее время, то изменение этого параметра приведет к перезагрузке экземпляра базы данных. Если перемещать это окно к текущему времени, то должно быть не менее 30 минут между текущим временем и концом окна, чтобы обеспечить применение ожидающих изменений.
По умолчанию: Используется существующее значение
Формат: ddd:hh24:mi-ddd:hh24:mi
Допустимые дни: Mon | Tue | Wed | Thu | Fri | Sat | Sun
Ограничения: Должен быть не менее 30 минут
--multi-az | --no-multi-az (логическое значение)
ApplyImmediately установлен в значение true для этого запроса.--engine-version (строка)
--allow-major-version-upgrade | --no-allow-major-version-upgrade (логическое значение)
--auto-minor-version-upgrade | --no-auto-minor-version-upgrade (логическое значение)
true во время окна технического обслуживания, и доступна более новая незначительная версия, и Neptune включил автоматическую установку исправлений для этой версии движка.--license-model (строка)
--iops (целое число)
Новое значение Provisioned IOPS (операций ввода/вывода в секунду) для экземпляра.
Изменение этого параметра не приводит к перерыву, и изменение применяется во время следующего окна технического обслуживания, если параметр ApplyImmediately установлен в значение true для этого запроса.
По умолчанию: Используется существующее значение
--option-group-name (строка)
--new-db-instance-identifier (строка)
Новый идентификатор экземпляра базы данных для экземпляра базы данных при переименовании экземпляра базы данных. При изменении идентификатора экземпляра базы данных произойдет немедленная перезагрузка экземпляра, если вы установите Apply Immediately в значение true, или перезагрузка произойдет во время следующего окна технического обслуживания, если Apply Immediately в значение false. Это значение хранится как строка в нижнем регистре.
Ограничения:
- Должно содержать от 1 до 63 букв, цифр или дефисов.
- Первый символ должен быть буквой.
- Не может заканчиваться дефисом или содержать два дефиса подряд.
Пример: mydbinstance
--storage-type (строка)
--tde-credential-arn (строка)
--tde-credential-password (строка)
--ca-certificate-identifier (строка)
--domain (строка)
--copy-tags-to-snapshot | --no-copy-tags-to-snapshot (логическое значение)
--monitoring-interval (целое число)
Интервал в секундах между точками, когда собираются метрики мониторинга с расширенными возможностями для экземпляра базы данных. Чтобы отключить сбор метрик мониторинга с расширенными возможностями, укажите 0. По умолчанию - 0.
Если MonitoringRoleArn указан, то вы также должны установить MonitoringInterval в значение, отличное от 0.
Допустимые значения: 0, 1, 5, 10, 15, 30, 60
--db-port-number (целое число)
Номер порта, на котором база данных принимает соединения.
Значение параметра DBPortNumber не должно совпадать ни с одним из значений портов, указанных для параметров в группе параметров для экземпляра базы данных.
Ваша база данных будет перезапущена при изменении значения DBPortNumber независимо от значения параметра ApplyImmediately.
По умолчанию: 8182
--publicly-accessible | --no-publicly-accessible (логическое значение)
--monitoring-role-arn (строка)
ARN для роли IAM, которая позволяет Neptune отправлять метрики расширенного мониторинга в Amazon CloudWatch Logs. Например, arn:aws:iam:123456789012:role/emaccess.
Если MonitoringInterval установлено в значение, отличное от 0, то вы должны указать значение MonitoringRoleArn.
--domain-iam-role-name (строка)
--promotion-tier (целое число)
Значение, которое определяет порядок, в котором реплика чтения повышается до основного экземпляра после сбоя существующего основного экземпляра.
По умолчанию: 1
Допустимые значения: 0 - 15
--enable-iam-database-authentication | --no-enable-iam-database-authentication (логическое значение)
True, чтобы включить сопоставление учетных записей Amazon Identity and Access Management (IAM) с учетными записями базы данных, и иначе false.
Вы можете включить аутентификацию IAM базы данных для следующих движков баз данных
Не применимо. Сопоставление учетных записей Amazon IAM с учетными записями базы данных управляется кластером базы данных. Дополнительные сведения см. в разделе ModifyDBCluster .
По умолчанию: false
--enable-performance-insights | --no-enable-performance-insights (логическое значение)
--performance-insights-kms-key-id (строка)
--cloudwatch-logs-export-configuration (структура)
Параметр конфигурации для типов журналов, которые нужно включить для экспорта в CloudWatch Logs для конкретного экземпляра базы данных или кластера базы данных.
EnableLogTypes -> (список)
Список типов журналов, которые нужно включить.
(строка)
DisableLogTypes -> (список)
Список типов журналов, которые нужно отключить.
(строка)
Сокращенный синтаксис:
EnableLogTypes=string,string,DisableLogTypes=string,string
Синтаксис JSON:
{
"EnableLogTypes": ["string", ...],
"DisableLogTypes": ["string", ...]
}
--deletion-protection | --no-deletion-protection (логическое значение)
--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-auto-prompt (логическое)
Автоматически запрашивать параметры ввода CLI.
--no-cli-auto-prompt (логическое)
Отключить автоматический запрос параметров ввода CLI.
Вывод
DBInstance -> (структура)
Содержит сведения об экземпляре базы данных Amazon Neptune.
Этот тип данных используется в качестве элемента ответа в действии DescribeDBInstances.
DBInstanceIdentifier -> (строка)
DBInstanceClass -> (строка)
Engine -> (строка)
DBInstanceStatus -> (строка)
MasterUsername -> (строка)
DBName -> (строка)
Endpoint -> (структура)
Указывает конечную точку подключения.
Address -> (строка)
Port -> (целое число)
HostedZoneId -> (строка)
AllocatedStorage -> (целое число)
InstanceCreateTime -> (метка времени)
PreferredBackupWindow -> (строка)
BackupRetentionPeriod.BackupRetentionPeriod -> (целое число)
DBSecurityGroups -> (список)
Предоставляет список элементов группы безопасности базы данных, содержащих только подэлементы DBSecurityGroup.Name и DBSecurityGroup.Status.
(структура)
Указывает членство в выделенной группе безопасности базы данных.
DBSecurityGroupName -> (строка)
Status -> (строка)
VpcSecurityGroups -> (список)
Предоставляет список элементов группы безопасности VPC, к которым принадлежит экземпляр базы данных.
(структура)
Этот тип данных используется в качестве элемента ответа для запросов о членстве в группе безопасности VPC.
VpcSecurityGroupId -> (строка)
Status -> (строка)
DBParameterGroups -> (список)
Предоставляет список групп параметров базы данных, примененных к этому экземпляру базы данных.
(структура)
Состояние группы параметров базы данных.
Этот тип данных используется в качестве элемента ответа в следующих действиях:
- CreateDBInstance
- DeleteDBInstance
- ModifyDBInstance
- RebootDBInstance
DBParameterGroupName -> (строка)
ParameterApplyStatus -> (строка)
AvailabilityZone -> (строка)
DBSubnetGroup -> (структура)
Указывает информацию о группе подсетей, связанной с экземпляром базы данных, включая имя, описание и подсети в группе подсетей.
DBSubnetGroupName -> (строка)
DBSubnetGroupDescription -> (строка)
VpcId -> (строка)
SubnetGroupStatus -> (строка)
Subnets -> (список)
Содержит список элементов подсети.
(структура)
Указывает подсеть.
Этот тип данных используется в качестве элемента ответа в действии DescribeDBSubnetGroups.
SubnetIdentifier -> (строка)
SubnetAvailabilityZone -> (структура)
Указывает зону доступности EC2, в которой находится подсеть.
Name -> (строка)
SubnetStatus -> (строка)
DBSubnetGroupArn -> (строка)
PreferredMaintenanceWindow -> (строка)
PendingModifiedValues -> (структура)
Указывает, что изменения в экземпляре базы данных ожидаются. Этот элемент включается только при ожидании изменений. Конкретные изменения определяются подэлементами.
DBInstanceClass -> (строка)
DBInstanceClass для экземпляра базы данных, которое будет применено или в настоящее время применяется.AllocatedStorage -> (целое число)
AllocatedStorage для экземпляра базы данных, который будет применен или в настоящее время применяется.MasterUserPassword -> (строка)
Port -> (целое число)
BackupRetentionPeriod -> (целое число)
MultiAZ -> (булево)
EngineVersion -> (строка)
LicenseModel -> (строка)
Iops -> (целое число)
DBInstanceIdentifier -> (строка)
DBInstanceIdentifier для экземпляра базы данных, которое будет применено или в настоящее время применяется.StorageType -> (строка)
CACertificateIdentifier -> (строка)
DBSubnetGroupName -> (строка)
PendingCloudwatchLogsExports -> (структура)
Эта PendingCloudwatchLogsExports структура указывает ожидаемые изменения, для которых включены и отключены журналы CloudWatch.
LogTypesToEnable -> (список)
Типы журналов, которые находятся в процессе отключения. После отключения эти типы журналов не экспортируются в CloudWatch Logs.
(строка)
LogTypesToDisable -> (список)
Типы журналов, которые находятся в процессе включения. После включения эти типы журналов экспортируются в CloudWatch Logs.
(строка)
LatestRestorableTime -> (метка времени)
MultiAZ -> (булево)
EngineVersion -> (строка)
AutoMinorVersionUpgrade -> (булево)
ReadReplicaSourceDBInstanceIdentifier -> (строка)
ReadReplicaDBInstanceIdentifiers -> (список)
Содержит один или несколько идентификаторов реплик чтения, связанных с этим экземпляром базы данных.
(строка)
ReadReplicaDBClusterIdentifiers -> (список)
Содержит один или несколько идентификаторов кластеров базы данных, которые являются репликами чтения этого экземпляра базы данных.
(строка)
LicenseModel -> (строка)
Iops -> (целое число)
OptionGroupMemberships -> (список)
(структура)
Не поддерживается Neptune.
OptionGroupName -> (строка)
Status -> (строка)
CharacterSetName -> (строка)
SecondaryAvailabilityZone -> (строка)
PubliclyAccessible -> (булево)
StatusInfos -> (список)
Состояние реплики чтения. Если экземпляр не является репликой чтения, это пустое значение.
(структура)
Предоставляет список сведений о состоянии экземпляра базы данных.
StatusType -> (строка)
Normal -> (булево)
Status -> (строка)
Message -> (строка)
StorageType -> (строка)
TdeCredentialArn -> (строка)
DbInstancePort -> (целое число)
DBClusterIdentifier -> (строка)
StorageEncrypted -> (булево)
KmsKeyId -> (строка)
DbiResourceId -> (строка)
CACertificateIdentifier -> (строка)
DomainMemberships -> (список)
Не поддерживается
(структура)
Запись о членстве в домене Active Directory, связанная с экземпляром базы данных.
Domain -> (строка)
Status -> (строка)
FQDN -> (строка)
IAMRoleName -> (строка)
CopyTagsToSnapshot -> (булево)
MonitoringInterval -> (целое число)
EnhancedMonitoringResourceArn -> (string)
MonitoringRoleArn -> (string)
PromotionTier -> (integer)
DBInstanceArn -> (string)
Timezone -> (string)
IAMDatabaseAuthenticationEnabled -> (boolean)
PerformanceInsightsEnabled -> (boolean)
PerformanceInsightsKMSKeyId -> (string)
EnabledCloudwatchLogsExports -> (list)
Список типов журналов, которые этот экземпляр базы данных настроен на экспорт в CloudWatch Logs.
(string)
DeletionProtection -> (boolean)
© Copyright 2025, Amazon Web Services. Created using Sphinx.