ModifyDBInstance - Amazon DocumentDB
请求参数响应元素错误另请参阅
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异，请参阅 中国的 Amazon Web Services 服务入门 (PDF)。

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

ModifyDBInstance

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

请求参数

有关所有操作的通用参数的信息，请参阅通用参数。

DBInstanceIdentifier

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

约束：

  • 必须与现有 DBInstance 的标识符匹配。

类型：字符串

必需：是

ApplyImmediately

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

如果此参数设置为 false，则在下一个维护时段中应用对实例的更改。某些参数更改会导致中断，在下次重启时应用。

默认：false

类型：布尔值

必需：否

AutoMinorVersionUpgrade

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

类型：布尔值

必需：否

CACertificateIdentifier

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

类型：字符串

必需：否

CertificateRotationRestart

指定在您轮换 SSL/TLS 证书时，是否重新启动 DB 实例。

默认情况下，当您轮换 SSL/TLS 证书时，DB 实例重新启动。证书直到 DB 实例重新启动才更新。

重要

仅当您未使用 SSL/TLS 连接到数据库实例时，才设置 此参数。

如果您正使用 SSL/TLS 连接到 DB 实例，请参阅 Amazon DocumentDB 开发者指南中的更新您的 Amazon DocumentDB TLS 证书和传输中数据加密。

类型：布尔值

必需：否

CopyTagsToSnapshot

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

类型：布尔值

必需：否

DBInstanceClass

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

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

默认值：使用现有设置。

类型：字符串

必需：否

EnablePerformanceInsights

指示是否为数据库实例启用 Performance Insights 的值。有关更多信息，请参阅使用 Amazon Performance Insights。

类型：布尔值

必需：否

NewDBInstanceIdentifier

重命名实例时实例的新标识符。当您更改实例标识符时，如果您将 Apply Immediately 设置成 true，则实例重启立即发生。如果您将 Apply Immediately 设置成 false，则实例重启在下一个维护窗口期间发生。此值以一个小写字符串存储。

约束：

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

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

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

例如：mydbinstance

类型：字符串

必需：否

PerformanceInsightsKMSKeyId

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

Amazon KMS 密钥标识符是 KMS 密钥的密钥 ARN、密钥 ID、别名 ARN 或 KMS 密钥的别名。

如果您没有为 PerformanceInsights KMS 指定值KeyId，则亚马逊文档数据库将使用您的默认 KMS 密钥。您的 Amazon Web Services 账户有默认 KMS 密钥。您的 Amazon 网络服务账户对每个 Amazon 网络服务区具有不同的默认 KMS 密钥。

类型：字符串

必需：否

PreferredMaintenanceWindow

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

默认值：使用现有设置。

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

有效日：Mon、Tue、Wed、Thu、Fri、Sat、Sun

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

类型：字符串

必需：否

PromotionTier

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

默认值：1

有效值：0-15

类型：整数

必需：否

响应元素

服务返回以下元素。

DBInstance

有关实例的详细信息。

类型：DBInstance 对象

错误

有关所有操作的常见错误的信息，请参阅常见错误。

AuthorizationNotFound

已指定的 CIDR IP 或 Amazon EC2 安全组未获得指定的安全组的授权。

Amazon DocumentDB 也可能未授权代表您使用 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 SDK 中使用此 API 的更多信息，请参阅以下内容：