本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。
# Neptune 執行個體 API
**動作:**
+ [CreateDBInstance (動作)](#CreateDBInstance)
+ [DeleteDBInstance (動作)](#DeleteDBInstance)
+ [ModifyDBInstance (動作)](#ModifyDBInstance)
+ [RebootDBInstance (動作)](#RebootDBInstance)
+ [DescribeDBInstances (動作)](#DescribeDBInstances)
+ [DescribeOrderableDBInstanceOptions (動作)](#DescribeOrderableDBInstanceOptions)
+ [DescribeValidDBInstanceModifications (動作)](#DescribeValidDBInstanceModifications)
**結構：**
+ [DBInstance (結構)](#DBInstance)
+ [DBInstanceStatusInfo (結構)](#DBInstanceStatusInfo)
+ [OrderableDBInstanceOption (結構)](#OrderableDBInstanceOption)
+ [PendingModifiedValues (結構)](#PendingModifiedValues)
+ [ValidStorageOptions (結構)](#ValidStorageOptions)
+ [ValidDBInstanceModificationsMessage (結構)](#ValidDBInstanceModificationsMessage)
## CreateDBInstance (動作)
此 API 的 AWS CLI 名稱為：`create-db-instance`。
建立新的資料庫執行個體。
**請求**
+ **AutoMinorVersionUpgrade** (在 CLI 中:`--auto-minor-version-upgrade`) – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
指出會在維護時段期間將次要引擎升級自動套用至資料庫執行個體。
預設：`true`
+ **AvailabilityZone** (在 CLI 中：`--availability-zone`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
在其中建立資料庫執行個體的 EC2 可用區域。
預設值：端點 Amazon 區域中系統隨機選擇的可用區域。
範例：`us-east-1d`
限制條件：若 MultiAZ 參數設為 `true`，則無法指定 AvailabilityZone 參數。指定的可用區域和目前端點必須位於同一 Amazon 區域。
+ **BackupRetentionPeriod** (在 CLI 中：`--backup-retention-period`) – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
自動備份保留的天數。
不適用。自動化備份的保留期會由資料庫叢集管理。如需詳細資訊，請參閱[CreateDBCluster (動作)](api-clusters.md#CreateDBCluster)。
預設：1
約束:
+ 該值必須介於 0 到 35 之間
+ 若資料庫執行個體是僅供讀取複本的來源，則無法設為 0
+ **CopyTagsToSnapshot** (在 CLI 中:`--copy-tags-to-snapshot`) – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
若為 True，則會從資料庫執行個體將所有標籤複製到資料庫執行個體的快照，否則為 False。預設值為 false。
+ **DBClusterIdentifier** (在 CLI 中：`--db-cluster-identifier`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
執行個體所屬資料庫叢集的識別碼。
如需建立資料庫叢集的詳細資訊，請參閱[CreateDBCluster (動作)](api-clusters.md#CreateDBCluster)。
類型：字串
+ **DBInstanceClass** (在 CLI 中：`--db-instance-class`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫執行個體的運算與記憶體容量，例如 `db.m4.large`。並非所有 Amazon 區域皆提供所有資料庫執行個體類別。
+ **DBInstanceIdentifier** (在 CLI 中：`--db-instance-identifier`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫執行個體識別符。此參數是以小寫字母字串的形式儲存。
約束:
+ 必須包含 1 到 63 個字母、數字或連字號。
+ 第一個字元必須是字母。
+ 不能以連字號結尾或連續包含兩個連字號。
範例：`mydbinstance`
+ **DBName** (在 CLI 中：`--db-name`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
不支援。
+ **DBParameterGroupName** (在 CLI 中：`--db-parameter-group-name`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
要與此資料庫執行個體建立關聯的資料庫參數群組名稱。若忽略此引數，則會使用指定引擎的預設 DBParameterGroup。
約束:
+ 必須為 1 到 255 個字母、數字或連字號。
+ 第一個字元必須是字母
+ 不能以連字號結尾或連續包含兩個連字號
+ **DBSecurityGroups** (在 CLI 中：`--db-security-groups`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
與此資料庫執行個體關聯的資料庫安全群組清單。
預設值：資料庫引擎的預設資料庫安全群組。
+ **DBSubnetGroupName** (在 CLI 中：`--db-subnet-group-name`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
要與此資料庫執行個體建立關聯的資料庫子網路群組。
如果沒有資料庫子網路群組，則它是非VPC DB執行個體。
+ **DeletionProtection** (在 CLI 中:`--deletion-protection`) – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
指示資料庫執行個體是否啟用刪除保護的值。啟用刪除保護時無法刪除資料庫。根據預設，刪除保護是停用的。請參閱[刪除資料庫執行個體](https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-instances-delete.html)。
即使刪除保護已在上層資料庫叢集中啟用，資料庫叢集中的資料庫執行個體仍可刪除。
+ **Domain** (在 CLI 中：`--domain`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定要在其中建立執行個體的 Active Directory 網域。
+ **DomainIAMRoleName** (在 CLI 中：`--domain-iam-role-name`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定對 Directory Service 發出 API 呼叫時要使用的 IAM 角色名稱。
+ **EnableCloudwatchLogsExports** (在 CLI 中：`--enable-cloudwatch-logs-exports`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
需要啟用，以匯出至 CloudWatch Logs 的日誌類型清單。
+ **EnableIAMDatabaseAuthentication** (在 CLI 中:`--enable-iam-database-authentication`) – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
Neptune 不提供支援 (已忽略)。
+ **Engine** (在 CLI 中：`--engine`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
要為此執行個體使用的資料庫引擎名稱。
有效值:`neptune`
+ **EngineVersion** (在 CLI 中：`--engine-version`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
要使用的資料庫引擎版本號碼。目前，設定此參數沒有任何作用。
+ **Iops** (在 CLI 中：`--iops`) – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
初始配置給資料庫執行個體的佈建IOPS數量 (每秒輸入/輸出作業)。
+ **KmsKeyId** (在 CLI 中：`--kms-key-id`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
加密資料庫執行個體的 Amazon KMS 金鑰識別符。
KMS 金鑰識別符是 KMS 加密金鑰的 Amazon Resource Name (ARN)。如果您用來建立資料庫執行個體的 Amazon 帳戶，與擁有用於加密新資料庫執行個體 KMS 加密金鑰的 Amazon 帳戶相同，則您可以使用 KMS 金鑰別名，而非 KM 加密金鑰的 ARN。
不適用。KMS 金鑰識別碼會由資料庫叢集管理。如需詳細資訊，請參閱[CreateDBCluster (動作)](api-clusters.md#CreateDBCluster)。
若 `StorageEncrypted` 參數為 True，並且您沒有為 `KmsKeyId` 參數指定值，則 Amazon Neptune 會使用您的預設加密金鑰。Amazon KMS 會為您的 Amazon 帳戶建立預設加密金鑰。您的 Amazon 帳戶在每個 Amazon 區域各有不同的預設加密金鑰。
+ **LicenseModel** (在 CLI 中：`--license-model`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
此資料庫執行個體的授權模型資訊。
有效值：`license-included` \| `bring-your-own-license` \| `general-public-license`
+ **MonitoringInterval** (在 CLI 中：`--monitoring-interval`) – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
為資料庫執行個體收集增強型監控指標點之間的間隔 (秒)。若要停用收集增強型監控指標，請指定 0。預設值為 0。
若指定 `MonitoringRoleArn`，您必須也將 `MonitoringInterval` 設為 0 之外的值。
有效值:`0, 1, 5, 10, 15, 30, 60`
+ **MonitoringRoleArn** (在 CLI 中：`--monitoring-role-arn`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
IAM 角色的 ARN，允許 Neptune 將增強型監控指標傳送到 Amazon CloudWatch Logs。例如 `arn:aws:iam:123456789012:role/emaccess`。
若 `MonitoringInterval` 設為 0 之外的值，則您必須提供 `MonitoringRoleArn` 值。
+ **MultiAZ** (在 CLI 中:`--multi-az`) – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
指定資料庫執行個體是否為異地同步備份部署。若 MultiAZ 參數設為 True，您便無法設定 AvailabilityZone 參數。
+ **Port** (在 CLI 中：`--port`) – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
資料庫接受連線的連接埠號碼。
不適用。連接埠會由資料庫叢集管理。如需詳細資訊，請參閱[CreateDBCluster (動作)](api-clusters.md#CreateDBCluster)。
預設：`8182`
類型：整數
+ **PreferredBackupWindow** (在 CLI 中：`--preferred-backup-window`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
每日時間範圍，自動化備份會在這段期間建立。
不適用。建立自動化備份的每日時間範圍會由資料庫叢集管理。如需詳細資訊，請參閱[CreateDBCluster (動作)](api-clusters.md#CreateDBCluster)。
+ **PreferredMaintenanceWindow** (在 CLI 中：`--preferred-maintenance-window`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
每週可能進行系統維護的時間範圍，以國際標準時間 (UTC) 表示。
格式：`ddd:hh24:mi-ddd:hh24:mi`
預設是從各 Amazon 區域 8 小時時段中隨機選取的 30 分鐘時段，並隨機發生在一週內的某一天。
有效日：星期一、星期二、星期三、星期四、星期五、星期六、星期日。
限制條件：必須至少是 30 分鐘的時段。
+ **PromotionTier** (在 CLI 中：`--promotion-tier`) – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
指定在現有主要執行個體失敗後，將僅供讀取複本提升為主要執行個體順序的值。
預設：1
有效值：0 到 15
+ **PubliclyAccessible** (在 CLI 中:`--publicly-accessible`) – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
此標記不應繼續使用。
+ **StorageEncrypted** (在 CLI 中:`--storage-encrypted`) – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
指定是否加密資料庫執行個體。
不適用。資料庫執行個體的加密會由資料庫叢集管理。如需詳細資訊，請參閱[CreateDBCluster (動作)](api-clusters.md#CreateDBCluster)。
預設：false
+ **StorageType** (在 CLI 中：`--storage-type`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
不適用。在 Neptune 中，儲存類型是在資料庫叢集層級進行管理。
+ **Tags** (在 CLI 中：`--tags`) – [Tag](api-other-apis.md#Tag) 物件的陣列。
要指派給新執行個體的標籤。
+ **TdeCredentialArn** (在 CLI 中：`--tde-credential-arn`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
來自金鑰存放區的 ARN，執行個體會與此 ARN 建立關聯以進行 TDE 加密。
+ **TdeCredentialPassword** (在 CLI 中：`--tde-credential-password`) – SensitiveString，類型為：`string` (UTF-8 編碼的字串)。
在金鑰存放區指定 ARN 的密碼，用於存取裝置。
+ **Timezone** (在 CLI 中：`--timezone`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫執行個體的時區。
+ **VpcSecurityGroupIds** (在 CLI 中：`--vpc-security-group-ids`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
與此資料庫執行個體關聯的 EC2 VPC 安全群組清單。
不適用。資料庫叢集會管理 EC2 VPC 安全群組的關聯清單。如需詳細資訊，請參閱[CreateDBCluster (動作)](api-clusters.md#CreateDBCluster)。
預設值：資料庫子網路群組 VPC 的預設 EC2 VPC 安全群組。
**回應**
包含 Amazon Neptune 資料庫執行個體的詳細資訊。
此資料類型在 [DescribeDBInstances (動作)](#DescribeDBInstances) 動作中會用來作為回應元素。
+ **AutoMinorVersionUpgrade** – 布林值，類型為：`boolean` (布林值 (true 或 false))。
指示會自動套用次要版本的修補程式。
+ **AvailabilityZone** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定資料庫執行個體所在的可用區域名稱。
+ **BackupRetentionPeriod** – 整數，類型為：`integer` (帶正負號的 32 位元整數)。
指定保留自動資料庫快照的天數。
+ **CACertificateIdentifier** – 字串，類型為：`string` (UTF-8 編碼的字串)。
此資料庫執行個體的憑證授權機構憑證識別碼。
+ **CopyTagsToSnapshot** – 布林值，類型為：`boolean` (布林值 (true 或 false))。
指定是否要從資料庫執行個體將標籤複製到資料庫執行個體的快照。
+ **DBClusterIdentifier** – 字串，類型為：`string` (UTF-8 編碼的字串)。
若資料庫執行個體是資料庫叢集的成員，則包含資料庫執行個體所屬資料庫叢集的名稱。
+ **DBInstanceArn** – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫執行個體的 Amazon Resource Name (ARN)。
+ **DBInstanceClass** – 字串，類型為：`string` (UTF-8 編碼的字串)。
包含資料庫執行個體之運算和記憶體容量類別的名稱。
+ **DBInstanceIdentifier** – 字串，類型為：`string` (UTF-8 編碼的字串)。
包含使用者提供的資料庫識別碼。此識別碼是可識別資料庫執行個體的唯一金鑰。
+ **DbInstancePort** – 整數，類型為：`integer` (帶正負號的 32 位元整數)。
指定資料庫執行個體接聽的連接埠。若資料庫執行個體是資料庫叢集的一部分，這可以是與資料庫叢集連接埠不同的連接埠。
+ **DBInstanceStatus** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定此資料庫的目前狀態。
+ **DbiResourceId** – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫執行個體的 Amazon 區域唯一、固定識別符。每當存取資料庫執行個體的 Amazon KMS 金鑰時，就會在 Amazon CloudTrail 日誌項目中找到此識別符。
+ **DBName** – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫名稱。
+ **DBParameterGroups** – 一個 [DBParameterGroupStatus](api-parameters.md#DBParameterGroupStatus) 物件陣列。
提供要套用到此資料庫執行個體的資料庫參數群組清單。
+ **DBSecurityGroups** – 一個 [DBSecurityGroupMembership](api-datatypes.md#DBSecurityGroupMembership) 物件陣列。
提供資料庫安全群組元素的清單，元素中只包含 `DBSecurityGroup.Name` 和 `DBSecurityGroup.Status` 子元素。
+ **DBSubnetGroup** – [DBSubnetGroup](api-subnets.md#DBSubnetGroup) 物件。
指定與資料庫執行個體相關聯子網路群組上的資訊，包含名稱、描述，以及子網路群組中的子網路。
+ **DeletionProtection** – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
指出資料庫執行個體是否已啟用刪除保護。如果刪除保護已經啟用，執行個體將無法刪除。請參閱[刪除資料庫執行個體](https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-instances-delete.html)。
+ **DomainMemberships** – 一個 [DomainMembership](api-datatypes.md#DomainMembership) 物件陣列。
不支援
+ **EnabledCloudwatchLogsExports** – 字串，類型為：`string` (UTF-8 編碼的字串)。
此資料庫執行個體已設為匯出至 CloudWatch Logs 的日誌類型清單。
+ **Endpoint** – [端點](api-datatypes.md#Endpoint) 物件。
指定連線端點。
+ **Engine** – 字串，類型為：`string` (UTF-8 編碼的字串)。
提供用於此資料庫執行個體的資料庫引擎名稱。
+ **EngineVersion** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指示資料庫引擎版本。
+ **EnhancedMonitoringResourceArn** – 字串，類型為：`string` (UTF-8 編碼的字串)。
Amazon CloudWatch Logs 日誌串流的 Amazon Resource Name (ARN)，該串流會接收資料庫執行個體的增強型監控指標。
+ **IAMDatabaseAuthenticationEnabled** – 布林值，類型為：`boolean` (布林值 (true 或 false))。
若 Amazon Identity and Access Management (IAM) 身分驗證已啟用，則為 True，否則為 False。
+ **InstanceCreateTime** – TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
提供建立資料庫執行個體的日期和時間。
+ **Iops** – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
指定佈建 IOPS (每秒 I/O 操作) 值。
+ **KmsKeyId** – 字串，類型為：`string` (UTF-8 編碼的字串)。
不支援：資料庫執行個體的加密會由資料庫叢集管理。
+ **LatestRestorableTime** – TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
指定可透過 point-in-time 還原還原資料庫的最新時間。
+ **LicenseModel** – 字串，類型為：`string` (UTF-8 編碼的字串)。
此資料庫執行個體的授權模型資訊。
+ **MonitoringInterval** – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
為資料庫執行個體收集增強型監控指標點之間的間隔 (秒)。
+ **MonitoringRoleArn** – 字串，類型為：`string` (UTF-8 編碼的字串)。
IAM 角色的 ARN，允許 Neptune 將增強型監控指標傳送到 Amazon CloudWatch Logs。
+ **MultiAZ** – 布林值，類型為：`boolean` (布林值 (true 或 false))。
指定資料庫執行個體是否為異地同步備份部署。
+ **PendingModifiedValues** – [PendingModifiedValues](#PendingModifiedValues) 物件。
指定對資料庫執行個體所進行的變更仍在擱置中。此元素只有在變更擱置中時才會包含在其中。特定的變更會由子元素識別。
+ **PreferredBackupWindow** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定每日的時間範圍，若有啟用自動化備份 (由 `BackupRetentionPeriod` 決定)，則自動化備份會在此期間建立。
+ **PreferredMaintenanceWindow** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定每週可能進行系統維護的時段，以世界協調時間 (UTC) 表示。
+ **PromotionTier** – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
此值指定在現有主要執行個體故障後，僅供讀取複本提升為主要執行個體的順序。
+ **PubliclyAccessible** – 布林值，類型為：`boolean` (布林值 (true 或 false))。
此標記不應繼續使用。
+ **ReadReplicaDBClusterIdentifiers** – 字串，類型為：`string` (UTF-8 編碼的字串)。
包含一或多個資料庫叢集的識別符，這些叢集是此資料庫執行個體的僅供讀取複本。
+ **ReadReplicaDBInstanceIdentifiers** – 字串，類型為：`string` (UTF-8 編碼的字串)。
包含一或多個與此資料庫執行個體相關聯僅供讀取複本的識別符。
+ **ReadReplicaSourceDBInstanceIdentifier** – 字串，類型為：`string` (UTF-8 編碼的字串)。
包含來源資料庫執行個體的識別符 (若此資料庫執行個體是僅供讀取複本)。
+ **SecondaryAvailabilityZone** – 字串，類型為：`string` (UTF-8 編碼的字串)。
若存在，指定具備多個可用區支援之資料庫執行個體的次要可用區名稱。
+ **StatusInfos** – 一個 [DBInstanceStatusInfo](#DBInstanceStatusInfo) 物件陣列。
僅供讀取複本的狀態。若執行個體並非僅供讀取複本，此處即為空白。
+ **StorageEncrypted** – 布林值，類型為：`boolean` (布林值 (true 或 false))。
不支援：資料庫執行個體的加密會由資料庫叢集管理。
+ **StorageType** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定與此資料庫執行個體相關聯的儲存類型。
+ **TdeCredentialArn** – 字串，類型為：`string` (UTF-8 編碼的字串)。
來自金鑰存放區的 ARN，執行個體會與此 ARN 建立關聯以進行 TDE 加密。
+ **Timezone** – 字串，類型為：`string` (UTF-8 編碼的字串)。
不支援。
+ **VpcSecurityGroups** – 一個 [VpcSecurityGroupMembership](api-datatypes.md#VpcSecurityGroupMembership) 物件陣列。
提供資料庫執行個體所屬 VPC 安全群組元素的清單。
**錯誤**
+ [DBInstanceAlreadyExistsFault](api-faults.md#DBInstanceAlreadyExistsFault)
+ [InsufficientDBInstanceCapacityFault](api-faults.md#InsufficientDBInstanceCapacityFault)
+ [DBParameterGroupNotFoundFault](api-faults.md#DBParameterGroupNotFoundFault)
+ [DBSecurityGroupNotFoundFault](api-faults.md#DBSecurityGroupNotFoundFault)
+ [InstanceQuotaExceededFault](api-faults.md#InstanceQuotaExceededFault)
+ [StorageQuotaExceededFault](api-faults.md#StorageQuotaExceededFault)
+ [DBSubnetGroupNotFoundFault](api-faults.md#DBSubnetGroupNotFoundFault)
+ [DBSubnetGroupDoesNotCoverEnoughAZs](api-faults.md#DBSubnetGroupDoesNotCoverEnoughAZs)
+ [InvalidDBClusterStateFault](api-faults.md#InvalidDBClusterStateFault)
+ [InvalidSubnet](api-faults.md#InvalidSubnet)
+ [InvalidVPCNetworkStateFault](api-faults.md#InvalidVPCNetworkStateFault)
+ [ProvisionedIopsNotAvailableInAZFault](api-faults.md#ProvisionedIopsNotAvailableInAZFault)
+ [OptionGroupNotFoundFault](api-faults.md#OptionGroupNotFoundFault)
+ [DBClusterNotFoundFault](api-faults.md#DBClusterNotFoundFault)
+ [StorageTypeNotSupportedFault](api-faults.md#StorageTypeNotSupportedFault)
+ [AuthorizationNotFoundFault](api-faults.md#AuthorizationNotFoundFault)
+ [KMSKeyNotAccessibleFault](api-faults.md#KMSKeyNotAccessibleFault)
+ [DomainNotFoundFault](api-faults.md#DomainNotFoundFault)
## DeleteDBInstance (動作)
此 API 的 AWS CLI 名稱為：`delete-db-instance`。
DeleteDBInstance 動作會刪除先前佈建的資料庫執行個體。刪除資料庫執行個體時，系統會一併刪除該執行個體所有的自動化備份，且無法復原。要由 `DeleteDBInstance` 刪除的資料庫執行個體手動資料庫快照則不會遭到刪除。
若您請求最終資料庫快照，則 Amazon Neptune 資料庫執行個體的狀態將為 `deleting`，並會持續到建立資料庫快照為止。API 動作 `DescribeDBInstance` 會用於監控此操作的狀態。動作一旦提交，便無法取消或回復。
請注意，當資料庫執行個體處於故障狀態，且其狀態為 `failed`、`incompatible-restore` 或 `incompatible-network` 時，您只能在 `SkipFinalSnapshot` 參數設為 `true` 時刪除它。
若資料庫執行個體是資料庫叢集中的唯一執行個體，或其已啟用刪除保護，則您將無法刪除該執行個體。
**請求**
+ **DBInstanceIdentifier** (在 CLI 中：`--db-instance-identifier`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
要刪除之資料庫執行個體的識別符。此參數沒有大小寫之分。
約束:
+ 必須符合現有資料庫執行個體的名稱。
+ **FinalDBSnapshotIdentifier** (在 CLI 中：`--final-db-snapshot-identifier`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
當 SkipFinalSnapshot 設為 `false` 時，所建立新 DBSnapshot 的 DBSnapshotIdentifier。
**注意**
指定此參數，同時又將 SkipFinalSnapshot 參數設為 true 時，便會導致錯誤。
約束:
+ 必須為 1 到 255 個字母或數字。
+ 第一個字元必須是字母
+ 不能以連字號結尾或連續包含兩個連字號
+ 無法在刪除僅供讀取複本時指定。
+ **SkipFinalSnapshot** (在 CLI 中:`--skip-final-snapshot`) – 布林值，類型為：`boolean` (布林值 (true 或 false))。
判斷最終資料庫快照是否建立於資料庫執行個體刪除之前。若指定 `true`，則不會建立任何 DBSnapshot。若指定 `false`，則會在刪除資料庫執行個體前建立資料庫快照。
請注意，當資料庫執行個體處於故障狀態，且其狀態為 'failed'、'incompatible-restore' 或 'incompatible-network' 時，它便只能在 SkipFinalSnapshot 參數設為 "true" 時刪除。
在刪除僅供讀取複本時指定 `true`。
**注意**
若 SkipFinalSnapshot 為 `false`，則必須指定 FinalDBSnapshotIdentifier 參數。
預設：`false`
**回應**
包含 Amazon Neptune 資料庫執行個體的詳細資訊。
此資料類型在 [DescribeDBInstances (動作)](#DescribeDBInstances) 動作中會用來作為回應元素。
+ **AutoMinorVersionUpgrade** – 布林值，類型為：`boolean` (布林值 (true 或 false))。
指示會自動套用次要版本的修補程式。
+ **AvailabilityZone** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定資料庫執行個體所在的可用區域名稱。
+ **BackupRetentionPeriod** – 整數，類型為：`integer` (帶正負號的 32 位元整數)。
指定保留自動資料庫快照的天數。
+ **CACertificateIdentifier** – 字串，類型為：`string` (UTF-8 編碼的字串)。
此資料庫執行個體的憑證授權機構憑證識別碼。
+ **CopyTagsToSnapshot** – 布林值，類型為：`boolean` (布林值 (true 或 false))。
指定是否要從資料庫執行個體將標籤複製到資料庫執行個體的快照。
+ **DBClusterIdentifier** – 字串，類型為：`string` (UTF-8 編碼的字串)。
若資料庫執行個體是資料庫叢集的成員，則包含資料庫執行個體所屬資料庫叢集的名稱。
+ **DBInstanceArn** – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫執行個體的 Amazon Resource Name (ARN)。
+ **DBInstanceClass** – 字串，類型為：`string` (UTF-8 編碼的字串)。
包含資料庫執行個體之運算和記憶體容量類別的名稱。
+ **DBInstanceIdentifier** – 字串，類型為：`string` (UTF-8 編碼的字串)。
包含使用者提供的資料庫識別碼。此識別碼是可識別資料庫執行個體的唯一金鑰。
+ **DbInstancePort** – 整數，類型為：`integer` (帶正負號的 32 位元整數)。
指定資料庫執行個體接聽的連接埠。若資料庫執行個體是資料庫叢集的一部分，這可以是與資料庫叢集連接埠不同的連接埠。
+ **DBInstanceStatus** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定此資料庫的目前狀態。
+ **DbiResourceId** – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫執行個體的 Amazon 區域唯一、固定識別符。每當存取資料庫執行個體的 Amazon KMS 金鑰時，就會在 Amazon CloudTrail 日誌項目中找到此識別符。
+ **DBName** – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫名稱。
+ **DBParameterGroups** – 一個 [DBParameterGroupStatus](api-parameters.md#DBParameterGroupStatus) 物件陣列。
提供要套用到此資料庫執行個體的資料庫參數群組清單。
+ **DBSecurityGroups** – 一個 [DBSecurityGroupMembership](api-datatypes.md#DBSecurityGroupMembership) 物件陣列。
提供資料庫安全群組元素的清單，元素中只包含 `DBSecurityGroup.Name` 和 `DBSecurityGroup.Status` 子元素。
+ **DBSubnetGroup** – [DBSubnetGroup](api-subnets.md#DBSubnetGroup) 物件。
指定與資料庫執行個體相關聯子網路群組上的資訊，包含名稱、描述，以及子網路群組中的子網路。
+ **DeletionProtection** – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
指出資料庫執行個體是否已啟用刪除保護。如果刪除保護已經啟用，執行個體將無法刪除。請參閱[刪除資料庫執行個體](https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-instances-delete.html)。
+ **DomainMemberships** – 一個 [DomainMembership](api-datatypes.md#DomainMembership) 物件陣列。
不支援
+ **EnabledCloudwatchLogsExports** – 字串，類型為：`string` (UTF-8 編碼的字串)。
此資料庫執行個體已設為匯出至 CloudWatch Logs 的日誌類型清單。
+ **Endpoint** – [端點](api-datatypes.md#Endpoint) 物件。
指定連線端點。
+ **Engine** – 字串，類型為：`string` (UTF-8 編碼的字串)。
提供用於此資料庫執行個體的資料庫引擎名稱。
+ **EngineVersion** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指示資料庫引擎版本。
+ **EnhancedMonitoringResourceArn** – 字串，類型為：`string` (UTF-8 編碼的字串)。
Amazon CloudWatch Logs 日誌串流的 Amazon Resource Name (ARN)，該串流會接收資料庫執行個體的增強型監控指標。
+ **IAMDatabaseAuthenticationEnabled** – 布林值，類型為：`boolean` (布林值 (true 或 false))。
若 Amazon Identity and Access Management (IAM) 身分驗證已啟用，則為 True，否則為 False。
+ **InstanceCreateTime** – TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
提供建立資料庫執行個體的日期和時間。
+ **Iops** – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
指定佈建 IOPS (每秒 I/O 操作) 值。
+ **KmsKeyId** – 字串，類型為：`string` (UTF-8 編碼的字串)。
不支援：資料庫執行個體的加密會由資料庫叢集管理。
+ **LatestRestorableTime** – TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
指定可透過 point-in-time 還原還原資料庫的最新時間。
+ **LicenseModel** – 字串，類型為：`string` (UTF-8 編碼的字串)。
此資料庫執行個體的授權模型資訊。
+ **MonitoringInterval** – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
為資料庫執行個體收集增強型監控指標點之間的間隔 (秒)。
+ **MonitoringRoleArn** – 字串，類型為：`string` (UTF-8 編碼的字串)。
IAM 角色的 ARN，允許 Neptune 將增強型監控指標傳送到 Amazon CloudWatch Logs。
+ **MultiAZ** – 布林值，類型為：`boolean` (布林值 (true 或 false))。
指定資料庫執行個體是否為異地同步備份部署。
+ **PendingModifiedValues** – [PendingModifiedValues](#PendingModifiedValues) 物件。
指定對資料庫執行個體所進行的變更仍在擱置中。此元素只有在變更擱置中時才會包含在其中。特定的變更會由子元素識別。
+ **PreferredBackupWindow** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定每日的時間範圍，若有啟用自動化備份 (由 `BackupRetentionPeriod` 決定)，則自動化備份會在此期間建立。
+ **PreferredMaintenanceWindow** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定每週可能進行系統維護的時段，以世界協調時間 (UTC) 表示。
+ **PromotionTier** – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
此值指定在現有主要執行個體故障後，僅供讀取複本提升為主要執行個體的順序。
+ **PubliclyAccessible** – 布林值，類型為：`boolean` (布林值 (true 或 false))。
此標記不應繼續使用。
+ **ReadReplicaDBClusterIdentifiers** – 字串，類型為：`string` (UTF-8 編碼的字串)。
包含一或多個資料庫叢集的識別符，這些叢集是此資料庫執行個體的僅供讀取複本。
+ **ReadReplicaDBInstanceIdentifiers** – 字串，類型為：`string` (UTF-8 編碼的字串)。
包含一或多個與此資料庫執行個體相關聯僅供讀取複本的識別符。
+ **ReadReplicaSourceDBInstanceIdentifier** – 字串，類型為：`string` (UTF-8 編碼的字串)。
包含來源資料庫執行個體的識別符 (若此資料庫執行個體是僅供讀取複本)。
+ **SecondaryAvailabilityZone** – 字串，類型為：`string` (UTF-8 編碼的字串)。
若存在，指定具備多個可用區支援之資料庫執行個體的次要可用區名稱。
+ **StatusInfos** – 一個 [DBInstanceStatusInfo](#DBInstanceStatusInfo) 物件陣列。
僅供讀取複本的狀態。若執行個體並非僅供讀取複本，此處即為空白。
+ **StorageEncrypted** – 布林值，類型為：`boolean` (布林值 (true 或 false))。
不支援：資料庫執行個體的加密會由資料庫叢集管理。
+ **StorageType** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定與此資料庫執行個體相關聯的儲存類型。
+ **TdeCredentialArn** – 字串，類型為：`string` (UTF-8 編碼的字串)。
來自金鑰存放區的 ARN，執行個體會與此 ARN 建立關聯以進行 TDE 加密。
+ **Timezone** – 字串，類型為：`string` (UTF-8 編碼的字串)。
不支援。
+ **VpcSecurityGroups** – 一個 [VpcSecurityGroupMembership](api-datatypes.md#VpcSecurityGroupMembership) 物件陣列。
提供資料庫執行個體所屬 VPC 安全群組元素的清單。
**錯誤**
+ [DBInstanceNotFoundFault](api-faults.md#DBInstanceNotFoundFault)
+ [InvalidDBInstanceStateFault](api-faults.md#InvalidDBInstanceStateFault)
+ [DBSnapshotAlreadyExistsFault](api-faults.md#DBSnapshotAlreadyExistsFault)
+ [SnapshotQuotaExceededFault](api-faults.md#SnapshotQuotaExceededFault)
+ [InvalidDBClusterStateFault](api-faults.md#InvalidDBClusterStateFault)
## ModifyDBInstance (動作)
此 API 的 AWS CLI 名稱為：`modify-db-instance`。
修改資料庫執行個體的設定。您可以透過在請求中指定這些參數及新的值，來變更一或多個資料庫組態參數。若要了解您可以對資料庫執行個體進行的修改，請在呼叫 [ModifyDBInstance (動作)](#ModifyDBInstance) 前呼叫 [DescribeValidDBInstanceModifications (動作)](#DescribeValidDBInstanceModifications)。
**請求**
+ **AllowMajorVersionUpgrade** (在 CLI 中:`--allow-major-version-upgrade`) – 布林值，類型為：`boolean` (布林值 (true 或 false))。
指示是否允許主要版本升級。變更此參數不會導致中斷，且變更會以非同步方式盡快套用。
+ **ApplyImmediately** (在 CLI 中:`--apply-immediately`) – 布林值，類型為：`boolean` (布林值 (true 或 false))。
指定此請求中的修改及任何擱置中的修改是否要以非同步方式盡快套用，無論資料庫執行個體的 `PreferredMaintenanceWindow` 設定為何。
若將此參數設為 `false`，則對資料庫執行個體的變更會在下一個維護時段期間套用。某些參數變更會造成中斷，且會在下一次呼叫 [RebootDBInstance (動作)](#RebootDBInstance)，或是下一次故障重新開機時套用。
預設：`false`
+ **AutoMinorVersionUpgrade** (在 CLI 中:`--auto-minor-version-upgrade`) – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
指出會在維護時段期間將次要版本升級自動套用至資料庫執行個體。除以下狀況外，變更此參數不會導致中斷，且變更會以非同步方式盡快套用。若在維護時段期間將此參數設為 `true`，且有可用的新次要版本，並且 Neptune 已為該引擎版本啟用自動修補時，便會導致中斷。
+ **BackupRetentionPeriod** (在 CLI 中：`--backup-retention-period`) – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
不適用。自動化備份的保留期會由資料庫叢集管理。如需詳細資訊，請參閱[ModifyDBCluster (動作)](api-clusters.md#ModifyDBCluster)。
預設值：使用現有設定
+ **CACertificateIdentifier** (在 CLI 中：`--ca-certificate-identifier`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
指出需要與執行個體建立關聯的憑證。
+ **CloudwatchLogsExportConfiguration** (在 CLI 中：`--cloudwatch-logs-export-configuration`) – [CloudwatchLogsExportConfiguration](api-clusters.md#CloudwatchLogsExportConfiguration) 物件。
要啟用的日誌類型的組態設定，適用於匯出到特定資料庫執行個體或資料庫叢集的 CloudWatch Logs。
+ **CopyTagsToSnapshot** (在 CLI 中:`--copy-tags-to-snapshot`) – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
若為 True，則會從資料庫執行個體將所有標籤複製到資料庫執行個體的快照，否則為 False。預設值為 false。
+ **DBInstanceClass** (在 CLI 中：`--db-instance-class`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
新的資料庫執行個體運算與記憶體容量，例如 `db.m4.large`。並非所有 Amazon 區域皆提供所有資料庫執行個體類別。
若您修改資料庫執行個體類別，則會在變更時發生中斷。變更會在下一個維護時段期間套用，除非針對此請求將 `ApplyImmediately` 指定為 `true`。
預設值：使用現有設定
+ **DBInstanceIdentifier** (在 CLI 中：`--db-instance-identifier`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫執行個體識別符。此值會以小寫字母字串的形式儲存。
約束:
+ 必須符合現有 DBInstance 的識別符。
+ **DBParameterGroupName** (在 CLI 中：`--db-parameter-group-name`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
要套用到資料庫執行個體的資料庫參數群組名稱。變更此設定不會導致中斷。參數群組名稱本身會立即變更，但在您重新啓動實例而不需容錯移轉的情況下，才會套用實際參數變更。資料庫執行個體「不會」自動重新開機，且參數變更也「不會」在下一個維護時段期間套用。
預設值：使用現有設定
限制條件：資料庫參數群組必須位於和此資料庫執行個體相同的資料庫參數群組系列中。
+ **DBPortNumber** (在 CLI 中：`--db-port-number`) – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
資料庫接受連線的連接埠號碼。
`DBPortNumber` 參數的值不得和任何在資料庫執行個體選項群組中為選項指定的連接埠值相符。
當您變更 `DBPortNumber` 的值時，您的資料庫會重新啟動，無論 `ApplyImmediately` 參數的值為何。
預設：`8182`
+ **DBSecurityGroups** (在 CLI 中：`--db-security-groups`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
要在此資料庫執行個體上授權的資料庫安全群組清單。變更此設定不會導致中斷，且變更會以非同步方式盡快套用。
約束:
+ 若有提供，則必須符合現有的 DBSecurityGroups。
+ **DBSubnetGroupName** (在 CLI 中：`--db-subnet-group-name`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫執行個體的新資料庫子網路群組。您可以使用此參數將資料庫執行個體移動至不同的 VPC。
變更子網路群組會在變更期間造成中斷。變更會在下一個維護時段期間套用，除非您針對 `ApplyImmediately` 參數指定 `true`。
限制條件：若有提供，則必須符合現有 DBSubnetGroup 的名稱。
範例：`mySubnetGroup`
+ **DeletionProtection** (在 CLI 中:`--deletion-protection`) – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
指示資料庫執行個體是否啟用刪除保護的值。啟用刪除保護時無法刪除資料庫。根據預設，刪除保護是停用的。請參閱[刪除資料庫執行個體](https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-instances-delete.html)。
+ **Domain** (在 CLI 中：`--domain`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
不支援。
+ **DomainIAMRoleName** (在 CLI 中：`--domain-iam-role-name`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
不支援
+ **EnableIAMDatabaseAuthentication** (在 CLI 中:`--enable-iam-database-authentication`) – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
設為 True 以啟用 Amazon Identity and Access Management (IAM) 帳戶對資料庫帳戶的對應，否則為 false。
您可以為以下資料庫引擎啟用 IAM 資料庫身分驗證
不適用。將 Amazon IAM 帳戶對應至資料庫帳戶由資料庫叢集管理。如需詳細資訊，請參閱[ModifyDBCluster (動作)](api-clusters.md#ModifyDBCluster)。
預設：`false`
+ **EngineVersion** (在 CLI 中：`--engine-version`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
要升級到的目標資料庫引擎版本號碼。目前，設定此參數沒有任何作用。若要將資料庫引擎升級至最新版本，請使用 [ApplyPendingMaintenanceAction (動作)](api-other-apis.md#ApplyPendingMaintenanceAction) API。
+ **Iops** (在 CLI 中：`--iops`) – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
執行個體的新佈建 IOPS (每秒 I/O 操作數) 值。
變更此設定不會導致中斷，且變更會在下一個維護時段期間套用，除非針對此請求將 `ApplyImmediately` 參數設為 `true`。
預設值：使用現有設定
+ **MonitoringInterval** (在 CLI 中：`--monitoring-interval`) – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
為資料庫執行個體收集增強型監控指標點之間的間隔 (秒)。若要停用收集增強型監控指標，請指定 0。預設值為 0。
若指定 `MonitoringRoleArn`，您必須也將 `MonitoringInterval` 設為 0 之外的值。
有效值:`0, 1, 5, 10, 15, 30, 60`
+ **MonitoringRoleArn** (在 CLI 中：`--monitoring-role-arn`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
IAM 角色的 ARN，允許 Neptune 將增強型監控指標傳送到 Amazon CloudWatch Logs。例如 `arn:aws:iam:123456789012:role/emaccess`。
若 `MonitoringInterval` 設為 0 之外的值，則您必須提供 `MonitoringRoleArn` 值。
+ **MultiAZ** (在 CLI 中:`--multi-az`) – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
指定資料庫執行個體是否為異地同步備份部署。變更此參數不會導致中斷，且變更會在下一個維護時段期間套用，除非針對此請求將 `ApplyImmediately` 參數設為 `true`。
+ **NewDBInstanceIdentifier** (在 CLI 中：`--new-db-instance-identifier`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
重新命名資料庫執行個體時，資料庫執行個體的新資料庫執行個體識別符。當您變更資料庫執行個體識別符時，若您將 `Apply Immediately` 設為 True，則執行個體會立即重新開機。若您將 `Apply Immediately` 設為 False，則會在下一個維護時段期間重新開機。此值會以小寫字母字串的形式儲存。
約束:
+ 必須包含 1 到 63 個字母、數字或連字號。
+ 第一個字元必須是字母。
+ 不能以連字號結尾或連續包含兩個連字號。
範例：`mydbinstance`
+ **PreferredBackupWindow** (在 CLI 中：`--preferred-backup-window`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
若已啟用自動化備份，則為每日時間範圍，自動化備份會在此期間建立。
不適用。建立自動化備份的每日時間範圍會由資料庫叢集管理。如需詳細資訊，請參閱[ModifyDBCluster (動作)](api-clusters.md#ModifyDBCluster)。
約束:
+ 格式必須為 hh24:mi-hh24:mi
+ 必須以國際標準時間 (UTC) 表示
+ 不得和慣用的維護時段衝突
+ 必須至少 30 分鐘
+ **PreferredMaintenanceWindow** (在 CLI 中：`--preferred-maintenance-window`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
每週可能進行系統維護的時間範圍 (UTC)，在此期間可能會發生中斷。除以下狀況外，變更此參數不會導致中斷，且變更會以非同步方式盡快套用。若有任何擱置中會造成重新開機的動作，且維護時段已變更成包含目前的時間，則變更此參數便會使資料庫執行個體重新開機。若將此時段移動到目前時間，則在目前時間和時段結束的時間之間必須至少間隔 30 分鐘，以確保套用擱置中的變更。
預設值：使用現有設定
格式：ddd:hh24:mi-ddd:hh24:mi
有效日：星期一 \| 星期二 \| 星期三 \| 星期四 \| 星期五 \| 星期六 \| 星期日
限制條件：必須至少 30 分鐘
+ **PromotionTier** (在 CLI 中：`--promotion-tier`) – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
此值指定在現有主要執行個體故障後，僅供讀取複本提升為主要執行個體的順序。
預設：1
有效值：0 到 15
+ **PubliclyAccessible** (在 CLI 中:`--publicly-accessible`) – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
此標記不應繼續使用。
+ **StorageType** (在 CLI 中：`--storage-type`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
不適用。在 Neptune 中，儲存類型是在資料庫叢集層級進行管理。
+ **TdeCredentialArn** (在 CLI 中：`--tde-credential-arn`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
來自金鑰存放區的 ARN，執行個體會與此 ARN 建立關聯以進行 TDE 加密。
+ **TdeCredentialPassword** (在 CLI 中：`--tde-credential-password`) – SensitiveString，類型為：`string` (UTF-8 編碼的字串)。
在金鑰存放區指定 ARN 的密碼，用於存取裝置。
+ **VpcSecurityGroupIds** (在 CLI 中：`--vpc-security-group-ids`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
要在此資料庫執行個體上授權的 EC2 VPC 安全群組清單。此變更會以非同步的方式盡快套用。
不適用。資料庫叢集會管理 EC2 VPC 安全群組的關聯清單。如需詳細資訊，請參閱[ModifyDBCluster (動作)](api-clusters.md#ModifyDBCluster)。
約束:
+ 若有提供，則必須符合現有的 VpcSecurityGroupIds。
**回應**
包含 Amazon Neptune 資料庫執行個體的詳細資訊。
此資料類型在 [DescribeDBInstances (動作)](#DescribeDBInstances) 動作中會用來作為回應元素。
+ **AutoMinorVersionUpgrade** – 布林值，類型為：`boolean` (布林值 (true 或 false))。
指示會自動套用次要版本的修補程式。
+ **AvailabilityZone** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定資料庫執行個體所在的可用區域名稱。
+ **BackupRetentionPeriod** – 整數，類型為：`integer` (帶正負號的 32 位元整數)。
指定保留自動資料庫快照的天數。
+ **CACertificateIdentifier** – 字串，類型為：`string` (UTF-8 編碼的字串)。
此資料庫執行個體的憑證授權機構憑證識別碼。
+ **CopyTagsToSnapshot** – 布林值，類型為：`boolean` (布林值 (true 或 false))。
指定是否要從資料庫執行個體將標籤複製到資料庫執行個體的快照。
+ **DBClusterIdentifier** – 字串，類型為：`string` (UTF-8 編碼的字串)。
若資料庫執行個體是資料庫叢集的成員，則包含資料庫執行個體所屬資料庫叢集的名稱。
+ **DBInstanceArn** – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫執行個體的 Amazon Resource Name (ARN)。
+ **DBInstanceClass** – 字串，類型為：`string` (UTF-8 編碼的字串)。
包含資料庫執行個體之運算和記憶體容量類別的名稱。
+ **DBInstanceIdentifier** – 字串，類型為：`string` (UTF-8 編碼的字串)。
包含使用者提供的資料庫識別碼。此識別碼是可識別資料庫執行個體的唯一金鑰。
+ **DbInstancePort** – 整數，類型為：`integer` (帶正負號的 32 位元整數)。
指定資料庫執行個體接聽的連接埠。若資料庫執行個體是資料庫叢集的一部分，這可以是與資料庫叢集連接埠不同的連接埠。
+ **DBInstanceStatus** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定此資料庫的目前狀態。
+ **DbiResourceId** – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫執行個體的 Amazon 區域唯一、固定識別符。每當存取資料庫執行個體的 Amazon KMS 金鑰時，就會在 Amazon CloudTrail 日誌項目中找到此識別符。
+ **DBName** – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫名稱。
+ **DBParameterGroups** – 一個 [DBParameterGroupStatus](api-parameters.md#DBParameterGroupStatus) 物件陣列。
提供要套用到此資料庫執行個體的資料庫參數群組清單。
+ **DBSecurityGroups** – 一個 [DBSecurityGroupMembership](api-datatypes.md#DBSecurityGroupMembership) 物件陣列。
提供資料庫安全群組元素的清單，元素中只包含 `DBSecurityGroup.Name` 和 `DBSecurityGroup.Status` 子元素。
+ **DBSubnetGroup** – [DBSubnetGroup](api-subnets.md#DBSubnetGroup) 物件。
指定與資料庫執行個體相關聯子網路群組上的資訊，包含名稱、描述，以及子網路群組中的子網路。
+ **DeletionProtection** – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
指出資料庫執行個體是否已啟用刪除保護。如果刪除保護已經啟用，執行個體將無法刪除。請參閱[刪除資料庫執行個體](https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-instances-delete.html)。
+ **DomainMemberships** – 一個 [DomainMembership](api-datatypes.md#DomainMembership) 物件陣列。
不支援
+ **EnabledCloudwatchLogsExports** – 字串，類型為：`string` (UTF-8 編碼的字串)。
此資料庫執行個體已設為匯出至 CloudWatch Logs 的日誌類型清單。
+ **Endpoint** – [端點](api-datatypes.md#Endpoint) 物件。
指定連線端點。
+ **Engine** – 字串，類型為：`string` (UTF-8 編碼的字串)。
提供用於此資料庫執行個體的資料庫引擎名稱。
+ **EngineVersion** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指示資料庫引擎版本。
+ **EnhancedMonitoringResourceArn** – 字串，類型為：`string` (UTF-8 編碼的字串)。
Amazon CloudWatch Logs 日誌串流的 Amazon Resource Name (ARN)，該串流會接收資料庫執行個體的增強型監控指標。
+ **IAMDatabaseAuthenticationEnabled** – 布林值，類型為：`boolean` (布林值 (true 或 false))。
若 Amazon Identity and Access Management (IAM) 身分驗證已啟用，則為 True，否則為 False。
+ **InstanceCreateTime** – TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
提供建立資料庫執行個體的日期和時間。
+ **Iops** – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
指定佈建 IOPS (每秒 I/O 操作) 值。
+ **KmsKeyId** – 字串，類型為：`string` (UTF-8 編碼的字串)。
不支援：資料庫執行個體的加密會由資料庫叢集管理。
+ **LatestRestorableTime** – TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
指定可透過 point-in-time 還原還原資料庫的最新時間。
+ **LicenseModel** – 字串，類型為：`string` (UTF-8 編碼的字串)。
此資料庫執行個體的授權模型資訊。
+ **MonitoringInterval** – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
為資料庫執行個體收集增強型監控指標點之間的間隔 (秒)。
+ **MonitoringRoleArn** – 字串，類型為：`string` (UTF-8 編碼的字串)。
IAM 角色的 ARN，允許 Neptune 將增強型監控指標傳送到 Amazon CloudWatch Logs。
+ **MultiAZ** – 布林值，類型為：`boolean` (布林值 (true 或 false))。
指定資料庫執行個體是否為異地同步備份部署。
+ **PendingModifiedValues** – [PendingModifiedValues](#PendingModifiedValues) 物件。
指定對資料庫執行個體所進行的變更仍在擱置中。此元素只有在變更擱置中時才會包含在其中。特定的變更會由子元素識別。
+ **PreferredBackupWindow** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定每日的時間範圍，若有啟用自動化備份 (由 `BackupRetentionPeriod` 決定)，則自動化備份會在此期間建立。
+ **PreferredMaintenanceWindow** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定每週可能進行系統維護的時段，以世界協調時間 (UTC) 表示。
+ **PromotionTier** – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
此值指定在現有主要執行個體故障後，僅供讀取複本提升為主要執行個體的順序。
+ **PubliclyAccessible** – 布林值，類型為：`boolean` (布林值 (true 或 false))。
此標記不應繼續使用。
+ **ReadReplicaDBClusterIdentifiers** – 字串，類型為：`string` (UTF-8 編碼的字串)。
包含一或多個資料庫叢集的識別符，這些叢集是此資料庫執行個體的僅供讀取複本。
+ **ReadReplicaDBInstanceIdentifiers** – 字串，類型為：`string` (UTF-8 編碼的字串)。
包含一或多個與此資料庫執行個體相關聯僅供讀取複本的識別符。
+ **ReadReplicaSourceDBInstanceIdentifier** – 字串，類型為：`string` (UTF-8 編碼的字串)。
包含來源資料庫執行個體的識別符 (若此資料庫執行個體是僅供讀取複本)。
+ **SecondaryAvailabilityZone** – 字串，類型為：`string` (UTF-8 編碼的字串)。
若存在，指定具備多個可用區支援之資料庫執行個體的次要可用區名稱。
+ **StatusInfos** – 一個 [DBInstanceStatusInfo](#DBInstanceStatusInfo) 物件陣列。
僅供讀取複本的狀態。若執行個體並非僅供讀取複本，此處即為空白。
+ **StorageEncrypted** – 布林值，類型為：`boolean` (布林值 (true 或 false))。
不支援：資料庫執行個體的加密會由資料庫叢集管理。
+ **StorageType** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定與此資料庫執行個體相關聯的儲存類型。
+ **TdeCredentialArn** – 字串，類型為：`string` (UTF-8 編碼的字串)。
來自金鑰存放區的 ARN，執行個體會與此 ARN 建立關聯以進行 TDE 加密。
+ **Timezone** – 字串，類型為：`string` (UTF-8 編碼的字串)。
不支援。
+ **VpcSecurityGroups** – 一個 [VpcSecurityGroupMembership](api-datatypes.md#VpcSecurityGroupMembership) 物件陣列。
提供資料庫執行個體所屬 VPC 安全群組元素的清單。
**錯誤**
+ [InvalidDBInstanceStateFault](api-faults.md#InvalidDBInstanceStateFault)
+ [InvalidDBSecurityGroupStateFault](api-faults.md#InvalidDBSecurityGroupStateFault)
+ [DBInstanceAlreadyExistsFault](api-faults.md#DBInstanceAlreadyExistsFault)
+ [DBInstanceNotFoundFault](api-faults.md#DBInstanceNotFoundFault)
+ [DBSecurityGroupNotFoundFault](api-faults.md#DBSecurityGroupNotFoundFault)
+ [DBParameterGroupNotFoundFault](api-faults.md#DBParameterGroupNotFoundFault)
+ [InsufficientDBInstanceCapacityFault](api-faults.md#InsufficientDBInstanceCapacityFault)
+ [StorageQuotaExceededFault](api-faults.md#StorageQuotaExceededFault)
+ [InvalidVPCNetworkStateFault](api-faults.md#InvalidVPCNetworkStateFault)
+ [ProvisionedIopsNotAvailableInAZFault](api-faults.md#ProvisionedIopsNotAvailableInAZFault)
+ [OptionGroupNotFoundFault](api-faults.md#OptionGroupNotFoundFault)
+ [DBUpgradeDependencyFailureFault](api-faults.md#DBUpgradeDependencyFailureFault)
+ [StorageTypeNotSupportedFault](api-faults.md#StorageTypeNotSupportedFault)
+ [AuthorizationNotFoundFault](api-faults.md#AuthorizationNotFoundFault)
+ [CertificateNotFoundFault](api-faults.md#CertificateNotFoundFault)
+ [DomainNotFoundFault](api-faults.md#DomainNotFoundFault)
## RebootDBInstance (動作)
此 API 的 AWS CLI 名稱為：`reboot-db-instance`。
您可能需要重新啟動資料庫執行個體，這通常是為了維護的原因。例如，如果您進行某些修改，或變更與資料庫執行個體相關聯的資料庫參數群組，則必須重新啓動執行個體，變更才會生效。
重新啟動資料庫執行個體，將重新啟動資料庫引擎服務。重新啟動資料庫執行個體會暫時中斷，在此期間，資料庫執行個體狀態設定為 rebooting (重新啟動中)。
**請求**
+ **DBInstanceIdentifier** (在 CLI 中：`--db-instance-identifier`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫執行個體識別符。此參數是以小寫字母字串的形式儲存。
約束:
+ 必須符合現有 DBInstance 的識別符。
+ **ForceFailover** (在 CLI 中:`--force-failover`) – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
若為 `true`，則會透過多個可用區容錯移轉進行重新開機。
限制條件：若執行個體並未針對多個可用區進行設定，您便無法指定 `true`。
**回應**
包含 Amazon Neptune 資料庫執行個體的詳細資訊。
此資料類型在 [DescribeDBInstances (動作)](#DescribeDBInstances) 動作中會用來作為回應元素。
+ **AutoMinorVersionUpgrade** – 布林值，類型為：`boolean` (布林值 (true 或 false))。
指示會自動套用次要版本的修補程式。
+ **AvailabilityZone** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定資料庫執行個體所在的可用區域名稱。
+ **BackupRetentionPeriod** – 整數，類型為：`integer` (帶正負號的 32 位元整數)。
指定保留自動資料庫快照的天數。
+ **CACertificateIdentifier** – 字串，類型為：`string` (UTF-8 編碼的字串)。
此資料庫執行個體的憑證授權機構憑證識別碼。
+ **CopyTagsToSnapshot** – 布林值，類型為：`boolean` (布林值 (true 或 false))。
指定是否要從資料庫執行個體將標籤複製到資料庫執行個體的快照。
+ **DBClusterIdentifier** – 字串，類型為：`string` (UTF-8 編碼的字串)。
若資料庫執行個體是資料庫叢集的成員，則包含資料庫執行個體所屬資料庫叢集的名稱。
+ **DBInstanceArn** – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫執行個體的 Amazon Resource Name (ARN)。
+ **DBInstanceClass** – 字串，類型為：`string` (UTF-8 編碼的字串)。
包含資料庫執行個體之運算和記憶體容量類別的名稱。
+ **DBInstanceIdentifier** – 字串，類型為：`string` (UTF-8 編碼的字串)。
包含使用者提供的資料庫識別碼。此識別碼是可識別資料庫執行個體的唯一金鑰。
+ **DbInstancePort** – 整數，類型為：`integer` (帶正負號的 32 位元整數)。
指定資料庫執行個體接聽的連接埠。若資料庫執行個體是資料庫叢集的一部分，這可以是與資料庫叢集連接埠不同的連接埠。
+ **DBInstanceStatus** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定此資料庫的目前狀態。
+ **DbiResourceId** – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫執行個體的 Amazon 區域唯一、固定識別符。每當存取資料庫執行個體的 Amazon KMS 金鑰時，就會在 Amazon CloudTrail 日誌項目中找到此識別符。
+ **DBName** – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫名稱。
+ **DBParameterGroups** – 一個 [DBParameterGroupStatus](api-parameters.md#DBParameterGroupStatus) 物件陣列。
提供要套用到此資料庫執行個體的資料庫參數群組清單。
+ **DBSecurityGroups** – 一個 [DBSecurityGroupMembership](api-datatypes.md#DBSecurityGroupMembership) 物件陣列。
提供資料庫安全群組元素的清單，元素中只包含 `DBSecurityGroup.Name` 和 `DBSecurityGroup.Status` 子元素。
+ **DBSubnetGroup** – [DBSubnetGroup](api-subnets.md#DBSubnetGroup) 物件。
指定與資料庫執行個體相關聯子網路群組上的資訊，包含名稱、描述，以及子網路群組中的子網路。
+ **DeletionProtection** – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
指出資料庫執行個體是否已啟用刪除保護。如果刪除保護已經啟用，執行個體將無法刪除。請參閱[刪除資料庫執行個體](https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-instances-delete.html)。
+ **DomainMemberships** – 一個 [DomainMembership](api-datatypes.md#DomainMembership) 物件陣列。
不支援
+ **EnabledCloudwatchLogsExports** – 字串，類型為：`string` (UTF-8 編碼的字串)。
此資料庫執行個體已設為匯出至 CloudWatch Logs 的日誌類型清單。
+ **Endpoint** – [端點](api-datatypes.md#Endpoint) 物件。
指定連線端點。
+ **Engine** – 字串，類型為：`string` (UTF-8 編碼的字串)。
提供用於此資料庫執行個體的資料庫引擎名稱。
+ **EngineVersion** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指示資料庫引擎版本。
+ **EnhancedMonitoringResourceArn** – 字串，類型為：`string` (UTF-8 編碼的字串)。
Amazon CloudWatch Logs 日誌串流的 Amazon Resource Name (ARN)，該串流會接收資料庫執行個體的增強型監控指標。
+ **IAMDatabaseAuthenticationEnabled** – 布林值，類型為：`boolean` (布林值 (true 或 false))。
若 Amazon Identity and Access Management (IAM) 身分驗證已啟用，則為 True，否則為 False。
+ **InstanceCreateTime** – TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
提供建立資料庫執行個體的日期和時間。
+ **Iops** – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
指定佈建 IOPS (每秒 I/O 操作) 值。
+ **KmsKeyId** – 字串，類型為：`string` (UTF-8 編碼的字串)。
不支援：資料庫執行個體的加密會由資料庫叢集管理。
+ **LatestRestorableTime** – TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
指定可透過 point-in-time 還原還原資料庫的最新時間。
+ **LicenseModel** – 字串，類型為：`string` (UTF-8 編碼的字串)。
此資料庫執行個體的授權模型資訊。
+ **MonitoringInterval** – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
為資料庫執行個體收集增強型監控指標點之間的間隔 (秒)。
+ **MonitoringRoleArn** – 字串，類型為：`string` (UTF-8 編碼的字串)。
IAM 角色的 ARN，允許 Neptune 將增強型監控指標傳送到 Amazon CloudWatch Logs。
+ **MultiAZ** – 布林值，類型為：`boolean` (布林值 (true 或 false))。
指定資料庫執行個體是否為異地同步備份部署。
+ **PendingModifiedValues** – [PendingModifiedValues](#PendingModifiedValues) 物件。
指定對資料庫執行個體所進行的變更仍在擱置中。此元素只有在變更擱置中時才會包含在其中。特定的變更會由子元素識別。
+ **PreferredBackupWindow** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定每日的時間範圍，若有啟用自動化備份 (由 `BackupRetentionPeriod` 決定)，則自動化備份會在此期間建立。
+ **PreferredMaintenanceWindow** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定每週可能進行系統維護的時段，以世界協調時間 (UTC) 表示。
+ **PromotionTier** – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
此值指定在現有主要執行個體故障後，僅供讀取複本提升為主要執行個體的順序。
+ **PubliclyAccessible** – 布林值，類型為：`boolean` (布林值 (true 或 false))。
此標記不應繼續使用。
+ **ReadReplicaDBClusterIdentifiers** – 字串，類型為：`string` (UTF-8 編碼的字串)。
包含一或多個資料庫叢集的識別符，這些叢集是此資料庫執行個體的僅供讀取複本。
+ **ReadReplicaDBInstanceIdentifiers** – 字串，類型為：`string` (UTF-8 編碼的字串)。
包含一或多個與此資料庫執行個體相關聯僅供讀取複本的識別符。
+ **ReadReplicaSourceDBInstanceIdentifier** – 字串，類型為：`string` (UTF-8 編碼的字串)。
包含來源資料庫執行個體的識別符 (若此資料庫執行個體是僅供讀取複本)。
+ **SecondaryAvailabilityZone** – 字串，類型為：`string` (UTF-8 編碼的字串)。
若存在，指定具備多個可用區支援之資料庫執行個體的次要可用區名稱。
+ **StatusInfos** – 一個 [DBInstanceStatusInfo](#DBInstanceStatusInfo) 物件陣列。
僅供讀取複本的狀態。若執行個體並非僅供讀取複本，此處即為空白。
+ **StorageEncrypted** – 布林值，類型為：`boolean` (布林值 (true 或 false))。
不支援：資料庫執行個體的加密會由資料庫叢集管理。
+ **StorageType** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定與此資料庫執行個體相關聯的儲存類型。
+ **TdeCredentialArn** – 字串，類型為：`string` (UTF-8 編碼的字串)。
來自金鑰存放區的 ARN，執行個體會與此 ARN 建立關聯以進行 TDE 加密。
+ **Timezone** – 字串，類型為：`string` (UTF-8 編碼的字串)。
不支援。
+ **VpcSecurityGroups** – 一個 [VpcSecurityGroupMembership](api-datatypes.md#VpcSecurityGroupMembership) 物件陣列。
提供資料庫執行個體所屬 VPC 安全群組元素的清單。
**錯誤**
+ [InvalidDBInstanceStateFault](api-faults.md#InvalidDBInstanceStateFault)
+ [DBInstanceNotFoundFault](api-faults.md#DBInstanceNotFoundFault)
## DescribeDBInstances (動作)
此 API 的 AWS CLI 名稱為：`describe-db-instances`。
傳回所佈建之執行個體的相關資訊，並支援分頁。
**注意**
此操作也可以傳回 Amazon RDS 執行個體和 Amazon DocDB 執行個體的資訊。
**請求**
+ **DBInstanceIdentifier** (在 CLI 中：`--db-instance-identifier`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
使用者提供的執行個體識別符。若指定此參數，則只會傳回特定資料庫執行個體的資訊。此參數沒有大小寫之分。
約束:
+ 若有提供，則必須符合現有 DBInstance 的識別符。
+ **Filters** (在 CLI 中：`--filters`) – [篩選條件](api-datatypes.md#Filter) 物件的陣列。
篩選條件，指定要描述的一或多個資料庫執行個體。
支援的篩選條件：
+ `db-cluster-id` - 接受資料庫叢集識別符及資料庫叢集 Amazon Resource Name (ARN)。結果清單只會包含與透過這些 ARN 識別資料庫叢集相關聯的資料庫執行個體資訊。
+ `engine` -接受引擎名稱 (例如 `neptune`)，並將結果清單限制為由該引擎建立的資料庫執行個體。
例如，若要從 Amazon CLI 調用此 API 並進行篩選，以便只傳回 Neptune 資料庫執行個體，您可以使用下列命令：
**Example**
```
aws neptune describe-db-instances \
--filters Name=engine,Values=neptune
```
+ **Marker** (在 CLI 中：`--marker`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
前一個 `DescribeDBInstances` 請求提供的選用分頁字符。若指定此參數，則回應只會包含超過標記的記錄，直到 `MaxRecords` 指定的值為止。
+ **MaxRecords** (在 CLI 中：`--max-records`) – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
要在回應中包含的記錄數量上限。若存在的記錄比 `MaxRecords` 值指定的更多，則稱為「標記」的分頁字符會包含在回應中，讓您可以擷取剩餘的結果。
預設：100
限制條件：最小 20，最大 100。
**回應**
+ **DBInstances** – 一個 [DBInstance](#DBInstance) 物件陣列。
[DBInstance (結構)](#DBInstance) 執行個體的清單。
+ **Marker** – 字串，類型為：`string` (UTF-8 編碼的字串)。
前一個請求提供的選用分頁字符。若指定此參數，則回應只會包含超過標記的記錄，直到 `MaxRecords` 指定的值為止。
**錯誤**
+ [DBInstanceNotFoundFault](api-faults.md#DBInstanceNotFoundFault)
## DescribeOrderableDBInstanceOptions (動作)
此 API 的 AWS CLI 名稱為：`describe-orderable-db-instance-options`。
傳回指定引擎的可排序資料庫執行個體選項清單。
**請求**
+ **DBInstanceClass** (在 CLI 中：`--db-instance-class`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫執行個體類別篩選條件值。指定此參數，以僅顯示與指定資料庫執行個體類別相符的可用供應項目。
+ **Engine** (在 CLI 中：`--engine`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
要為其擷取資料庫執行個體選項的引擎名稱。
+ **EngineVersion** (在 CLI 中：`--engine-version`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
引擎版本篩選條件值。指定此參數，以僅顯示與指定引擎版本相符的可用供應項目。
+ **Filters** (在 CLI 中：`--filters`) – [篩選條件](api-datatypes.md#Filter) 物件的陣列。
目前不支援此參數。
+ **LicenseModel** (在 CLI 中：`--license-model`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
授權模型篩選條件值。指定此參數，以僅顯示與指定授權模型相符的可用供應項目。
+ **Marker** (在 CLI 中：`--marker`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
前一個 DescribeOrderableDBInstanceOptions 請求提供的選用分頁字符。若指定此參數，則回應只會包含超過標記的記錄，直到 `MaxRecords` 指定的值為止。
+ **MaxRecords** (在 CLI 中：`--max-records`) – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
要在回應中包含的記錄數量上限。若存在的記錄比 `MaxRecords` 值指定的更多，則稱為「標記」的分頁字符會包含在回應中，讓您可以擷取剩餘的結果。
預設：100
限制條件：最小 20，最大 100。
+ **Vpc** (在 CLI 中:`--vpc`) – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
VPC 篩選條件值。指定此參數，以僅顯示可用的 VPC 或非 VPC 供應項目。
**回應**
+ **Marker** – 字串，類型為：`string` (UTF-8 編碼的字串)。
前一個 OrderableDBInstanceOptions 請求提供的選用分頁字符。若指定此參數，則回應只會包含超過標記的記錄，直到 `MaxRecords` 指定的值為止。
+ **OrderableDBInstanceOptions** – 一個 [OrderableDBInstanceOption](#OrderableDBInstanceOption) 物件陣列。
[OrderableDBInstanceOption (結構)](#OrderableDBInstanceOption) 結構，包含資料庫執行個體可排序選項的資訊。
## DescribeValidDBInstanceModifications (動作)
此 API 的 AWS CLI 名稱為：`describe-valid-db-instance-modifications`。
您可以呼叫 [DescribeValidDBInstanceModifications (動作)](#DescribeValidDBInstanceModifications) 來了解您可以對資料庫執行個體進行的修改。您可以在呼叫 [ModifyDBInstance (動作)](#ModifyDBInstance) 時使用此資訊。
**請求**
+ **DBInstanceIdentifier** (在 CLI 中：`--db-instance-identifier`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
客戶識別符或您資料庫執行個體的 ARN。
**回應**
您可以對資料庫執行個體進行的有效修改相關資訊。包含成功呼叫 [DescribeValidDBInstanceModifications (動作)](#DescribeValidDBInstanceModifications) 動作的結果。您可以在呼叫 [ModifyDBInstance (動作)](#ModifyDBInstance) 時使用此資訊。
+ **Storage** – 一個 [ValidStorageOptions](#ValidStorageOptions) 物件陣列。
您資料庫執行個體的有效儲存體選項。
**錯誤**
+ [DBInstanceNotFoundFault](api-faults.md#DBInstanceNotFoundFault)
+ [InvalidDBInstanceStateFault](api-faults.md#InvalidDBInstanceStateFault)
## *結構：*
## DBInstance (結構)
包含 Amazon Neptune 資料庫執行個體的詳細資訊。
此資料類型在 [DescribeDBInstances (動作)](#DescribeDBInstances) 動作中會用來作為回應元素。
**欄位**
+ **AutoMinorVersionUpgrade** - 這是布林值，類型為：`boolean` (布林值 (true 或 false))。
指示會自動套用次要版本的修補程式。
+ **AvailabilityZone** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
指定資料庫執行個體所在的可用區域名稱。
+ **BackupRetentionPeriod** - 這是整數，類型為：`integer` (帶正負號的 32 位元整數)。
指定保留自動資料庫快照的天數。
+ **CACertificateIdentifier** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
此資料庫執行個體的憑證授權機構憑證識別碼。
+ **CopyTagsToSnapshot** - 這是布林值，類型為：`boolean` (布林值 (true 或 false))。
指定是否要從資料庫執行個體將標籤複製到資料庫執行個體的快照。
+ **DBClusterIdentifier** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
若資料庫執行個體是資料庫叢集的成員，則包含資料庫執行個體所屬資料庫叢集的名稱。
+ **DBInstanceArn** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫執行個體的 Amazon Resource Name (ARN)。
+ **DBInstanceClass** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
包含資料庫執行個體之運算和記憶體容量類別的名稱。
+ **DBInstanceIdentifier** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
包含使用者提供的資料庫識別碼。此識別碼是可識別資料庫執行個體的唯一金鑰。
+ **DbInstancePort** - 這是整數，類型為：`integer` (帶正負號的 32 位元整數)。
指定資料庫執行個體接聽的連接埠。若資料庫執行個體是資料庫叢集的一部分，這可以是與資料庫叢集連接埠不同的連接埠。
+ **DBInstanceStatus** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
指定此資料庫的目前狀態。
+ **DbiResourceId** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫執行個體的 Amazon 區域唯一、固定識別符。每當存取資料庫執行個體的 Amazon KMS 金鑰時，就會在 Amazon CloudTrail 日誌項目中找到此識別符。
+ **DBName** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫名稱。
+ **DBParameterGroups** - 這是 [DBParameterGroupStatus](api-parameters.md#DBParameterGroupStatus) 物件的陣列。
提供要套用到此資料庫執行個體的資料庫參數群組清單。
+ **DBSecurityGroups** - 這是 [DBSecurityGroupMembership](api-datatypes.md#DBSecurityGroupMembership) 物件的陣列。
提供資料庫安全群組元素的清單，元素中只包含 `DBSecurityGroup.Name` 和 `DBSecurityGroup.Status` 子元素。
+ **DBSubnetGroup** - 這是一個 [DBSubnetGroup](api-subnets.md#DBSubnetGroup) 物件。
指定與資料庫執行個體相關聯子網路群組上的資訊，包含名稱、描述，以及子網路群組中的子網路。
+ **DeletionProtection** – 這是 BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
指出資料庫執行個體是否已啟用刪除保護。如果刪除保護已經啟用，執行個體將無法刪除。請參閱[刪除資料庫執行個體](https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-instances-delete.html)。
+ **DomainMemberships** - 這是 [DomainMembership](api-datatypes.md#DomainMembership) 物件的陣列。
不支援
+ **EnabledCloudwatchLogsExports** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
此資料庫執行個體已設為匯出至 CloudWatch Logs 的日誌類型清單。
+ **Endpoint** - 這是一個 [端點](api-datatypes.md#Endpoint) 物件。
指定連線端點。
+ **Engine** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
提供用於此資料庫執行個體的資料庫引擎名稱。
+ **EngineVersion** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
指示資料庫引擎版本。
+ **EnhancedMonitoringResourceArn** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
Amazon CloudWatch Logs 日誌串流的 Amazon Resource Name (ARN)，該串流會接收資料庫執行個體的增強型監控指標。
+ **IAMDatabaseAuthenticationEnabled** - 這是布林值，類型為：`boolean` (布林值 (true 或 false))。
若 Amazon Identity and Access Management (IAM) 身分驗證已啟用，則為 True，否則為 False。
+ **InstanceCreateTime** – 這是 TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
提供建立資料庫執行個體的日期和時間。
+ **Iops** – 這是 IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
指定佈建 IOPS (每秒 I/O 操作) 值。
+ **KmsKeyId** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
不支援：資料庫執行個體的加密會由資料庫叢集管理。
+ **LatestRestorableTime** – 這是 TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
指定可透過 point-in-time 還原還原資料庫的最新時間。
+ **LicenseModel** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
此資料庫執行個體的授權模型資訊。
+ **MonitoringInterval** – 這是 IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
為資料庫執行個體收集增強型監控指標點之間的間隔 (秒)。
+ **MonitoringRoleArn** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
IAM 角色的 ARN，允許 Neptune 將增強型監控指標傳送到 Amazon CloudWatch Logs。
+ **MultiAZ** - 這是布林值，類型為：`boolean` (布林值 (true 或 false))。
指定資料庫執行個體是否為異地同步備份部署。
+ **PendingModifiedValues** - 這是一個 [PendingModifiedValues](#PendingModifiedValues) 物件。
指定對資料庫執行個體所進行的變更仍在擱置中。此元素只有在變更擱置中時才會包含在其中。特定的變更會由子元素識別。
+ **PreferredBackupWindow** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
指定每日的時間範圍，若有啟用自動化備份 (由 `BackupRetentionPeriod` 決定)，則自動化備份會在此期間建立。
+ **PreferredMaintenanceWindow** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
指定每週可能進行系統維護的時段，以世界協調時間 (UTC) 表示。
+ **PromotionTier** – 這是 IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
此值指定在現有主要執行個體故障後，僅供讀取複本提升為主要執行個體的順序。
+ **PubliclyAccessible** - 這是布林值，類型為：`boolean` (布林值 (true 或 false))。
此標記不應繼續使用。
+ **ReadReplicaDBClusterIdentifiers** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
包含一或多個資料庫叢集的識別符，這些叢集是此資料庫執行個體的僅供讀取複本。
+ **ReadReplicaDBInstanceIdentifiers** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
包含一或多個與此資料庫執行個體相關聯僅供讀取複本的識別符。
+ **ReadReplicaSourceDBInstanceIdentifier** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
包含來源資料庫執行個體的識別符 (若此資料庫執行個體是僅供讀取複本)。
+ **SecondaryAvailabilityZone** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
若存在，指定具備多個可用區支援之資料庫執行個體的次要可用區名稱。
+ **StatusInfos** - 這是 [DBInstanceStatusInfo](#DBInstanceStatusInfo) 物件的陣列。
僅供讀取複本的狀態。若執行個體並非僅供讀取複本，此處即為空白。
+ **StorageEncrypted** - 這是布林值，類型為：`boolean` (布林值 (true 或 false))。
不支援：資料庫執行個體的加密會由資料庫叢集管理。
+ **StorageType** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
指定與此資料庫執行個體相關聯的儲存類型。
+ **TdeCredentialArn** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
來自金鑰存放區的 ARN，執行個體會與此 ARN 建立關聯以進行 TDE 加密。
+ **Timezone** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
不支援。
+ **VpcSecurityGroups** - 這是 [VpcSecurityGroupMembership](api-datatypes.md#VpcSecurityGroupMembership) 物件的陣列。
提供資料庫執行個體所屬 VPC 安全群組元素的清單。
`DBInstance` 會用來做為以下項目的回應元素：
+ [CreateDBInstance](#CreateDBInstance)
+ [DeleteDBInstance](#DeleteDBInstance)
+ [ModifyDBInstance](#ModifyDBInstance)
+ [RebootDBInstance](#RebootDBInstance)
## DBInstanceStatusInfo (結構)
提供資料庫執行個體的狀態資訊清單。
**欄位**
+ **Message** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
若執行個體發生錯誤，則為錯誤的詳細資訊。若執行個體並未處於錯誤狀態，則此值為空白。
+ **Normal** - 這是布林值，類型為：`boolean` (布林值 (true 或 false))。
布林值，若執行個體正常運作，則為 True，若執行個體處於錯誤狀態，則為 False。
+ **Status** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫執行個體的狀態。針對僅供讀取複本的 StatusType，其值可以是正在複寫、錯誤、已停止或已終止。
+ **StatusType** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
此值目前是「讀取複寫」。
## OrderableDBInstanceOption (結構)
包含資料庫執行個體的可用選項清單。
此資料類型在 [DescribeOrderableDBInstanceOptions (動作)](#DescribeOrderableDBInstanceOptions) 動作中會用來作為回應元素。
**欄位**
+ **AvailabilityZones** - 這是 [AvailabilityZone](api-datatypes.md#AvailabilityZone) 物件的陣列。
資料庫執行個體的可用區域清單。
+ **DBInstanceClass** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫執行個體的資料庫執行個體類別。
+ **Engine** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫執行個體的引擎類型。
+ **EngineVersion** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫執行個體的引擎版本。
+ **LicenseModel** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫執行個體的授權模型。
+ **MaxIopsPerDbInstance** – 這是 IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
資料庫執行個體的總佈建 IOPS 上限。
+ **MaxIopsPerGib** - 這是 DoubleOptional，類型為：`double` (雙精度 IEEE 754 浮點數)。
資料庫執行個體的每 GiB 佈建 IOPS 上限。
+ **MaxStorageSize** – 這是 IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
資料庫執行個體的儲存體大小上限。
+ **MinIopsPerDbInstance** – 這是 IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
資料庫執行個體的總佈建 IOPS 下限。
+ **MinIopsPerGib** - 這是 DoubleOptional，類型為：`double` (雙精度 IEEE 754 浮點數)。
資料庫執行個體的每 GiB 佈建 IOPS 下限。
+ **MinStorageSize** – 這是 IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
資料庫執行個體的儲存體大小下限。
+ **MultiAZCapable** - 這是布林值，類型為：`boolean` (布林值 (true 或 false))。
指出資料庫執行個體是否具備多個可用區功能。
+ **ReadReplicaCapable** - 這是布林值，類型為：`boolean` (布林值 (true 或 false))。
指出資料庫執行個體是否可以擁有僅供讀取複本。
+ **StorageType** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
不適用。在 Neptune 中，儲存類型是在資料庫叢集層級進行管理。
+ **SupportsEnhancedMonitoring** - 這是布林值，類型為：`boolean` (布林值 (true 或 false))。
指出資料庫執行個體是否支援增強型監控，其間隔介於 1 到 60 秒。
+ **SupportsGlobalDatabases** - 這是布林值，類型為：`boolean` (布林值 (true 或 false))。
一值，指示您是否可以使用 Neptune 全球資料庫，搭配其他資料庫引擎屬性的特定組合。
+ **SupportsIAMDatabaseAuthentication** - 這是布林值，類型為：`boolean` (布林值 (true 或 false))。
指出資料庫執行個體是否支援 IAM 資料庫身分驗證。
+ **SupportsIops** - 這是布林值，類型為：`boolean` (布林值 (true 或 false))。
指出資料庫執行個體是否支援佈建 IOPS。
+ **SupportsStorageEncryption** - 這是布林值，類型為：`boolean` (布林值 (true 或 false))。
指出資料庫執行個體是否支援加密儲存體。
+ **Vpc** - 這是布林值，類型為：`boolean` (布林值 (true 或 false))。
指出資料庫執行個體是否位於 VPC 中。
## PendingModifiedValues (結構)
此資料類型在 [ModifyDBInstance (動作)](#ModifyDBInstance) 動作中會用來作為回應元素。
**欄位**
+ **AllocatedStorage** – 這是 IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
包含要套用或目前正在套用之資料庫執行個體的新 `AllocatedStorage` 大小。
+ **BackupRetentionPeriod** – 這是 IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
指定保留自動化備份的待處理天數。
+ **CACertificateIdentifier** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
指定資料庫執行個體 CA 憑證的識別符。
+ **DBInstanceClass** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
包含要套用或目前正在套用之資料庫執行個體的新 `DBInstanceClass`。
+ **DBInstanceIdentifier** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
包含要套用或目前正在套用之資料庫執行個體的新 `DBInstanceIdentifier`。
+ **DBSubnetGroupName** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫執行個體的新資料庫子網路群組。
+ **EngineVersion** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
指示資料庫引擎版本。
+ **Iops** – 這是 IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
指定要套用或目前正在套用之資料庫執行個體的新佈建 IOPS 值。
+ **MultiAZ** – 這是 BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
指出單一可用區資料庫執行個體要變更為異地同步備份部署。
+ **PendingCloudwatchLogsExports** - 這是一個 [PendingCloudwatchLogsExports](api-clusters.md#PendingCloudwatchLogsExports) 物件。
此 `PendingCloudwatchLogsExports` 結構會指定 CloudWatch Logs 啟用和停用的待定變更。
+ **Port** – 這是 IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
指定資料庫執行個體的待處理連接埠。
+ **StorageType** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
不適用。在 Neptune 中，儲存類型是在資料庫叢集層級進行管理。
## ValidStorageOptions (結構)
不適用。在 Neptune 中，儲存類型是在資料庫叢集層級進行管理。
**欄位**
+ **IopsToStorageRatio** - 這是 [DoubleRange](api-datatypes.md#DoubleRange) 物件的陣列。
不適用。在 Neptune 中，儲存類型是在資料庫叢集層級進行管理。
+ **ProvisionedIops** - 這是 [範圍](api-datatypes.md#Range) 物件的陣列。
不適用。在 Neptune 中，儲存類型是在資料庫叢集層級進行管理。
+ **StorageSize** - 這是 [範圍](api-datatypes.md#Range) 物件的陣列。
不適用。在 Neptune 中，儲存類型是在資料庫叢集層級進行管理。
+ **StorageType** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
不適用。在 Neptune 中，儲存類型是在資料庫叢集層級進行管理。
## ValidDBInstanceModificationsMessage (結構)
您可以對資料庫執行個體進行的有效修改相關資訊。包含成功呼叫 [DescribeValidDBInstanceModifications (動作)](#DescribeValidDBInstanceModifications) 動作的結果。您可以在呼叫 [ModifyDBInstance (動作)](#ModifyDBInstance) 時使用此資訊。
**欄位**
+ **Storage** - 這是 [ValidStorageOptions](#ValidStorageOptions) 物件的陣列。
您資料庫執行個體的有效儲存體選項。
`ValidDBInstanceModificationsMessage` 會用來做為以下項目的回應元素：
+ [DescribeValidDBInstanceModifications](#DescribeValidDBInstanceModifications)