本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

# 資料類型
<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 Elastic Clusters 支援下列資料類型：
+  [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 SDKs中使用此 API 的詳細資訊，請參閱以下內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/AvailabilityZone) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/AvailabilityZone) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/AvailabilityZone) 

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

的憑證授權機構 (CA) 憑證 AWS 帳戶。

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

**注意**  
在下列清單中，會先說明所需的參數。

 ** CertificateArn **   
憑證的 Amazon Resource Name (ARN)。  
範例：`arn:aws:rds:us-east-1::cert:rds-ca-2019`  
類型：字串  
必要：否

 ** CertificateIdentifier **   
識別憑證的唯一金鑰。  
範例：`rds-ca-2019`  
類型：字串  
必要：否

 ** CertificateType **   
憑證的類型。  
範例：`CA`  
類型：字串  
必要：否

 ** Thumbprint **   
憑證的指紋。  
類型：字串  
必要：否

 ** ValidFrom **   
憑證有效的開始日期時間。  
範例：`2019-07-31T17:57:09Z`  
類型：Timestamp  
必要：否

 ** ValidTill **   
憑證失效的日期時間。  
範例：`2024-07-31T17:57:09Z`  
類型：Timestamp  
必要：否

## 另請參閱
<a name="API_Certificate_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱以下內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/Certificate) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/Certificate) 
+  [AWS 適用於 Ruby V3 的 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)。 *Amazon DocumentDB *

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

**注意**  
在下列清單中，會先說明所需的參數。

 ** CAIdentifier **   
用於資料庫執行個體伺服器憑證的 CA 憑證的 CA 識別符。  
類型：字串  
必要：否

 ** ValidTill **   
資料庫執行個體的伺服器憑證過期日期。  
類型：Timestamp  
必要：否

## 另請參閱
<a name="API_CertificateDetails_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱以下內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CertificateDetails) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CertificateDetails) 
+  [AWS 適用於 Ruby V3 的 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 SDKs中使用此 API 的詳細資訊，請參閱以下內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CloudwatchLogsExportConfiguration) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CloudwatchLogsExportConfiguration) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CloudwatchLogsExportConfiguration) 

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

包含主要使用者密碼的 Secrets Manager 中由 Amazon DocumentDB 管理的 AWS 秘密。

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

**注意**  
在下列清單中，會先說明所需的參數。

 ** KmsKeyId **   
用來加密秘密的 AWS KMS 金鑰識別符。  
類型：字串  
必要：否

 ** SecretArn **   
秘密的 Amazon Resource Name (ARN)。  
類型：字串  
必要：否

 ** SecretStatus **   
秘密的狀態。  
可能的狀態值包括下列項目：  
+ 建立 - 正在建立秘密。
+ 作用中 - 秘密可供正常使用和輪換。
+ 輪換 - 正在輪換秘密。
+ 受損 - 秘密可用來存取資料庫登入資料，但無法輪換。例如，如果變更許可，使得 Amazon DocumentDB 無法再存取秘密或秘密的 KMS 金鑰，則秘密可能會具有此狀態。

  當密碼具有此狀態時，您可以更正導致狀態的條件。或者，修改執行個體以關閉資料庫登入資料的自動管理，然後再次修改執行個體以開啟資料庫登入資料的自動管理。
類型：字串  
必要：否

## 另請參閱
<a name="API_ClusterMasterUserSecret_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱以下內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ClusterMasterUserSecret) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ClusterMasterUserSecret) 
+  [AWS 適用於 Ruby V3 的 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) 指定建立叢集的時間。  
類型：Timestamp  
必要：否

 ** DBClusterArn **   
叢集的 Amazon Resource Name (ARN)。  
類型：字串  
必要：否

 ** DBClusterIdentifier **   
包含使用者提供的叢集識別符。此識別符是識別叢集的唯一金鑰。  
類型：字串  
必要：否

 ** DBClusterMembers.DBClusterMember.N **   
提供組成叢集的執行個體清單。  
類型：[DBClusterMember](API_DBClusterMember.md) 物件陣列  
必要：否

 ** DBClusterParameterGroup **   
指定叢集的叢集參數群組名稱。  
類型：字串  
必要：否

 ** DbClusterResourceId **   
叢集 AWS 區域的唯一不可變識別符。每當存取叢集的 AWS KMS 金鑰時， AWS CloudTrail 日誌項目中都會找到此識別符。  
類型：字串  
必要：否

 ** DBSubnetGroup **   
指定與叢集相關聯的子網路群組資訊，包括子網路群組中的名稱、描述和子網路。  
類型：字串  
必要：否

 ** DeletionProtection **   
指定是否可以刪除此叢集。如果 `DeletionProtection` 已啟用，除非修改並`DeletionProtection`停用，否則無法刪除叢集。 會`DeletionProtection`保護叢集免於意外刪除。  
類型：布林值  
必要：否

 ** EarliestRestorableTime **   
可使用point-in-time還原還原資料庫的最早時間。  
類型：Timestamp  
必要：否

 ** EnabledCloudwatchLogsExports.member.N **   
此叢集設定為匯出至 Amazon CloudWatch Logs 的日誌類型清單。  
類型：字串陣列  
必要：否

 ** Endpoint **   
指定叢集主要執行個體的連線端點。  
類型：字串  
必要：否

 ** Engine **   
提供要用於此叢集的資料庫引擎名稱。  
類型：字串  
必要：否

 ** EngineVersion **   
指示資料庫引擎版本。  
類型：字串  
必要：否

 ** HostedZoneId **   
指定當您建立託管區域時，Amazon Route 53 指派的 ID。  
類型：字串  
必要：否

 ** IOOptimizedNextAllowedModificationTime **   
下次您可以修改 Amazon DocumentDB 叢集以使用 iopt1 儲存類型。  
類型：Timestamp  
必要：否

 ** KmsKeyId **   
如果 `StorageEncrypted`是 `true`，則為加密叢集的 AWS KMS 金鑰識別符。  
類型：字串  
必要：否

 ** LatestRestorableTime **   
指定可透過 point-in-time 還原還原資料庫的最新時間。  
類型：Timestamp  
必要：否

 ** MasterUsername **   
包含叢集的主要使用者名稱。  
類型：字串  
必要：否

 ** MasterUserSecret **   
由 Secrets Manager 中的 Amazon DocumentDB 管理的 AWS 秘密，用於主要使用者密碼。  
類型：[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)。 Amazon DocumentDB   
有效值: `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 Serverless 叢集的擴展組態。  
類型：[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 SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBCluster) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBCluster) 
+  [AWS 適用於 Ruby V3 的 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 SDKs中使用此 API 的詳細資訊，請參閱以下內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBClusterMember) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBClusterMember) 
+  [AWS 適用於 Ruby V3 的 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 Resource Name (ARN)。  
類型：字串  
必要：否

 ** DBClusterParameterGroupName **   
提供叢集參數群組的名稱。  
類型：字串  
必要：否

 ** DBParameterGroupFamily **   
提供此叢集參數群組相容的參數群組系列名稱。  
類型：字串  
必要：否

 ** Description **   
提供此叢集參數群組的客戶指定描述。  
類型：字串  
必要：否

## 另請參閱
<a name="API_DBClusterParameterGroup_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱以下內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBClusterParameterGroup) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBClusterParameterGroup) 
+  [AWS 適用於 Ruby V3 的 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 Resource Name (ARN)。  
類型：字串  
必要：否

 ** Status **   
描述 IAMrole 與叢集之間的關聯狀態。`Status` 屬性會傳回下列其中一個值：  
+  `ACTIVE` - IAMrole ARN 與叢集相關聯，可用於代表您存取其他 AWS 服務。
+  `PENDING` - IAMrole ARN 正在與叢集建立關聯。
+  `INVALID` - IAMrole ARN 與叢集相關聯，但叢集無法擔任 IAMrole 代表您存取其他 AWS 服務。
類型：字串  
必要：否

## 另請參閱
<a name="API_DBClusterRole_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱以下內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBClusterRole) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBClusterRole) 
+  [AWS 適用於 Ruby V3 的 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) 指定叢集建立的時間。  
類型：Timestamp  
必要：否

 ** DBClusterIdentifier **   
指定從中建立此叢集快照之叢集的叢集識別符。  
類型：字串  
必要：否

 ** DBClusterSnapshotArn **   
叢集快照的 Amazon Resource Name (ARN)。  
類型：字串  
必要：否

 ** DBClusterSnapshotIdentifier **   
指定叢集快照的識別符。  
類型：字串  
必要：否

 ** Engine **   
指定資料庫引擎的名稱。  
類型：字串  
必要：否

 ** EngineVersion **   
提供此叢集快照的資料庫引擎版本。  
類型：字串  
必要：否

 ** KmsKeyId **   
如果 `StorageEncrypted`是 `true`，則為加密叢集快照的 AWS KMS 金鑰識別符。  
類型：字串  
必要：否

 ** MasterUsername **   
提供叢集快照的主要使用者名稱。  
類型：字串  
必要：否

 ** PercentProgress **   
指定已傳輸的估計資料百分比。  
類型：整數  
必要：否

 ** Port **   
指定叢集在快照時接聽的連接埠。  
類型：整數  
必要：否

 ** SnapshotCreateTime **   
以 UTC 提供快照的拍攝時間。  
類型：Timestamp  
必要：否

 ** SnapshotType **   
提供叢集快照的類型。  
類型：字串  
必要：否

 ** SourceDBClusterSnapshotArn **   
如果叢集快照是從來源叢集快照複製，則為來源叢集快照的 ARN；否則為 null 值。  
類型：字串  
必要：否

 ** Status **   
指定此叢集快照的狀態。  
類型：字串  
必要：否

 ** StorageEncrypted **   
指定叢集快照是否已加密。  
類型：布林值  
必要：否

 ** StorageType **   
與您的叢集快照相關聯的儲存類型  
如需 Amazon DocumentDB 叢集儲存類型的資訊，請參閱《*Amazon DocumentDB 開發人員指南*》中的叢集儲存組態。  
儲存類型 - 的有效值 `standard | iopt1`   
預設值為 `standard `   
類型：字串  
必要：否

 ** VpcId **   
提供與叢集快照相關聯的虛擬私有雲端 (VPC) ID。  
類型：字串  
必要：否

## 另請參閱
<a name="API_DBClusterSnapshot_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱以下內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBClusterSnapshot) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBClusterSnapshot) 
+  [AWS 適用於 Ruby V3 的 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 帳戶 授權複製或還原手動叢集快照IDs 清單。如果 的值`all`在清單中，則手動叢集快照是公開的，可供任何 AWS 帳戶 複製或還原。  
類型：字串陣列  
必要：否

## 另請參閱
<a name="API_DBClusterSnapshotAttribute_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱以下內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBClusterSnapshotAttribute) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBClusterSnapshotAttribute) 
+  [AWS 適用於 Ruby V3 的 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 SDKs中使用此 API 的詳細資訊，請參閱以下內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBClusterSnapshotAttributesResult) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBClusterSnapshotAttributesResult) 
+  [AWS 適用於 Ruby V3 的 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 Serverless 屬性或限制。您可以在決定要在新的或升級的叢集中使用的 Amazon DocumentDB 版本時，測試此屬性的值。您也可以擷取現有叢集的版本，並檢查該版本是否支援特定 Amazon DocumentDB Serverless 功能，再嘗試使用這些功能。  
類型：[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)。 *Amazon DocumentDB *  
類型：字串陣列  
必要：否

 ** SupportsCertificateRotationWithoutRestart **   
指出引擎版本是否支援輪換伺服器憑證，而不重新啟動資料庫執行個體。  
類型：布林值  
必要：否

 ** SupportsLogExportsToCloudwatchLogs **   
指出引擎版本是否支援將 指定的日誌類型匯出`ExportableLogTypes`至 CloudWatch Logs 的值。  
類型：布林值  
必要：否

 ** ValidUpgradeTarget.UpgradeTarget.N **   
此資料庫引擎版本可升級的引擎版本清單。  
類型：[UpgradeTarget](API_UpgradeTarget.md) 物件陣列  
必要：否

## 另請參閱
<a name="API_DBEngineVersion_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBEngineVersion) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBEngineVersion) 
+  [AWS 適用於 Ruby V3 的 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 **   
此資料庫執行個體的憑證授權機構憑證識別碼。  
類型：字串  
必要：否

 ** CertificateDetails **   
資料庫執行個體的伺服器憑證詳細資訊。  
類型：[CertificateDetails](API_CertificateDetails.md) 物件  
必要：否

 ** CopyTagsToSnapshot **   
值，指示是否將標籤從資料庫執行個體複製到資料庫執行個體快照。根據預設，不會複製標籤。  
類型：布林值  
必要：否

 ** DBClusterIdentifier **   
如果執行個體是叢集的成員，則包含執行個體所屬的叢集名稱。  
類型：字串  
必要：否

 ** DBInstanceArn **   
執行個體的 Amazon Resource Name (ARN)。  
類型：字串  
必要：否

 ** DBInstanceClass **   
包含執行個體的運算和記憶體容量類別名稱。  
類型：字串  
必要：否

 ** DBInstanceIdentifier **   
包含使用者提供的資料庫識別符。此識別符是識別執行個體的唯一金鑰。  
類型：字串  
必要：否

 ** DBInstanceStatus **   
指定此資料庫的目前狀態。  
類型：字串  
必要：否

 ** DbiResourceId **   
執行個體 AWS 區域的唯一不可變識別符。每當存取執行個體的 AWS KMS 金鑰時， AWS CloudTrail 日誌項目中都會找到此識別碼。  
類型：字串  
必要：否

 ** DBSubnetGroup **   
指定與執行個體相關聯的子網路群組資訊，包括子網路群組中的名稱、描述和子網路。  
類型：[DBSubnetGroup](API_DBSubnetGroup.md) 物件  
必要：否

 ** EnabledCloudwatchLogsExports.member.N **   
此執行個體設定為匯出至 CloudWatch Logs 的日誌類型清單。  
類型：字串陣列  
必要：否

 ** Endpoint **   
指定連線端點。  
類型：[Endpoint](API_Endpoint.md) 物件  
必要：否

 ** Engine **   
提供要用於此執行個體的資料庫引擎名稱。  
類型：字串  
必要：否

 ** EngineVersion **   
指示資料庫引擎版本。  
類型：字串  
必要：否

 ** InstanceCreateTime **   
提供執行個體建立的日期和時間。  
類型：Timestamp  
必要：否

 ** KmsKeyId **   
 如果 `StorageEncrypted`是 `true`，則為加密執行個體的 AWS KMS 金鑰識別符。  
類型：字串  
必要：否

 ** LatestRestorableTime **   
指定可透過 point-in-time 還原還原資料庫的最新時間。  
類型：Timestamp  
必要：否

 ** PendingModifiedValues **   
指定執行個體的變更正在等待中。只有在變更待定時，才會包含此元素。特定的變更會由子元素識別。  
類型：[PendingModifiedValues](API_PendingModifiedValues.md) 物件  
必要：否

 ** PerformanceInsightsEnabled **   
`true` 如果資料庫執行個體已啟用 Amazon RDS Performance Insights，則設為 ，否則設為 `false`。  
類型：布林值  
必要：否

 ** PerformanceInsightsKMSKeyId **   
Performance Insights 資料加密的 AWS KMS 金鑰識別符。 AWS KMS 金鑰 ID 是 Amazon Resource Name (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 SDKs中使用此 API 的詳細資訊，請參閱以下內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBInstance) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBInstance) 
+  [AWS 適用於 Ruby V3 的 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 SDKs中使用此 API 的詳細資訊，請參閱以下內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBInstanceStatusInfo) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBInstanceStatusInfo) 
+  [AWS 適用於 Ruby V3 的 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 Resource Name (ARN)。  
類型：字串  
必要：否

 ** DBSubnetGroupDescription **   
提供子網路群組的描述。  
類型：字串  
必要：否

 ** DBSubnetGroupName **   
子網路群組的名稱。  
類型：字串  
必要：否

 ** SubnetGroupStatus **   
提供子網路群組的狀態。  
類型：字串  
必要：否

 ** Subnets.Subnet.N **   
子網路群組中一或多個子網路的詳細資訊。  
類型：[Subnet](API_Subnet.md) 物件陣列  
必要：否

 ** SupportedNetworkTypes.member.N **   
資料庫子網路群組的網路類型。  
有效值: `IPV4` \$1 `DUAL`   
只能`DBSubnetGroup`支援 IPv4 通訊協定或 IPv4 和 IPv6 通訊協定 (DUAL)。  
類型：字串陣列  
必要：否

 ** VpcId **   
提供子網路群組的虛擬私有雲端 (VPC) ID。  
類型：字串  
必要：否

## 另請參閱
<a name="API_DBSubnetGroup_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBSubnetGroup) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBSubnetGroup) 
+  [AWS 適用於 Ruby V3 的 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 SDKs中使用此 API 的詳細資訊，請參閱以下內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/Endpoint) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/Endpoint) 
+  [AWS 適用於 Ruby V3 的 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 SDKs中使用此 API 的詳細資訊，請參閱以下內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/EngineDefaults) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/EngineDefaults) 
+  [AWS 適用於 Ruby V3 的 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 **   
指定事件的日期和時間。  
類型：Timestamp  
必要：否

 ** EventCategories.EventCategory.N **   
指定事件類別。  
類型：字串陣列  
必要：否

 ** Message **   
提供此事件的文字。  
類型：字串  
必要：否

 ** SourceArn **   
事件的 Amazon Resource Name (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 SDKs中使用此 API 的詳細資訊，請參閱以下內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/Event) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/Event) 
+  [AWS 適用於 Ruby V3 的 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 SDKs中使用此 API 的詳細資訊，請參閱以下內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/EventCategoriesMap) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/EventCategoriesMap) 
+  [AWS 適用於 Ruby V3 的 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 Resource Name (ARN)。  
類型：字串  
必要：否

 ** SnsTopicArn **   
Amazon DocumentDB 事件通知訂閱的主題 ARN。  
類型：字串  
必要：否

 ** SourceIdsList.SourceId.N **   
Amazon DocumentDB 事件通知訂閱IDs 清單。  
類型：字串陣列  
必要：否

 ** 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 SDKs中使用此 API 的詳細資訊，請參閱以下內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/EventSubscription) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/EventSubscription) 
+  [AWS 適用於 Ruby V3 的 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 叢集的 Amazon Resource Name (ARN)。  
類型：字串  
必要：否

 ** IsDataLossAllowed **   
指出操作是全域切換還是全域容錯移轉。如果允許資料遺失，則操作是全域容錯移轉。否則，它是切換。  
類型：布林值  
必要：否

 ** Status **   
全域叢集的目前狀態。可能的值如下：  
+  **待定** – 服務收到切換或容錯移轉全域叢集的請求。在操作開始之前，正在驗證全域叢集的主要叢集和指定的次要叢集。
+  **容錯移轉** – 所選的次要叢集正在提升，成為容錯移轉至全域叢集的新主要叢集。
+  **取消** – 切換或容錯移轉全域叢集的請求已取消，且主要叢集和選取的次要叢集正在返回其先前的狀態。
類型：字串  
有效值:`pending | failing-over | cancelling`   
必要：否

 ** ToDbClusterArn **   
目前正在提升且與此狀態相關聯的 Amazon DocumentDB 叢集的 Amazon Resource Name (ARN)。  
類型：字串  
必要：否

## 另請參閱
<a name="API_FailoverState_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/FailoverState) 
+  [AWS 適用於 Java V2 的 SDK](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>

一組命名的篩選條件值，用於傳回更具體的結果清單。您可以使用篩選條件，依特定條件比對一組資源，例如 IDs。

篩選條件不支援萬用字元。

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

**注意**  
在下列清單中，會先說明所需的參數。

 ** Name **   
篩選條件的名稱。篩選條件名稱區分大小寫。  
類型：字串  
必要：是

 ** Values.Value.N **   
一或多個篩選條件值。篩選條件值區分大小寫。  
類型：字串陣列  
必要：是

## 另請參閱
<a name="API_Filter_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱以下內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/Filter) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/Filter) 
+  [AWS 適用於 Ruby V3 的 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 Resource Name (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>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/GlobalCluster) 
+  [AWS 適用於 Java V2 的 SDK](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 Resource Name (ARN)。  
類型：字串  
必要：否

 ** IsWriter **   
 指定 Amazon DocumentDB 叢集是否為與其相關聯之 Amazon DocumentDB 全域叢集的主要叢集 （即具有讀寫功能）。  
類型：布林值  
必要：否

 ** Readers.member.N **   
與 Amazon DocumentDB 全域叢集相關聯的每個唯讀次要叢集的 Amazon Resource Name (ARN)。  
類型：字串陣列  
必要：否

 ** SynchronizationStatus **   
全域叢集中每個 Amazon DocumentDB 叢集的同步狀態。  
類型：字串  
有效值:`connected | pending-resync`   
必要：否

## 另請參閱
<a name="API_GlobalClusterMember_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/GlobalClusterMember) 
+  [AWS 適用於 Java V2 的 SDK](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 SDKs中使用此 API 的詳細資訊，請參閱以下內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/OrderableDBInstanceOption) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/OrderableDBInstanceOption) 
+  [AWS 適用於 Ruby V3 的 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 SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/Parameter) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/Parameter) 
+  [AWS 適用於 Ruby V3 的 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 SDKs中使用此 API 的詳細資訊，請參閱以下內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/PendingCloudwatchLogsExports) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/PendingCloudwatchLogsExports) 
+  [AWS 適用於 Ruby V3 的 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` 選擇使用請求。  
類型：Timestamp  
必要：否

 ** CurrentApplyDate **   
待處理維護動作套用至資源時的有效日期。  
類型：Timestamp  
必要：否

 ** Description **   
提供維護動作更多詳細資訊的描述。  
類型：字串  
必要：否

 ** ForcedApplyDate **   
自動套用維護動作時的日期。維護動作會在此日期套用至資源，無論資源的維護時段為何。如已指定此日期，則忽略任何 `immediate` 選擇使用請求。  
類型：Timestamp  
必要：否

 ** OptInStatus **   
指出資源已收到的選擇使用請求類型。  
類型：字串  
必要：否

## 另請參閱
<a name="API_PendingMaintenanceAction_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱以下內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/PendingMaintenanceAction) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/PendingMaintenanceAction) 
+  [AWS 適用於 Ruby V3 的 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 SDKs中使用此 API 的詳細資訊，請參閱以下內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/PendingModifiedValues) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/PendingModifiedValues) 
+  [AWS 適用於 Ruby V3 的 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 Resource Name (ARN)。  
類型：字串  
必要：否

## 另請參閱
<a name="API_ResourcePendingMaintenanceActions_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱以下內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ResourcePendingMaintenanceActions) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ResourcePendingMaintenanceActions) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ResourcePendingMaintenanceActions) 

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

指定任何與 Amazon DocumentDB 引擎版本不同的 Amazon DocumentDB Serverless 屬性或限制。您可以在決定要在新的或升級的叢集中使用的 Amazon DocumentDB 版本時，測試此屬性的值。您也可以擷取現有叢集的版本，並檢查該版本是否支援特定 Amazon DocumentDB Serverless 功能，再嘗試使用這些功能。

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

**注意**  
在下列清單中，會先說明必要的參數。

 ** MaxCapacity **   
Amazon DocumentDB Serverless 叢集中執行個體的 Amazon DocumentDB 容量單位 (DCUs) 數目上限。您可以用半步驟遞增來指定 DCU 值，例如 32、32.5、33 等。  
類型：Double  
必要：否

 ** MinCapacity **   
Amazon DocumentDB Serverless 叢集中執行個體的 Amazon DocumentDB 容量單位 (DCUs) 數目下限。您可以用半步驟遞增來指定 DCU 值，例如 8、8.5、9 等。  
類型：Double  
必要：否

## 另請參閱
<a name="API_ServerlessV2FeaturesSupport_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ServerlessV2FeaturesSupport) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ServerlessV2FeaturesSupport) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ServerlessV2FeaturesSupport) 

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

設定 Amazon DocumentDB Serverless 叢集的擴展組態。

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

**注意**  
在下列清單中，會先說明必要的參數。

 ** MaxCapacity **   
Amazon DocumentDB Serverless 叢集中執行個體的 Amazon DocumentDB 容量單位 (DCUs) 數目上限。您可以用半步驟遞增來指定 DCU 值，例如 32、32.5、33 等。  
類型：Double  
必要：否

 ** MinCapacity **   
Amazon DocumentDB Serverless 叢集中執行個體的 Amazon DocumentDB 容量單位 (DCUs) 數目下限。您可以用半步驟遞增來指定 DCU 值，例如 8、8.5、9 等。  
類型：Double  
必要：否

## 另請參閱
<a name="API_ServerlessV2ScalingConfiguration_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ServerlessV2ScalingConfiguration) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ServerlessV2ScalingConfiguration) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ServerlessV2ScalingConfiguration) 

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

擷取 Amazon DocumentDB Serverless 叢集的擴展組態。

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

**注意**  
在下列清單中，會先描述必要的參數。

 ** MaxCapacity **   
Amazon DocumentDB Serverless 叢集中執行個體的 Amazon DocumentDB 容量單位 (DCUs) 數目上限。您可以用半步驟遞增來指定 DCU 值，例如 32、32.5、33 等。  
類型：Double  
必要：否

 ** MinCapacity **   
Amazon DocumentDB Serverless 叢集中執行個體的 Amazon DocumentDB 容量單位 (DCUs) 數目下限。您可以用半步驟遞增來指定 DCU 值，例如 8、8.5、9 等。  
類型：Double  
必要：否

## 另請參閱
<a name="API_ServerlessV2ScalingConfigurationInfo_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ServerlessV2ScalingConfigurationInfo) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ServerlessV2ScalingConfigurationInfo) 
+  [AWS 適用於 Ruby V3 的 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 SDKs中使用此 API 的詳細資訊，請參閱以下內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/Subnet) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/Subnet) 
+  [AWS 適用於 Ruby V3 的 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 regex： "^(【\$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 regex： "^(【\$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 SDKs中使用此 API 的詳細資訊，請參閱以下內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/Tag) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/Tag) 
+  [AWS 適用於 Ruby V3 的 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 SDKs中使用此 API 的詳細資訊，請參閱以下內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/UpgradeTarget) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/UpgradeTarget) 
+  [AWS 適用於 Ruby V3 的 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 SDKs中使用此 API 的詳細資訊，請參閱以下內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/VpcSecurityGroupMembership) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/VpcSecurityGroupMembership) 
+  [AWS 適用於 Ruby V3 的 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 Elastic Clusters 支援下列資料類型：
+  [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>
指派給每個彈性叢集碎片vCPUs 數量。上限為 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 IDs。  
類型：字串陣列  
必要：是

 ** 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 SDKs中使用此 API 的詳細資訊，請參閱以下內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/Cluster) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/Cluster) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/Cluster) 

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

Amazon DocumentDB 彈性叢集的清單。

## 目錄
<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 SDKs中使用此 API 的詳細資訊，請參閱以下內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ClusterInList) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ClusterInList) 
+  [AWS 適用於 Ruby V3 的 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 Resource Name (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 IDs。  
類型：字串陣列  
必要：是

 ** 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 SDKs中使用此 API 的詳細資訊，請參閱以下內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ClusterSnapshot) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ClusterSnapshot) 
+  [AWS 適用於 Ruby V3 的 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 SDKs中使用此 API 的詳細資訊，請參閱以下內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ClusterSnapshotInList) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ClusterSnapshotInList) 
+  [AWS 適用於 Ruby V3 的 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 SDKs中使用此 API 的詳細資訊，請參閱以下內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/PendingMaintenanceActionDetails) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/PendingMaintenanceActionDetails) 
+  [AWS 適用於 Ruby V3 的 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 Resource Name (ARN)。  
類型：字串  
必要：否

## 另請參閱
<a name="API_elastic_ResourcePendingMaintenanceAction_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱以下內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ResourcePendingMaintenanceAction) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ResourcePendingMaintenanceAction) 
+  [AWS 適用於 Ruby V3 的 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 SDKs中使用此 API 的詳細資訊，請參閱以下內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/Shard) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/Shard) 
+  [AWS 適用於 Ruby V3 的 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 SDKs中使用此 API 的詳細資訊，請參閱以下內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ValidationExceptionField) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ValidationExceptionField) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ValidationExceptionField)