本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
DBInstance
有关实例的详细信息。
内容
注意
下表中,首先描述的是必需参数。
- AutoMinorVersionUpgrade
-
不适用。此参数不适用于 Amazon DocumentDB。无论设置的值如何,Amazon DocumentDB 都不会执行次要版本升级。
类型:布尔值
必需:否
- AvailabilityZone
-
指定实例所在可用区域的名称。
类型:字符串
必需:否
- BackupRetentionPeriod
-
指定自动快照的保留天数。
类型:整数
必需:否
- CACertificateIdentifier
-
此数据库实例的 CA 证书的标识符。
类型:字符串
必需:否
- CertificateDetails
-
数据库实例服务器证书的详细信息。
类型:CertificateDetails 对象
必需:否
- CopyTagsToSnapshot
-
指示是否将标签从数据库实例复制到数据库实例快照的值。默认情况下,不复制标签。
类型:布尔值
必需:否
- DBClusterIdentifier
-
如果实例属于某个集群,则包含实例所属的集群的名称。
类型:字符串
必需:否
- DBInstanceArn
-
实例的 Amazon 资源名称(ARN)。
类型:字符串
必需:否
- DBInstanceClass
-
包含实例的计算和内存容量级别名称。
类型:字符串
必需:否
- DBInstanceIdentifier
-
包含用户提供的数据库标识符。此标识符是标识实例的唯一密钥。
类型:字符串
必需:否
- DBInstanceStatus
-
指定此数据库的当前状态。
类型:字符串
必需:否
- DbiResourceId
-
实例 AWS 区域的唯一不可变标识符。每当访问实例的 AWS KMS 密钥时,都会在 AWS CloudTrail 日志条目中找到此标识符。
类型:字符串
必需:否
- DBSubnetGroup
-
指定与实例关联的子网组的信息,包括名称、描述和子网组中的子网。
类型:DBSubnetGroup 对象
必需:否
- EnabledCloudwatchLogsExports.member.N
-
此实例配置为导出到 CloudWatch 日志的日志类型列表。
类型:字符串数组
必需:否
- Endpoint
-
指定连接端点。
类型:Endpoint 对象
必需:否
- Engine
-
提供要用于此实例的数据库引擎的名称。
类型:字符串
必需:否
- EngineVersion
-
指示数据库引擎版本。
类型:字符串
必需:否
- InstanceCreateTime
-
提供创建实例的日期和时间。
类型:时间戳
必需:否
- KmsKeyId
-
如果
StorageEncrypted
是true
,则为加密实例的 AWS KMS 密钥标识符。类型:字符串
必需:否
- LatestRestorableTime
-
指定通过还原可以将数据库 point-in-time还原到的最晚时间。
类型:时间戳
必需:否
- PendingModifiedValues
-
指定对实例的更改待处理。仅在更改待处理时包含此元素。特定更改由子元素标识。
类型:PendingModifiedValues 对象
必需:否
- PreferredBackupWindow
-
指定在启用自动备份时,自动执行备份的日常时间范围,如
BackupRetentionPeriod
所规定。类型:字符串
必需:否
- PreferredMaintenanceWindow
-
指定可进行系统维护的每周时间范围(采用通用协调时间 (UTC))。
类型:字符串
必需:否
- PromotionTier
-
该值指定在现有主实例发生故障后将 Amazon DocumentDB 副本提升为主实例的顺序。
类型:整数
必需:否
- PubliclyAccessible
-
不支持。Amazon DocumentDB 目前不支持公有端点。
PubliclyAccessible
的值始终为false
。类型:布尔值
必需:否
- StatusInfos.DBInstanceStatusInfo.N
-
只读副本的状态。如果实例不是只读副本,则此项空白。
类型:DBInstanceStatusInfo 对象数组
必需:否
- StorageEncrypted
-
指定是否已对实例加密。
类型:布尔值
必需:否
- VpcSecurityGroups.VpcSecurityGroupMembership.N
-
提供实例所属的 VPC 安全组元素的列表。
类型:VpcSecurityGroupMembership 对象数组
必需:否
另请参阅
有关在特定语言的 AWS SDK 中使用此 API 的更多信息,请参阅以下内容: