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

# ClusterSnapshot
<a name="API_elastic_ClusterSnapshot"></a>

返回有关特定弹性集群快照的信息。

## 目录
<a name="API_elastic_ClusterSnapshot_Contents"></a>

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

 ** adminUserName **   <a name="documentdb-Type-elastic_ClusterSnapshot-adminUserName"></a>
弹性集群管理员的名称。  
类型：字符串  
必需：是

 ** clusterArn **   <a name="documentdb-Type-elastic_ClusterSnapshot-clusterArn"></a>
弹性集群的 ARN 标识符。  
类型：字符串  
必需：是

 ** clusterCreationTime **   <a name="documentdb-Type-elastic_ClusterSnapshot-clusterCreationTime"></a>
创建弹性集群的时间，采用通用协调时间 (UTC)。  
类型：字符串  
必需：是

 ** kmsKeyId **   <a name="documentdb-Type-elastic_ClusterSnapshot-kmsKeyId"></a>
KMS 密钥标识符是 KMS 加密密钥的 Amazon 资源名称 (ARN)。如果使用拥有此 KMS 加密密钥的同一 Amazon 账户创建集群，则可以使用 KMS 密钥别名而不是 ARN 作为 KMS 加密密钥。如果此处未指定加密密钥，Amazon DocumentDB 将使用 KMS 为您的账户创建的默认加密密钥。您的账户在每个 Amazon 区域都有一个不同的默认加密密钥。  
类型：字符串  
必需：是

 ** snapshotArn **   <a name="documentdb-Type-elastic_ClusterSnapshot-snapshotArn"></a>
弹性集群快照的 ARN 标识符。  
类型：字符串  
必需：是

 ** snapshotCreationTime **   <a name="documentdb-Type-elastic_ClusterSnapshot-snapshotCreationTime"></a>
创建弹性集群快照的时间，采用通用协调时间 (UTC)。  
类型：字符串  
必需：是

 ** snapshotName **   <a name="documentdb-Type-elastic_ClusterSnapshot-snapshotName"></a>
弹性集群快照的名称。  
类型：字符串  
必需：是

 ** status **   <a name="documentdb-Type-elastic_ClusterSnapshot-status"></a>
弹性集群快照的状态。  
类型：字符串  
有效值：`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 **   <a name="documentdb-Type-elastic_ClusterSnapshot-subnetIds"></a>
弹性集群的 Amazon EC2 子网 ID。  
类型：字符串数组  
必需：是

 ** vpcSecurityGroupIds **   <a name="documentdb-Type-elastic_ClusterSnapshot-vpcSecurityGroupIds"></a>
要与弹性集群关联的 EC2 VPC 安全组的列表。  
类型：字符串数组  
必需：是

 ** snapshotType **   <a name="documentdb-Type-elastic_ClusterSnapshot-snapshotType"></a>
要返回的集群快照的类型。可以指定以下值之一：  
+  `automated` - 返回 Amazon DocumentDB 已为您的 AWS 账户自动创建的所有集群快照。
+  `manual` - 返回您已为自身 AWS 账户手动创建的所有集群快照。
类型：字符串  
有效值：`MANUAL | AUTOMATED`  
必需：否

## 另请参阅
<a name="API_elastic_ClusterSnapshot_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ClusterSnapshot) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ClusterSnapshot) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ClusterSnapshot)