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

# 数据类型
<a name="API_Types"></a>

支持以下数据类型 Amazon DocumentDB (with MongoDB compatibility)：
+  [AvailabilityZone](API_AvailabilityZone.md) 
+  [Certificate](API_Certificate.md) 
+  [CertificateDetails](API_CertificateDetails.md) 
+  [CloudwatchLogsExportConfiguration](API_CloudwatchLogsExportConfiguration.md) 
+  [ClusterMasterUserSecret](API_ClusterMasterUserSecret.md) 
+  [DBCluster](API_DBCluster.md) 
+  [DBClusterMember](API_DBClusterMember.md) 
+  [DBClusterParameterGroup](API_DBClusterParameterGroup.md) 
+  [DBClusterRole](API_DBClusterRole.md) 
+  [DBClusterSnapshot](API_DBClusterSnapshot.md) 
+  [DBClusterSnapshotAttribute](API_DBClusterSnapshotAttribute.md) 
+  [DBClusterSnapshotAttributesResult](API_DBClusterSnapshotAttributesResult.md) 
+  [DBEngineVersion](API_DBEngineVersion.md) 
+  [DBInstance](API_DBInstance.md) 
+  [DBInstanceStatusInfo](API_DBInstanceStatusInfo.md) 
+  [DBSubnetGroup](API_DBSubnetGroup.md) 
+  [Endpoint](API_Endpoint.md) 
+  [EngineDefaults](API_EngineDefaults.md) 
+  [Event](API_Event.md) 
+  [EventCategoriesMap](API_EventCategoriesMap.md) 
+  [EventSubscription](API_EventSubscription.md) 
+  [FailoverState](API_FailoverState.md) 
+  [Filter](API_Filter.md) 
+  [GlobalCluster](API_GlobalCluster.md) 
+  [GlobalClusterMember](API_GlobalClusterMember.md) 
+  [OrderableDBInstanceOption](API_OrderableDBInstanceOption.md) 
+  [Parameter](API_Parameter.md) 
+  [PendingCloudwatchLogsExports](API_PendingCloudwatchLogsExports.md) 
+  [PendingMaintenanceAction](API_PendingMaintenanceAction.md) 
+  [PendingModifiedValues](API_PendingModifiedValues.md) 
+  [ResourcePendingMaintenanceActions](API_ResourcePendingMaintenanceActions.md) 
+  [ServerlessV2FeaturesSupport](API_ServerlessV2FeaturesSupport.md) 
+  [ServerlessV2ScalingConfiguration](API_ServerlessV2ScalingConfiguration.md) 
+  [ServerlessV2ScalingConfigurationInfo](API_ServerlessV2ScalingConfigurationInfo.md) 
+  [Subnet](API_Subnet.md) 
+  [Tag](API_Tag.md) 
+  [UpgradeTarget](API_UpgradeTarget.md) 
+  [VpcSecurityGroupMembership](API_VpcSecurityGroupMembership.md) 

Amazon DocumentDB 弹性集群支持以下数据类型：
+  [Cluster](API_elastic_Cluster.md) 
+  [ClusterInList](API_elastic_ClusterInList.md) 
+  [ClusterSnapshot](API_elastic_ClusterSnapshot.md) 
+  [ClusterSnapshotInList](API_elastic_ClusterSnapshotInList.md) 
+  [PendingMaintenanceActionDetails](API_elastic_PendingMaintenanceActionDetails.md) 
+  [ResourcePendingMaintenanceAction](API_elastic_ResourcePendingMaintenanceAction.md) 
+  [Shard](API_elastic_Shard.md) 
+  [ValidationExceptionField](API_elastic_ValidationExceptionField.md) 

# Amazon DocumentDB (with MongoDB compatibility)
<a name="API_Types_Amazon_DocumentDB_with_MongoDB_compatibility"></a>

支持以下数据类型 Amazon DocumentDB (with MongoDB compatibility)：
+  [AvailabilityZone](API_AvailabilityZone.md) 
+  [Certificate](API_Certificate.md) 
+  [CertificateDetails](API_CertificateDetails.md) 
+  [CloudwatchLogsExportConfiguration](API_CloudwatchLogsExportConfiguration.md) 
+  [ClusterMasterUserSecret](API_ClusterMasterUserSecret.md) 
+  [DBCluster](API_DBCluster.md) 
+  [DBClusterMember](API_DBClusterMember.md) 
+  [DBClusterParameterGroup](API_DBClusterParameterGroup.md) 
+  [DBClusterRole](API_DBClusterRole.md) 
+  [DBClusterSnapshot](API_DBClusterSnapshot.md) 
+  [DBClusterSnapshotAttribute](API_DBClusterSnapshotAttribute.md) 
+  [DBClusterSnapshotAttributesResult](API_DBClusterSnapshotAttributesResult.md) 
+  [DBEngineVersion](API_DBEngineVersion.md) 
+  [DBInstance](API_DBInstance.md) 
+  [DBInstanceStatusInfo](API_DBInstanceStatusInfo.md) 
+  [DBSubnetGroup](API_DBSubnetGroup.md) 
+  [Endpoint](API_Endpoint.md) 
+  [EngineDefaults](API_EngineDefaults.md) 
+  [Event](API_Event.md) 
+  [EventCategoriesMap](API_EventCategoriesMap.md) 
+  [EventSubscription](API_EventSubscription.md) 
+  [FailoverState](API_FailoverState.md) 
+  [Filter](API_Filter.md) 
+  [GlobalCluster](API_GlobalCluster.md) 
+  [GlobalClusterMember](API_GlobalClusterMember.md) 
+  [OrderableDBInstanceOption](API_OrderableDBInstanceOption.md) 
+  [Parameter](API_Parameter.md) 
+  [PendingCloudwatchLogsExports](API_PendingCloudwatchLogsExports.md) 
+  [PendingMaintenanceAction](API_PendingMaintenanceAction.md) 
+  [PendingModifiedValues](API_PendingModifiedValues.md) 
+  [ResourcePendingMaintenanceActions](API_ResourcePendingMaintenanceActions.md) 
+  [ServerlessV2FeaturesSupport](API_ServerlessV2FeaturesSupport.md) 
+  [ServerlessV2ScalingConfiguration](API_ServerlessV2ScalingConfiguration.md) 
+  [ServerlessV2ScalingConfigurationInfo](API_ServerlessV2ScalingConfigurationInfo.md) 
+  [Subnet](API_Subnet.md) 
+  [Tag](API_Tag.md) 
+  [UpgradeTarget](API_UpgradeTarget.md) 
+  [VpcSecurityGroupMembership](API_VpcSecurityGroupMembership.md) 

# AvailabilityZone
<a name="API_AvailabilityZone"></a>

可用区信息。

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

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

 ** Name **   
可用区的名称。  
类型：字符串  
必需：否

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

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

# Certificate
<a name="API_Certificate"></a>

AWS 账户 的证书颁发机构 (CA) 证书。

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

**注意**  
下表中，首先描述的是必需参数。

 ** CertificateArn **   
证书的 Amazon 资源名称（ARN）。  
示例：`arn:aws:rds:us-east-1::cert:rds-ca-2019`  
类型：字符串  
必需：否

 ** CertificateIdentifier **   
标识证书的唯一密钥。  
示例：`rds-ca-2019`  
类型：字符串  
必需：否

 ** CertificateType **   
证书的类型。  
示例：`CA`  
类型：字符串  
必需：否

 ** Thumbprint **   
证书的指纹。  
类型：字符串  
必需：否

 ** ValidFrom **   
证书生效的起始日期—时间。  
示例：`2019-07-31T17:57:09Z`  
类型：时间戳  
必需：否

 ** ValidTill **   
证书不再有效的日期—时间。  
示例：`2024-07-31T17:57:09Z`  
类型：时间戳  
必需：否

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

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

# CertificateDetails
<a name="API_CertificateDetails"></a>

返回数据库实例服务器证书的详细信息。

有关更多信息，请参阅 *Amazon DocumentDB 开发者指南*中的[更新 Amazon DocumentDB TLS 证书](https://docs.aws.amazon.com/documentdb/latest/developerguide/ca_cert_rotation.html)和[传输中数据加密](https://docs.aws.amazon.com/documentdb/latest/developerguide/security.encryption.ssl.html)。

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

**注意**  
下表中，首先描述的是必需参数。

 ** CAIdentifier **   
用于数据库实例的服务器证书的 CA 证书的 CA 标识符。  
类型：字符串  
必需：否

 ** ValidTill **   
数据库实例的服务器证书的到期日期。  
类型：时间戳  
必需：否

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

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

# CloudwatchLogsExportConfiguration
<a name="API_CloudwatchLogsExportConfiguration"></a>

要启用日志类型的配置设置，以便针对特定实例或集群导出到 Amazon CloudWatch Logs。

`EnableLogTypes` 和 `DisableLogTypes` 数组确定将哪些日志导出（或不导出）到 CloudWatch Logs。这些数组中的值取决于所使用的引擎。

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

**注意**  
下表中，首先描述的是必需参数。

 ** DisableLogTypes.member.N **   
要禁用的日志类型列表。  
类型：字符串数组  
必需：否

 ** EnableLogTypes.member.N **   
要启用的日志类型的列表。  
类型：字符串数组  
必需：否

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

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

# 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) 

# DBCluster
<a name="API_DBCluster"></a>

有关集群的详细信息。

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

**注意**  
下表中，首先描述的是必需参数。

 ** AssociatedRoles.DBClusterRole.N **   
提供与集群关联的 AWS Identity and Access Management（IAM）角色的列表。与集群关联的（IAM）角色授予集群代表您访问其他 AWS 服务的权限。  
类型：[DBClusterRole](API_DBClusterRole.md) 对象数组  
必需：否

 ** AvailabilityZones.AvailabilityZone.N **   
提供可在其上创建集群中实例的 Amazon EC2 可用区的列表。  
类型：字符串数组  
必需：否

 ** BackupRetentionPeriod **   
指定自动快照的保留天数。  
类型：整数  
必需：否

 ** CloneGroupId **   
标识数据库集群与之关联的克隆组。  
类型：字符串  
必需：否

 ** ClusterCreateTime **   
指定创建集群的时间，采用通用协调时间 (UTC)。  
类型：时间戳  
必需：否

 ** DBClusterArn **   
集群的 Amazon 资源名称 (ARN)。  
类型：字符串  
必需：否

 ** DBClusterIdentifier **   
包含用户提供的集群标识符。此标识符是识别集群的唯一键。  
类型：字符串  
必需：否

 ** DBClusterMembers.DBClusterMember.N **   
提供组成集群的实例的列表。  
类型：[DBClusterMember](API_DBClusterMember.md) 对象数组  
必需：否

 ** 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。  
类型：字符串  
必需：否

 ** IOOptimizedNextAllowedModificationTime **   
下次您可以修改 Amazon DocumentDB 集群以使用 iopt1 存储类型。  
类型：时间戳  
必需：否

 ** KmsKeyId **   
如果 `StorageEncrypted` 为 `true`，则为加密集群的 AWS KMS 密钥标识符。  
类型：字符串  
必需：否

 ** LatestRestorableTime **   
指定数据库可以使用时间点还原的最新还原时间。  
类型：时间戳  
必需：否

 ** MasterUsername **   
包含集群的主用户名。  
类型：字符串  
必需：否

 ** MasterUserSecret **   
Amazon DocumentDB 在 AWS Secrets Manager 中管理的用于主用户密码的密钥。  
类型：[ClusterMasterUserSecret](API_ClusterMasterUserSecret.md) 对象  
必需：否

 ** MultiAZ **   
指定集群是否在多个可用区中有实例。  
类型：布尔值  
必需：否

 ** NetworkType **   
集群的网络类型。  
网络类型由为集群指定的 `DBSubnetGroup` 确定。`DBSubnetGroup` 只可以支持 IPv4 协议或 IPv4 和 IPv6 协议（`DUAL`）。  
有关更多信息，请参阅《Amazon DocumentDB 开发人员指南》中 [VPC 中的 DocumentDB 集群](https://docs.aws.amazon.com/documentdb/latest/developerguide/vpc-clusters.html)。  
有效值：`IPV4` \$1 `DUAL`   
类型：字符串  
必需：否

 ** PercentProgress **   
指定操作的进度百分比。  
类型：字符串  
必需：否

 ** Port **   
指定数据库引擎侦听的端口。  
类型：整数  
必需：否

 ** PreferredBackupWindow **   
指定在启用自动备份时，自动执行备份的日常时间范围，如 `BackupRetentionPeriod` 所规定。  
类型：字符串  
必需：否

 ** PreferredMaintenanceWindow **   
指定可进行系统维护的每周时间范围（采用通用协调时间 (UTC)）。  
类型：字符串  
必需：否

 ** ReaderEndpoint **   
集群的读取器端点。集群的读取器端点负载均衡集群中可用的 Amazon DocumentDB 副本间的连接。当客户端请求与读取器端点的新连接时，Amazon DocumentDB 将在集群中的 Amazon DocumentDB 副本之间分配连接请求。该功能可帮助平衡集群中跨多个 Amazon DocumentDB 副本的读取工作负载。  
如果发生了失效转移并且连接到的 Amazon DocumentDB 副本被提升为主实例，则将删除您的连接。要继续向集群中的其他 Amazon DocumentDB 副本发送读取工作负载，您可以随后重新连接到读取器端点。  
类型：字符串  
必需：否

 ** ReadReplicaIdentifiers.ReadReplicaIdentifier.N **   
包含与此集群关联的辅助集群的一个或多个标识符。  
类型：字符串数组  
必需：否

 ** ReplicationSourceIdentifier **   
包含源集群的标识符，如该集群是辅助集群。  
类型：字符串  
必需：否

 ** ServerlessV2ScalingConfiguration **   
Amazon DocumentDB 无服务器集群的扩缩配置。  
类型：[ServerlessV2ScalingConfigurationInfo](API_ServerlessV2ScalingConfigurationInfo.md) 对象  
必需：否

 ** Status **   
指定此集群的当前状态。  
类型：字符串  
必需：否

 ** StorageEncrypted **   
指定集群是否已加密。  
类型：布尔值  
必需：否

 ** StorageType **   
与集群关联的存储类型  
有关 Amazon DocumentDB 集群存储类型的信息，请参阅*《Amazon DocumentDB 开发人员指南》*中的集群存储配置。  
存储类型的有效值 - `standard | iopt1`   
默认值为 `standard `   
类型：字符串  
必需：否

 ** VpcSecurityGroups.VpcSecurityGroupMembership.N **   
提供集群从属的虚拟私有云（VPC）安全组的列表。  
类型：[VpcSecurityGroupMembership](API_VpcSecurityGroupMembership.md) 对象数组  
必需：否

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

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

# DBClusterMember
<a name="API_DBClusterMember"></a>

包含有关属于集群的实例的信息。

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

**注意**  
下表中，首先描述的是必需参数。

 ** DBClusterParameterGroupStatus **   
指定数据库集群的此成员的集群参数组状态。  
类型：字符串  
必需：否

 ** DBInstanceIdentifier **   
指定集群的此成员的实例标识符。  
类型：字符串  
必需：否

 ** IsClusterWriter **   
如果集群成员是集群的主实例，值为 `true`，否则为 `false`。  
类型：布尔值  
必需：否

 ** PromotionTier **   
该值指定在现有主实例发生故障后将 Amazon DocumentDB 副本提升为主实例的顺序。  
类型：整数  
必需：否

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

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

# DBClusterParameterGroup
<a name="API_DBClusterParameterGroup"></a>

有关集群参数组的详细信息。

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

**注意**  
下表中描述了必需参数：

 ** DBClusterParameterGroupArn **   
集群参数组的 Amazon 资源名称 (ARN)。  
类型：字符串  
必需：否

 ** DBClusterParameterGroupName **   
提供集群参数组的名称。  
类型：字符串  
必需：否

 ** DBParameterGroupFamily **   
提供此集群参数组兼容的参数组系列的名称。  
类型：字符串  
必需：否

 ** Description **   
为此集群参数组提供客户指定的描述。  
类型：字符串  
必需：否

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

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

# DBClusterRole
<a name="API_DBClusterRole"></a>

描述与集群关联的 AWS Identity and Access Management（IAM）角色。

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

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

 ** RoleArn **   
与数据库集群关联 IAMrole 的 Amazon 资源名称（ARN）。  
类型：字符串  
必需：否

 ** Status **   
描述 IAMrole 与集群之间关联的状态。`Status` 属性返回以下值之一：  
+  `ACTIVE` - 该 IAMrole ARN 已与集群关联，可用于代表您访问其他 AWS 服务。
+  `PENDING` - 与集群关联的 IAMrole ARN。
+  `INVALID` - IAMrole ARN 与集群关联，但集群无法代入 IAMrole 以代表您访问其他 AWS 服务。
类型：字符串  
必需：否

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

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

# DBClusterSnapshot
<a name="API_DBClusterSnapshot"></a>

有关集群快照的详细信息。

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

**注意**  
下表中描述了必需参数：

 ** AvailabilityZones.AvailabilityZone.N **   
提供集群快照中的实例可以还原到的 Amazon EC2 可用区列表。  
类型：字符串数组  
必需：否

 ** ClusterCreateTime **   
指定创建集群的时间，采用通用协调时间 (UTC)。  
类型：时间戳  
必需：否

 ** DBClusterIdentifier **   
指定从中创建了此集群快照的集群的集群标识符。  
类型：字符串  
必需：否

 ** DBClusterSnapshotArn **   
集群快照的 Amazon 资源名称 (ARN)。  
类型：字符串  
必需：否

 ** DBClusterSnapshotIdentifier **   
指定集群快照的标识符。  
类型：字符串  
必需：否

 ** Engine **   
指定数据库引擎的名称。  
类型：字符串  
必需：否

 ** EngineVersion **   
提供此集群快照的数据库引擎的版本。  
类型：字符串  
必需：否

 ** KmsKeyId **   
如果 `StorageEncrypted` 为 `true`，则为加密集群快照的 AWS KMS 密钥标识符。  
类型：字符串  
必需：否

 ** MasterUsername **   
提供集群快照的主用户名。  
类型：字符串  
必需：否

 ** PercentProgress **   
指定估计的已传输数据百分比。  
类型：整数  
必需：否

 ** Port **   
指定获取快照时集群侦听的端口。  
类型：整数  
必需：否

 ** SnapshotCreateTime **   
提供获取快照的时间，以 UTC 表示。  
类型：时间戳  
必需：否

 ** SnapshotType **   
提供集群快照的类型。  
类型：字符串  
必需：否

 ** SourceDBClusterSnapshotArn **   
如果集群快照复制自源集群快照，则为源集群快照的 ARN，否则为 null 值。  
类型：字符串  
必需：否

 ** Status **   
指定此集群快照的状态。  
类型：字符串  
必需：否

 ** StorageEncrypted **   
指定是否加密集群快照。  
类型：布尔值  
必需：否

 ** StorageType **   
与集群快照关联的存储类型  
有关 Amazon DocumentDB 集群存储类型的信息，请参阅*《Amazon DocumentDB 开发人员指南》*中的集群存储配置。  
存储类型的有效值 - `standard | iopt1`   
默认值为 `standard `   
类型：字符串  
必需：否

 ** VpcId **   
提供与集群快照关联的虚拟私有云（VPC）ID。  
类型：字符串  
必需：否

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

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

# DBClusterSnapshotAttribute
<a name="API_DBClusterSnapshotAttribute"></a>

包含手动集群快照属性的名称和值。

手动集群快照属性用于授权其他 AWS 账户 还原手动集群快照。

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

**注意**  
下表中描述了必需参数：

 ** AttributeName **   
手动集群快照属性的名称。  
名为 `restore` 的属性引用有权复制或还原手动集群快照的 AWS 账户 列表。  
类型：字符串  
必需：否

 ** AttributeValues.AttributeValue.N **   
手动集群快照属性的值。  
如果 `AttributeName` 字段设置为 `restore`，则此元素返回已授权复制或还原手动集群快照的 AWS 账户 列表。如果列表中有值 `all`，则手动集群快照为公有，可供任意 AWS 账户 复制或还原。  
类型：字符串数组  
必需：否

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

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

# DBClusterSnapshotAttributesResult
<a name="API_DBClusterSnapshotAttributesResult"></a>

有关集群快照关联属性的详细信息。

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

**注意**  
下表中，首先描述的是必需参数。

 ** DBClusterSnapshotAttributes.DBClusterSnapshotAttribute.N **   
集群快照的属性和值的列表。  
类型：[DBClusterSnapshotAttribute](API_DBClusterSnapshotAttribute.md) 对象数组  
必需：否

 ** DBClusterSnapshotIdentifier **   
属性应用到的集群快照的标识符。  
类型：字符串  
必需：否

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

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

# DBEngineVersion
<a name="API_DBEngineVersion"></a>

 有关引擎版本的详细信息。

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

**注意**  
下表中，首先描述的是必需参数。

 ** DBEngineDescription **   
数据库引擎的描述。  
类型：字符串  
必需：否

 ** DBEngineVersionDescription **   
数据库引擎版本的描述。  
类型：字符串  
必需：否

 ** DBParameterGroupFamily **   
用于数据库引擎的参数组系列的名称。  
类型：字符串  
必需：否

 ** Engine **   
数据库引擎的名称。  
类型：字符串  
必需：否

 ** EngineVersion **   
数据库引擎的版本号。  
类型：字符串  
必需：否

 ** ExportableLogTypes.member.N **   
数据库引擎已可用于导出到 Amazon CloudWatch Logs 的日志类型。  
类型：字符串数组  
必需：否

 ** ServerlessV2FeaturesSupport **   
指定 Amazon DocumentDB 引擎版本之间存在差异的任何 Amazon DocumentDB 无服务器属性或限制。在决定对新集群或升级后的集群使用哪个 Amazon DocumentDB 版本时，可以测试此属性的值。您还可以检索现有集群的版本，并检查该版本是否支持特定的 Amazon DocumentDB 无服务器功能，然后再尝试使用这些功能。  
类型：[ServerlessV2FeaturesSupport](API_ServerlessV2FeaturesSupport.md) 对象  
必需：否

 ** SupportedCACertificateIdentifiers.member.N **   
受支持 CA 证书标识符列表。  
有关更多信息，请参阅 *Amazon DocumentDB 开发者指南*中的[更新 Amazon DocumentDB TLS 证书](https://docs.aws.amazon.com/documentdb/latest/developerguide/ca_cert_rotation.html)和[传输中数据加密](https://docs.aws.amazon.com/documentdb/latest/developerguide/security.encryption.ssl.html)。  
类型：字符串数组  
必需：否

 ** SupportsCertificateRotationWithoutRestart **   
表示引擎版本是否支持在不重启数据库实例的情况下轮换服务器证书。  
类型：布尔值  
必需：否

 ** SupportsLogExportsToCloudwatchLogs **   
一个值，指示引擎版本是否支持将 `ExportableLogTypes` 指定的日志类型导出到 CloudWatch Logs。  
类型：布尔值  
必需：否

 ** ValidUpgradeTarget.UpgradeTarget.N **   
此数据库引擎版本可以升级到的引擎版本列表。  
类型：[UpgradeTarget](API_UpgradeTarget.md) 对象数组  
必需：否

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

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

# DBInstance
<a name="API_DBInstance"></a>

有关实例的详细信息。

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

**注意**  
下表中，首先描述的是必需参数。

 ** AutoMinorVersionUpgrade **   
不适用。此参数不适用于 Amazon DocumentDB。无论设置的值如何，Amazon DocumentDB 都不会执行次要版本升级。  
类型：布尔值  
必需：否

 ** AvailabilityZone **   
指定实例所在可用区域的名称。  
类型：字符串  
必需：否

 ** BackupRetentionPeriod **   
指定自动快照的保留天数。  
类型：整数  
必需：否

 ** CACertificateIdentifier **   
此数据库实例的 CA 证书的标识符。  
类型：字符串  
必需：否

 ** CertificateDetails **   
数据库实例服务器证书的详细信息。  
类型：[CertificateDetails](API_CertificateDetails.md) 对象  
必需：否

 ** CopyTagsToSnapshot **   
指示是否将标签从数据库实例复制到数据库实例快照的值。默认情况下，不复制标签。  
类型：布尔值  
必需：否

 ** DBClusterIdentifier **   
如果实例属于某个集群，则包含实例所属的集群的名称。  
类型：字符串  
必需：否

 ** DBInstanceArn **   
实例的 Amazon 资源名称（ARN）。  
类型：字符串  
必需：否

 ** DBInstanceClass **   
包含实例的计算和内存容量级别名称。  
类型：字符串  
必需：否

 ** DBInstanceIdentifier **   
包含用户提供的数据库标识符。此标识符是标识实例的唯一密钥。  
类型：字符串  
必需：否

 ** DBInstanceStatus **   
指定此数据库的当前状态。  
类型：字符串  
必需：否

 ** DbiResourceId **   
实例的 AWS 区域 唯一且不变的标识符。每次访问实例的 AWS CloudTrail 密钥时，可以在 AWS KMS 日志条目中找到该标识符。  
类型：字符串  
必需：否

 ** DBSubnetGroup **   
指定与实例关联的子网组的信息，包括名称、描述和子网组中的子网。  
类型：[DBSubnetGroup](API_DBSubnetGroup.md) 对象  
必需：否

 ** EnabledCloudwatchLogsExports.member.N **   
此实例配置为导出到 CloudWatch Logs 的日志类型的列表。  
类型：字符串数组  
必需：否

 ** Endpoint **   
指定连接端点。  
类型：[Endpoint](API_Endpoint.md) 对象  
必需：否

 ** Engine **   
提供要用于此实例的数据库引擎的名称。  
类型：字符串  
必需：否

 ** EngineVersion **   
指示数据库引擎版本。  
类型：字符串  
必需：否

 ** InstanceCreateTime **   
提供创建实例的日期和时间。  
类型：时间戳  
必需：否

 ** KmsKeyId **   
 如果 `StorageEncrypted` 为 `true`，则为加密的实例的 AWS KMS 密钥标识符。  
类型：字符串  
必需：否

 ** LatestRestorableTime **   
指定数据库可以使用时间点还原的最新还原时间。  
类型：时间戳  
必需：否

 ** PendingModifiedValues **   
指定对实例的更改待处理。仅在更改待处理时包含此元素。特定更改由子元素标识。  
类型：[PendingModifiedValues](API_PendingModifiedValues.md) 对象  
必需：否

 ** PerformanceInsightsEnabled **   
如果为数据库实例启用了 Amazon RDS 性能详情，设置为 `true`，否则设置为 `false`。  
类型：布尔值  
必需：否

 ** PerformanceInsightsKMSKeyId **   
用于加密 Performance Insights 数据的 AWS KMS 密钥标识符。AWS KMS 密钥 ID 是 Amazon 资源名称 (ARN)、AWS KMS 密钥标识符或 AWS KMS 加密密钥的 AWS KMS 密钥别名。  
类型：字符串  
必需：否

 ** PreferredBackupWindow **   
 指定在启用自动备份时，自动执行备份的日常时间范围，如 `BackupRetentionPeriod` 所规定。  
类型：字符串  
必需：否

 ** PreferredMaintenanceWindow **   
指定可进行系统维护的每周时间范围（采用通用协调时间 (UTC)）。  
类型：字符串  
必需：否

 ** PromotionTier **   
该值指定在现有主实例发生故障后将 Amazon DocumentDB 副本提升为主实例的顺序。  
类型：整数  
必需：否

 ** PubliclyAccessible **   
不支持。Amazon DocumentDB 目前不支持公有端点。`PubliclyAccessible` 的值始终为 `false`。  
类型：布尔值  
必需：否

 ** StatusInfos.DBInstanceStatusInfo.N **   
只读副本的状态。如果实例不是只读副本，则此项空白。  
类型：[DBInstanceStatusInfo](API_DBInstanceStatusInfo.md) 对象数组  
必需：否

 ** StorageEncrypted **   
指定是否已对实例加密。  
类型：布尔值  
必需：否

 ** VpcSecurityGroups.VpcSecurityGroupMembership.N **   
提供实例所属的 VPC 安全组元素的列表。  
类型：[VpcSecurityGroupMembership](API_VpcSecurityGroupMembership.md) 对象数组  
必需：否

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

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

# DBInstanceStatusInfo
<a name="API_DBInstanceStatusInfo"></a>

提供实例状态信息的列表。

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

**注意**  
下表中，首先描述的是必需参数。

 ** Message **   
实例出现错误时，错误的详细信息。如果实例未处于出错状态，则此值为空白。  
类型：字符串  
必需：否

 ** Normal **   
布尔值，如果实例正常运行则为 `true`，如果实例处于错误状态则为 `false`。  
类型：布尔值  
必需：否

 ** Status **   
实例的状态。对于只读副本的 `StatusType`，这些值可以是 `replicating`、错误、`stopped` 或`terminated`。  
类型：字符串  
必需：否

 ** StatusType **   
目前此值为“`read replication`”。  
类型：字符串  
必需：否

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

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

# DBSubnetGroup
<a name="API_DBSubnetGroup"></a>

有关子网组的详细信息。

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

**注意**  
下表中，首先描述的是必需参数。

 ** DBSubnetGroupArn **   
数据库子网组的 Amazon 资源名称 (ARN)。  
类型：字符串  
必需：否

 ** DBSubnetGroupDescription **   
提供子网组的描述。  
类型：字符串  
必需：否

 ** DBSubnetGroupName **   
子网组的名称。  
类型：字符串  
必需：否

 ** SubnetGroupStatus **   
提供子网组的状态。  
类型：字符串  
必需：否

 ** Subnets.Subnet.N **   
有关子网组内一个或多个子网的详细信息。  
类型：[Subnet](API_Subnet.md) 对象数组  
必需：否

 ** SupportedNetworkTypes.member.N **   
数据库子网组的网络类型。  
有效值：`IPV4` \$1 `DUAL`   
`DBSubnetGroup` 只可以支持 IPv4 协议或 IPv4 和 IPv6 协议（双）。  
类型：字符串数组  
必需：否

 ** VpcId **   
提供子网组的虚拟私有云（VPC）ID。  
类型：字符串  
必需：否

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

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

# Endpoint
<a name="API_Endpoint"></a>

用于访问集群或实例的网络信息。客户端程序必须指定访问这些 Amazon DocumentDB 资源的有效端点。

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

**注意**  
下表中，首先描述的是必需参数。

 ** Address **   
指定实例的 DNS 地址。  
类型：字符串  
必需：否

 ** HostedZoneId **   
指定在您创建托管区域时 Amazon Route 53 分配的 ID。  
类型：字符串  
必需：否

 ** Port **   
指定数据库引擎侦听的端口。  
类型：整数  
必需：否

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

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

# EngineDefaults
<a name="API_EngineDefaults"></a>

包含成功调用 `DescribeEngineDefaultClusterParameters` 操作的结果。

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

**注意**  
下表中，首先描述的是必需参数。

 ** DBParameterGroupFamily **   
要返回其引擎参数信息的集群参数组族的名称。  
类型：字符串  
必需：否

 ** Marker **   
由之前的请求提供的可选分页标记。如果指定此参数，则响应仅包含标记之外的记录，最大数量为 `MaxRecords` 指定的值。  
类型：字符串  
必需：否

 ** Parameters.Parameter.N **   
特定集群参数组系列的参数。  
类型：[Parameter](API_Parameter.md) 对象数组  
必需：否

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

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

# Event
<a name="API_Event"></a>

事件详细信息。

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

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

 ** Date **   
指定事件的日期和时间。  
类型：时间戳  
必需：否

 ** EventCategories.EventCategory.N **   
指定事件的类别。  
类型：字符串数组  
必需：否

 ** Message **   
提供此事件的文本。  
类型：字符串  
必需：否

 ** SourceArn **   
事件的 Amazon 资源名称 (ARN)。  
类型：字符串  
必需：否

 ** SourceIdentifier **   
提供事件的源的标识符。  
类型：字符串  
必需：否

 ** SourceType **   
为此事件指定源类型。  
类型：字符串  
有效值：`db-instance | db-parameter-group | db-security-group | db-snapshot | db-cluster | db-cluster-snapshot`  
必需：否

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

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

# EventCategoriesMap
<a name="API_EventCategoriesMap"></a>

事件源类型，附有一个或多个事件类别名称。

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

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

 ** EventCategories.EventCategory.N **   
指定源类型的事件类别。  
类型：字符串数组  
必需：否

 ** SourceType **   
返回的类别所属的源类型。  
类型：字符串  
必需：否

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

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

# EventSubscription
<a name="API_EventSubscription"></a>

有关您已订阅事件的详细信息。

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

**注意**  
下表中，首先描述的是必需参数。

 ** CustomerAwsId **   
与 Amazon DocumentDB 事件通知订阅关联的 AWS 客户账户。  
类型：字符串  
必需：否

 ** CustSubscriptionId **   
Amazon DocumentDB 事件通知订阅 ID。  
类型：字符串  
必需：否

 ** Enabled **   
指示是否启用订阅的布尔值。值为 `true` 表示已启用订阅。  
类型：布尔值  
必需：否

 ** EventCategoriesList.EventCategory.N **   
Amazon DocumentDB 事件通知订阅的事件类别列表。  
类型：字符串数组  
必需：否

 ** EventSubscriptionArn **   
事件订阅的 Amazon 资源名称 (ARN)。  
类型：字符串  
必需：否

 ** SnsTopicArn **   
Amazon DocumentDB 事件通知订阅的主题 ARN。  
类型：字符串  
必需：否

 ** SourceIdsList.SourceId.N **   
Amazon DocumentDB 事件通知订阅的源 ID 列表。  
类型：字符串数组  
必需：否

 ** SourceType **   
Amazon DocumentDB 事件通知订阅的源类型。  
类型：字符串  
必需：否

 ** Status **   
Amazon DocumentDB 事件通知订阅的状态。  
约束：  
可以是以下值之一：`creating`，`modifying`，`deleting`，`active`，`no-permission`，`topic-not-exist`  
状态 `no-permission` 表示 Amazon DocumentDB 不再有权发布到 SNS 主题。状态 `topic-not-exist` 表示主题在创建订阅之后删除。  
类型：字符串  
必需：否

 ** SubscriptionCreationTime **   
建立 Amazon DocumentDB 事件通知訂閱的時間。  
类型：字符串  
必需：否

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

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

# FailoverState
<a name="API_FailoverState"></a>

包含 Amazon DocumentDB 全局群集上的计划或处理中操作的状态。除非已计划或正在全局群集上执行切换或故障转移操作，否则此数据类型为空。

## 内容
<a name="API_FailoverState_Contents"></a>

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

 ** FromDbClusterArn **   
当前正在降级的 Amazon DocumentDB 集群的亚马逊资源名称 (ARN)，该名称与此状态相关联。  
类型：字符串  
必需：否

 ** IsDataLossAllowed **   
表示操作是全局切换还是全局故障转移。如果允许数据丢失，则操作是全局故障转移。否则，就是切换。  
类型：布尔值  
必需：否

 ** Status **   
全局群集的当前状态。可能值如下所示：  
+  **pen** ding — 该服务收到了切换或故障切换全局群集的请求。操作开始之前，正在验证全局群集的主群集和指定的辅助群集。
+  **failing-over** — 选定的辅助群集被提升为新的主群集，以便对全局群集进行故障切换。
+  **cancelling** — 切换或故障切换全局群集的请求已取消，主群集和选定的辅助群集将恢复到以前的状态。
类型：字符串  
有效值：`pending | failing-over | cancelling`  
必需：否

 ** ToDbClusterArn **   
当前正在升级且与此状态关联的 Amazon DocumentDB 集群的亚马逊资源名称 (ARN)。  
类型：字符串  
必需：否

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

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

# Filter
<a name="API_Filter"></a>

已命名的筛选器值组，用于返回更具体的结果列表。您可以使用筛选器按特定标准（例如 ID）匹配一组资源。

筛选器中不支持通配符。

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

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

 ** Name **   
筛选器的名称。筛选器名称区分大小写。  
类型：字符串  
必需：是

 ** Values.Value.N **   
一个或多个筛选器值。筛选值区分大小写。  
类型：字符串数组  
必需：是

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

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

# GlobalCluster
<a name="API_GlobalCluster"></a>

一种表示 Amazon DocumentDB 全局集群的数据类型。

## 内容
<a name="API_GlobalCluster_Contents"></a>

**注意**  
下表中，首先描述的是必需参数。

 ** DatabaseName **   
新全局集群中的默认数据库名称。  
类型：字符串  
必需：否

 ** DeletionProtection **   
新全局集群的删除保护设置。  
类型：布尔值  
必需：否

 ** Engine **   
全局集群使用的 Amazon DocumentDB 数据库引擎。  
类型：字符串  
必需：否

 ** EngineVersion **   
指示数据库引擎版本。  
类型：字符串  
必需：否

 ** FailoverState **   
一个数据对象，包含此全局群集的正在处理或待处理的切换或故障转移进程的当前状态的所有属性。除非在此全局群集上调用了`SwitchoverGlobalCluster`或`FailoverGlobalCluster`操作，否则此对象为空。  
类型：[FailoverState](API_FailoverState.md) 对象  
必需：否

 ** GlobalClusterArn **   
全局集群的 Amazon 资源名称 (ARN)。  
类型：字符串  
必需：否

 ** GlobalClusterIdentifier **   
包含用户提供的全局集群标识符。此标识符是识别全局集群的唯一键。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 255。  
模式：`[A-Za-z][0-9A-Za-z-:._]*`  
必需：否

 ** GlobalClusterMembers.GlobalClusterMember.N **   
全局群集 IDs 中辅助群集的群集列表。目前仅限一项。  
类型：[GlobalClusterMember](API_GlobalClusterMember.md) 对象数组  
必需：否

 ** GlobalClusterResourceId **   
全局 AWS 区域数据库集群的区域唯一、不可变的标识符。每当访问集群的 AWS KMS 客户主密钥 (CMK) 时，都会在 AWS CloudTrail 日志条目中找到此标识符。  
类型：字符串  
必需：否

 ** Status **   
指定此全局集群的当前状态。  
类型：字符串  
必需：否

 ** StorageEncrypted **   
全局集群的存储加密设置。  
类型：布尔值  
必需：否

 ** TagList.Tag.N **   
全局集群标签列表。  
类型：[Tag](API_Tag.md) 对象数组  
必需：否

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

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

# GlobalClusterMember
<a name="API_GlobalClusterMember"></a>

一种数据结构，附带有关与 Amazon DocumentDB 全局集群关联的任何主集群和辅助集群的信息。

## 内容
<a name="API_GlobalClusterMember_Contents"></a>

**注意**  
下表中，首先描述的是必需参数。

 ** DBClusterArn **   
每个 Amazon DocumentDB 集群的 Amazon 资源名称（ARN）。  
类型：字符串  
必需：否

 ** IsWriter **   
 指定 Amazon DocumentDB 集群是否为与该集群关联的 Amazon DocumentDB 全局集群的主集群（即具有读写能力）。  
类型：布尔值  
必需：否

 ** Readers.member.N **   
与 Amazon DocumentDB 全局集群关联的每个只读辅助集群的 Amazon 资源名称（ARN）。  
类型：字符串数组  
必需：否

 ** SynchronizationStatus **   
全局集群中每个 Amazon DocumentDB 集群的同步状态。  
类型：字符串  
有效值：`connected | pending-resync`  
必需：否

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

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

# OrderableDBInstanceOption
<a name="API_OrderableDBInstanceOption"></a>

可提供给实例的选项。

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

**注意**  
下表中，首先描述的是必需参数。

 ** AvailabilityZones.AvailabilityZone.N **   
实例的可用区域列表。  
类型：[AvailabilityZone](API_AvailabilityZone.md) 对象数组  
必需：否

 ** DBInstanceClass **   
实例的实例类。  
类型：字符串  
必需：否

 ** Engine **   
实例的引擎类型。  
类型：字符串  
必需：否

 ** EngineVersion **   
实例的引擎版本。  
类型：字符串  
必需：否

 ** LicenseModel **   
实例的许可模式  
类型：字符串  
必需：否

 ** StorageType **   
与数据库集群关联的存储类型  
类型：字符串  
必需：否

 ** Vpc **   
表示实例是否位于虚拟私有云（VPC）中。  
类型：布尔值  
必需：否

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

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

# Parameter
<a name="API_Parameter"></a>

有关单个参数的详细信息。

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

**注意**  
下表中，首先描述的是必需参数。

 ** AllowedValues **   
指定参数值的有效范围。  
类型：字符串  
必需：否

 ** ApplyMethod **   
指示何时应用参数更新。  
类型：字符串  
有效值：`immediate | pending-reboot`  
必需：否

 ** ApplyType **   
指定引擎特定的参数类型。  
类型：字符串  
必需：否

 ** DataType **   
指定参数的有效数据类型。  
类型：字符串  
必需：否

 ** Description **   
提供参数的说明。  
类型：字符串  
必需：否

 ** IsModifiable **   
 指示参数可以修改 (`true`) 还是不能修改 (`false`)。一些参数具有安全或操作影响，会阻止更改这些参数。  
类型：布尔值  
必需：否

 ** MinimumEngineVersion **   
参数可以应用到的最早引擎版本。  
类型：字符串  
必需：否

 ** ParameterName **   
指定参数的名称。  
类型：字符串  
必需：否

 ** ParameterValue **   
指定参数的值。必须是一个或多个集群参数 `AllowedValues`（CSV 格式）：  
有效值为：  
+  `enabled`：集群接受使用 TLS 版本 1.0 到 1.3 的安全连接。
+  `disabled`：此集群不接受使用 TLS 的安全连接。
+  `fips-140-3`：集群仅接受符合联邦信息处理标准（FIPS）出版物 140-3 要求的安全连接。在以下区域，从 Amazon DocumentDB 5.0（引擎版本 3.0.3727）集群开始才支持此功能：ca-central-1、us-west-2、us-east-1、us-east-2、us-gov-east-1、us-gov-west-1。
+  `tls1.2+`：集群接受使用 TLS 版本 1.2 及更高版本的安全连接。从 Amazon DocumentDB 4.0（引擎版本 2.0.10980）和 Amazon DocumentDB 5.0（引擎版本 3.0.11051）开始才支持此功能。
+  `tls1.3+`：集群接受使用 TLS 版本 1.3 及更高版本的安全连接。从 Amazon DocumentDB 4.0（引擎版本 2.0.10980）和 Amazon DocumentDB 5.0（引擎版本 3.0.11051）开始才支持此功能。
类型：字符串  
必需：否

 ** Source **   
指示参数值的源。  
类型：字符串  
必需：否

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

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

# PendingCloudwatchLogsExports
<a name="API_PendingCloudwatchLogsExports"></a>

其配置仍处于待处理状态的日志类型的列表。这些日志类型正处于激活或停用过程中。

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

**注意**  
下表中，首先描述的是必需参数。

 ** LogTypesToDisable.member.N **   
处于启用过程中的日志类型。启用之后，这些日志类型会导出到 Amazon CloudWatch Logs。  
类型：字符串数组  
必需：否

 ** LogTypesToEnable.member.N **   
处于停用过程中的日志类型。停用之后，这些日志类型不会导出到 CloudWatch Logs。  
类型：字符串数组  
必需：否

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

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

# PendingMaintenanceAction
<a name="API_PendingMaintenanceAction"></a>

提供有关资源的待处理维护操作的信息。

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

**注意**  
下表中，首先描述的是必需参数。

 ** Action **   
可用于资源的待处理维护操作的类型。  
类型：字符串  
必需：否

 ** AutoAppliedAfterDate **   
应用操作时维护时段的日期。维护操作在此日期之后的第一个维护时段期间应用于资源。如果指定了此日期，则忽略任何 `next-maintenance` 加入请求。  
类型：时间戳  
必需：否

 ** CurrentApplyDate **   
待处理维护操作应用于资源的生效日期。  
类型：时间戳  
必需：否

 ** Description **   
提供有关维护操作的更多详细信息的描述。  
类型：字符串  
必需：否

 ** ForcedApplyDate **   
自动应用维护操作时的日期。无论资源的维护时段如何，维护操作都将在此日期应用于资源。如果指定了此日期，则忽略任何 `immediate` 加入请求。  
类型：时间戳  
必需：否

 ** OptInStatus **   
指示已为资源接收的加入请求的类型。  
类型：字符串  
必需：否

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

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

# PendingModifiedValues
<a name="API_PendingModifiedValues"></a>

 一个实例的一个或多个已修改设置。已请求这些修改的设置，但尚未应用。

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

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

 ** AllocatedStorage **   
 包含将要应用或当前正在应用的当时实例的新 `AllocatedStorage` 大小。  
类型：整数  
必需：否

 ** BackupRetentionPeriod **   
指定保留自动备份的挂起天数。  
类型：整数  
必需：否

 ** CACertificateIdentifier **   
指定数据库实例的证书机构（CA）证书的标识符。  
类型：字符串  
必需：否

 ** DBInstanceClass **   
 包含将要应用或当前正在应用的实例的新 `DBInstanceClass`。  
类型：字符串  
必需：否

 ** DBInstanceIdentifier **   
 包含将要应用或当前正在应用的实例的新 `DBInstanceIdentifier`。  
类型：字符串  
必需：否

 ** DBSubnetGroupName **   
实例的新子网组。  
类型：字符串  
必需：否

 ** EngineVersion **   
指示数据库引擎版本。  
类型：字符串  
必需：否

 ** Iops **   
指定将应用或当前正在应用的实例的新预配置 IOPS 值。  
类型：整数  
必需：否

 ** LicenseModel **   
实例的许可模式。  
有效值: `license-included`, `bring-your-own-license`, `general-public-license`   
类型：字符串  
必需：否

 ** MasterUserPassword **   
包含数据库实例的主凭证的待处理或当前正在进行的更改。  
类型：字符串  
必需：否

 ** MultiAZ **   
指示单可用区实例将更改为多可用区部署。  
类型：布尔值  
必需：否

 ** PendingCloudwatchLogsExports **   
其配置仍处于待处理状态的日志类型的列表。这些日志类型正处于激活或停用过程中。  
类型：[PendingCloudwatchLogsExports](API_PendingCloudwatchLogsExports.md) 对象  
必需：否

 ** Port **   
指定实例的挂起端口。  
类型：整数  
必需：否

 ** StorageType **   
指定要与实例关联的存储类型。  
类型：字符串  
必需：否

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

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

# ResourcePendingMaintenanceActions
<a name="API_ResourcePendingMaintenanceActions"></a>

表示 [ApplyPendingMaintenanceAction](API_ApplyPendingMaintenanceAction.md) 的输出。

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

**注意**  
下表中，首先描述的是必需参数。

 ** PendingMaintenanceActionDetails.PendingMaintenanceAction.N **   
一个列表，提供有关资源的待处理维护操作的详细信息。  
类型：[PendingMaintenanceAction](API_PendingMaintenanceAction.md) 对象数组  
必需：否

 ** ResourceIdentifier **   
有待处理维护操作的资源的 Amazon 资源名称（ARN）。  
类型：字符串  
必需：否

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

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

# ServerlessV2FeaturesSupport
<a name="API_ServerlessV2FeaturesSupport"></a>

指定 Amazon DocumentDB 引擎版本之间存在差异的任何 Amazon DocumentDB 无服务器属性或限制。在决定对新集群或升级后的集群使用哪个 Amazon DocumentDB 版本时，可以测试此属性的值。您还可以检索现有集群的版本，并检查该版本是否支持特定的 Amazon DocumentDB 无服务器功能，然后再尝试使用这些功能。

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

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

 ** MaxCapacity **   
Amazon DocumentDB 无服务器集群中实例的最大 Amazon DocumentDB 容量单位（DCU）数量。您能够以半步增量指定 DCU 值，如 32、32.5、33，以此类推。  
类型：双精度  
必需：否

 ** MinCapacity **   
Amazon DocumentDB 无服务器集群中实例的最小 Amazon DocumentDB 容量单位（DCU）数量。您能够以半步增量指定 DCU 值，如 8、8.5、9，以此类推。  
类型：双精度  
必需：否

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

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

# ServerlessV2ScalingConfiguration
<a name="API_ServerlessV2ScalingConfiguration"></a>

设置 Amazon DocumentDB 无服务器集群的扩缩配置。

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

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

 ** MaxCapacity **   
Amazon DocumentDB 无服务器集群中实例的最大 Amazon DocumentDB 容量单位（DCU）数量。您能够以半步增量指定 DCU 值，如 32、32.5、33，以此类推。  
类型：双精度  
必需：否

 ** MinCapacity **   
Amazon DocumentDB 无服务器集群中实例的最小 Amazon DocumentDB 容量单位（DCU）数量。您能够以半步增量指定 DCU 值，如 8、8.5、9，以此类推。  
类型：双精度  
必需：否

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

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

# ServerlessV2ScalingConfigurationInfo
<a name="API_ServerlessV2ScalingConfigurationInfo"></a>

检索 Amazon DocumentDB 无服务器集群的扩缩配置。

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

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

 ** MaxCapacity **   
Amazon DocumentDB 无服务器集群中实例的最大 Amazon DocumentDB 容量单位（DCU）数量。您能够以半步增量指定 DCU 值，如 32、32.5、33，以此类推。  
类型：双精度  
必需：否

 ** MinCapacity **   
Amazon DocumentDB 无服务器集群中实例的最小 Amazon DocumentDB 容量单位（DCU）数量。您能够以半步增量指定 DCU 值，如 8、8.5、9，以此类推。  
类型：双精度  
必需：否

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

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

# Subnet
<a name="API_Subnet"></a>

 有关子网的详细信息。

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

**注意**  
下表中，首先描述的是必需参数。

 ** SubnetAvailabilityZone **   
指定子网的可用区。  
类型：[AvailabilityZone](API_AvailabilityZone.md) 对象  
必需：否

 ** SubnetIdentifier **   
指定子网的标识符。  
类型：字符串  
必需：否

 ** SubnetStatus **   
指定子网的状态。  
类型：字符串  
必需：否

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

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

# Tag
<a name="API_Tag"></a>

分配给包含键值对的 Amazon DocumentDB 资源的元数据。

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

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

 ** Key **   
标签的必填名称。该字符串值的长度可以在 1 到 128 个 Unicode 字符之间，并且不能带有前缀“`aws:`”或“`rds:`”。该字符串只能包含 Unicode 字母、数字、空格、“\$1”、“.”、“/”、“=”、“\$1”、“-”的集合（Java 正则表达式：“^([\$1\$1p\$1L\$1\$1\$1p\$1Z\$1\$1\$1p\$1N\$1\$1.:/=\$1\$1\$1-]\$1)\$1”)。  
类型：字符串  
必需：否

 ** Value **   
标签的可选值。该字符串值的长度可以在 1 到 256 个 Unicode 字符之间，并且不能带有前缀“`aws:`”或“`rds:`”。该字符串只能包含 Unicode 字母、数字、空格、“\$1”、“.”、“/”、“=”、“\$1”、“-”的集合（Java 正则表达式：“^([\$1\$1p\$1L\$1\$1\$1p\$1Z\$1\$1\$1p\$1N\$1\$1.:/=\$1\$1\$1-]\$1)\$1”)。  
类型：字符串  
必需：否

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

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

# UpgradeTarget
<a name="API_UpgradeTarget"></a>

实例可以升级到的数据库引擎的版本。

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

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

 ** AutoUpgrade **   
一个值，指示目标版本是否应用于`AutoMinorVersionUpgrade`设置为 `true` 的任何源数据库实例。  
类型：布尔值  
必需：否

 ** Description **   
实例可以升级到的数据库引擎的版本。  
类型：字符串  
必需：否

 ** Engine **   
升级目标数据库引擎的名称。  
类型：字符串  
必需：否

 ** EngineVersion **   
升级目标数据库引擎的版本号。  
类型：字符串  
必需：否

 ** IsMajorVersionUpgrade **   
一个值，用于指示数据库引擎是否已升级到主要版本。  
类型：布尔值  
必需：否

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

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

# VpcSecurityGroupMembership
<a name="API_VpcSecurityGroupMembership"></a>

用作查询虚拟私有云（VPC）安全组成员资格的响应元素。

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

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

 ** Status **   
VPC 安全组的状态。  
类型：字符串  
必需：否

 ** VpcSecurityGroupId **   
VPC 安全组的名称。  
类型：字符串  
必需：否

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

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

# Amazon DocumentDB Elastic Clusters
<a name="API_Types_Amazon_DocumentDB_Elastic_Clusters"></a>

Amazon DocumentDB 弹性集群支持以下数据类型：
+  [Cluster](API_elastic_Cluster.md) 
+  [ClusterInList](API_elastic_ClusterInList.md) 
+  [ClusterSnapshot](API_elastic_ClusterSnapshot.md) 
+  [ClusterSnapshotInList](API_elastic_ClusterSnapshotInList.md) 
+  [PendingMaintenanceActionDetails](API_elastic_PendingMaintenanceActionDetails.md) 
+  [ResourcePendingMaintenanceAction](API_elastic_ResourcePendingMaintenanceAction.md) 
+  [Shard](API_elastic_Shard.md) 
+  [ValidationExceptionField](API_elastic_ValidationExceptionField.md) 

# Cluster
<a name="API_elastic_Cluster"></a>

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

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

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

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

 ** authType **   <a name="documentdb-Type-elastic_Cluster-authType"></a>
弹性集群的身份验证类型。  
类型：字符串  
有效值：`PLAIN_TEXT | SECRET_ARN`  
必需：是

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

 ** clusterEndpoint **   <a name="documentdb-Type-elastic_Cluster-clusterEndpoint"></a>
用于连接到弹性集群的 URL。  
类型：字符串  
必需：是

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

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

 ** kmsKeyId **   <a name="documentdb-Type-elastic_Cluster-kmsKeyId"></a>
用于弹性集群加密的 KMS 密钥标识符。  
类型：字符串  
必需：是

 ** preferredMaintenanceWindow **   <a name="documentdb-Type-elastic_Cluster-preferredMaintenanceWindow"></a>
可进行系统维护的每周时间范围（采用通用协调时间（UTC））。  
 *格式*：`ddd:hh24:mi-ddd:hh24:mi`  
类型：字符串  
必需：是

 ** shardCapacity **   <a name="documentdb-Type-elastic_Cluster-shardCapacity"></a>
分配给每个弹性集群分片的 vCPU 数目。最大值为 64。允许值为 2、4、8、16、32、64。  
类型：整数  
必需：是

 ** shardCount **   <a name="documentdb-Type-elastic_Cluster-shardCount"></a>
分配给弹性集群的分片数目。最大值为 32。  
类型：整数  
必需：是

 ** status **   <a name="documentdb-Type-elastic_Cluster-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_Cluster-subnetIds"></a>
弹性集群的 Amazon EC2 子网 ID。  
类型：字符串数组  
必需：是

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

 ** backupRetentionPeriod **   <a name="documentdb-Type-elastic_Cluster-backupRetentionPeriod"></a>
自动快照的保留天数。  
类型：整数  
必需：否

 ** preferredBackupWindow **   <a name="documentdb-Type-elastic_Cluster-preferredBackupWindow"></a>
在启用自动备份的情况下每日执行自动备份的时间范围，如 `backupRetentionPeriod` 所规定。  
类型：字符串  
必需：否

 ** shardInstanceCount **   <a name="documentdb-Type-elastic_Cluster-shardInstanceCount"></a>
适用于此集群中所有分片的副本实例数量。`shardInstanceCount` 值为 1 表示有一个写入器实例，其他任何实例都是可用于读取和提高可用性的副本。  
类型：整数  
必需：否

 ** shards **   <a name="documentdb-Type-elastic_Cluster-shards"></a>
集群中的分片总数。  
类型：[Shard](API_elastic_Shard.md) 对象数组  
必需：否

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

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

# ClusterInList
<a name="API_elastic_ClusterInList"></a>

Amazon DocumentDB Elastic Clusters 列表。

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

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

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

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

 ** status **   <a name="documentdb-Type-elastic_ClusterInList-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`  
必需：是

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

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

# 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) 

# ClusterSnapshotInList
<a name="API_elastic_ClusterSnapshotInList"></a>

弹性集群快照的列表。

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

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

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

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

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

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

 ** status **   <a name="documentdb-Type-elastic_ClusterSnapshotInList-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`  
必需：是

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

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

# PendingMaintenanceActionDetails
<a name="API_elastic_PendingMaintenanceActionDetails"></a>

检索待处理的维护操作的详细信息。

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

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

 ** action **   <a name="documentdb-Type-elastic_PendingMaintenanceActionDetails-action"></a>
显示待处理维护操作的具体操作。  
类型：字符串  
必需：是

 ** autoAppliedAfterDate **   <a name="documentdb-Type-elastic_PendingMaintenanceActionDetails-autoAppliedAfterDate"></a>
显示应用操作时维护时段的日期。维护操作在此日期之后的第一个维护时段期间应用于资源。如果指定了此日期，则忽略任何 `NEXT_MAINTENANCE` `optInType` 请求。  
类型：字符串  
必需：否

 ** currentApplyDate **   <a name="documentdb-Type-elastic_PendingMaintenanceActionDetails-currentApplyDate"></a>
显示待处理维护操作应用于资源的生效日期。  
类型：字符串  
必需：否

 ** description **   <a name="documentdb-Type-elastic_PendingMaintenanceActionDetails-description"></a>
显示有关维护操作的更多详细信息的描述。  
类型：字符串  
必需：否

 ** forcedApplyDate **   <a name="documentdb-Type-elastic_PendingMaintenanceActionDetails-forcedApplyDate"></a>
显示自动应用维护操作时的日期。无论资源的维护时段如何，维护操作都将在此日期应用于资源。如果指定了此日期，则忽略任何 `IMMEDIATE` `optInType` 请求。  
类型：字符串  
必需：否

 ** optInStatus **   <a name="documentdb-Type-elastic_PendingMaintenanceActionDetails-optInStatus"></a>
显示已为资源接收的 `optInType` 请求的类型。  
类型：字符串  
必需：否

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

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

# ResourcePendingMaintenanceAction
<a name="API_elastic_ResourcePendingMaintenanceAction"></a>

提供有关资源的待处理维护操作的信息。

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

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

 ** pendingMaintenanceActionDetails **   <a name="documentdb-Type-elastic_ResourcePendingMaintenanceAction-pendingMaintenanceActionDetails"></a>
提供有关资源的待处理维护操作的信息。  
类型：[PendingMaintenanceActionDetails](API_elastic_PendingMaintenanceActionDetails.md) 对象数组  
必需：否

 ** resourceArn **   <a name="documentdb-Type-elastic_ResourcePendingMaintenanceAction-resourceArn"></a>
待处理的维护操作应用于的资源的 Amazon DocumentDB Amazon 资源名称（ARN）。  
类型：字符串  
必需：否

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

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

# Shard
<a name="API_elastic_Shard"></a>

分片的名称。

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

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

 ** createTime **   <a name="documentdb-Type-elastic_Shard-createTime"></a>
创建分片的时间，采用通用协调时间 (UTC)。  
类型：字符串  
必需：是

 ** shardId **   <a name="documentdb-Type-elastic_Shard-shardId"></a>
分片的 ID。  
类型：字符串  
必需：是

 ** status **   <a name="documentdb-Type-elastic_Shard-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`  
必需：是

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

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

# ValidationExceptionField
<a name="API_elastic_ValidationExceptionField"></a>

其中出现给定验证异常的特定字段。

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

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

 ** message **   <a name="documentdb-Type-elastic_ValidationExceptionField-message"></a>
描述此字段中验证异常的错误消息。  
类型：字符串  
必需：是

 ** name **   <a name="documentdb-Type-elastic_ValidationExceptionField-name"></a>
其中发生验证异常的字段的名称。  
类型：字符串  
必需：是

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

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