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

# ClusterMasterUserSecret
<a name="API_ClusterMasterUserSecret"></a>

包含 Amazon DocumentDB 在 AWS Secrets Manager 中管理的用于主用户密码的密钥。

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

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

 ** KmsKeyId **   
用于加密密钥的 AWS KMS 密钥标识符。  
类型：字符串  
必需：否

 ** SecretArn **   
密钥的 Amazon 资源名称（ARN）。  
类型：字符串  
必需：否

 ** SecretStatus **   
密钥的状态。  
可能的状态值包括：  
+ creating – 密钥正在创建中。
+ active – 密钥可用于正常使用和轮换。
+ rotating – 密钥正在轮换。
+ impaired – 密钥可用于访问数据库凭证，但不能轮换。例如，如果权限发生了更改，使得 Amazon DocumentDB 无法再访问密钥或密钥的 KMS 密钥，则密钥可能具有此状态。

  当密钥具有此状态时，您可以更正导致该状态的条件。或者，修改实例以关闭数据库凭证的自动管理，然后再次修改实例以启用数据库凭证的自动管理。
类型：字符串  
必需：否

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

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