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

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

DBInstance

有关实例的详细信息。

目录

注意

在下面的列表中,首先描述了必需的参数。

AutoMinorVersionUpgrade

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

类型: 布尔值

必需 否

AvailabilityZone

指定实例所在的可用区名称。

类型: 字符串

必需 否

BackupRetentionPeriod

指定自动快照的保留天数。

类型: 整数

必需 否

CACertificateIdentifier

此数据库实例的 CA 证书的标识符。

类型: 字符串

必需 否

CopyTagsToSnapshot

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

类型: 布尔值

必需 否

DBClusterIdentifier

如果实例是集群的成员,则包含该实例所属集群的名称。

类型: 字符串

必需 否

DBInstanceArn

实例的 Amazon 资源名称(ARN)。

类型: 字符串

必需 否

DBInstanceClass

包含实例的计算和内存容量类的名称。

类型: 字符串

必需 否

DBInstanceIdentifier

包含用户提供的数据库标识符。此标识符是识别实例的唯一键。

类型: 字符串

必需 否

DBInstanceStatus

指定此数据库的当前状态。

类型: 字符串

必需 否

DbiResourceId

这些区域有:Amazon Web Services 区域-实例的唯一不可变标识符。此标识符位于Amazon CloudTrail每当日志条目Amazon KMS访问该实例的密钥。

类型: 字符串

必需 否

DBSubnetGroup

指定与实例关联的子网组的信息,包括名称、描述和子网组中的子网。

类型:DBSubnetGroup 对象

必需 否

EnabledCloudwatchLogsExports.member.N

此实例配置为导出到的日志类型列表 CloudWatch 日志。

类型: 字符串数组

必需 否

Endpoint

指定连接终端节点。

类型:Endpoint 对象

必需 否

Engine

提供用于此实例的数据库引擎的名称。

类型: 字符串

必需 否

EngineVersion

指示数据库引擎版本。

类型: 字符串

必需 否

InstanceCreateTime

提供创建实例的日期和时间。

类型: 时间戳

必需 否

KmsKeyId

如果StorageEncryptedtrue,Amazon KMS加密实例的密钥标识符。

类型: 字符串

必需 否

LatestRestorableTime

指定数据库可以恢复到的最新时间 point-in-time还原。

类型: 时间戳

必需 否

PendingModifiedValues

指定对实例的更改处于待处理状态。只有在更改待处理时才包含此元素。特定更改由子元素标识。

类型:PendingModifiedValues 对象

必需 否

PreferredBackupWindow

指定在启用自动备份时,自动执行备份的日常时间范围,如 BackupRetentionPeriod 所规定。

类型: 字符串

必需 否

PreferredMaintenanceWindow

指定可进行系统维护的每周时间范围(采用通用协调时间 (UTC))。

类型: 字符串

必需 否

PromotionTier

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

类型: 整数

必需 否

PubliclyAccessible

不支持。Amazon DocumentDB B 目前不支持公共终端节点。的值PubliclyAccessible总是false.

类型: 布尔值

必需 否

StatusInfos.DBInstanceStatusInfo.N

只读副本的状态。如果该实例不是只读副本,则为空。

类型: 数组DBInstanceStatusInfo对象

必需 否

StorageEncrypted

指定实例是否已加密。

类型: 布尔值

必需 否

VpcSecurityGroups.VpcSecurityGroupMembership.N

提供实例所属的 VPC 安全组元素的列表。

类型: 数组VpcSecurityGroupMembership对象

必需 否

另请参阅

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