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

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

DBCluster

有关集群的详细信息。

目录

注意

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

AssociatedRoles.DBClusterRole.N

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

类型: 数组DBClusterRole对象

:必需 否

AvailabilityZones.AvailabilityZone.N

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

类型: 字符串数组

:必需 否

BackupRetentionPeriod

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

类型: 整数

:必需 否

ClusterCreateTime

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

类型: 时间戳

:必需 否

DBClusterArn

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

类型: 字符串

:必需 否

DBClusterIdentifier

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

类型: 字符串

:必需 否

DBClusterMembers.DBClusterMember.N

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

类型: 数组DBClusterMember对象

:必需 否

DBClusterParameterGroup

指定集群参数组的名称。

类型: 字符串

:必需 否

DbClusterResourceId

这些区域有:Amazon Web Services 区域-集群的唯一且不变的标识符。此标识符可在Amazon CloudTrail随时记录条目Amazon KMS已访问集群的密钥。

类型: 字符串

:必需 否

DBSubnetGroup

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

类型: 字符串

:必需 否

DeletionProtection

指定是否可以删除此集群。如果DeletionProtection已启用,除非集群被修改,否则无法删除集群。DeletionProtection已禁用。DeletionProtection防止意外删除集群。

类型: Boolean

:必需 否

EarliestRestorableTime

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

类型: 时间戳

:必需 否

EnabledCloudwatchLogsExports.member.N

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

类型: 字符串数组

:必需 否

Endpoint

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

类型: 字符串

:必需 否

Engine

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

类型: 字符串

:必需 否

EngineVersion

指示数据库引擎版本。

类型: 字符串

:必需 否

HostedZoneId

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

类型: 字符串

:必需 否

KmsKeyId

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

类型: 字符串

:必需 否

LatestRestorableTime

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

类型: 时间戳

:必需 否

MasterUsername

包含集群的主用户名。

类型: 字符串

:必需 否

MultiAZ

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

类型: Boolean

:必需 否

PercentProgress

指定操作的进度百分比。

类型: 字符串

:必需 否

Port

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

类型: 整数

:必需 否

PreferredBackupWindow

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

类型: 字符串

:必需 否

PreferredMaintenanceWindow

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

类型: 字符串

:必需 否

ReaderEndpoint

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

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

类型: 字符串

:必需 否

ReadReplicaIdentifiers.ReadReplicaIdentifier.N

包含一个或多个与此集群关联的辅助集群的标识符。

类型: 字符串数组

:必需 否

ReplicationSourceIdentifier

包含源集群(如果此集群是辅助集群)的标识符。

类型: 字符串

:必需 否

Status

指定此集群的当前状态。

类型: 字符串

:必需 否

StorageEncrypted

指定集群是否已加密。

类型: Boolean

:必需 否

VpcSecurityGroups.VpcSecurityGroupMembership.N

提供集群所属的虚拟私有云 (VPC) 安全组的列表。

类型: 数组VpcSecurityGroupMembership对象

:必需 否

另请参阅

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