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

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

DBCluster

有关集群的详细信息。

Contents

注意

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

关联者。数据库群集角色。n

提供与集群关联的 AWS Identity of Access Management (IAM) 角色的列表。与集群关联的 IAM 角色授予集群代表您访问其他 AWS 服务的权限。

类型: 数组DBClusterRoleobjects

:必需 否

可用性区域。可用性区。n

提供可在其中创建集群中的实例的 Amazon EC2 可用区的列表。

类型: 字符串数组

:必需 否

BackupRetentionPeriod

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

类型: 整数

:必需 否

ClusterCreateTime

指定集群的创建时间,采用通用协调时 (UTC)。

类型: 时间戳

:必需 否

DBClusterArn

集群的 Amazon 资源名称 (ARN)。

类型: 字符串

:必需 否

DBClusterIdentifier

包含用户提供的集群标识符。此标识符是识别集群的唯一键。

类型: 字符串

:必需 否

数据库群集成员。数据库群集成员。n

提供组成集群的实例的列表。

类型: 数组DBClusterMemberobjects

:必需 否

DBClusterParameterGroup

指定集群参数组的名称。

类型: 字符串

:必需 否

DbClusterResourceId

集群在 AWS 区域中唯一的不可变标识符。只要访问了用户集群的 AWS KMS 密钥,就可在 AWS CloudTrail 日志条目中找到此标识符。

类型: 字符串

:必需 否

DBSubnetGroup

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

类型: 字符串

:必需 否

DeletionProtection

指定是否可以删除此集群。如果DeletionProtection,则无法删除集群,除非集群被修改,并且DeletionProtection处于禁用状态。DeletionProtection防止意外删除集群。

类型: Boolean

:必需 否

EarliestRestorableTime

数据库可以使用时间点还原的最早还原时间。

类型: 时间戳

:必需 否

已启用云监视日志性别。成员。n

此集群配置为导出到 Amazon CloudWatch Logs 的日志类型的列表。

类型: 字符串数组

:必需 否

Endpoint

指定集群的主实例的连接终端节点。

类型: 字符串

:必需 否

Engine

提供要用于此集群的数据库引擎的名称。

类型: 字符串

:必需 否

EngineVersion

指示数据库引擎版本。

类型: 字符串

:必需 否

HostedZoneId

指定在您创建托管区域时 Amazon Route 53 分配的 ID。

类型: 字符串

:必需 否

KmsKeyId

如果StorageEncryptedtrue,即加密集群的 AWS KMS 密钥标识符。

类型: 字符串

:必需 否

LatestRestorableTime

指定数据库可以使用时间点还原的最新还原时间。

类型: 时间戳

:必需 否

MasterUsername

包含集群的主用户名。

类型: 字符串

:必需 否

MultiAZ

指定集群是否在多个可用区中有实例。

类型: Boolean

:必需 否

PercentProgress

指定操作的进度百分比。

类型: 字符串

:必需 否

端口

指定数据库引擎侦听的端口。

类型: 整数

:必需 否

PreferredBackupWindow

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

类型: 字符串

:必需 否

PreferredMaintenanceWindow

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

类型: 字符串

:必需 否

ReaderEndpoint

集群的读取器终端节点。集群的读取器终端节点跨集群中可用的 Amazon DocumentDB 副本,实现连接的负载均衡。当客户端请求与读取器终端节点的新连接时,Amazon DocumentDB 将在集群中的 Amazon DocumentDB 副本之间分配连接请求。此功能可帮助平衡跨集群中的多个 Amazon DocumentDB 副本的读取工作负载。

如果发生了故障转移并且连接到的 Amazon DocumentDB 副本将提升到主实例,则将删除您的连接。要继续向集群中的其他 Amazon DocumentDB 副本发送读取工作负载,您可以随后重新连接到读取器终端节点。

类型: 字符串

:必需 否

状态

指定此集群的当前状态。

类型: 字符串

:必需 否

StorageEncrypted

指定集群是否已加密。

类型: Boolean

:必需 否

VPC 安全组。VPC 安全组成员。n

提供集群所属的 Virtual Private Cloud (VPC) 安全组的列表。

类型: 数组VpcSecurityGroupMembershipobjects

:必需 否

另请参阅

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