Cluster - Amazon DocumentDB

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

Cluster

返回有关特定静态集群的信息。

内容

注意

下表中首先描述了必需参数。

adminUserName

弹性集群管理员的名称。

类型:字符串

必需:是

authType

弹性集群的身份验证类型。

类型:字符串

有效值:PLAIN_TEXT | SECRET_ARN

必需:是

clusterArn

弹性集群的ARN标识符。

类型:字符串

必需:是

clusterEndpoint

URL用于连接到弹性集群。

类型:字符串

必需:是

clusterName

弹性集群的名称。

类型:字符串

必需:是

createTime

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

类型:字符串

必需:是

kmsKeyId

用于加密弹性集群的密KMS钥标识符。

类型:字符串

必需:是

preferredMaintenanceWindow

每周可以进行系统维护的时间范围,以通用协调时间 (UTC) 为单位。

Format: ddd:hh24:mi-ddd:hh24:mi

类型:字符串

必需:是

shardCapacity

vCPUs 分配给每个弹性集群分片的数量。最大值为 64。允许值为 2、4、8、16、32、64。

类型:整数

必需:是

shardCount

分配给弹性集群的分片数目。最大值为 32。

类型:整数

必需:是

status

弹性集群的状态。

类型:字符串

有效值:CREATING | ACTIVE | DELETING | UPDATING | VPC_ENDPOINT_LIMIT_EXCEEDED | IP_ADDRESS_LIMIT_EXCEEDED | INVALID_SECURITY_GROUP_ID | INVALID_SUBNET_ID | INACCESSIBLE_ENCRYPTION_CREDS | INACCESSIBLE_SECRET_ARN | INACCESSIBLE_VPC_ENDPOINT | INCOMPATIBLE_NETWORK | MERGING | MODIFYING | SPLITTING | COPYING | STARTING | STOPPING | STOPPED | MAINTENANCE | INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE

必需:是

subnetIds

弹性集群IDs的 Amazon EC2 子网。

类型:字符串数组

必需:是

vpcSecurityGroupIds

与该弹性集群关联EC2VPC的安全组列表。

类型:字符串数组

必需:是

backupRetentionPeriod

保留自动快照的天数。

类型:整数

必需:否

preferredBackupWindow

如果启用了自动备份,则创建自动备份的每日时间范围,由确定backupRetentionPeriod

类型:字符串

必需:否

shardInstanceCount

应用于集群中所有分片的副本实例数量。shardInstanceCount值为 1 表示只有一个写入器实例,而任何其他实例都是可用于读取和提高可用性的副本。

类型:整数

必需:否

shards

集群中的分片总数。

类型:Shard 对象数组

必需:否

另请参阅

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