ModifyDBInstance - Amazon DocumentDB
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 Amazon Web Services 服务入门

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

ModifyDBInstance

修改实例的设置。您可通过在请求中指定这些参数以及新值,更改一个或多个数据库配置参数。

请求参数

有关所有操作的通用参数的信息,请参见常见参数.

DBInstanceIdentifier

实例标识符。此值以一个小写字符串存储。

约束:

  • 必须匹配现有标识符匹配DBInstance.

类型: 字符串

必需 是

ApplyImmediately

指定是否尽快异步应用此请求中的修改和任何待处理的修改,无论如何PreferredMaintenanceWindow为实例设置。

如果将参数设置为false,对实例所做更改在下一维护时段内生效。某些参数更改可能会导致中断,并在下次重新启动时应用。

默认值:false

类型: 布尔值

必需 否

AutoMinorVersionUpgrade

此参数不适用于 Amazon DocumentDB。无论设置的值如何,Amazon DocumentDB 都不会执行次要版本升级。

类型: 布尔值

必需 否

CACertificateIdentifier

指示需要与实例相关联的证书。

类型: 字符串

必需 否

CopyTagsToSnapshot

指示是否将数据库实例的所有标签复制到数据库实例快照的值。默认情况下,不复制标签。

类型: 布尔值

必需 否

DBInstanceClass

实例的新计算和内存容量;例如,db.r5.large. 并非所有实例类都可用Amazon Web Services 区域.

如果您修改实例类,则在更改期间会发生中断。更改在下一个维护时段内应用,除非此请求的 ApplyImmediately 指定为 true

默认值:使用现有设置。

类型: 字符串

必需 否

EnablePerformanceInsights

指示是否为数据库实例启用 Performance Insights 的值。有关更多信息,请参阅 。使用亚马逊Performance Insights.

类型: 布尔值

必需 否

NewDBInstanceIdentifier

重命名实例时,实例的新实例标识符。当您更改实例标识符时,如果您设置了实例标识符,则实例会立即重启Apply Immediatelytrue. 如果设置,则在下一维护时段内生效Apply Immediatelyfalse. 此值以一个小写字符串存储。

约束:

  • 必须包含 1 到 63 个字母、数字或连字符。

  • 第一个字符必须是字母。

  • 不能以连字符结束或包含两个连续连字符。

示例:mydbinstance

类型: 字符串

必需 否

PerformanceInsightsKMSKeyId

用于加密 Performance Insights 数据的 Amazon KMS 密钥标识符。

这些区域有:Amazon KMS密钥 ARN、密钥 ID、别名 ARN、密钥 ID、密钥 ID、密钥 ID、密钥 ID、密钥 ID、密钥 ID、密钥 ID、

如果您未指定值 PerformanceInsights自杀KeyId,则亚马逊文档数据库会使用您的默认 KS DocumentDB 使用您的默认 K 您的亚马逊云科技账户有一个默认 KS 云密钥。您的Amazon Web Services 账户在每个Amazon Web Services 云科技区域都有不同的默认 KMS 密钥。

类型: 字符串

必需 否

PreferredMaintenanceWindow

可进行系统维护的每周时间范围(采用 UTC),这可能导致中断。更改此参数不会导致中断,所做更改不会导致中断,所做更改会尽快以异步方式应用。如果有待操作导致重启动,并且维护时段经过更改,加入了当前时间,更改此参数会导致实例重启动。如果将此时段移到当前时间,则当前时间与该时段结束之间必须相隔至少 30 分钟以确保应用待处理的更改。

默认值:使用现有设置。

格式:ddd:hh24:mi-ddd:hh24:mi

有效值:Mon、Tue、Wed、Thu、Fri、Wed、Fri、Sat、

约束:必须至少为 30 分钟。

类型: 字符串

必需 否

PromotionTier

该值指定在现有主实例发生故障后将 Amazon DocumentDB 副本提升为主实例的顺序。

默认值:1

有效值:0-15

类型: 整数

必需 否

响应元素

以下元素由服务返回。

DBInstance

有关实例的详细信息。

类型:DBInstance 对象

错误

有关所有操作的常见错误的信息,请参见常见错误.

AuthorizationNotFound

指定的 CIDR IP 或 Amazon EC2 安全组未被授权进入指定的安全组。

Amazon DocumentDB B 也可能无权使用 IAM 代表您执行必要的操作。

HTTP 状态代码:404

CertificateNotFound

CertificateIdentifier不引用现有证书。

HTTP 状态代码:404

DBInstanceAlreadyExists

您已经有一个具有给定标识符的实例。

HTTP 状态代码:400

DBInstanceNotFound

DBInstanceIdentifier不引用现有实例。

HTTP 状态代码:404

DBParameterGroupNotFound

DBParameterGroupName不引用现有参数组。

HTTP 状态代码:404

DBSecurityGroupNotFound

DBSecurityGroupName不引用现有安全组。

HTTP 状态代码:404

DBUpgradeDependencyFailure

升级失败,因为依赖的资源无法修改。

HTTP 状态代码:400

InsufficientDBInstanceCapacity

指定的实例类在指定可用区中不可用。

HTTP 状态代码:400

InvalidDBInstanceState

指定的实例不在可用状态。

HTTP 状态代码:400

InvalidDBSecurityGroupState

安全组的状态不允许删除。

HTTP 状态代码:400

InvalidVPCNetworkStateFault

由于进行了更改,子网组创建后并未覆盖所有可用区。

HTTP 状态代码:400

StorageQuotaExceeded

该请求将导致您超过所有实例的允许可用存储量。

HTTP 状态代码:400

StorageTypeNotSupported

存储指定的StorageType无法与数据库实例相关联。

HTTP 状态代码:400

另请参阅

有关在特定语言的 Amazon 软件开发工具包中使用此 API 的更多信息,请参阅以下内容: