本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
DBInstance
執行個體的詳細資訊。
目錄
注意
在下列清單中,會先說明必要的參數。
- AutoMinorVersionUpgrade
-
不適用。此參數不適用於 Amazon DocumentDB。無論設定的值為何,Amazon DocumentDB 都不會執行次要版本升級。
類型:布林值
必要:否
- AvailabilityZone
-
指定執行個體所在的可用區域名稱。
類型:字串
必要:否
- BackupRetentionPeriod
-
指定保留自動快照的天數。
類型:整數
必要:否
- CACertificateIdentifier
-
此資料庫執行個體的憑證授權機構憑證識別碼。
類型:字串
必要:否
- CertificateDetails
-
資料庫執行個體伺服器憑證的詳細資訊。
類型:CertificateDetails 物件
必要:否
- CopyTagsToSnapshot
-
值,指示是否將標籤從資料庫執行個體複製到資料庫執行個體快照。根據預設,不會複製標籤。
類型:布林值
必要:否
- DBClusterIdentifier
-
如果執行處理是叢集的成員,則包含執行處理所屬的叢集名稱。
類型:字串
必要:否
- DBInstanceArn
-
執行個體的 Amazon 資源名稱 (ARN)。
類型:字串
必要:否
- DBInstanceClass
-
包含執行個體的運算和記憶體容量類別的名稱。
類型:字串
必要:否
- DBInstanceIdentifier
-
包含使用者提供的資料庫識別碼。此識別碼是識別執行個體的唯一金鑰。
類型:字串
必要:否
- DBInstanceStatus
-
指定此資料庫的目前狀態。
類型:字串
必要:否
- DbiResourceId
-
執行個 AWS 區域體的唯一且不可變的識別碼。每當存取執行個體的 AWS KMS 金鑰時,都會在 AWS CloudTrail 記錄項目中找到此識別碼。
類型:字串
必要:否
- DBSubnetGroup
-
指定與執行個體相關聯之子網路群組的資訊,包括子網路群組中的名稱、說明和子網路。
類型:DBSubnetGroup 物件
必要:否
- EnabledCloudwatchLogsExports.member.N
-
此執行個體設定為匯出至記錄檔的 CloudWatch 記錄類型清單。
類型:字串陣列
必要:否
- Endpoint
-
指定連線端點。
類型:Endpoint 物件
必要:否
- Engine
-
提供要用於此執行處理的資料庫引擎名稱。
類型:字串
必要:否
- EngineVersion
-
指示資料庫引擎版本。
類型:字串
必要:否
- InstanceCreateTime
-
提供執行個體的建立日期和時間。
類型:Timestamp
必要:否
- KmsKeyId
-
如果
StorageEncrypted
是true
,則為加密執行個體的 AWS KMS 金鑰識別碼。類型:字串
必要:否
- LatestRestorableTime
-
指定可以透過還原來 point-in-time還原資料庫的最近時間。
類型:Timestamp
必要:否
- PendingModifiedValues
-
指定執行個體的變更處於擱置狀態。只有當變更處於擱置狀態時,才會包含此元素。特定的變更會由子元素識別。
類型:PendingModifiedValues 物件
必要:否
- PerformanceInsightsEnabled
-
設定為是
true
否為資料庫執行個體啟用 Amazon Perfor RDS mance Insights,否則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 物件陣列
必要:否
- StorageEncrypted
-
指定執行個體是否已加密。
類型:布林值
必要:否
- VpcSecurityGroups.VpcSecurityGroupMembership.N
-
提供執行個體所屬的VPC安全群組元素清單。
類型:VpcSecurityGroupMembership 物件陣列
必要:否
另請參閱
如需有關API在其中一種特定語言中使用此功能的詳細資訊 AWS SDKs,請參閱下列內容: