DBCluster - Amazon DocumentDB

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

DBCluster

有关集群的详细信息。

内容

注意

下表中,首先描述的是必需参数。

AssociatedRoles.DBClusterRole.N

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

类型:DBClusterRole 对象数组

必需:否

AvailabilityZones.AvailabilityZone.N

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

类型:字符串数组

必需:否

BackupRetentionPeriod

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

类型:整数

必需:否

CloneGroupId

标识数据库集群与之关联的克隆组。

类型:字符串

必需:否

ClusterCreateTime

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

类型:时间戳

必需:否

DBClusterArn

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

类型:字符串

必需:否

DBClusterIdentifier

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

类型:字符串

必需:否

DBClusterMembers.DBClusterMember.N

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

类型:DBClusterMember 对象数组

必需:否

DBClusterParameterGroup

指定集群的集群参数组名称。

类型:字符串

必需:否

DbClusterResourceId

集群在 AWS 区域 中唯一的不可变标识符。每次访问集群的 AWS KMS 密钥时,可以在 AWS CloudTrail 日志条目中找到该标识符。

类型:字符串

必需:否

DBSubnetGroup

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

类型:字符串

必需:否

DeletionProtection

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

类型:布尔值

必需:否

EarliestRestorableTime

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

类型:时间戳

必需:否

EnabledCloudwatchLogsExports.member.N

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

类型:字符串数组

必需:否

Endpoint

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

类型:字符串

必需:否

Engine

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

类型:字符串

必需:否

EngineVersion

指示数据库引擎版本。

类型:字符串

必需:否

HostedZoneId

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

类型:字符串

必需:否

KmsKeyId

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

类型:字符串

必需:否

LatestRestorableTime

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

类型:时间戳

必需:否

MasterUsername

包含集群的主用户名。

类型:字符串

必需:否

MultiAZ

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

类型:布尔值

必需:否

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

指定集群是否已加密。

类型:布尔值

必需:否

StorageType

与集群关联的存储类型

与集群关联的存储类型

有关 Amazon DocumentDB 集群存储类型的信息,请参阅《Amazon DocumentDB 开发人员指南》中的集群存储配置。

存储类型的有效值 - standard | iopt1

默认值为 standard

类型:字符串

必需:否

VpcSecurityGroups.VpcSecurityGroupMembership.N

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

类型:VpcSecurityGroupMembership 对象数组

必需:否

另请参阅

有关在特定语言的 AWS SDK 中使用此 API 的更多信息,请参阅以下内容: