

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

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