本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。
# Amazon Neptune 管理 API 參考
本章記載您可以用來管理和維護您 Neptune 資料庫叢集的 Neptune API 操作。
Neptune 會在複寫拓撲中連線的資料庫伺服器叢集上運作。因此，管理 Neptune 通常會涉及將變更部署到多部伺服器，並確保所有 Neptune 複本都和主伺服器保持同步。
由於 Neptune 會隨著您的資料增加而透明地擴展基礎儲存體，因此管理 Neptune 只需要進行相對較少的磁碟儲存體管理。同樣地，因為 Neptune 會自動執行連續備份，因此 Neptune 叢集不需要為執行備份進行大量的規劃或停機時間。
**Contents**
+ [Neptune 資料庫叢集 API](api-clusters.md)
+ [CreateDBCluster (動作)](api-clusters.md#CreateDBCluster)
+ [DeleteDBCluster (動作)](api-clusters.md#DeleteDBCluster)
+ [ModifyDBCluster (動作)](api-clusters.md#ModifyDBCluster)
+ [StartDBCluster (動作)](api-clusters.md#StartDBCluster)
+ [StopDBCluster (動作)](api-clusters.md#StopDBCluster)
+ [AddRoleToDBCluster (動作)](api-clusters.md#AddRoleToDBCluster)
+ [RemoveRoleFromDBCluster (動作)](api-clusters.md#RemoveRoleFromDBCluster)
+ [FailoverDBCluster (動作)](api-clusters.md#FailoverDBCluster)
+ [PromoteReadReplicaDBCluster (動作)](api-clusters.md#PromoteReadReplicaDBCluster)
+ [DescribeDBClusters (動作)](api-clusters.md#DescribeDBClusters)
+ [*結構：*](api-clusters.md#api-clusters-structures-spacer)
+ [DBCluster (結構)](api-clusters.md#DBCluster)
+ [DBClusterMember (結構)](api-clusters.md#DBClusterMember)
+ [DBClusterRole (結構)](api-clusters.md#DBClusterRole)
+ [CloudwatchLogsExportConfiguration (結構)](api-clusters.md#CloudwatchLogsExportConfiguration)
+ [PendingCloudwatchLogsExports (結構)](api-clusters.md#PendingCloudwatchLogsExports)
+ [ClusterPendingModifiedValues (結構)](api-clusters.md#ClusterPendingModifiedValues)
+ [Neptune 全球資料庫 API](api-global-dbs.md)
+ [CreateGlobalCluster (動作)](api-global-dbs.md#CreateGlobalCluster)
+ [DeleteGlobalCluster (動作)](api-global-dbs.md#DeleteGlobalCluster)
+ [ModifyGlobalCluster (動作)](api-global-dbs.md#ModifyGlobalCluster)
+ [DescribeGlobalClusters (動作)](api-global-dbs.md#DescribeGlobalClusters)
+ [FailoverGlobalCluster (動作)](api-global-dbs.md#FailoverGlobalCluster)
+ [RemoveFromGlobalCluster (動作)](api-global-dbs.md#RemoveFromGlobalCluster)
+ [*結構：*](api-global-dbs.md#api-global-dbs-structures-spacer)
+ [GlobalCluster (結構)](api-global-dbs.md#GlobalCluster)
+ [GlobalClusterMember (結構)](api-global-dbs.md#GlobalClusterMember)
+ [Neptune 執行個體 API](api-instances.md)
+ [CreateDBInstance (動作)](api-instances.md#CreateDBInstance)
+ [DeleteDBInstance (動作)](api-instances.md#DeleteDBInstance)
+ [ModifyDBInstance (動作)](api-instances.md#ModifyDBInstance)
+ [RebootDBInstance (動作)](api-instances.md#RebootDBInstance)
+ [DescribeDBInstances (動作)](api-instances.md#DescribeDBInstances)
+ [DescribeOrderableDBInstanceOptions (動作)](api-instances.md#DescribeOrderableDBInstanceOptions)
+ [DescribeValidDBInstanceModifications (動作)](api-instances.md#DescribeValidDBInstanceModifications)
+ [*結構：*](api-instances.md#api-instances-structures-spacer)
+ [DBInstance (結構)](api-instances.md#DBInstance)
+ [DBInstanceStatusInfo (結構)](api-instances.md#DBInstanceStatusInfo)
+ [OrderableDBInstanceOption (結構)](api-instances.md#OrderableDBInstanceOption)
+ [PendingModifiedValues (結構)](api-instances.md#PendingModifiedValues)
+ [ValidStorageOptions (結構)](api-instances.md#ValidStorageOptions)
+ [ValidDBInstanceModificationsMessage (結構)](api-instances.md#ValidDBInstanceModificationsMessage)
+ [Neptune 參數 API](api-parameters.md)
+ [CopyDBParameterGroup (動作)](api-parameters.md#CopyDBParameterGroup)
+ [CopyDBClusterParameterGroup (動作)](api-parameters.md#CopyDBClusterParameterGroup)
+ [CreateDBParameterGroup (動作)](api-parameters.md#CreateDBParameterGroup)
+ [CreateDBClusterParameterGroup (動作)](api-parameters.md#CreateDBClusterParameterGroup)
+ [DeleteDBParameterGroup (動作)](api-parameters.md#DeleteDBParameterGroup)
+ [DeleteDBClusterParameterGroup (動作)](api-parameters.md#DeleteDBClusterParameterGroup)
+ [ModifyDBParameterGroup (動作)](api-parameters.md#ModifyDBParameterGroup)
+ [ModifyDBClusterParameterGroup (動作)](api-parameters.md#ModifyDBClusterParameterGroup)
+ [ResetDBParameterGroup (動作)](api-parameters.md#ResetDBParameterGroup)
+ [ResetDBClusterParameterGroup (動作)](api-parameters.md#ResetDBClusterParameterGroup)
+ [DescribeDBParameters (動作)](api-parameters.md#DescribeDBParameters)
+ [DescribeDBParameterGroups (動作)](api-parameters.md#DescribeDBParameterGroups)
+ [DescribeDBClusterParameters (動作)](api-parameters.md#DescribeDBClusterParameters)
+ [DescribeDBClusterParameterGroups (動作)](api-parameters.md#DescribeDBClusterParameterGroups)
+ [DescribeEngineDefaultParameters (動作)](api-parameters.md#DescribeEngineDefaultParameters)
+ [DescribeEngineDefaultClusterParameters (動作)](api-parameters.md#DescribeEngineDefaultClusterParameters)
+ [*結構：*](api-parameters.md#api-parameters-structures-spacer)
+ [Parameter (結構)](api-parameters.md#Parameter)
+ [DBParameterGroup (結構)](api-parameters.md#DBParameterGroup)
+ [DBClusterParameterGroup (結構)](api-parameters.md#DBClusterParameterGroup)
+ [DBParameterGroupStatus (結構)](api-parameters.md#DBParameterGroupStatus)
+ [Neptune 子網路 API](api-subnets.md)
+ [CreateDBSubnetGroup (動作)](api-subnets.md#CreateDBSubnetGroup)
+ [DeleteDBSubnetGroup (動作)](api-subnets.md#DeleteDBSubnetGroup)
+ [ModifyDBSubnetGroup (動作)](api-subnets.md#ModifyDBSubnetGroup)
+ [DescribeDBSubnetGroups (動作)](api-subnets.md#DescribeDBSubnetGroups)
+ [*結構：*](api-subnets.md#api-subnets-structures-spacer)
+ [Subnet (結構)](api-subnets.md#Subnet)
+ [DBSubnetGroup (結構)](api-subnets.md#DBSubnetGroup)
+ [Neptune 快照 API](api-snapshots.md)
+ [CreateDBClusterSnapshot (動作)](api-snapshots.md#CreateDBClusterSnapshot)
+ [DeleteDBClusterSnapshot (動作)](api-snapshots.md#DeleteDBClusterSnapshot)
+ [CopyDBClusterSnapshot (動作)](api-snapshots.md#CopyDBClusterSnapshot)
+ [ModifyDBClusterSnapshotAttribute (動作)](api-snapshots.md#ModifyDBClusterSnapshotAttribute)
+ [RestoreDBClusterFromSnapshot (動作)](api-snapshots.md#RestoreDBClusterFromSnapshot)
+ [RestoreDBClusterToPointInTime (動作)](api-snapshots.md#RestoreDBClusterToPointInTime)
+ [DescribeDBClusterSnapshots (動作)](api-snapshots.md#DescribeDBClusterSnapshots)
+ [DescribeDBClusterSnapshotAttributes (動作)](api-snapshots.md#DescribeDBClusterSnapshotAttributes)
+ [*結構：*](api-snapshots.md#api-snapshots-structures-spacer)
+ [DBClusterSnapshot (結構)](api-snapshots.md#DBClusterSnapshot)
+ [DBClusterSnapshotAttribute (結構)](api-snapshots.md#DBClusterSnapshotAttribute)
+ [DBClusterSnapshotAttributesResult (結構)](api-snapshots.md#DBClusterSnapshotAttributesResult)
+ [Neptune 事件 API](api-events.md)
+ [CreateEventSubscription (動作)](api-events.md#CreateEventSubscription)
+ [DeleteEventSubscription (動作)](api-events.md#DeleteEventSubscription)
+ [ModifyEventSubscription (動作)](api-events.md#ModifyEventSubscription)
+ [DescribeEventSubscriptions (動作)](api-events.md#DescribeEventSubscriptions)
+ [AddSourceIdentifierToSubscription (動作)](api-events.md#AddSourceIdentifierToSubscription)
+ [RemoveSourceIdentifierFromSubscription (動作)](api-events.md#RemoveSourceIdentifierFromSubscription)
+ [DescribeEvents (動作)](api-events.md#DescribeEvents)
+ [DescribeEventCategories (動作)](api-events.md#DescribeEventCategories)
+ [*結構：*](api-events.md#api-events-structures-spacer)
+ [Event (結構)](api-events.md#Event)
+ [EventCategoriesMap (結構)](api-events.md#EventCategoriesMap)
+ [EventSubscription (結構)](api-events.md#EventSubscription)
+ [其他 Neptune API](api-other-apis.md)
+ [AddTagsToResource (動作)](api-other-apis.md#AddTagsToResource)
+ [ListTagsForResource (動作)](api-other-apis.md#ListTagsForResource)
+ [RemoveTagsFromResource (動作)](api-other-apis.md#RemoveTagsFromResource)
+ [ApplyPendingMaintenanceAction (動作)](api-other-apis.md#ApplyPendingMaintenanceAction)
+ [DescribePendingMaintenanceActions (動作)](api-other-apis.md#DescribePendingMaintenanceActions)
+ [DescribeDBEngineVersions (動作)](api-other-apis.md#DescribeDBEngineVersions)
+ [*結構：*](api-other-apis.md#api-other-apis-structures-spacer)
+ [DBEngineVersion (結構)](api-other-apis.md#DBEngineVersion)
+ [EngineDefaults (結構)](api-other-apis.md#EngineDefaults)
+ [PendingMaintenanceAction (結構)](api-other-apis.md#PendingMaintenanceAction)
+ [ResourcePendingMaintenanceActions (結構)](api-other-apis.md#ResourcePendingMaintenanceActions)
+ [UpgradeTarget (結構)](api-other-apis.md#UpgradeTarget)
+ [Tag (結構)](api-other-apis.md#Tag)
+ [常見的 Neptune 資料類型](api-datatypes.md)
+ [AvailabilityZone (結構)](api-datatypes.md#AvailabilityZone)
+ [DBSecurityGroupMembership (結構)](api-datatypes.md#DBSecurityGroupMembership)
+ [DomainMembership (結構)](api-datatypes.md#DomainMembership)
+ [DoubleRange (結構)](api-datatypes.md#DoubleRange)
+ [Endpoint (結構)](api-datatypes.md#Endpoint)
+ [Filter (結構)](api-datatypes.md#Filter)
+ [Range (結構)](api-datatypes.md#Range)
+ [ServerlessV2ScalingConfiguration (結構)](api-datatypes.md#ServerlessV2ScalingConfiguration)
+ [ServerlessV2ScalingConfigurationInfo (結構)](api-datatypes.md#ServerlessV2ScalingConfigurationInfo)
+ [Timezone (結構)](api-datatypes.md#Timezone)
+ [VpcSecurityGroupMembership (結構)](api-datatypes.md#VpcSecurityGroupMembership)
+ [針對個別 API 的 Neptune 例外狀況](api-faults.md)
+ [AuthorizationAlreadyExistsFault (結構)](api-faults.md#AuthorizationAlreadyExistsFault)
+ [AuthorizationNotFoundFault (結構)](api-faults.md#AuthorizationNotFoundFault)
+ [AuthorizationQuotaExceededFault (結構)](api-faults.md#AuthorizationQuotaExceededFault)
+ [CertificateNotFoundFault (結構)](api-faults.md#CertificateNotFoundFault)
+ [DBClusterAlreadyExistsFault (結構)](api-faults.md#DBClusterAlreadyExistsFault)
+ [DBClusterNotFoundFault (結構)](api-faults.md#DBClusterNotFoundFault)
+ [DBClusterParameterGroupNotFoundFault (結構)](api-faults.md#DBClusterParameterGroupNotFoundFault)
+ [DBClusterQuotaExceededFault (結構)](api-faults.md#DBClusterQuotaExceededFault)
+ [DBClusterRoleAlreadyExistsFault (結構)](api-faults.md#DBClusterRoleAlreadyExistsFault)
+ [DBClusterRoleNotFoundFault (結構)](api-faults.md#DBClusterRoleNotFoundFault)
+ [DBClusterRoleQuotaExceededFault (結構)](api-faults.md#DBClusterRoleQuotaExceededFault)
+ [DBClusterSnapshotAlreadyExistsFault (結構)](api-faults.md#DBClusterSnapshotAlreadyExistsFault)
+ [DBClusterSnapshotNotFoundFault (結構)](api-faults.md#DBClusterSnapshotNotFoundFault)
+ [DBInstanceAlreadyExistsFault (結構)](api-faults.md#DBInstanceAlreadyExistsFault)
+ [DBInstanceNotFoundFault (結構)](api-faults.md#DBInstanceNotFoundFault)
+ [DBLogFileNotFoundFault (結構)](api-faults.md#DBLogFileNotFoundFault)
+ [DBParameterGroupAlreadyExistsFault (結構)](api-faults.md#DBParameterGroupAlreadyExistsFault)
+ [DBParameterGroupNotFoundFault (結構)](api-faults.md#DBParameterGroupNotFoundFault)
+ [DBParameterGroupQuotaExceededFault (結構)](api-faults.md#DBParameterGroupQuotaExceededFault)
+ [DBSecurityGroupAlreadyExistsFault (結構)](api-faults.md#DBSecurityGroupAlreadyExistsFault)
+ [DBSecurityGroupNotFoundFault (結構)](api-faults.md#DBSecurityGroupNotFoundFault)
+ [DBSecurityGroupNotSupportedFault (結構)](api-faults.md#DBSecurityGroupNotSupportedFault)
+ [DBSecurityGroupQuotaExceededFault (結構)](api-faults.md#DBSecurityGroupQuotaExceededFault)
+ [DBSnapshotAlreadyExistsFault (結構)](api-faults.md#DBSnapshotAlreadyExistsFault)
+ [DBSnapshotNotFoundFault (結構)](api-faults.md#DBSnapshotNotFoundFault)
+ [DBSubnetGroupAlreadyExistsFault (結構)](api-faults.md#DBSubnetGroupAlreadyExistsFault)
+ [DBSubnetGroupDoesNotCoverEnoughAZs (結構)](api-faults.md#DBSubnetGroupDoesNotCoverEnoughAZs)
+ [DBSubnetGroupNotAllowedFault (結構)](api-faults.md#DBSubnetGroupNotAllowedFault)
+ [DBSubnetGroupNotFoundFault (結構)](api-faults.md#DBSubnetGroupNotFoundFault)
+ [DBSubnetGroupQuotaExceededFault (結構)](api-faults.md#DBSubnetGroupQuotaExceededFault)
+ [DBSubnetQuotaExceededFault (結構)](api-faults.md#DBSubnetQuotaExceededFault)
+ [DBUpgradeDependencyFailureFault (結構)](api-faults.md#DBUpgradeDependencyFailureFault)
+ [DomainNotFoundFault (結構)](api-faults.md#DomainNotFoundFault)
+ [EventSubscriptionQuotaExceededFault (結構)](api-faults.md#EventSubscriptionQuotaExceededFault)
+ [GlobalClusterAlreadyExistsFault (結構)](api-faults.md#GlobalClusterAlreadyExistsFault)
+ [GlobalClusterNotFoundFault (結構)](api-faults.md#GlobalClusterNotFoundFault)
+ [GlobalClusterQuotaExceededFault (結構)](api-faults.md#GlobalClusterQuotaExceededFault)
+ [InstanceQuotaExceededFault (結構)](api-faults.md#InstanceQuotaExceededFault)
+ [InsufficientDBClusterCapacityFault (結構)](api-faults.md#InsufficientDBClusterCapacityFault)
+ [InsufficientDBInstanceCapacityFault (結構)](api-faults.md#InsufficientDBInstanceCapacityFault)
+ [InsufficientStorageClusterCapacityFault (結構)](api-faults.md#InsufficientStorageClusterCapacityFault)
+ [InvalidDBClusterEndpointStateFault (結構)](api-faults.md#InvalidDBClusterEndpointStateFault)
+ [InvalidDBClusterSnapshotStateFault (結構)](api-faults.md#InvalidDBClusterSnapshotStateFault)
+ [InvalidDBClusterStateFault (結構)](api-faults.md#InvalidDBClusterStateFault)
+ [InvalidDBInstanceStateFault (結構)](api-faults.md#InvalidDBInstanceStateFault)
+ [InvalidDBParameterGroupStateFault (結構)](api-faults.md#InvalidDBParameterGroupStateFault)
+ [InvalidDBSecurityGroupStateFault (結構)](api-faults.md#InvalidDBSecurityGroupStateFault)
+ [InvalidDBSnapshotStateFault (結構)](api-faults.md#InvalidDBSnapshotStateFault)
+ [InvalidDBSubnetGroupFault (結構)](api-faults.md#InvalidDBSubnetGroupFault)
+ [InvalidDBSubnetGroupStateFault (結構)](api-faults.md#InvalidDBSubnetGroupStateFault)
+ [InvalidDBSubnetStateFault (結構)](api-faults.md#InvalidDBSubnetStateFault)
+ [InvalidEventSubscriptionStateFault (結構)](api-faults.md#InvalidEventSubscriptionStateFault)
+ [InvalidGlobalClusterStateFault (結構)](api-faults.md#InvalidGlobalClusterStateFault)
+ [InvalidOptionGroupStateFault (結構)](api-faults.md#InvalidOptionGroupStateFault)
+ [InvalidRestoreFault (結構)](api-faults.md#InvalidRestoreFault)
+ [InvalidSubnet (結構)](api-faults.md#InvalidSubnet)
+ [InvalidVPCNetworkStateFault (結構)](api-faults.md#InvalidVPCNetworkStateFault)
+ [KMSKeyNotAccessibleFault (結構)](api-faults.md#KMSKeyNotAccessibleFault)
+ [OptionGroupNotFoundFault (結構)](api-faults.md#OptionGroupNotFoundFault)
+ [PointInTimeRestoreNotEnabledFault (結構)](api-faults.md#PointInTimeRestoreNotEnabledFault)
+ [ProvisionedIopsNotAvailableInAZFault (結構)](api-faults.md#ProvisionedIopsNotAvailableInAZFault)
+ [ResourceNotFoundFault (結構)](api-faults.md#ResourceNotFoundFault)
+ [SNSInvalidTopicFault (結構)](api-faults.md#SNSInvalidTopicFault)
+ [SNSNoAuthorizationFault (結構)](api-faults.md#SNSNoAuthorizationFault)
+ [SNSTopicArnNotFoundFault (結構)](api-faults.md#SNSTopicArnNotFoundFault)
+ [SharedSnapshotQuotaExceededFault (結構)](api-faults.md#SharedSnapshotQuotaExceededFault)
+ [SnapshotQuotaExceededFault (結構)](api-faults.md#SnapshotQuotaExceededFault)
+ [SourceNotFoundFault (結構)](api-faults.md#SourceNotFoundFault)
+ [StorageQuotaExceededFault (結構)](api-faults.md#StorageQuotaExceededFault)
+ [StorageTypeNotSupportedFault (結構)](api-faults.md#StorageTypeNotSupportedFault)
+ [SubnetAlreadyInUse (結構)](api-faults.md#SubnetAlreadyInUse)
+ [SubscriptionAlreadyExistFault (結構)](api-faults.md#SubscriptionAlreadyExistFault)
+ [SubscriptionCategoryNotFoundFault (結構)](api-faults.md#SubscriptionCategoryNotFoundFault)
+ [SubscriptionNotFoundFault (結構)](api-faults.md#SubscriptionNotFoundFault)
# Neptune 資料庫叢集 API
**動作:**
+ [CreateDBCluster (動作)](#CreateDBCluster)
+ [DeleteDBCluster (動作)](#DeleteDBCluster)
+ [ModifyDBCluster (動作)](#ModifyDBCluster)
+ [StartDBCluster (動作)](#StartDBCluster)
+ [StopDBCluster (動作)](#StopDBCluster)
+ [AddRoleToDBCluster (動作)](#AddRoleToDBCluster)
+ [RemoveRoleFromDBCluster (動作)](#RemoveRoleFromDBCluster)
+ [FailoverDBCluster (動作)](#FailoverDBCluster)
+ [PromoteReadReplicaDBCluster (動作)](#PromoteReadReplicaDBCluster)
+ [DescribeDBClusters (動作)](#DescribeDBClusters)
**結構：**
+ [DBCluster (結構)](#DBCluster)
+ [DBClusterMember (結構)](#DBClusterMember)
+ [DBClusterRole (結構)](#DBClusterRole)
+ [CloudwatchLogsExportConfiguration (結構)](#CloudwatchLogsExportConfiguration)
+ [PendingCloudwatchLogsExports (結構)](#PendingCloudwatchLogsExports)
+ [ClusterPendingModifiedValues (結構)](#ClusterPendingModifiedValues)
## CreateDBCluster (動作)
此 API 的 AWS CLI 名稱為：`create-db-cluster`。
建立新的 Amazon Neptune 資料庫叢集。
您可以使用 `ReplicationSourceIdentifier` 參數來建立資料庫叢集，做為另一個資料庫叢集或 Amazon Neptune 資料庫執行個體的僅供讀取複本。
請注意，當您直接使用 `CreateDBCluster` 建立新叢集時，預設會停用刪除保護 (當您在主控台中建立新的生產叢集時，預設會啟用刪除保護)。如果資料庫叢集的 `DeletionProtection` 欄位設定為 `false`，您只能刪除資料庫叢集。
**請求**
+ **AvailabilityZones** (在 CLI 中：`--availability-zones`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
EC2 可用區域的清單，在這些可用區域中可以建立資料庫叢集中的執行個體。
+ **BackupRetentionPeriod** (在 CLI 中：`--backup-retention-period`) – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
自動備份保留的天數。您必須指定一個值 (最小值為 1)。
預設：1
約束:
+ 該值必須介於 1 到 35 之間
+ **CopyTagsToSnapshot** (在 CLI 中:`--copy-tags-to-snapshot`) – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
*如果設定為 `true`，則會將標籤複製到所建立之資料庫叢集的任何快照。*
+ **DatabaseName** (在 CLI 中：`--database-name`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
您資料庫的名稱最長可達 64 個英數字元。若您沒有提供名稱，Amazon Neptune 將不會在您建立的資料庫叢集中建立資料庫。
+ **DBClusterIdentifier** (在 CLI 中：`--db-cluster-identifier`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫叢集識別碼 此參數是以小寫字母字串的形式儲存。
約束:
+ 必須包含 1 到 63 個字母、數字或連字號。
+ 第一個字元必須是字母。
+ 不能以連字號結尾或連續包含兩個連字號。
範例：`my-cluster1`
+ **DBClusterParameterGroupName** (在 CLI 中：`--db-cluster-parameter-group-name`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
要與此資料庫叢集建立關聯的資料庫叢集參數群組名稱。若省略此引數，則會使用預設。
約束:
+ 若有提供，則必須符合現有 DBClusterParameterGroup 的名稱。
+ **DBSubnetGroupName** (在 CLI 中：`--db-subnet-group-name`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
要與此資料庫叢集建立關聯的資料庫子網路群組。
限制條件：必須符合現有 DBSubnetGroup 的名稱。絕不能為預設值。
範例：`mySubnetgroup`
+ **DeletionProtection** (在 CLI 中:`--deletion-protection`) – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
指示資料庫叢集是否已啟用刪除保護的值。啟用刪除保護時無法刪除資料庫。根據預設，刪除保護是啟用的。
+ **EnableCloudwatchLogsExports** (在 CLI 中：`--enable-cloudwatch-logs-exports`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
此資料庫叢集應該匯出至 CloudWatch Logs 的日誌類型清單。有效的日誌類型為：`audit` (用來發佈稽核日誌) 和 `slowquery` (用來發佈慢查詢日誌)。請參閱[將 Neptune 日誌發佈至 Amazon CloudWatch Logs](https://docs.aws.amazon.com/neptune/latest/userguide/cloudwatch-logs.html)。
+ **EnableIAMDatabaseAuthentication** (在 CLI 中:`--enable-iam-database-authentication`) – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
如果設定為 `true`，則會針對整個資料庫叢集啟用 Amazon Identity and Access Management (IAM) 身分驗證 (這無法在執行個體層級設定)。
預設：`false`。
+ **Engine** (在 CLI 中：`--engine`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
要用於此資料庫叢集的資料庫引擎名稱。
有效值:`neptune`
+ **EngineVersion** (在 CLI 中：`--engine-version`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
要用於新資料庫叢集的資料庫引擎版本號碼。
範例：`1.2.1.0`
+ **GlobalClusterIdentifier** (在 CLI 中：`--global-cluster-identifier`) – GlobalClusterIdentifier，類型為：`string` (UTF-8 編碼的字串)，不小於 1 或大於 255 ?st?s，符合此規則運算式：`[A-Za-z][0-9A-Za-z-:._]*`。
應將此新資料庫叢集新增至其中之 Neptune 全球資料庫的 ID。
+ **KmsKeyId** (在 CLI 中：`--kms-key-id`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
已加密資料庫叢集的 Amazon KMS 金鑰識別符。
KMS 金鑰識別符是 KMS 加密金鑰的 Amazon Resource Name (ARN)。如果您使用擁有用來加密新資料庫叢集 KMS 加密金鑰的相同 Amazon 帳戶建立資料庫叢集，您可以改為使用 KMS 金鑰別名，而非 KMS 加密金鑰的 ARN。
若加密金鑰並未在 `KmsKeyId` 中指定：
+ 若 `ReplicationSourceIdentifier` 可識別加密來源，則 Amazon Neptune 會使用用於加密來源的加密金鑰。否則，Amazon Neptune 將使用您的預設加密金鑰。
+ 若 `StorageEncrypted` 參數為 true 且並未指定 `ReplicationSourceIdentifier`，則 Amazon Neptune 會使用您的預設加密金鑰。
Amazon KMS 會為您的 Amazon 帳戶建立預設加密金鑰。您的 Amazon 帳戶在每個 Amazon 區域各有不同的預設加密金鑰。
如果您在另一個 Amazon 區域內建立加密資料庫叢集的僅供讀取複本，您必須將 `KmsKeyId` 設為在目標 Amazon 區域中有效的 KMS 金鑰 ID。此金鑰會用於加密該 Amazon 區域內的僅供讀取複本。
+ **Port** (在 CLI 中：`--port`) – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
資料庫叢集中執行個體接受連線的連接埠號碼。
預設：`8182`
+ **PreferredBackupWindow** (在 CLI 中：`--preferred-backup-window`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
每日的時間範圍，若使用 `BackupRetentionPeriod` 參數啟用自動化備份，則會在此期間建立自動化備份。
預設是從每個 Amazon 區域 8 小時的時段內隨機選取的 30 分鐘時段。若要查看可用的時段，請參閱《Amazon Neptune 使用者指南》**中的 [Neptune 維護時段](https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-maintaining.html#manage-console-maintaining-window)。
約束:
+ 格式必須為 `hh24:mi-hh24:mi`。
+ 必須以國際標準時間 (UTC) 表示。
+ 不得和慣用的維護時段衝突。
+ 必須至少 30 分鐘。
+ **PreferredMaintenanceWindow** (在 CLI 中：`--preferred-maintenance-window`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
每週可能進行系統維護的時段，以國際標準時間 (UTC) 表示。
格式：`ddd:hh24:mi-ddd:hh24:mi`
預設是從各 Amazon 區域 8 小時時段中隨機選取的 30 分鐘時段，並隨機發生在一週內的某一天。若要查看可用的時段，請參閱《Amazon Neptune 使用者指南》**中的 [Neptune 維護時段](https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-maintaining.html#manage-console-maintaining-window)。
有效日：星期一、星期二、星期三、星期四、星期五、星期六、星期日。
限制條件：必須至少是 30 分鐘的時段。
+ **PreSignedUrl** (在 CLI 中：`--pre-signed-url`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
目前不支援此參數。
+ **ReplicationSourceIdentifier** (在 CLI 中：`--replication-source-identifier`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
如果此資料庫叢集已做為僅供讀取複本建立，則為來源資料庫執行個體或資料庫叢集的 Amazon Resource Name (ARN)。
+ **ServerlessV2ScalingConfiguration** (在 CLI 中：`--serverless-v2-scaling-configuration`) – [ServerlessV2ScalingConfiguration](api-datatypes.md#ServerlessV2ScalingConfiguration) 物件。
包含 Neptune Serverless 資料庫叢集的擴展組態。
如需詳細資訊，請參閱《Amazon Neptune 使用者指南》**中的[使用 Amazon Neptune Serverless](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html)。
+ **StorageEncrypted** (在 CLI 中:`--storage-encrypted`) – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
指定是否要加密資料庫叢集。
+ **StorageType** (在 CLI 中：`--storage-type`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
新 DB 叢集的儲存類型。
有效值：
+ **`standard`** – (*預設值*) 針對具有中等至少量 I/O 使用率的應用程式設定具成本效益的資料庫儲存體。設定為 `standard`時，回應中不會傳回儲存類型。
+ **`iopt1`** – 啟用 [I/O 優化儲存](https://docs.aws.amazon.com/neptune/latest/userguide/storage-types.html#provisioned-iops-storage)，旨在符合 I/O 密集型圖形工作負載的需求，而這些工作負載則需要可預測的定價、低 I/O 延遲和一致的 I/O 輸送量。
僅引擎版本 1.3.0.0 開始提供 Neptune I/O 優化儲存。
+ **Tags** (在 CLI 中：`--tags`) – [Tag](api-other-apis.md#Tag) 物件的陣列。
要指派給新資料庫叢集的標籤。
+ **VpcSecurityGroupIds** (在 CLI 中：`--vpc-security-group-ids`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
與此資料庫叢集關聯的 EC2 VPC 安全群組清單。
**回應**
包含 Amazon Neptune 資料庫叢集的詳細資訊。
此資料類型會在 [DescribeDBClusters (動作)](#DescribeDBClusters) 動作中用作回應元素。
+ **AllocatedStorage** – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
`AllocatedStorage` 一律會傳回 1，因為 Neptune 資料庫叢集儲存體大小並非固定，而是會視需要自動調整。
+ **AssociatedRoles** – 一個 [DBClusterRole](#DBClusterRole) 物件陣列。
提供與資料庫叢集相關聯的 Amazon Identity and Access Management (IAM) 角色清單。與資料庫叢集相關聯的 IAM 角色，會授予資料庫叢集代您存取其他 Amazon 服務的許可。
+ **AutomaticRestartTime** – TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
資料庫叢集將自動重新啟動的時間。
+ **AvailabilityZones** – 字串，類型為：`string` (UTF-8 編碼的字串)。
提供可在其中建立資料庫叢集內執行個體的 EC2 可用區域清單。
+ **BacktrackConsumedChangeRecords** - LongOptional，類型為：`long` (帶正負號的 64 位元整數)。
Neptune 不提供支援。
+ **BacktrackWindow** - LongOptional，類型為：`long` (帶正負號的 64 位元整數)。
Neptune 不提供支援。
+ **BackupRetentionPeriod** – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
指定保留自動資料庫快照的天數。
+ **Capacity** – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
Neptune 不提供支援。
+ **CloneGroupId** – 字串，類型為：`string` (UTF-8 編碼的字串)。
識別與資料庫叢集建立關聯的複製群組。
+ **ClusterCreateTime** – TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
指定建立資料庫叢集的時間，以國際標準時間 (UTC) 表示。
+ **CopyTagsToSnapshot** – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
*如果設定為 `true`，則會將標籤複製到所建立之資料庫叢集的任何快照。*
+ **CrossAccountClone** – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
如果設定為 `true`，則可跨帳戶複製資料庫叢集。
+ **DatabaseName** – 字串，類型為：`string` (UTF-8 編碼的字串)。
包含此資料庫叢集初始資料庫的名稱，該資料庫是在建立時提供的 (若建立資料庫叢集時有指定的話)。在資料庫叢集使用期間，會傳回此名稱。
+ **DBClusterArn** – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫叢集的 Amazon Resource Name (ARN)。
+ **DBClusterIdentifier** – 字串，類型為：`string` (UTF-8 編碼的字串)。
包含使用者提供的資料庫叢集識別碼。此識別碼為可識別資料庫叢集的唯一金鑰。
+ **DBClusterMembers** – 一個 [DBClusterMember](#DBClusterMember) 物件陣列。
提供組成資料庫叢集的執行個體清單。
+ **DBClusterParameterGroup** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定資料庫叢集的資料庫叢集參數群組名稱。
+ **DbClusterResourceId** – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫叢集的 Amazon 區域唯一、固定識別符。此識別符可在每次存取資料庫叢集的 Amazon KMS 金鑰時，於 Amazon CloudTrail 日誌項目中找到。
+ **DBSubnetGroup** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定與資料庫叢集建立關聯子網路群組的資訊，包括名稱、描述，以及子網路群組中的子網路。
+ **DeletionProtection** – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
指示資料庫叢集是否已啟用刪除保護。啟用刪除保護時無法刪除資料庫。
+ **EarliestBacktrackTime** – TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
Neptune 不提供支援。
+ **EarliestRestorableTime** – TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
指定可透過 point-in-time 還原還原資料庫的最早時間。
+ **EnabledCloudwatchLogsExports** – 字串，類型為：`string` (UTF-8 編碼的字串)。
此資料庫叢集已設為匯出至 CloudWatch Logs 的日誌類型清單。有效的日誌類型為：`audit` (用來將稽核日誌發佈至 CloudWatch) 和 slowquery (用來將慢查詢日誌發佈至 CloudWatch)。請參閱[將 Neptune 日誌發佈至 Amazon CloudWatch Logs](https://docs.aws.amazon.com/neptune/latest/userguide/cloudwatch-logs.html)。
+ **Endpoint** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定資料庫叢集主要執行個體的連線端點。
+ **Engine** – 字串，類型為：`string` (UTF-8 編碼的字串)。
提供要用於此資料庫叢集的資料庫引擎名稱。
+ **EngineVersion** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指示資料庫引擎版本。
+ **GlobalClusterIdentifier** – GlobalClusterIdentifier，類型為：`string` (UTF-8 編碼的字串)，不小於 1 或大於 255 ?st?s，符合此規則運算式：`[A-Za-z][0-9A-Za-z-:._]*`。
包含使用者提供的全球資料庫叢集識別符。此識別符為可識別全球資料庫的唯一金鑰。
+ **HostedZoneId** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定當您建立託管區域時，Amazon Route 53 指派的 ID。
+ **IAMDatabaseAuthenticationEnabled** – 布林值，類型為：`boolean` (布林值 (true 或 false))。
若有啟用 Amazon Identity and Access Management (IAM) 帳戶對資料庫帳戶的映射，則為 true，否則為 false。
+ **IOOptimizedNextAllowedModificationTime** – TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
下次您可以修改資料庫叢集以使用 `iopt1` 儲存類型。
+ **KmsKeyId** – 字串，類型為：`string` (UTF-8 編碼的字串)。
若 `StorageEncrypted` 為 true，則為加密資料庫叢集的 Amazon KMS 金鑰識別碼。
+ **LatestRestorableTime** – TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
指定可透過 point-in-time 還原還原資料庫的最新時間。
+ **MultiAZ** – 布林值，類型為：`boolean` (布林值 (true 或 false))。
指定資料庫叢集是否在多個可用區域中擁有執行個體。
+ **PendingModifiedValues** – [ClusterPendingModifiedValues](#ClusterPendingModifiedValues) 物件。
此資料類型會在 `ModifyDBCluster` 操作中用作回應元素，並包含將在下一個維護時段期間套用的變更。
+ **PercentProgress** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定操作的進度 (百分比)。
+ **Port** – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
指定資料庫引擎接聽的連接埠。
+ **PreferredBackupWindow** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定每日的時間範圍，若有啟用自動化備份 (由 `BackupRetentionPeriod` 決定)，則自動化備份會在此期間建立。
+ **PreferredMaintenanceWindow** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定每週可能進行系統維護的時段，以世界協調時間 (UTC) 表示。
+ **ReaderEndpoint** – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫叢集的讀取器端點。資料庫叢集的讀取器端點，用來針對資料庫叢集中可用僅供讀取複本的連線進行負載平衡。當用戶端向讀取器端點請求新連線時，Neptune 會在資料庫叢集中的僅供讀取複本間分散連線請求。此功能有助於在您資料庫叢集中的多個僅供讀取複本間平衡您的讀取工作負載。
若發生容錯移轉，且您連線的僅供讀取複本提升為主要執行個體，則會中斷您的連線。若要繼續將您的讀取工作負載傳送到叢集內的其他僅供讀取複本，您可以接著重新連線到讀取器端點。
+ **ReadReplicaIdentifiers** – 字串，類型為：`string` (UTF-8 編碼的字串)。
包含與此資料庫叢集相關聯的一或多個僅供讀取複本識別符。
+ **ReplicationSourceIdentifier** – 字串，類型為：`string` (UTF-8 編碼的字串)。
Neptune 不提供支援。
+ **ReplicationType** – 字串，類型為：`string` (UTF-8 編碼的字串)。
Neptune 不提供支援。
+ **ServerlessV2ScalingConfiguration** – [ServerlessV2ScalingConfigurationInfo](api-datatypes.md#ServerlessV2ScalingConfigurationInfo) 物件。
顯示 Neptune Serverless 資料庫叢集的擴展組態。
如需詳細資訊，請參閱《Amazon Neptune 使用者指南》**中的[使用 Amazon Neptune Serverless](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html)。
+ **Status** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定此資料庫叢集的目前狀態。
+ **StorageEncrypted** – 布林值，類型為：`boolean` (布林值 (true 或 false))。
指定是否要加密資料庫叢集。
+ **StorageType** – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫叢集使用的儲存類型。
有效值：
+ **`standard`** – (*預設值*) 針對具有中至低 I/O 使用量的應用程式提供具成本效益的資料庫儲存體。
+ **`iopt1`** – 啟用 [I/O 優化儲存](https://docs.aws.amazon.com/neptune/latest/userguide/storage-types.html#provisioned-iops-storage)，旨在符合 I/O 密集型圖形工作負載的需求，而這些工作負載則需要可預測的定價、低 I/O 延遲和一致的 I/O 輸送量。
僅引擎版本 1.3.0.0 開始提供 Neptune I/O 優化儲存。
+ **VpcSecurityGroups** – 一個 [VpcSecurityGroupMembership](api-datatypes.md#VpcSecurityGroupMembership) 物件陣列。
提供資料庫叢集歸屬的 VPC 安全群組清單。
**錯誤**
+ [DBClusterAlreadyExistsFault](api-faults.md#DBClusterAlreadyExistsFault)
+ [InsufficientStorageClusterCapacityFault](api-faults.md#InsufficientStorageClusterCapacityFault)
+ [DBClusterQuotaExceededFault](api-faults.md#DBClusterQuotaExceededFault)
+ [StorageQuotaExceededFault](api-faults.md#StorageQuotaExceededFault)
+ [DBSubnetGroupNotFoundFault](api-faults.md#DBSubnetGroupNotFoundFault)
+ [InvalidVPCNetworkStateFault](api-faults.md#InvalidVPCNetworkStateFault)
+ [InvalidDBClusterStateFault](api-faults.md#InvalidDBClusterStateFault)
+ [InvalidDBSubnetGroupStateFault](api-faults.md#InvalidDBSubnetGroupStateFault)
+ [InvalidSubnet](api-faults.md#InvalidSubnet)
+ [InvalidDBInstanceStateFault](api-faults.md#InvalidDBInstanceStateFault)
+ [DBClusterParameterGroupNotFoundFault](api-faults.md#DBClusterParameterGroupNotFoundFault)
+ [KMSKeyNotAccessibleFault](api-faults.md#KMSKeyNotAccessibleFault)
+ [DBClusterNotFoundFault](api-faults.md#DBClusterNotFoundFault)
+ [DBInstanceNotFoundFault](api-faults.md#DBInstanceNotFoundFault)
+ [DBSubnetGroupDoesNotCoverEnoughAZs](api-faults.md#DBSubnetGroupDoesNotCoverEnoughAZs)
+ [GlobalClusterNotFoundFault](api-faults.md#GlobalClusterNotFoundFault)
+ [InvalidGlobalClusterStateFault](api-faults.md#InvalidGlobalClusterStateFault)
## DeleteDBCluster (動作)
此 API 的 AWS CLI 名稱為：`delete-db-cluster`。
DeleteDBCluster 動作會刪除先前佈建的資料庫叢集。當您刪除資料庫叢集時，所有該資料庫叢集的自動化備份都會遭到刪除，並且無法復原。指定資料庫叢集的手動資料庫叢集快照則不會刪除。
請注意，如果刪除保護已經啟用，資料庫叢集將無法刪除。如果要刪除，您必須先將其 `DeletionProtection` 欄位設定為 `False`。
**請求**
+ **DBClusterIdentifier** (在 CLI 中：`--db-cluster-identifier`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
欲刪除資料庫叢集的資料庫叢集識別符。此參數沒有大小寫之分。
約束:
+ 必須符合現有的 DBClusterIdentifier。
+ **FinalDBSnapshotIdentifier** (在 CLI 中：`--final-db-snapshot-identifier`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
當 `SkipFinalSnapshot` 設為 `false` 時，所建立新資料庫叢集快照的資料庫叢集快照識別符。
**注意**
指定此參數，同時又將 `SkipFinalShapshot` 參數設為 true 時，便會導致錯誤。
約束:
+ 必須為 1 到 255 個字母、數字或連字號。
+ 第一個字元必須是字母
+ 不能以連字號結尾或連續包含兩個連字號
+ **SkipFinalSnapshot** (在 CLI 中:`--skip-final-snapshot`) – 布林值，類型為：`boolean` (布林值 (true 或 false))。
判斷最終資料庫叢集快照是否建立於資料庫叢集刪除之前。若指定 `true`，則不會建立資料庫叢集快照。若指定 `false`，則資料庫叢集快照會在刪除資料庫叢集前建立。
**注意**
若 `SkipFinalSnapshot` 是 `false`，則您必須指定 `FinalDBSnapshotIdentifier` 參數。
預設：`false`
**回應**
包含 Amazon Neptune 資料庫叢集的詳細資訊。
此資料類型會在 [DescribeDBClusters (動作)](#DescribeDBClusters) 動作中用作回應元素。
+ **AllocatedStorage** – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
`AllocatedStorage` 一律會傳回 1，因為 Neptune 資料庫叢集儲存體大小並非固定，而是會視需要自動調整。
+ **AssociatedRoles** – 一個 [DBClusterRole](#DBClusterRole) 物件陣列。
提供與資料庫叢集相關聯的 Amazon Identity and Access Management (IAM) 角色清單。與資料庫叢集相關聯的 IAM 角色，會授予資料庫叢集代您存取其他 Amazon 服務的許可。
+ **AutomaticRestartTime** – TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
資料庫叢集將自動重新啟動的時間。
+ **AvailabilityZones** – 字串，類型為：`string` (UTF-8 編碼的字串)。
提供可在其中建立資料庫叢集內執行個體的 EC2 可用區域清單。
+ **BacktrackConsumedChangeRecords** - LongOptional，類型為：`long` (帶正負號的 64 位元整數)。
Neptune 不提供支援。
+ **BacktrackWindow** - LongOptional，類型為：`long` (帶正負號的 64 位元整數)。
Neptune 不提供支援。
+ **BackupRetentionPeriod** – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
指定保留自動資料庫快照的天數。
+ **Capacity** – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
Neptune 不提供支援。
+ **CloneGroupId** – 字串，類型為：`string` (UTF-8 編碼的字串)。
識別與資料庫叢集建立關聯的複製群組。
+ **ClusterCreateTime** – TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
指定建立資料庫叢集的時間，以國際標準時間 (UTC) 表示。
+ **CopyTagsToSnapshot** – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
*如果設定為 `true`，則會將標籤複製到所建立之資料庫叢集的任何快照。*
+ **CrossAccountClone** – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
如果設定為 `true`，則可跨帳戶複製資料庫叢集。
+ **DatabaseName** – 字串，類型為：`string` (UTF-8 編碼的字串)。
包含此資料庫叢集初始資料庫的名稱，該資料庫是在建立時提供的 (若建立資料庫叢集時有指定的話)。在資料庫叢集使用期間，會傳回此名稱。
+ **DBClusterArn** – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫叢集的 Amazon Resource Name (ARN)。
+ **DBClusterIdentifier** – 字串，類型為：`string` (UTF-8 編碼的字串)。
包含使用者提供的資料庫叢集識別碼。此識別碼為可識別資料庫叢集的唯一金鑰。
+ **DBClusterMembers** – 一個 [DBClusterMember](#DBClusterMember) 物件陣列。
提供組成資料庫叢集的執行個體清單。
+ **DBClusterParameterGroup** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定資料庫叢集的資料庫叢集參數群組名稱。
+ **DbClusterResourceId** – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫叢集的 Amazon 區域唯一、固定識別符。此識別符可在每次存取資料庫叢集的 Amazon KMS 金鑰時，於 Amazon CloudTrail 日誌項目中找到。
+ **DBSubnetGroup** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定與資料庫叢集建立關聯子網路群組的資訊，包括名稱、描述，以及子網路群組中的子網路。
+ **DeletionProtection** – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
指示資料庫叢集是否已啟用刪除保護。啟用刪除保護時無法刪除資料庫。
+ **EarliestBacktrackTime** – TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
Neptune 不提供支援。
+ **EarliestRestorableTime** – TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
指定可透過 point-in-time 還原還原資料庫的最早時間。
+ **EnabledCloudwatchLogsExports** – 字串，類型為：`string` (UTF-8 編碼的字串)。
此資料庫叢集已設為匯出至 CloudWatch Logs 的日誌類型清單。有效的日誌類型為：`audit` (用來將稽核日誌發佈至 CloudWatch) 和 slowquery (用來將慢查詢日誌發佈至 CloudWatch)。請參閱[將 Neptune 日誌發佈至 Amazon CloudWatch Logs](https://docs.aws.amazon.com/neptune/latest/userguide/cloudwatch-logs.html)。
+ **Endpoint** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定資料庫叢集主要執行個體的連線端點。
+ **Engine** – 字串，類型為：`string` (UTF-8 編碼的字串)。
提供要用於此資料庫叢集的資料庫引擎名稱。
+ **EngineVersion** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指示資料庫引擎版本。
+ **GlobalClusterIdentifier** – GlobalClusterIdentifier，類型為：`string` (UTF-8 編碼的字串)，不小於 1 或大於 255 ?st?s，符合此規則運算式：`[A-Za-z][0-9A-Za-z-:._]*`。
包含使用者提供的全球資料庫叢集識別符。此識別符為可識別全球資料庫的唯一金鑰。
+ **HostedZoneId** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定當您建立託管區域時，Amazon Route 53 指派的 ID。
+ **IAMDatabaseAuthenticationEnabled** – 布林值，類型為：`boolean` (布林值 (true 或 false))。
若有啟用 Amazon Identity and Access Management (IAM) 帳戶對資料庫帳戶的映射，則為 true，否則為 false。
+ **IOOptimizedNextAllowedModificationTime** – TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
下次您可以修改資料庫叢集以使用 `iopt1` 儲存類型。
+ **KmsKeyId** – 字串，類型為：`string` (UTF-8 編碼的字串)。
若 `StorageEncrypted` 為 true，則為加密資料庫叢集的 Amazon KMS 金鑰識別碼。
+ **LatestRestorableTime** – TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
指定可透過 point-in-time 還原還原資料庫的最新時間。
+ **MultiAZ** – 布林值，類型為：`boolean` (布林值 (true 或 false))。
指定資料庫叢集是否在多個可用區域中擁有執行個體。
+ **PendingModifiedValues** – [ClusterPendingModifiedValues](#ClusterPendingModifiedValues) 物件。
此資料類型會在 `ModifyDBCluster` 操作中用作回應元素，並包含將在下一個維護時段期間套用的變更。
+ **PercentProgress** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定操作的進度 (百分比)。
+ **Port** – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
指定資料庫引擎接聽的連接埠。
+ **PreferredBackupWindow** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定每日的時間範圍，若有啟用自動化備份 (由 `BackupRetentionPeriod` 決定)，則自動化備份會在此期間建立。
+ **PreferredMaintenanceWindow** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定每週可能進行系統維護的時段，以世界協調時間 (UTC) 表示。
+ **ReaderEndpoint** – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫叢集的讀取器端點。資料庫叢集的讀取器端點，用來針對資料庫叢集中可用僅供讀取複本的連線進行負載平衡。當用戶端向讀取器端點請求新連線時，Neptune 會在資料庫叢集中的僅供讀取複本間分散連線請求。此功能有助於在您資料庫叢集中的多個僅供讀取複本間平衡您的讀取工作負載。
若發生容錯移轉，且您連線的僅供讀取複本提升為主要執行個體，則會中斷您的連線。若要繼續將您的讀取工作負載傳送到叢集內的其他僅供讀取複本，您可以接著重新連線到讀取器端點。
+ **ReadReplicaIdentifiers** – 字串，類型為：`string` (UTF-8 編碼的字串)。
包含與此資料庫叢集相關聯的一或多個僅供讀取複本識別符。
+ **ReplicationSourceIdentifier** – 字串，類型為：`string` (UTF-8 編碼的字串)。
Neptune 不提供支援。
+ **ReplicationType** – 字串，類型為：`string` (UTF-8 編碼的字串)。
Neptune 不提供支援。
+ **ServerlessV2ScalingConfiguration** – [ServerlessV2ScalingConfigurationInfo](api-datatypes.md#ServerlessV2ScalingConfigurationInfo) 物件。
顯示 Neptune Serverless 資料庫叢集的擴展組態。
如需詳細資訊，請參閱《Amazon Neptune 使用者指南》**中的[使用 Amazon Neptune Serverless](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html)。
+ **Status** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定此資料庫叢集的目前狀態。
+ **StorageEncrypted** – 布林值，類型為：`boolean` (布林值 (true 或 false))。
指定是否要加密資料庫叢集。
+ **StorageType** – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫叢集使用的儲存類型。
有效值：
+ **`standard`** – (*預設值*) 針對具有中至低 I/O 使用量的應用程式提供具成本效益的資料庫儲存體。
+ **`iopt1`** – 啟用 [I/O 優化儲存](https://docs.aws.amazon.com/neptune/latest/userguide/storage-types.html#provisioned-iops-storage)，旨在符合 I/O 密集型圖形工作負載的需求，而這些工作負載則需要可預測的定價、低 I/O 延遲和一致的 I/O 輸送量。
僅引擎版本 1.3.0.0 開始提供 Neptune I/O 優化儲存。
+ **VpcSecurityGroups** – 一個 [VpcSecurityGroupMembership](api-datatypes.md#VpcSecurityGroupMembership) 物件陣列。
提供資料庫叢集歸屬的 VPC 安全群組清單。
**錯誤**
+ [DBClusterNotFoundFault](api-faults.md#DBClusterNotFoundFault)
+ [InvalidDBClusterStateFault](api-faults.md#InvalidDBClusterStateFault)
+ [DBClusterSnapshotAlreadyExistsFault](api-faults.md#DBClusterSnapshotAlreadyExistsFault)
+ [SnapshotQuotaExceededFault](api-faults.md#SnapshotQuotaExceededFault)
+ [InvalidDBClusterSnapshotStateFault](api-faults.md#InvalidDBClusterSnapshotStateFault)
## ModifyDBCluster (動作)
此 API 的 AWS CLI 名稱為：`modify-db-cluster`。
修改資料庫叢集的設定。您可以透過在請求中指定這些參數及新的值，來變更一或多個資料庫組態參數。
**請求**
+ **AllowMajorVersionUpgrade** (在 CLI 中:`--allow-major-version-upgrade`) – 布林值，類型為：`boolean` (布林值 (true 或 false))。
一值，指示是否允許不同主要版本之間升級。
限制條件：在提供 `EngineVersion` 參數，使用與資料庫叢集目前版本不同的主要版本時，您必須設定 allow-major-version-upgrade 旗標。
+ **ApplyImmediately** (在 CLI 中:`--apply-immediately`) – 布林值，類型為：`boolean` (布林值 (true 或 false))。
指定此請求中的修改及任何擱置中的請求是否要以非同步方式盡快套用的值，無論資料庫叢集的 `PreferredMaintenanceWindow` 設定為何。若將此參數設為 `false`，對資料庫叢集的變更會在下次維護時段期間才會套用。
`ApplyImmediately` 參數只會影響 `NewDBClusterIdentifier` 值。如果您將 `ApplyImmediately` 參數值設定為 false，則對 `NewDBClusterIdentifier` 值的變更會在下一個維護時段期間套用。所有其他的變更都會立即套用，無論 `ApplyImmediately` 參數的值為何。
預設：`false`
+ **BackupRetentionPeriod** (在 CLI 中：`--backup-retention-period`) – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
自動備份保留的天數。您必須指定一個值 (最小值為 1)。
預設：1
約束:
+ 該值必須介於 1 到 35 之間
+ **CloudwatchLogsExportConfiguration** (在 CLI 中：`--cloudwatch-logs-export-configuration`) – [CloudwatchLogsExportConfiguration](#CloudwatchLogsExportConfiguration) 物件。
要啟用的日誌類型的組態設定，適用於匯出到特定資料庫叢集的 CloudWatch Logs。請參閱[使用 CLI 將 Neptune 稽核日誌發佈至 CloudWatch Logs](https://docs.aws.amazon.com/neptune/latest/userguide/cloudwatch-logs.html#cloudwatch-logs-cli)。
+ **CopyTagsToSnapshot** (在 CLI 中:`--copy-tags-to-snapshot`) – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
*如果設定為 `true`，則會將標籤複製到所建立之資料庫叢集的任何快照。*
+ **DBClusterIdentifier** (在 CLI 中：`--db-cluster-identifier`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
欲修改叢集的資料庫叢集識別符。此參數不區分大小寫。
約束:
+ 必須符合現有 DBCluster 的識別碼。
+ **DBClusterParameterGroupName** (在 CLI 中：`--db-cluster-parameter-group-name`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫叢集欲使用的資料庫叢集參數群組名稱。
+ **DBInstanceParameterGroupName** (在 CLI 中：`--db-instance-parameter-group-name`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
要套用至所有資料庫叢集執行個體的資料庫參數群組名稱。
**注意**
當您使用 `DBInstanceParameterGroupName` 套用參數群組時，參數變更不會在下一個維護時段期間套用，而是會立即套用。
預設：現有名稱設定
約束:
+ 資料庫參數群組必須位於與目標資料庫叢集版本相同的資料庫參數群組系列中。
+ `DBInstanceParameterGroupName` 參數只在與 `AllowMajorVersionUpgrade` 參數結合時才有效。
+ **DeletionProtection** (在 CLI 中:`--deletion-protection`) – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
指示資料庫叢集是否已啟用刪除保護的值。啟用刪除保護時無法刪除資料庫。根據預設，刪除保護是停用的。
+ **EnableIAMDatabaseAuthentication** (在 CLI 中:`--enable-iam-database-authentication`) – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
設為 True 以啟用 Amazon Identity and Access Management (IAM) 帳戶對資料庫帳戶的對應，否則為 false。
預設：`false`
+ **EngineVersion** (在 CLI 中：`--engine-version`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
您要升級的資料庫引擎版本號碼。變更此參數會造成中斷。變更會在下一次維護時段期間套用，除非 `ApplyImmediately` 參數已設為 true。
如需有效引擎版本的清單，請參閱 [Amazon Neptune 的引擎版本](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases.html)，或呼叫 [DescribeDBEngineVersions (動作)](api-other-apis.md#DescribeDBEngineVersions)。
+ **NewDBClusterIdentifier** (在 CLI 中：`--new-db-cluster-identifier`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
重新命名資料庫叢集時的新資料庫叢集識別符。此值會以小寫字母字串的形式儲存。
約束:
+ 必須包含 1 到 63 個字母、數字或連字號
+ 第一個字元必須是字母
+ 不能以連字號結尾或連續包含兩個連字號
範例：`my-cluster2`
+ **Port** (在 CLI 中：`--port`) – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
資料庫叢集接受連線連接埠號碼。
限制條件：值必須為 `1150-65535`
預設值：與原始資料庫叢集相同的連接埠。
+ **PreferredBackupWindow** (在 CLI 中：`--preferred-backup-window`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
每日的時間範圍，若使用 `BackupRetentionPeriod` 參數啟用自動化備份，則會在此期間建立自動化備份。
預設是從每個 Amazon 區域 8 小時的時段內隨機選取的 30 分鐘時段。
約束:
+ 格式必須為 `hh24:mi-hh24:mi`。
+ 必須以國際標準時間 (UTC) 表示。
+ 不得和慣用的維護時段衝突。
+ 必須至少 30 分鐘。
+ **PreferredMaintenanceWindow** (在 CLI 中：`--preferred-maintenance-window`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
每週可能進行系統維護的時段，以國際標準時間 (UTC) 表示。
格式：`ddd:hh24:mi-ddd:hh24:mi`
預設是從各 Amazon 區域 8 小時時段中隨機選取的 30 分鐘時段，並隨機發生在一週內的某一天。
有效日：星期一、星期二、星期三、星期四、星期五、星期六、星期日。
限制條件：必須至少是 30 分鐘的時段。
+ **ServerlessV2ScalingConfiguration** (在 CLI 中：`--serverless-v2-scaling-configuration`) – [ServerlessV2ScalingConfiguration](api-datatypes.md#ServerlessV2ScalingConfiguration) 物件。
包含 Neptune Serverless 資料庫叢集的擴展組態。
如需詳細資訊，請參閱《Amazon Neptune 使用者指南》**中的[使用 Amazon Neptune Serverless](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html)。
+ **StorageType** (在 CLI 中：`--storage-type`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
和資料庫叢集相關聯的儲存類型。
有效值：
+ **`standard`** – (*預設值*) 針對具有中至低 I/O 使用量的應用程式設定具成本效益的資料庫儲存體。
+ **`iopt1`** – 啟用 [I/O 優化儲存](https://docs.aws.amazon.com/neptune/latest/userguide/storage-types.html#provisioned-iops-storage)，旨在符合 I/O 密集型圖形工作負載的需求，而這些工作負載則需要可預測的定價、低 I/O 延遲和一致的 I/O 輸送量。
僅引擎版本 1.3.0.0 開始提供 Neptune I/O 優化儲存。
+ **VpcSecurityGroupIds** (在 CLI 中：`--vpc-security-group-ids`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫叢集將歸屬的 VPC 安全群組清單。
**回應**
包含 Amazon Neptune 資料庫叢集的詳細資訊。
此資料類型會在 [DescribeDBClusters (動作)](#DescribeDBClusters) 動作中用作回應元素。
+ **AllocatedStorage** – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
`AllocatedStorage` 一律會傳回 1，因為 Neptune 資料庫叢集儲存體大小並非固定，而是會視需要自動調整。
+ **AssociatedRoles** – 一個 [DBClusterRole](#DBClusterRole) 物件陣列。
提供與資料庫叢集相關聯的 Amazon Identity and Access Management (IAM) 角色清單。與資料庫叢集相關聯的 IAM 角色，會授予資料庫叢集代您存取其他 Amazon 服務的許可。
+ **AutomaticRestartTime** – TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
資料庫叢集將自動重新啟動的時間。
+ **AvailabilityZones** – 字串，類型為：`string` (UTF-8 編碼的字串)。
提供可在其中建立資料庫叢集內執行個體的 EC2 可用區域清單。
+ **BacktrackConsumedChangeRecords** - LongOptional，類型為：`long` (帶正負號的 64 位元整數)。
Neptune 不提供支援。
+ **BacktrackWindow** - LongOptional，類型為：`long` (帶正負號的 64 位元整數)。
Neptune 不提供支援。
+ **BackupRetentionPeriod** – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
指定保留自動資料庫快照的天數。
+ **Capacity** – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
Neptune 不提供支援。
+ **CloneGroupId** – 字串，類型為：`string` (UTF-8 編碼的字串)。
識別與資料庫叢集建立關聯的複製群組。
+ **ClusterCreateTime** – TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
指定建立資料庫叢集的時間，以國際標準時間 (UTC) 表示。
+ **CopyTagsToSnapshot** – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
*如果設定為 `true`，則會將標籤複製到所建立之資料庫叢集的任何快照。*
+ **CrossAccountClone** – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
如果設定為 `true`，則可跨帳戶複製資料庫叢集。
+ **DatabaseName** – 字串，類型為：`string` (UTF-8 編碼的字串)。
包含此資料庫叢集初始資料庫的名稱，該資料庫是在建立時提供的 (若建立資料庫叢集時有指定的話)。在資料庫叢集使用期間，會傳回此名稱。
+ **DBClusterArn** – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫叢集的 Amazon Resource Name (ARN)。
+ **DBClusterIdentifier** – 字串，類型為：`string` (UTF-8 編碼的字串)。
包含使用者提供的資料庫叢集識別碼。此識別碼為可識別資料庫叢集的唯一金鑰。
+ **DBClusterMembers** – 一個 [DBClusterMember](#DBClusterMember) 物件陣列。
提供組成資料庫叢集的執行個體清單。
+ **DBClusterParameterGroup** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定資料庫叢集的資料庫叢集參數群組名稱。
+ **DbClusterResourceId** – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫叢集的 Amazon 區域唯一、固定識別符。此識別符可在每次存取資料庫叢集的 Amazon KMS 金鑰時，於 Amazon CloudTrail 日誌項目中找到。
+ **DBSubnetGroup** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定與資料庫叢集建立關聯子網路群組的資訊，包括名稱、描述，以及子網路群組中的子網路。
+ **DeletionProtection** – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
指示資料庫叢集是否已啟用刪除保護。啟用刪除保護時無法刪除資料庫。
+ **EarliestBacktrackTime** – TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
Neptune 不提供支援。
+ **EarliestRestorableTime** – TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
指定可透過 point-in-time 還原還原資料庫的最早時間。
+ **EnabledCloudwatchLogsExports** – 字串，類型為：`string` (UTF-8 編碼的字串)。
此資料庫叢集已設為匯出至 CloudWatch Logs 的日誌類型清單。有效的日誌類型為：`audit` (用來將稽核日誌發佈至 CloudWatch) 和 slowquery (用來將慢查詢日誌發佈至 CloudWatch)。請參閱[將 Neptune 日誌發佈至 Amazon CloudWatch Logs](https://docs.aws.amazon.com/neptune/latest/userguide/cloudwatch-logs.html)。
+ **Endpoint** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定資料庫叢集主要執行個體的連線端點。
+ **Engine** – 字串，類型為：`string` (UTF-8 編碼的字串)。
提供要用於此資料庫叢集的資料庫引擎名稱。
+ **EngineVersion** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指示資料庫引擎版本。
+ **GlobalClusterIdentifier** – GlobalClusterIdentifier，類型為：`string` (UTF-8 編碼的字串)，不小於 1 或大於 255 ?st?s，符合此規則運算式：`[A-Za-z][0-9A-Za-z-:._]*`。
包含使用者提供的全球資料庫叢集識別符。此識別符為可識別全球資料庫的唯一金鑰。
+ **HostedZoneId** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定當您建立託管區域時，Amazon Route 53 指派的 ID。
+ **IAMDatabaseAuthenticationEnabled** – 布林值，類型為：`boolean` (布林值 (true 或 false))。
若有啟用 Amazon Identity and Access Management (IAM) 帳戶對資料庫帳戶的映射，則為 true，否則為 false。
+ **IOOptimizedNextAllowedModificationTime** – TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
下次您可以修改資料庫叢集以使用 `iopt1` 儲存類型。
+ **KmsKeyId** – 字串，類型為：`string` (UTF-8 編碼的字串)。
若 `StorageEncrypted` 為 true，則為加密資料庫叢集的 Amazon KMS 金鑰識別碼。
+ **LatestRestorableTime** – TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
指定可透過 point-in-time 還原還原資料庫的最新時間。
+ **MultiAZ** – 布林值，類型為：`boolean` (布林值 (true 或 false))。
指定資料庫叢集是否在多個可用區域中擁有執行個體。
+ **PendingModifiedValues** – [ClusterPendingModifiedValues](#ClusterPendingModifiedValues) 物件。
此資料類型會在 `ModifyDBCluster` 操作中用作回應元素，並包含將在下一個維護時段期間套用的變更。
+ **PercentProgress** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定操作的進度 (百分比)。
+ **Port** – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
指定資料庫引擎接聽的連接埠。
+ **PreferredBackupWindow** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定每日的時間範圍，若有啟用自動化備份 (由 `BackupRetentionPeriod` 決定)，則自動化備份會在此期間建立。
+ **PreferredMaintenanceWindow** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定每週可能進行系統維護的時段，以世界協調時間 (UTC) 表示。
+ **ReaderEndpoint** – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫叢集的讀取器端點。資料庫叢集的讀取器端點，用來針對資料庫叢集中可用僅供讀取複本的連線進行負載平衡。當用戶端向讀取器端點請求新連線時，Neptune 會在資料庫叢集中的僅供讀取複本間分散連線請求。此功能有助於在您資料庫叢集中的多個僅供讀取複本間平衡您的讀取工作負載。
若發生容錯移轉，且您連線的僅供讀取複本提升為主要執行個體，則會中斷您的連線。若要繼續將您的讀取工作負載傳送到叢集內的其他僅供讀取複本，您可以接著重新連線到讀取器端點。
+ **ReadReplicaIdentifiers** – 字串，類型為：`string` (UTF-8 編碼的字串)。
包含與此資料庫叢集相關聯的一或多個僅供讀取複本識別符。
+ **ReplicationSourceIdentifier** – 字串，類型為：`string` (UTF-8 編碼的字串)。
Neptune 不提供支援。
+ **ReplicationType** – 字串，類型為：`string` (UTF-8 編碼的字串)。
Neptune 不提供支援。
+ **ServerlessV2ScalingConfiguration** – [ServerlessV2ScalingConfigurationInfo](api-datatypes.md#ServerlessV2ScalingConfigurationInfo) 物件。
顯示 Neptune Serverless 資料庫叢集的擴展組態。
如需詳細資訊，請參閱《Amazon Neptune 使用者指南》**中的[使用 Amazon Neptune Serverless](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html)。
+ **Status** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定此資料庫叢集的目前狀態。
+ **StorageEncrypted** – 布林值，類型為：`boolean` (布林值 (true 或 false))。
指定是否要加密資料庫叢集。
+ **StorageType** – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫叢集使用的儲存類型。
有效值：
+ **`standard`** – (*預設值*) 針對具有中至低 I/O 使用量的應用程式提供具成本效益的資料庫儲存體。
+ **`iopt1`** – 啟用 [I/O 優化儲存](https://docs.aws.amazon.com/neptune/latest/userguide/storage-types.html#provisioned-iops-storage)，旨在符合 I/O 密集型圖形工作負載的需求，而這些工作負載則需要可預測的定價、低 I/O 延遲和一致的 I/O 輸送量。
僅引擎版本 1.3.0.0 開始提供 Neptune I/O 優化儲存。
+ **VpcSecurityGroups** – 一個 [VpcSecurityGroupMembership](api-datatypes.md#VpcSecurityGroupMembership) 物件陣列。
提供資料庫叢集歸屬的 VPC 安全群組清單。
**錯誤**
+ [DBClusterNotFoundFault](api-faults.md#DBClusterNotFoundFault)
+ [InvalidDBClusterStateFault](api-faults.md#InvalidDBClusterStateFault)
+ [StorageQuotaExceededFault](api-faults.md#StorageQuotaExceededFault)
+ [DBSubnetGroupNotFoundFault](api-faults.md#DBSubnetGroupNotFoundFault)
+ [InvalidVPCNetworkStateFault](api-faults.md#InvalidVPCNetworkStateFault)
+ [InvalidDBSubnetGroupStateFault](api-faults.md#InvalidDBSubnetGroupStateFault)
+ [InvalidSubnet](api-faults.md#InvalidSubnet)
+ [DBClusterParameterGroupNotFoundFault](api-faults.md#DBClusterParameterGroupNotFoundFault)
+ [InvalidDBSecurityGroupStateFault](api-faults.md#InvalidDBSecurityGroupStateFault)
+ [InvalidDBInstanceStateFault](api-faults.md#InvalidDBInstanceStateFault)
+ [DBClusterAlreadyExistsFault](api-faults.md#DBClusterAlreadyExistsFault)
+ [StorageTypeNotSupportedFault](api-faults.md#StorageTypeNotSupportedFault)
## StartDBCluster (動作)
此 API 的 AWS CLI 名稱為：`start-db-cluster`。
透過使用 Amazon 主控台、Amazon CLI stop-db-cluster 命令或 StopDBCluster API，來啟動停止的 Amazon Neptune 資料庫叢集。
**請求**
+ **DBClusterIdentifier** (在 CLI 中：`--db-cluster-identifier`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
要啟動的 Neptune 資料庫叢集的資料庫叢集識別符。此參數是以小寫字母字串的形式儲存。
**回應**
包含 Amazon Neptune 資料庫叢集的詳細資訊。
此資料類型會在 [DescribeDBClusters (動作)](#DescribeDBClusters) 動作中用作回應元素。
+ **AllocatedStorage** – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
`AllocatedStorage` 一律會傳回 1，因為 Neptune 資料庫叢集儲存體大小並非固定，而是會視需要自動調整。
+ **AssociatedRoles** – 一個 [DBClusterRole](#DBClusterRole) 物件陣列。
提供與資料庫叢集相關聯的 Amazon Identity and Access Management (IAM) 角色清單。與資料庫叢集相關聯的 IAM 角色，會授予資料庫叢集代您存取其他 Amazon 服務的許可。
+ **AutomaticRestartTime** – TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
資料庫叢集將自動重新啟動的時間。
+ **AvailabilityZones** – 字串，類型為：`string` (UTF-8 編碼的字串)。
提供可在其中建立資料庫叢集內執行個體的 EC2 可用區域清單。
+ **BacktrackConsumedChangeRecords** - LongOptional，類型為：`long` (帶正負號的 64 位元整數)。
Neptune 不提供支援。
+ **BacktrackWindow** - LongOptional，類型為：`long` (帶正負號的 64 位元整數)。
Neptune 不提供支援。
+ **BackupRetentionPeriod** – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
指定保留自動資料庫快照的天數。
+ **Capacity** – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
Neptune 不提供支援。
+ **CloneGroupId** – 字串，類型為：`string` (UTF-8 編碼的字串)。
識別與資料庫叢集建立關聯的複製群組。
+ **ClusterCreateTime** – TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
指定建立資料庫叢集的時間，以國際標準時間 (UTC) 表示。
+ **CopyTagsToSnapshot** – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
*如果設定為 `true`，則會將標籤複製到所建立之資料庫叢集的任何快照。*
+ **CrossAccountClone** – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
如果設定為 `true`，則可跨帳戶複製資料庫叢集。
+ **DatabaseName** – 字串，類型為：`string` (UTF-8 編碼的字串)。
包含此資料庫叢集初始資料庫的名稱，該資料庫是在建立時提供的 (若建立資料庫叢集時有指定的話)。在資料庫叢集使用期間，會傳回此名稱。
+ **DBClusterArn** – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫叢集的 Amazon Resource Name (ARN)。
+ **DBClusterIdentifier** – 字串，類型為：`string` (UTF-8 編碼的字串)。
包含使用者提供的資料庫叢集識別碼。此識別碼為可識別資料庫叢集的唯一金鑰。
+ **DBClusterMembers** – 一個 [DBClusterMember](#DBClusterMember) 物件陣列。
提供組成資料庫叢集的執行個體清單。
+ **DBClusterParameterGroup** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定資料庫叢集的資料庫叢集參數群組名稱。
+ **DbClusterResourceId** – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫叢集的 Amazon 區域唯一、固定識別符。此識別符可在每次存取資料庫叢集的 Amazon KMS 金鑰時，於 Amazon CloudTrail 日誌項目中找到。
+ **DBSubnetGroup** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定與資料庫叢集建立關聯子網路群組的資訊，包括名稱、描述，以及子網路群組中的子網路。
+ **DeletionProtection** – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
指示資料庫叢集是否已啟用刪除保護。啟用刪除保護時無法刪除資料庫。
+ **EarliestBacktrackTime** – TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
Neptune 不提供支援。
+ **EarliestRestorableTime** – TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
指定可透過 point-in-time 還原還原資料庫的最早時間。
+ **EnabledCloudwatchLogsExports** – 字串，類型為：`string` (UTF-8 編碼的字串)。
此資料庫叢集已設為匯出至 CloudWatch Logs 的日誌類型清單。有效的日誌類型為：`audit` (用來將稽核日誌發佈至 CloudWatch) 和 slowquery (用來將慢查詢日誌發佈至 CloudWatch)。請參閱[將 Neptune 日誌發佈至 Amazon CloudWatch Logs](https://docs.aws.amazon.com/neptune/latest/userguide/cloudwatch-logs.html)。
+ **Endpoint** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定資料庫叢集主要執行個體的連線端點。
+ **Engine** – 字串，類型為：`string` (UTF-8 編碼的字串)。
提供要用於此資料庫叢集的資料庫引擎名稱。
+ **EngineVersion** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指示資料庫引擎版本。
+ **GlobalClusterIdentifier** – GlobalClusterIdentifier，類型為：`string` (UTF-8 編碼的字串)，不小於 1 或大於 255 ?st?s，符合此規則運算式：`[A-Za-z][0-9A-Za-z-:._]*`。
包含使用者提供的全球資料庫叢集識別符。此識別符為可識別全球資料庫的唯一金鑰。
+ **HostedZoneId** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定當您建立託管區域時，Amazon Route 53 指派的 ID。
+ **IAMDatabaseAuthenticationEnabled** – 布林值，類型為：`boolean` (布林值 (true 或 false))。
若有啟用 Amazon Identity and Access Management (IAM) 帳戶對資料庫帳戶的映射，則為 true，否則為 false。
+ **IOOptimizedNextAllowedModificationTime** – TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
下次您可以修改資料庫叢集以使用 `iopt1` 儲存類型。
+ **KmsKeyId** – 字串，類型為：`string` (UTF-8 編碼的字串)。
若 `StorageEncrypted` 為 true，則為加密資料庫叢集的 Amazon KMS 金鑰識別碼。
+ **LatestRestorableTime** – TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
指定可透過 point-in-time 還原還原資料庫的最新時間。
+ **MultiAZ** – 布林值，類型為：`boolean` (布林值 (true 或 false))。
指定資料庫叢集是否在多個可用區域中擁有執行個體。
+ **PendingModifiedValues** – [ClusterPendingModifiedValues](#ClusterPendingModifiedValues) 物件。
此資料類型會在 `ModifyDBCluster` 操作中用作回應元素，並包含將在下一個維護時段期間套用的變更。
+ **PercentProgress** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定操作的進度 (百分比)。
+ **Port** – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
指定資料庫引擎接聽的連接埠。
+ **PreferredBackupWindow** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定每日的時間範圍，若有啟用自動化備份 (由 `BackupRetentionPeriod` 決定)，則自動化備份會在此期間建立。
+ **PreferredMaintenanceWindow** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定每週可能進行系統維護的時段，以世界協調時間 (UTC) 表示。
+ **ReaderEndpoint** – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫叢集的讀取器端點。資料庫叢集的讀取器端點，用來針對資料庫叢集中可用僅供讀取複本的連線進行負載平衡。當用戶端向讀取器端點請求新連線時，Neptune 會在資料庫叢集中的僅供讀取複本間分散連線請求。此功能有助於在您資料庫叢集中的多個僅供讀取複本間平衡您的讀取工作負載。
若發生容錯移轉，且您連線的僅供讀取複本提升為主要執行個體，則會中斷您的連線。若要繼續將您的讀取工作負載傳送到叢集內的其他僅供讀取複本，您可以接著重新連線到讀取器端點。
+ **ReadReplicaIdentifiers** – 字串，類型為：`string` (UTF-8 編碼的字串)。
包含與此資料庫叢集相關聯的一或多個僅供讀取複本識別符。
+ **ReplicationSourceIdentifier** – 字串，類型為：`string` (UTF-8 編碼的字串)。
Neptune 不提供支援。
+ **ReplicationType** – 字串，類型為：`string` (UTF-8 編碼的字串)。
Neptune 不提供支援。
+ **ServerlessV2ScalingConfiguration** – [ServerlessV2ScalingConfigurationInfo](api-datatypes.md#ServerlessV2ScalingConfigurationInfo) 物件。
顯示 Neptune Serverless 資料庫叢集的擴展組態。
如需詳細資訊，請參閱《Amazon Neptune 使用者指南》**中的[使用 Amazon Neptune Serverless](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html)。
+ **Status** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定此資料庫叢集的目前狀態。
+ **StorageEncrypted** – 布林值，類型為：`boolean` (布林值 (true 或 false))。
指定是否要加密資料庫叢集。
+ **StorageType** – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫叢集使用的儲存類型。
有效值：
+ **`standard`** – (*預設值*) 針對具有中至低 I/O 使用量的應用程式提供具成本效益的資料庫儲存體。
+ **`iopt1`** – 啟用 [I/O 優化儲存](https://docs.aws.amazon.com/neptune/latest/userguide/storage-types.html#provisioned-iops-storage)，旨在符合 I/O 密集型圖形工作負載的需求，而這些工作負載則需要可預測的定價、低 I/O 延遲和一致的 I/O 輸送量。
僅引擎版本 1.3.0.0 開始提供 Neptune I/O 優化儲存。
+ **VpcSecurityGroups** – 一個 [VpcSecurityGroupMembership](api-datatypes.md#VpcSecurityGroupMembership) 物件陣列。
提供資料庫叢集歸屬的 VPC 安全群組清單。
**錯誤**
+ [DBClusterNotFoundFault](api-faults.md#DBClusterNotFoundFault)
+ [InvalidDBClusterStateFault](api-faults.md#InvalidDBClusterStateFault)
+ [InvalidDBInstanceStateFault](api-faults.md#InvalidDBInstanceStateFault)
## StopDBCluster (動作)
此 API 的 AWS CLI 名稱為：`stop-db-cluster`。
停止 Amazon Neptune 資料庫叢集。當您停止資料庫叢集時，Neptune 會留資料庫叢集的中繼資料，包括端點和資料庫參數群組。
Neptune 也會保留交易日誌，以便您視需要進行時間點還原。
**請求**
+ **DBClusterIdentifier** (在 CLI 中：`--db-cluster-identifier`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
要停止的 Neptune 資料庫叢集的資料庫叢集識別符。此參數是以小寫字母字串的形式儲存。
**回應**
包含 Amazon Neptune 資料庫叢集的詳細資訊。
此資料類型會在 [DescribeDBClusters (動作)](#DescribeDBClusters) 動作中用作回應元素。
+ **AllocatedStorage** – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
`AllocatedStorage` 一律會傳回 1，因為 Neptune 資料庫叢集儲存體大小並非固定，而是會視需要自動調整。
+ **AssociatedRoles** – 一個 [DBClusterRole](#DBClusterRole) 物件陣列。
提供與資料庫叢集相關聯的 Amazon Identity and Access Management (IAM) 角色清單。與資料庫叢集相關聯的 IAM 角色，會授予資料庫叢集代您存取其他 Amazon 服務的許可。
+ **AutomaticRestartTime** – TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
資料庫叢集將自動重新啟動的時間。
+ **AvailabilityZones** – 字串，類型為：`string` (UTF-8 編碼的字串)。
提供可在其中建立資料庫叢集內執行個體的 EC2 可用區域清單。
+ **BacktrackConsumedChangeRecords** - LongOptional，類型為：`long` (帶正負號的 64 位元整數)。
Neptune 不提供支援。
+ **BacktrackWindow** - LongOptional，類型為：`long` (帶正負號的 64 位元整數)。
Neptune 不提供支援。
+ **BackupRetentionPeriod** – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
指定保留自動資料庫快照的天數。
+ **Capacity** – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
Neptune 不提供支援。
+ **CloneGroupId** – 字串，類型為：`string` (UTF-8 編碼的字串)。
識別與資料庫叢集建立關聯的複製群組。
+ **ClusterCreateTime** – TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
指定建立資料庫叢集的時間，以國際標準時間 (UTC) 表示。
+ **CopyTagsToSnapshot** – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
*如果設定為 `true`，則會將標籤複製到所建立之資料庫叢集的任何快照。*
+ **CrossAccountClone** – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
如果設定為 `true`，則可跨帳戶複製資料庫叢集。
+ **DatabaseName** – 字串，類型為：`string` (UTF-8 編碼的字串)。
包含此資料庫叢集初始資料庫的名稱，該資料庫是在建立時提供的 (若建立資料庫叢集時有指定的話)。在資料庫叢集使用期間，會傳回此名稱。
+ **DBClusterArn** – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫叢集的 Amazon Resource Name (ARN)。
+ **DBClusterIdentifier** – 字串，類型為：`string` (UTF-8 編碼的字串)。
包含使用者提供的資料庫叢集識別碼。此識別碼為可識別資料庫叢集的唯一金鑰。
+ **DBClusterMembers** – 一個 [DBClusterMember](#DBClusterMember) 物件陣列。
提供組成資料庫叢集的執行個體清單。
+ **DBClusterParameterGroup** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定資料庫叢集的資料庫叢集參數群組名稱。
+ **DbClusterResourceId** – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫叢集的 Amazon 區域唯一、固定識別符。此識別符可在每次存取資料庫叢集的 Amazon KMS 金鑰時，於 Amazon CloudTrail 日誌項目中找到。
+ **DBSubnetGroup** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定與資料庫叢集建立關聯子網路群組的資訊，包括名稱、描述，以及子網路群組中的子網路。
+ **DeletionProtection** – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
指示資料庫叢集是否已啟用刪除保護。啟用刪除保護時無法刪除資料庫。
+ **EarliestBacktrackTime** – TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
Neptune 不提供支援。
+ **EarliestRestorableTime** – TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
指定可透過 point-in-time 還原還原資料庫的最早時間。
+ **EnabledCloudwatchLogsExports** – 字串，類型為：`string` (UTF-8 編碼的字串)。
此資料庫叢集已設為匯出至 CloudWatch Logs 的日誌類型清單。有效的日誌類型為：`audit` (用來將稽核日誌發佈至 CloudWatch) 和 slowquery (用來將慢查詢日誌發佈至 CloudWatch)。請參閱[將 Neptune 日誌發佈至 Amazon CloudWatch Logs](https://docs.aws.amazon.com/neptune/latest/userguide/cloudwatch-logs.html)。
+ **Endpoint** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定資料庫叢集主要執行個體的連線端點。
+ **Engine** – 字串，類型為：`string` (UTF-8 編碼的字串)。
提供要用於此資料庫叢集的資料庫引擎名稱。
+ **EngineVersion** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指示資料庫引擎版本。
+ **GlobalClusterIdentifier** – GlobalClusterIdentifier，類型為：`string` (UTF-8 編碼的字串)，不小於 1 或大於 255 ?st?s，符合此規則運算式：`[A-Za-z][0-9A-Za-z-:._]*`。
包含使用者提供的全球資料庫叢集識別符。此識別符為可識別全球資料庫的唯一金鑰。
+ **HostedZoneId** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定當您建立託管區域時，Amazon Route 53 指派的 ID。
+ **IAMDatabaseAuthenticationEnabled** – 布林值，類型為：`boolean` (布林值 (true 或 false))。
若有啟用 Amazon Identity and Access Management (IAM) 帳戶對資料庫帳戶的映射，則為 true，否則為 false。
+ **IOOptimizedNextAllowedModificationTime** – TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
下次您可以修改資料庫叢集以使用 `iopt1` 儲存類型。
+ **KmsKeyId** – 字串，類型為：`string` (UTF-8 編碼的字串)。
若 `StorageEncrypted` 為 true，則為加密資料庫叢集的 Amazon KMS 金鑰識別碼。
+ **LatestRestorableTime** – TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
指定可透過 point-in-time 還原還原資料庫的最新時間。
+ **MultiAZ** – 布林值，類型為：`boolean` (布林值 (true 或 false))。
指定資料庫叢集是否在多個可用區域中擁有執行個體。
+ **PendingModifiedValues** – [ClusterPendingModifiedValues](#ClusterPendingModifiedValues) 物件。
此資料類型會在 `ModifyDBCluster` 操作中用作回應元素，並包含將在下一個維護時段期間套用的變更。
+ **PercentProgress** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定操作的進度 (百分比)。
+ **Port** – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
指定資料庫引擎接聽的連接埠。
+ **PreferredBackupWindow** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定每日的時間範圍，若有啟用自動化備份 (由 `BackupRetentionPeriod` 決定)，則自動化備份會在此期間建立。
+ **PreferredMaintenanceWindow** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定每週可能進行系統維護的時段，以世界協調時間 (UTC) 表示。
+ **ReaderEndpoint** – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫叢集的讀取器端點。資料庫叢集的讀取器端點，用來針對資料庫叢集中可用僅供讀取複本的連線進行負載平衡。當用戶端向讀取器端點請求新連線時，Neptune 會在資料庫叢集中的僅供讀取複本間分散連線請求。此功能有助於在您資料庫叢集中的多個僅供讀取複本間平衡您的讀取工作負載。
若發生容錯移轉，且您連線的僅供讀取複本提升為主要執行個體，則會中斷您的連線。若要繼續將您的讀取工作負載傳送到叢集內的其他僅供讀取複本，您可以接著重新連線到讀取器端點。
+ **ReadReplicaIdentifiers** – 字串，類型為：`string` (UTF-8 編碼的字串)。
包含與此資料庫叢集相關聯的一或多個僅供讀取複本識別符。
+ **ReplicationSourceIdentifier** – 字串，類型為：`string` (UTF-8 編碼的字串)。
Neptune 不提供支援。
+ **ReplicationType** – 字串，類型為：`string` (UTF-8 編碼的字串)。
Neptune 不提供支援。
+ **ServerlessV2ScalingConfiguration** – [ServerlessV2ScalingConfigurationInfo](api-datatypes.md#ServerlessV2ScalingConfigurationInfo) 物件。
顯示 Neptune Serverless 資料庫叢集的擴展組態。
如需詳細資訊，請參閱《Amazon Neptune 使用者指南》**中的[使用 Amazon Neptune Serverless](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html)。
+ **Status** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定此資料庫叢集的目前狀態。
+ **StorageEncrypted** – 布林值，類型為：`boolean` (布林值 (true 或 false))。
指定是否要加密資料庫叢集。
+ **StorageType** – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫叢集使用的儲存類型。
有效值：
+ **`standard`** – (*預設值*) 針對具有中至低 I/O 使用量的應用程式提供具成本效益的資料庫儲存體。
+ **`iopt1`** – 啟用 [I/O 優化儲存](https://docs.aws.amazon.com/neptune/latest/userguide/storage-types.html#provisioned-iops-storage)，旨在符合 I/O 密集型圖形工作負載的需求，而這些工作負載則需要可預測的定價、低 I/O 延遲和一致的 I/O 輸送量。
僅引擎版本 1.3.0.0 開始提供 Neptune I/O 優化儲存。
+ **VpcSecurityGroups** – 一個 [VpcSecurityGroupMembership](api-datatypes.md#VpcSecurityGroupMembership) 物件陣列。
提供資料庫叢集歸屬的 VPC 安全群組清單。
**錯誤**
+ [DBClusterNotFoundFault](api-faults.md#DBClusterNotFoundFault)
+ [InvalidDBClusterStateFault](api-faults.md#InvalidDBClusterStateFault)
+ [InvalidDBInstanceStateFault](api-faults.md#InvalidDBInstanceStateFault)
## AddRoleToDBCluster (動作)
此 API 的 AWS CLI 名稱為：`add-role-to-db-cluster`。
將 Identity and Access Management (IAM) 角色與 Neptune 資料庫叢集建立關聯。
**請求**
+ **DBClusterIdentifier** (在 CLI 中：`--db-cluster-identifier`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
要與 IAM 角色建立關聯的資料庫叢集名稱。
+ **FeatureName** (在 CLI 中：`--feature-name`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
IAM 角色與其相關聯之 Neptune 資料庫叢集的功能名稱。如需支援的功能名稱清單，請參閱 [DBEngineVersion (結構)](api-other-apis.md#DBEngineVersion)。
+ **RoleArn** (在 CLI 中：`--role-arn`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
要與 Neptune 資料庫叢集建立關聯的 IAM 角色 Amazon Resource Name (ARN)，例如 `arn:aws:iam::123456789012:role/NeptuneAccessRole`。
**回應**
+ *無回應參數。*
**錯誤**
+ [DBClusterNotFoundFault](api-faults.md#DBClusterNotFoundFault)
+ [DBClusterRoleAlreadyExistsFault](api-faults.md#DBClusterRoleAlreadyExistsFault)
+ [InvalidDBClusterStateFault](api-faults.md#InvalidDBClusterStateFault)
+ [DBClusterRoleQuotaExceededFault](api-faults.md#DBClusterRoleQuotaExceededFault)
## RemoveRoleFromDBCluster (動作)
此 API 的 AWS CLI 名稱為：`remove-role-from-db-cluster`。
從資料庫叢集解除關聯一個 Identity and Access Management (IAM) 角色。
**請求**
+ **DBClusterIdentifier** (在 CLI 中：`--db-cluster-identifier`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
要從 IAM 角色解除關聯的資料庫叢集名稱。
+ **FeatureName** (在 CLI 中：`--feature-name`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
IAM 角色要與其取消關聯之資料庫叢集的功能名稱。如需支援的功能名稱清單，請參閱 [DescribeDBEngineVersions (動作)](api-other-apis.md#DescribeDBEngineVersions)。
+ **RoleArn** (在 CLI 中：`--role-arn`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
要從資料庫叢集解除關聯的 IAM 角色 Amazon Resource Name (ARN)，例如 `arn:aws:iam::123456789012:role/NeptuneAccessRole`。
**回應**
+ *無回應參數。*
**錯誤**
+ [DBClusterNotFoundFault](api-faults.md#DBClusterNotFoundFault)
+ [DBClusterRoleNotFoundFault](api-faults.md#DBClusterRoleNotFoundFault)
+ [InvalidDBClusterStateFault](api-faults.md#InvalidDBClusterStateFault)
## FailoverDBCluster (動作)
此 API 的 AWS CLI 名稱為：`failover-db-cluster`。
強制資料庫叢集進行容錯移轉。
資料庫叢集的容錯移轉會將資料庫叢集中的其中一個僅供讀取複本 (唯讀執行個體) 提升為主要執行個體 (叢集寫入器)。
Amazon Neptune 會在主要執行個體失敗時，自動容錯移轉至僅供讀取複本 (若有的話)。當您想要模擬主要執行個體故障以進行測試時，可以強制容錯移轉。由於資料庫叢集中的每個執行個體都有自己的端點地址，當容錯移轉完成時，您將需要清除和重新建立任何使用這些端點地址的現有連線。
**請求**
+ **DBClusterIdentifier** (在 CLI 中：`--db-cluster-identifier`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
要強制其進行容錯移轉的資料庫叢集識別符。此參數不區分大小寫。
約束:
+ 必須符合現有 DBCluster 的識別碼。
+ **TargetDBInstanceIdentifier** (在 CLI 中：`--target-db-instance-identifier`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
要提升為主要執行個體的執行個體名稱。
您必須為資料庫叢集中的僅供讀取複本指定執行個體識別符。例如 `mydbcluster-replica1`。
**回應**
包含 Amazon Neptune 資料庫叢集的詳細資訊。
此資料類型會在 [DescribeDBClusters (動作)](#DescribeDBClusters) 動作中用作回應元素。
+ **AllocatedStorage** – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
`AllocatedStorage` 一律會傳回 1，因為 Neptune 資料庫叢集儲存體大小並非固定，而是會視需要自動調整。
+ **AssociatedRoles** – 一個 [DBClusterRole](#DBClusterRole) 物件陣列。
提供與資料庫叢集相關聯的 Amazon Identity and Access Management (IAM) 角色清單。與資料庫叢集相關聯的 IAM 角色，會授予資料庫叢集代您存取其他 Amazon 服務的許可。
+ **AutomaticRestartTime** – TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
資料庫叢集將自動重新啟動的時間。
+ **AvailabilityZones** – 字串，類型為：`string` (UTF-8 編碼的字串)。
提供可在其中建立資料庫叢集內執行個體的 EC2 可用區域清單。
+ **BacktrackConsumedChangeRecords** - LongOptional，類型為：`long` (帶正負號的 64 位元整數)。
Neptune 不提供支援。
+ **BacktrackWindow** - LongOptional，類型為：`long` (帶正負號的 64 位元整數)。
Neptune 不提供支援。
+ **BackupRetentionPeriod** – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
指定保留自動資料庫快照的天數。
+ **Capacity** – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
Neptune 不提供支援。
+ **CloneGroupId** – 字串，類型為：`string` (UTF-8 編碼的字串)。
識別與資料庫叢集建立關聯的複製群組。
+ **ClusterCreateTime** – TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
指定建立資料庫叢集的時間，以國際標準時間 (UTC) 表示。
+ **CopyTagsToSnapshot** – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
*如果設定為 `true`，則會將標籤複製到所建立之資料庫叢集的任何快照。*
+ **CrossAccountClone** – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
如果設定為 `true`，則可跨帳戶複製資料庫叢集。
+ **DatabaseName** – 字串，類型為：`string` (UTF-8 編碼的字串)。
包含此資料庫叢集初始資料庫的名稱，該資料庫是在建立時提供的 (若建立資料庫叢集時有指定的話)。在資料庫叢集使用期間，會傳回此名稱。
+ **DBClusterArn** – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫叢集的 Amazon Resource Name (ARN)。
+ **DBClusterIdentifier** – 字串，類型為：`string` (UTF-8 編碼的字串)。
包含使用者提供的資料庫叢集識別碼。此識別碼為可識別資料庫叢集的唯一金鑰。
+ **DBClusterMembers** – 一個 [DBClusterMember](#DBClusterMember) 物件陣列。
提供組成資料庫叢集的執行個體清單。
+ **DBClusterParameterGroup** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定資料庫叢集的資料庫叢集參數群組名稱。
+ **DbClusterResourceId** – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫叢集的 Amazon 區域唯一、固定識別符。此識別符可在每次存取資料庫叢集的 Amazon KMS 金鑰時，於 Amazon CloudTrail 日誌項目中找到。
+ **DBSubnetGroup** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定與資料庫叢集建立關聯子網路群組的資訊，包括名稱、描述，以及子網路群組中的子網路。
+ **DeletionProtection** – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
指示資料庫叢集是否已啟用刪除保護。啟用刪除保護時無法刪除資料庫。
+ **EarliestBacktrackTime** – TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
Neptune 不提供支援。
+ **EarliestRestorableTime** – TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
指定可透過 point-in-time 還原還原資料庫的最早時間。
+ **EnabledCloudwatchLogsExports** – 字串，類型為：`string` (UTF-8 編碼的字串)。
此資料庫叢集已設為匯出至 CloudWatch Logs 的日誌類型清單。有效的日誌類型為：`audit` (用來將稽核日誌發佈至 CloudWatch) 和 slowquery (用來將慢查詢日誌發佈至 CloudWatch)。請參閱[將 Neptune 日誌發佈至 Amazon CloudWatch Logs](https://docs.aws.amazon.com/neptune/latest/userguide/cloudwatch-logs.html)。
+ **Endpoint** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定資料庫叢集主要執行個體的連線端點。
+ **Engine** – 字串，類型為：`string` (UTF-8 編碼的字串)。
提供要用於此資料庫叢集的資料庫引擎名稱。
+ **EngineVersion** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指示資料庫引擎版本。
+ **GlobalClusterIdentifier** – GlobalClusterIdentifier，類型為：`string` (UTF-8 編碼的字串)，不小於 1 或大於 255 ?st?s，符合此規則運算式：`[A-Za-z][0-9A-Za-z-:._]*`。
包含使用者提供的全球資料庫叢集識別符。此識別符為可識別全球資料庫的唯一金鑰。
+ **HostedZoneId** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定當您建立託管區域時，Amazon Route 53 指派的 ID。
+ **IAMDatabaseAuthenticationEnabled** – 布林值，類型為：`boolean` (布林值 (true 或 false))。
若有啟用 Amazon Identity and Access Management (IAM) 帳戶對資料庫帳戶的映射，則為 true，否則為 false。
+ **IOOptimizedNextAllowedModificationTime** – TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
下次您可以修改資料庫叢集以使用 `iopt1` 儲存類型。
+ **KmsKeyId** – 字串，類型為：`string` (UTF-8 編碼的字串)。
若 `StorageEncrypted` 為 true，則為加密資料庫叢集的 Amazon KMS 金鑰識別碼。
+ **LatestRestorableTime** – TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
指定可透過 point-in-time 還原還原資料庫的最新時間。
+ **MultiAZ** – 布林值，類型為：`boolean` (布林值 (true 或 false))。
指定資料庫叢集是否在多個可用區域中擁有執行個體。
+ **PendingModifiedValues** – [ClusterPendingModifiedValues](#ClusterPendingModifiedValues) 物件。
此資料類型會在 `ModifyDBCluster` 操作中用作回應元素，並包含將在下一個維護時段期間套用的變更。
+ **PercentProgress** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定操作的進度 (百分比)。
+ **Port** – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
指定資料庫引擎接聽的連接埠。
+ **PreferredBackupWindow** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定每日的時間範圍，若有啟用自動化備份 (由 `BackupRetentionPeriod` 決定)，則自動化備份會在此期間建立。
+ **PreferredMaintenanceWindow** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定每週可能進行系統維護的時段，以世界協調時間 (UTC) 表示。
+ **ReaderEndpoint** – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫叢集的讀取器端點。資料庫叢集的讀取器端點，用來針對資料庫叢集中可用僅供讀取複本的連線進行負載平衡。當用戶端向讀取器端點請求新連線時，Neptune 會在資料庫叢集中的僅供讀取複本間分散連線請求。此功能有助於在您資料庫叢集中的多個僅供讀取複本間平衡您的讀取工作負載。
若發生容錯移轉，且您連線的僅供讀取複本提升為主要執行個體，則會中斷您的連線。若要繼續將您的讀取工作負載傳送到叢集內的其他僅供讀取複本，您可以接著重新連線到讀取器端點。
+ **ReadReplicaIdentifiers** – 字串，類型為：`string` (UTF-8 編碼的字串)。
包含與此資料庫叢集相關聯的一或多個僅供讀取複本識別符。
+ **ReplicationSourceIdentifier** – 字串，類型為：`string` (UTF-8 編碼的字串)。
Neptune 不提供支援。
+ **ReplicationType** – 字串，類型為：`string` (UTF-8 編碼的字串)。
Neptune 不提供支援。
+ **ServerlessV2ScalingConfiguration** – [ServerlessV2ScalingConfigurationInfo](api-datatypes.md#ServerlessV2ScalingConfigurationInfo) 物件。
顯示 Neptune Serverless 資料庫叢集的擴展組態。
如需詳細資訊，請參閱《Amazon Neptune 使用者指南》**中的[使用 Amazon Neptune Serverless](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html)。
+ **Status** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定此資料庫叢集的目前狀態。
+ **StorageEncrypted** – 布林值，類型為：`boolean` (布林值 (true 或 false))。
指定是否要加密資料庫叢集。
+ **StorageType** – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫叢集使用的儲存類型。
有效值：
+ **`standard`** – (*預設值*) 針對具有中至低 I/O 使用量的應用程式提供具成本效益的資料庫儲存體。
+ **`iopt1`** – 啟用 [I/O 優化儲存](https://docs.aws.amazon.com/neptune/latest/userguide/storage-types.html#provisioned-iops-storage)，旨在符合 I/O 密集型圖形工作負載的需求，而這些工作負載則需要可預測的定價、低 I/O 延遲和一致的 I/O 輸送量。
僅引擎版本 1.3.0.0 開始提供 Neptune I/O 優化儲存。
+ **VpcSecurityGroups** – 一個 [VpcSecurityGroupMembership](api-datatypes.md#VpcSecurityGroupMembership) 物件陣列。
提供資料庫叢集歸屬的 VPC 安全群組清單。
**錯誤**
+ [DBClusterNotFoundFault](api-faults.md#DBClusterNotFoundFault)
+ [InvalidDBClusterStateFault](api-faults.md#InvalidDBClusterStateFault)
+ [InvalidDBInstanceStateFault](api-faults.md#InvalidDBInstanceStateFault)
## PromoteReadReplicaDBCluster (動作)
此 API 的 AWS CLI 名稱為：`promote-read-replica-db-cluster`。
不支援。
**請求**
+ **DBClusterIdentifier** (在 CLI 中：`--db-cluster-identifier`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
不支援。
**回應**
包含 Amazon Neptune 資料庫叢集的詳細資訊。
此資料類型會在 [DescribeDBClusters (動作)](#DescribeDBClusters) 動作中用作回應元素。
+ **AllocatedStorage** – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
`AllocatedStorage` 一律會傳回 1，因為 Neptune 資料庫叢集儲存體大小並非固定，而是會視需要自動調整。
+ **AssociatedRoles** – 一個 [DBClusterRole](#DBClusterRole) 物件陣列。
提供與資料庫叢集相關聯的 Amazon Identity and Access Management (IAM) 角色清單。與資料庫叢集相關聯的 IAM 角色，會授予資料庫叢集代您存取其他 Amazon 服務的許可。
+ **AutomaticRestartTime** – TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
資料庫叢集將自動重新啟動的時間。
+ **AvailabilityZones** – 字串，類型為：`string` (UTF-8 編碼的字串)。
提供可在其中建立資料庫叢集內執行個體的 EC2 可用區域清單。
+ **BacktrackConsumedChangeRecords** - LongOptional，類型為：`long` (帶正負號的 64 位元整數)。
Neptune 不提供支援。
+ **BacktrackWindow** - LongOptional，類型為：`long` (帶正負號的 64 位元整數)。
Neptune 不提供支援。
+ **BackupRetentionPeriod** – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
指定保留自動資料庫快照的天數。
+ **Capacity** – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
Neptune 不提供支援。
+ **CloneGroupId** – 字串，類型為：`string` (UTF-8 編碼的字串)。
識別與資料庫叢集建立關聯的複製群組。
+ **ClusterCreateTime** – TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
指定建立資料庫叢集的時間，以國際標準時間 (UTC) 表示。
+ **CopyTagsToSnapshot** – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
*如果設定為 `true`，則會將標籤複製到所建立之資料庫叢集的任何快照。*
+ **CrossAccountClone** – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
如果設定為 `true`，則可跨帳戶複製資料庫叢集。
+ **DatabaseName** – 字串，類型為：`string` (UTF-8 編碼的字串)。
包含此資料庫叢集初始資料庫的名稱，該資料庫是在建立時提供的 (若建立資料庫叢集時有指定的話)。在資料庫叢集使用期間，會傳回此名稱。
+ **DBClusterArn** – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫叢集的 Amazon Resource Name (ARN)。
+ **DBClusterIdentifier** – 字串，類型為：`string` (UTF-8 編碼的字串)。
包含使用者提供的資料庫叢集識別碼。此識別碼為可識別資料庫叢集的唯一金鑰。
+ **DBClusterMembers** – 一個 [DBClusterMember](#DBClusterMember) 物件陣列。
提供組成資料庫叢集的執行個體清單。
+ **DBClusterParameterGroup** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定資料庫叢集的資料庫叢集參數群組名稱。
+ **DbClusterResourceId** – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫叢集的 Amazon 區域唯一、固定識別符。此識別符可在每次存取資料庫叢集的 Amazon KMS 金鑰時，於 Amazon CloudTrail 日誌項目中找到。
+ **DBSubnetGroup** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定與資料庫叢集建立關聯子網路群組的資訊，包括名稱、描述，以及子網路群組中的子網路。
+ **DeletionProtection** – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
指示資料庫叢集是否已啟用刪除保護。啟用刪除保護時無法刪除資料庫。
+ **EarliestBacktrackTime** – TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
Neptune 不提供支援。
+ **EarliestRestorableTime** – TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
指定可透過 point-in-time 還原還原資料庫的最早時間。
+ **EnabledCloudwatchLogsExports** – 字串，類型為：`string` (UTF-8 編碼的字串)。
此資料庫叢集已設為匯出至 CloudWatch Logs 的日誌類型清單。有效的日誌類型為：`audit` (用來將稽核日誌發佈至 CloudWatch) 和 slowquery (用來將慢查詢日誌發佈至 CloudWatch)。請參閱[將 Neptune 日誌發佈至 Amazon CloudWatch Logs](https://docs.aws.amazon.com/neptune/latest/userguide/cloudwatch-logs.html)。
+ **Endpoint** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定資料庫叢集主要執行個體的連線端點。
+ **Engine** – 字串，類型為：`string` (UTF-8 編碼的字串)。
提供要用於此資料庫叢集的資料庫引擎名稱。
+ **EngineVersion** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指示資料庫引擎版本。
+ **GlobalClusterIdentifier** – GlobalClusterIdentifier，類型為：`string` (UTF-8 編碼的字串)，不小於 1 或大於 255 ?st?s，符合此規則運算式：`[A-Za-z][0-9A-Za-z-:._]*`。
包含使用者提供的全球資料庫叢集識別符。此識別符為可識別全球資料庫的唯一金鑰。
+ **HostedZoneId** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定當您建立託管區域時，Amazon Route 53 指派的 ID。
+ **IAMDatabaseAuthenticationEnabled** – 布林值，類型為：`boolean` (布林值 (true 或 false))。
若有啟用 Amazon Identity and Access Management (IAM) 帳戶對資料庫帳戶的映射，則為 true，否則為 false。
+ **IOOptimizedNextAllowedModificationTime** – TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
下次您可以修改資料庫叢集以使用 `iopt1` 儲存類型。
+ **KmsKeyId** – 字串，類型為：`string` (UTF-8 編碼的字串)。
若 `StorageEncrypted` 為 true，則為加密資料庫叢集的 Amazon KMS 金鑰識別碼。
+ **LatestRestorableTime** – TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
指定可透過 point-in-time 還原還原資料庫的最新時間。
+ **MultiAZ** – 布林值，類型為：`boolean` (布林值 (true 或 false))。
指定資料庫叢集是否在多個可用區域中擁有執行個體。
+ **PendingModifiedValues** – [ClusterPendingModifiedValues](#ClusterPendingModifiedValues) 物件。
此資料類型會在 `ModifyDBCluster` 操作中用作回應元素，並包含將在下一個維護時段期間套用的變更。
+ **PercentProgress** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定操作的進度 (百分比)。
+ **Port** – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
指定資料庫引擎接聽的連接埠。
+ **PreferredBackupWindow** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定每日的時間範圍，若有啟用自動化備份 (由 `BackupRetentionPeriod` 決定)，則自動化備份會在此期間建立。
+ **PreferredMaintenanceWindow** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定每週可能進行系統維護的時段，以世界協調時間 (UTC) 表示。
+ **ReaderEndpoint** – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫叢集的讀取器端點。資料庫叢集的讀取器端點，用來針對資料庫叢集中可用僅供讀取複本的連線進行負載平衡。當用戶端向讀取器端點請求新連線時，Neptune 會在資料庫叢集中的僅供讀取複本間分散連線請求。此功能有助於在您資料庫叢集中的多個僅供讀取複本間平衡您的讀取工作負載。
若發生容錯移轉，且您連線的僅供讀取複本提升為主要執行個體，則會中斷您的連線。若要繼續將您的讀取工作負載傳送到叢集內的其他僅供讀取複本，您可以接著重新連線到讀取器端點。
+ **ReadReplicaIdentifiers** – 字串，類型為：`string` (UTF-8 編碼的字串)。
包含與此資料庫叢集相關聯的一或多個僅供讀取複本識別符。
+ **ReplicationSourceIdentifier** – 字串，類型為：`string` (UTF-8 編碼的字串)。
Neptune 不提供支援。
+ **ReplicationType** – 字串，類型為：`string` (UTF-8 編碼的字串)。
Neptune 不提供支援。
+ **ServerlessV2ScalingConfiguration** – [ServerlessV2ScalingConfigurationInfo](api-datatypes.md#ServerlessV2ScalingConfigurationInfo) 物件。
顯示 Neptune Serverless 資料庫叢集的擴展組態。
如需詳細資訊，請參閱《Amazon Neptune 使用者指南》**中的[使用 Amazon Neptune Serverless](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html)。
+ **Status** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定此資料庫叢集的目前狀態。
+ **StorageEncrypted** – 布林值，類型為：`boolean` (布林值 (true 或 false))。
指定是否要加密資料庫叢集。
+ **StorageType** – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫叢集使用的儲存類型。
有效值：
+ **`standard`** – (*預設值*) 針對具有中至低 I/O 使用量的應用程式提供具成本效益的資料庫儲存體。
+ **`iopt1`** – 啟用 [I/O 優化儲存](https://docs.aws.amazon.com/neptune/latest/userguide/storage-types.html#provisioned-iops-storage)，旨在符合 I/O 密集型圖形工作負載的需求，而這些工作負載則需要可預測的定價、低 I/O 延遲和一致的 I/O 輸送量。
僅引擎版本 1.3.0.0 開始提供 Neptune I/O 優化儲存。
+ **VpcSecurityGroups** – 一個 [VpcSecurityGroupMembership](api-datatypes.md#VpcSecurityGroupMembership) 物件陣列。
提供資料庫叢集歸屬的 VPC 安全群組清單。
**錯誤**
+ [DBClusterNotFoundFault](api-faults.md#DBClusterNotFoundFault)
+ [InvalidDBClusterStateFault](api-faults.md#InvalidDBClusterStateFault)
## DescribeDBClusters (動作)
此 API 的 AWS CLI 名稱為：`describe-db-clusters`。
傳回所佈建之資料庫叢集的相關資訊，並支援分頁。
**注意**
此操作也可以傳回 Amazon RDS 叢集和 Amazon DocDB 叢集的資訊。
**請求**
+ **DBClusterIdentifier** (在 CLI 中：`--db-cluster-identifier`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
使用者提供的資料庫叢集識別符。若指定此參數，則只會傳回特定資料庫叢集的資訊。此參數沒有大小寫之分。
約束:
+ 若有提供此項目，則必須符合現有的 DBClusterIdentifier。
+ **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-clusters \
--filters Name=engine,Values=neptune
```
+ **Marker** (在 CLI 中：`--marker`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
前一個 [DescribeDBClusters (動作)](#DescribeDBClusters) 請求提供的選用分頁字符。若指定此參數，則回應只會包含超過標記的記錄，直到 `MaxRecords` 指定的值為止。
+ **MaxRecords** (在 CLI 中：`--max-records`) – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
要在回應中包含的記錄數量上限。若存在的記錄比 `MaxRecords` 值指定的更多，則稱為「標記」的分頁字符會包含在回應中，讓您可以擷取剩餘的結果。
預設：100
限制條件：最小 20，最大 100。
**回應**
+ **DBClusters** – 一個 [DBCluster](#DBCluster) 物件陣列。
包含使用者的資料庫叢集清單。
+ **Marker** – 字串，類型為：`string` (UTF-8 編碼的字串)。
可用於後續 DescribeDBClusters 請求的分頁字符。
**錯誤**
+ [DBClusterNotFoundFault](api-faults.md#DBClusterNotFoundFault)
## *結構：*
## DBCluster (結構)
包含 Amazon Neptune 資料庫叢集的詳細資訊。
此資料類型會在 [DescribeDBClusters (動作)](#DescribeDBClusters) 動作中用作回應元素。
**欄位**
+ **AllocatedStorage** – 這是 IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
`AllocatedStorage` 一律會傳回 1，因為 Neptune 資料庫叢集儲存體大小並非固定，而是會視需要自動調整。
+ **AssociatedRoles** - 這是 [DBClusterRole](#DBClusterRole) 物件的陣列。
提供與資料庫叢集相關聯的 Amazon Identity and Access Management (IAM) 角色清單。與資料庫叢集相關聯的 IAM 角色，會授予資料庫叢集代您存取其他 Amazon 服務的許可。
+ **AutomaticRestartTime** – 這是 TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
資料庫叢集將自動重新啟動的時間。
+ **AvailabilityZones** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
提供可在其中建立資料庫叢集內執行個體的 EC2 可用區域清單。
+ **BacktrackConsumedChangeRecords** - 這是 LongOptional 整數，類型為：`long` (帶正負號的 64 位元整數)。
Neptune 不提供支援。
+ **BacktrackWindow** - 這是 LongOptional 整數，類型為：`long` (帶正負號的 64 位元整數)。
Neptune 不提供支援。
+ **BackupRetentionPeriod** – 這是 IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
指定保留自動資料庫快照的天數。
+ **Capacity** – 這是 IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
Neptune 不提供支援。
+ **CloneGroupId** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
識別與資料庫叢集建立關聯的複製群組。
+ **ClusterCreateTime** – 這是 TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
指定建立資料庫叢集的時間，以國際標準時間 (UTC) 表示。
+ **CopyTagsToSnapshot** – 這是 BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
*如果設定為 `true`，則會將標籤複製到所建立之資料庫叢集的任何快照。*
+ **CrossAccountClone** – 這是 BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
如果設定為 `true`，則可跨帳戶複製資料庫叢集。
+ **DatabaseName** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
包含此資料庫叢集初始資料庫的名稱，該資料庫是在建立時提供的 (若建立資料庫叢集時有指定的話)。在資料庫叢集使用期間，會傳回此名稱。
+ **DBClusterArn** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫叢集的 Amazon Resource Name (ARN)。
+ **DBClusterIdentifier** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
包含使用者提供的資料庫叢集識別碼。此識別碼為可識別資料庫叢集的唯一金鑰。
+ **DBClusterMembers** - 這是 [DBClusterMember](#DBClusterMember) 物件的陣列。
提供組成資料庫叢集的執行個體清單。
+ **DBClusterParameterGroup** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
指定資料庫叢集的資料庫叢集參數群組名稱。
+ **DbClusterResourceId** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫叢集的 Amazon 區域唯一、固定識別符。此識別符可在每次存取資料庫叢集的 Amazon KMS 金鑰時，於 Amazon CloudTrail 日誌項目中找到。
+ **DBSubnetGroup** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
指定與資料庫叢集建立關聯子網路群組的資訊，包括名稱、描述，以及子網路群組中的子網路。
+ **DeletionProtection** – 這是 BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
指示資料庫叢集是否已啟用刪除保護。啟用刪除保護時無法刪除資料庫。
+ **EarliestBacktrackTime** – 這是 TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
Neptune 不提供支援。
+ **EarliestRestorableTime** – 這是 TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
指定可透過 point-in-time 還原還原資料庫的最早時間。
+ **EnabledCloudwatchLogsExports** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
此資料庫叢集已設為匯出至 CloudWatch Logs 的日誌類型清單。有效的日誌類型為：`audit` (用來將稽核日誌發佈至 CloudWatch) 和 slowquery (用來將慢查詢日誌發佈至 CloudWatch)。請參閱[將 Neptune 日誌發佈至 Amazon CloudWatch Logs](https://docs.aws.amazon.com/neptune/latest/userguide/cloudwatch-logs.html)。
+ **Endpoint** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
指定資料庫叢集主要執行個體的連線端點。
+ **Engine** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
提供要用於此資料庫叢集的資料庫引擎名稱。
+ **EngineVersion** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
指示資料庫引擎版本。
+ **GlobalClusterIdentifier** - 這是 GlobalClusterIdentifier，類型為：`string` (UTF-8 編碼的字串)，不小於 1 或大於 255 ?st?s，符合此規則運算式：`[A-Za-z][0-9A-Za-z-:._]*`。
包含使用者提供的全球資料庫叢集識別符。此識別符為可識別全球資料庫的唯一金鑰。
+ **HostedZoneId** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
指定當您建立託管區域時，Amazon Route 53 指派的 ID。
+ **IAMDatabaseAuthenticationEnabled** - 這是布林值，類型為：`boolean` (布林值 (true 或 false))。
若有啟用 Amazon Identity and Access Management (IAM) 帳戶對資料庫帳戶的映射，則為 true，否則為 false。
+ **IOOptimizedNextAllowedModificationTime** – 這是 TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
下次您可以修改資料庫叢集以使用 `iopt1` 儲存類型。
+ **KmsKeyId** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
若 `StorageEncrypted` 為 true，則為加密資料庫叢集的 Amazon KMS 金鑰識別碼。
+ **LatestRestorableTime** – 這是 TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
指定可透過 point-in-time 還原還原資料庫的最新時間。
+ **MultiAZ** - 這是布林值，類型為：`boolean` (布林值 (true 或 false))。
指定資料庫叢集是否在多個可用區域中擁有執行個體。
+ **PendingModifiedValues** - 這是一個 [ClusterPendingModifiedValues](#ClusterPendingModifiedValues) 物件。
此資料類型會在 `ModifyDBCluster` 操作中用作回應元素，並包含將在下一個維護時段期間套用的變更。
+ **PercentProgress** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
指定操作的進度 (百分比)。
+ **Port** – 這是 IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
指定資料庫引擎接聽的連接埠。
+ **PreferredBackupWindow** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
指定每日的時間範圍，若有啟用自動化備份 (由 `BackupRetentionPeriod` 決定)，則自動化備份會在此期間建立。
+ **PreferredMaintenanceWindow** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
指定每週可能進行系統維護的時段，以世界協調時間 (UTC) 表示。
+ **ReaderEndpoint** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫叢集的讀取器端點。資料庫叢集的讀取器端點，用來針對資料庫叢集中可用僅供讀取複本的連線進行負載平衡。當用戶端向讀取器端點請求新連線時，Neptune 會在資料庫叢集中的僅供讀取複本間分散連線請求。此功能有助於在您資料庫叢集中的多個僅供讀取複本間平衡您的讀取工作負載。
若發生容錯移轉，且您連線的僅供讀取複本提升為主要執行個體，則會中斷您的連線。若要繼續將您的讀取工作負載傳送到叢集內的其他僅供讀取複本，您可以接著重新連線到讀取器端點。
+ **ReadReplicaIdentifiers** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
包含與此資料庫叢集相關聯的一或多個僅供讀取複本識別符。
+ **ReplicationSourceIdentifier** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
Neptune 不提供支援。
+ **ReplicationType** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
Neptune 不提供支援。
+ **ServerlessV2ScalingConfiguration** - 這是一個 [ServerlessV2ScalingConfigurationInfo](api-datatypes.md#ServerlessV2ScalingConfigurationInfo) 物件。
顯示 Neptune Serverless 資料庫叢集的擴展組態。
如需詳細資訊，請參閱《Amazon Neptune 使用者指南》**中的[使用 Amazon Neptune Serverless](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html)。
+ **Status** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
指定此資料庫叢集的目前狀態。
+ **StorageEncrypted** - 這是布林值，類型為：`boolean` (布林值 (true 或 false))。
指定是否要加密資料庫叢集。
+ **StorageType** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫叢集使用的儲存類型。
有效值：
+ **`standard`** – (*預設值*) 針對具有中至低 I/O 使用量的應用程式提供具成本效益的資料庫儲存體。
+ **`iopt1`** – 啟用 [I/O 優化儲存](https://docs.aws.amazon.com/neptune/latest/userguide/storage-types.html#provisioned-iops-storage)，旨在符合 I/O 密集型圖形工作負載的需求，而這些工作負載則需要可預測的定價、低 I/O 延遲和一致的 I/O 輸送量。
僅引擎版本 1.3.0.0 開始提供 Neptune I/O 優化儲存。
+ **VpcSecurityGroups** - 這是 [VpcSecurityGroupMembership](api-datatypes.md#VpcSecurityGroupMembership) 物件的陣列。
提供資料庫叢集歸屬的 VPC 安全群組清單。
`DBCluster` 會用來做為以下項目的回應元素：
+ [CreateDBCluster](#CreateDBCluster)
+ [DeleteDBCluster](#DeleteDBCluster)
+ [FailoverDBCluster](#FailoverDBCluster)
+ [ModifyDBCluster](#ModifyDBCluster)
+ [PromoteReadReplicaDBCluster](#PromoteReadReplicaDBCluster)
+ [RestoreDBClusterFromSnapshot](api-snapshots.md#RestoreDBClusterFromSnapshot)
+ [RestoreDBClusterToPointInTime](api-snapshots.md#RestoreDBClusterToPointInTime)
+ [StartDBCluster](#StartDBCluster)
+ [StopDBCluster](#StopDBCluster)
## DBClusterMember (結構)
包含做為資料庫叢集一部分的執行個體相關資訊。
**欄位**
+ **DBClusterParameterGroupStatus** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
指定此資料庫叢集成員的資料庫叢集參數群組狀態。
+ **DBInstanceIdentifier** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
指定此資料庫叢集成員的執行個體識別符。
+ **IsClusterWriter** - 這是布林值，類型為：`boolean` (布林值 (true 或 false))。
若叢集成員是資料庫叢集的主要執行個體，則該值為 `true`，否則為 `false`。
+ **PromotionTier** – 這是 IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
此值指定在現有主要執行個體故障後，僅供讀取複本提升為主要執行個體的順序。
## DBClusterRole (結構)
描述與資料庫叢集相關聯的 Amazon Identity and Access Management (IAM) 角色。
**欄位**
+ **FeatureName** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
與 Amazon Identity and Access Management (IAM) 角色關聯的功能名稱。如需支援的功能名稱清單，請參閱 [DescribeDBEngineVersions (動作)](api-other-apis.md#DescribeDBEngineVersions)。
+ **RoleArn** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
與資料庫叢集相關聯的 IAM 角色 Amazon Resource Name (ARN)。
+ **Status** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
描述 IAM 角色和資料庫叢集之間關聯的狀態。Status 屬性會傳回下列其中一個值：
+ `ACTIVE` - 與資料庫叢集相關聯的 IAM 角色 ARN，可用於代您存取其他 Amazon 服務。
+ `PENDING` - IAM 角色 ARN 正在和資料庫叢集建立關聯。
+ `INVALID` - 與資料庫叢集相關聯的 IAM 角色 ARN，但資料庫叢集無法取得 IAM 角色來代您存取其他 Amazon 服務。
## CloudwatchLogsExportConfiguration (結構)
要啟用的日誌類型的組態設定，適用於匯出到特定資料庫執行個體或資料庫叢集的 CloudWatch Logs。
`EnableLogTypes` 和 `DisableLogTypes` 陣列決定要將哪些日誌匯出 (或不匯出) 到 CloudWatch Logs。
有效的日誌類型為：`audit` (用來發佈稽核日誌) 和 `slowquery` (用來發佈慢查詢日誌)。請參閱[將 Neptune 日誌發佈至 Amazon CloudWatch Logs](https://docs.aws.amazon.com/neptune/latest/userguide/cloudwatch-logs.html)。
**欄位**
+ **DisableLogTypes** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
要停用的日誌類型清單。
+ **EnableLogTypes** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
要啟用的日誌類型清單。
## PendingCloudwatchLogsExports (結構)
組態仍待處理的日誌類型清單。換言之，這些日誌類型正在進行啟用或停用中。
有效的日誌類型為：`audit` (用來發佈稽核日誌) 和 `slowquery` (用來發佈慢查詢日誌)。請參閱[將 Neptune 日誌發佈至 Amazon CloudWatch Logs](https://docs.aws.amazon.com/neptune/latest/userguide/cloudwatch-logs.html)。
**欄位**
+ **LogTypesToDisable** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
正在進行啟用的日誌類型。日誌之後，這些日誌類型會匯出到 CloudWatch Logs。
+ **LogTypesToEnable** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
正在進行停用的日誌類型。停用日誌之後，這些日誌類型不會匯出到 CloudWatch Logs。
## ClusterPendingModifiedValues (結構)
此資料類型會在 `ModifyDBCluster` 操作中用作回應元素，並包含將在下一個維護時段期間套用的變更。
**欄位**
+ **AllocatedStorage** – 這是 IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
為資料庫引擎所配置的儲存體大小，以 GiB 為單位。對於 Neptune，`AllocatedStorage` 一律會傳回 1，因為 Neptune 資料庫叢集儲存體大小並非固定，而是會視需要自動調整。
+ **BackupRetentionPeriod** – 這是 IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
自動資料庫快照保留的天數。
+ **DBClusterIdentifier** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫叢集的 DBClusterIdentifier 值。
+ **EngineVersion** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫引擎版本。
+ **IAMDatabaseAuthenticationEnabled** – 這是 BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
指出是否啟用 AWS Identity and Access Management (IAM) 帳戶與資料庫帳戶映射的值。
+ **Iops** – 這是 IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
佈建 IOPS (每秒 I/O 操作) 值。此設定僅適用於多可用區域資料庫叢集。
+ **PendingCloudwatchLogsExports** - 這是一個 [PendingCloudwatchLogsExports](#PendingCloudwatchLogsExports) 物件。
此 `PendingCloudwatchLogsExports` 結構會指定 CloudWatch Logs 啟用和停用的待定變更。
+ **StorageType** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫叢集的儲存類型的待處理變更。 有效值：
+ **`standard`** – (*預設值*) 針對具有中至低 I/O 使用量的應用程式設定具成本效益的資料庫儲存體。
+ **`iopt1`** – 啟用 [I/O 優化儲存](https://docs.aws.amazon.com/neptune/latest/userguide/storage-types.html#provisioned-iops-storage)，旨在符合 I/O 密集型圖形工作負載的需求，而這些工作負載則需要可預測的定價、低 I/O 延遲和一致的 I/O 輸送量。
僅引擎版本 1.3.0.0 開始提供 Neptune I/O 優化儲存。
# Neptune 全球資料庫 API
**動作:**
+ [CreateGlobalCluster (動作)](#CreateGlobalCluster)
+ [DeleteGlobalCluster (動作)](#DeleteGlobalCluster)
+ [ModifyGlobalCluster (動作)](#ModifyGlobalCluster)
+ [DescribeGlobalClusters (動作)](#DescribeGlobalClusters)
+ [FailoverGlobalCluster (動作)](#FailoverGlobalCluster)
+ [RemoveFromGlobalCluster (動作)](#RemoveFromGlobalCluster)
**結構：**
+ [GlobalCluster (結構)](#GlobalCluster)
+ [GlobalClusterMember (結構)](#GlobalClusterMember)
## CreateGlobalCluster (動作)
此 API 的 AWS CLI 名稱為：`create-global-cluster`。
建立分散在多個 Amazon 區域的 Neptune 全球資料庫。全球資料庫包含具有讀寫功能的單一主要叢集，以及唯讀次要叢集，可透過 Neptune 儲存子系統執行的高速複寫接收來自主要叢集的資料。
您可以建立最初空白的全球資料庫，然後將主要叢集和次要叢集新增至其中，也可以在建立操作期間指定現有的 Neptune 叢集，使其成為全球資料庫的主要叢集。
**請求**
+ **DatabaseName** (在 CLI 中：`--database-name`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
新全球資料庫的名稱 (最多可有 64 個英數字元)。
+ **DeletionProtection** (在 CLI 中:`--deletion-protection`) – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
新的全域資料庫的刪除保護設定。啟用刪除保護時無法刪除全域資料庫。
+ **Engine** (在 CLI 中：`--engine`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
要在全球資料庫中使用的資料庫引擎名稱。
有效值：`neptune`
+ **EngineVersion** (在 CLI 中：`--engine-version`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
全球資料庫要使用的 Neptune 引擎版本。
有效值為：`1.2.0.0` 或以上。
+ **GlobalClusterIdentifier** (在 CLI 中：`--global-cluster-identifier`) – *必要：*GlobalClusterIdentifier，類型為：`string` (UTF-8 編碼的字串)，不小於 1 或大於 255 ?st?s，符合此規則運算式：`[A-Za-z][0-9A-Za-z-:._]*`。
新全域資料庫叢集的叢集識別碼。
+ **SourceDBClusterIdentifier** (在 CLI 中：`--source-db-cluster-identifier`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
(*選用*) 現有 Neptune 資料庫叢集的 Amazon Resource Name (ARN)，此資料庫叢集要用作新全球資料庫的主要叢集。
+ **StorageEncrypted** (在 CLI 中:`--storage-encrypted`) – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
新全球資料庫叢集的儲存加密設定。
**回應**
包含 Amazon Neptune 全球資料庫的詳細資訊。
此資料類型會用作 [CreateGlobalCluster (動作)](#CreateGlobalCluster)、[DescribeGlobalClusters (動作)](#DescribeGlobalClusters)、[ModifyGlobalCluster (動作)](#ModifyGlobalCluster)、[DeleteGlobalCluster (動作)](#DeleteGlobalCluster)、[FailoverGlobalCluster (動作)](#FailoverGlobalCluster) 和 [RemoveFromGlobalCluster (動作)](#RemoveFromGlobalCluster) 的回應元素。
+ **DeletionProtection** – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
全球資料庫的刪除保護設定。
+ **Engine** – 字串，類型為：`string` (UTF-8 編碼的字串)。
全球資料庫所使用的 Neptune 資料庫引擎 (`"neptune"`)。
+ **EngineVersion** – 字串，類型為：`string` (UTF-8 編碼的字串)。
全球資料庫所使用的 Neptune 引擎版本。
+ **GlobalClusterArn** – 字串，類型為：`string` (UTF-8 編碼的字串)。
全球資料庫的 Amazon Resource Name (ARN)。
+ **GlobalClusterIdentifier** – GlobalClusterIdentifier，類型為：`string` (UTF-8 編碼的字串)，不小於 1 或大於 255 ?st?s，符合此規則運算式：`[A-Za-z][0-9A-Za-z-:._]*`。
包含使用者提供的全球資料庫叢集識別符。此識別符為可識別全球資料庫的唯一金鑰。
+ **GlobalClusterMembers** – 一個 [GlobalClusterMember](#GlobalClusterMember) 物件陣列。
屬於全球資料庫之所有資料庫叢集的叢集 ARN 和執行個體 ARN 清單。
+ **GlobalClusterResourceId** – 字串，類型為：`string` (UTF-8 編碼的字串)。
全球資料庫的不可變識別符，在所有區域內都是唯一的。此識別碼可在每次存取資料庫叢集的 KMS 金鑰時，於 CloudTrail 日誌項目中找到。
+ **Status** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定此全球資料庫的目前狀態。
+ **StorageEncrypted** – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
全球資料庫的儲存加密設定。
**錯誤**
+ [GlobalClusterAlreadyExistsFault](api-faults.md#GlobalClusterAlreadyExistsFault)
+ [GlobalClusterQuotaExceededFault](api-faults.md#GlobalClusterQuotaExceededFault)
+ [InvalidDBClusterStateFault](api-faults.md#InvalidDBClusterStateFault)
+ [DBClusterNotFoundFault](api-faults.md#DBClusterNotFoundFault)
## DeleteGlobalCluster (動作)
此 API 的 AWS CLI 名稱為：`delete-global-cluster`。
刪除全球資料庫。必須先分離或刪除主要叢集和所有次要叢集。
**請求**
+ **GlobalClusterIdentifier** (在 CLI 中：`--global-cluster-identifier`) – *必要：*GlobalClusterIdentifier，類型為：`string` (UTF-8 編碼的字串)，不小於 1 或大於 255 ?st?s，符合此規則運算式：`[A-Za-z][0-9A-Za-z-:._]*`。
要刪除之全球資料庫叢集的叢集識別符。
**回應**
包含 Amazon Neptune 全球資料庫的詳細資訊。
此資料類型會用作 [CreateGlobalCluster (動作)](#CreateGlobalCluster)、[DescribeGlobalClusters (動作)](#DescribeGlobalClusters)、[ModifyGlobalCluster (動作)](#ModifyGlobalCluster)、[DeleteGlobalCluster (動作)](#DeleteGlobalCluster)、[FailoverGlobalCluster (動作)](#FailoverGlobalCluster) 和 [RemoveFromGlobalCluster (動作)](#RemoveFromGlobalCluster) 的回應元素。
+ **DeletionProtection** – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
全球資料庫的刪除保護設定。
+ **Engine** – 字串，類型為：`string` (UTF-8 編碼的字串)。
全球資料庫所使用的 Neptune 資料庫引擎 (`"neptune"`)。
+ **EngineVersion** – 字串，類型為：`string` (UTF-8 編碼的字串)。
全球資料庫所使用的 Neptune 引擎版本。
+ **GlobalClusterArn** – 字串，類型為：`string` (UTF-8 編碼的字串)。
全球資料庫的 Amazon Resource Name (ARN)。
+ **GlobalClusterIdentifier** – GlobalClusterIdentifier，類型為：`string` (UTF-8 編碼的字串)，不小於 1 或大於 255 ?st?s，符合此規則運算式：`[A-Za-z][0-9A-Za-z-:._]*`。
包含使用者提供的全球資料庫叢集識別符。此識別符為可識別全球資料庫的唯一金鑰。
+ **GlobalClusterMembers** – 一個 [GlobalClusterMember](#GlobalClusterMember) 物件陣列。
屬於全球資料庫之所有資料庫叢集的叢集 ARN 和執行個體 ARN 清單。
+ **GlobalClusterResourceId** – 字串，類型為：`string` (UTF-8 編碼的字串)。
全球資料庫的不可變識別符，在所有區域內都是唯一的。此識別碼可在每次存取資料庫叢集的 KMS 金鑰時，於 CloudTrail 日誌項目中找到。
+ **Status** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定此全球資料庫的目前狀態。
+ **StorageEncrypted** – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
全球資料庫的儲存加密設定。
**錯誤**
+ [GlobalClusterNotFoundFault](api-faults.md#GlobalClusterNotFoundFault)
+ [InvalidGlobalClusterStateFault](api-faults.md#InvalidGlobalClusterStateFault)
## ModifyGlobalCluster (動作)
此 API 的 AWS CLI 名稱為：`modify-global-cluster`。
修改 Amazon Neptune 全球叢集的設定。您可以透過在請求中指定這些參數及其新值，來變更一或多個資料庫組態參數。
**請求**
+ **AllowMajorVersionUpgrade** (在 CLI 中:`--allow-major-version-upgrade`) – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
指示是否允許升級主要版本的值。
限制條件：如果您為主要版本與資料庫執行個體目前版本不同的 `EngineVersion` 參數指定一值，則必須允許主要版本升級。
如果您升級全球資料庫的主要版本，叢集和資料庫執行個體參數群組會設定為新版本的預設參數群組，因此您必須在完成升級之後套用任何自訂參數群組。
+ **DeletionProtection** (在 CLI 中:`--deletion-protection`) – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
指示全球資料庫是否已啟用刪除保護。啟用刪除保護時無法刪除全球資料庫。
+ **EngineVersion** (在 CLI 中：`--engine-version`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
您要升級的資料庫引擎版本號碼。變更此參數將會造成中斷。變更會在下一次維護時段期間套用，除非已啟用 `ApplyImmediately`。
若要列出所有可用的 Neptune 引擎版本，請使用以下命令：
**Example**
```
aws neptune describe-db-engine-versions \
--engine neptune \
--query '*[]|[?SupportsGlobalDatabases == 'true'].[EngineVersion]'
```
+ **GlobalClusterIdentifier** (在 CLI 中：`--global-cluster-identifier`) – *必要：*GlobalClusterIdentifier，類型為：`string` (UTF-8 編碼的字串)，不小於 1 或大於 255 ?st?s，符合此規則運算式：`[A-Za-z][0-9A-Za-z-:._]*`。
要修改之全球叢集的資料庫叢集識別符。此參數不區分大小寫。
限制條件：必須符合現有全球資料庫叢集的識別符。
+ **NewGlobalClusterIdentifier** (在 CLI 中：`--new-global-cluster-identifier`) – GlobalClusterIdentifier，類型為：`string` (UTF-8 編碼的字串)，不小於 1 或大於 255 ?st?s，符合此規則運算式：`[A-Za-z][0-9A-Za-z-:._]*`。
要指派給全球資料庫的新叢集識別符。此值會以小寫字母字串的形式儲存。
約束:
+ 必須包含 1 到 63 個字母、數字或連字號。
+ 第一個字元必須是字母。
+ 不能以一個連字號結尾或是連續包含兩個連字號
範例：`my-cluster2`
**回應**
包含 Amazon Neptune 全球資料庫的詳細資訊。
此資料類型會用作 [CreateGlobalCluster (動作)](#CreateGlobalCluster)、[DescribeGlobalClusters (動作)](#DescribeGlobalClusters)、[ModifyGlobalCluster (動作)](#ModifyGlobalCluster)、[DeleteGlobalCluster (動作)](#DeleteGlobalCluster)、[FailoverGlobalCluster (動作)](#FailoverGlobalCluster) 和 [RemoveFromGlobalCluster (動作)](#RemoveFromGlobalCluster) 的回應元素。
+ **DeletionProtection** – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
全球資料庫的刪除保護設定。
+ **Engine** – 字串，類型為：`string` (UTF-8 編碼的字串)。
全球資料庫所使用的 Neptune 資料庫引擎 (`"neptune"`)。
+ **EngineVersion** – 字串，類型為：`string` (UTF-8 編碼的字串)。
全球資料庫所使用的 Neptune 引擎版本。
+ **GlobalClusterArn** – 字串，類型為：`string` (UTF-8 編碼的字串)。
全球資料庫的 Amazon Resource Name (ARN)。
+ **GlobalClusterIdentifier** – GlobalClusterIdentifier，類型為：`string` (UTF-8 編碼的字串)，不小於 1 或大於 255 ?st?s，符合此規則運算式：`[A-Za-z][0-9A-Za-z-:._]*`。
包含使用者提供的全球資料庫叢集識別符。此識別符為可識別全球資料庫的唯一金鑰。
+ **GlobalClusterMembers** – 一個 [GlobalClusterMember](#GlobalClusterMember) 物件陣列。
屬於全球資料庫之所有資料庫叢集的叢集 ARN 和執行個體 ARN 清單。
+ **GlobalClusterResourceId** – 字串，類型為：`string` (UTF-8 編碼的字串)。
全球資料庫的不可變識別符，在所有區域內都是唯一的。此識別碼可在每次存取資料庫叢集的 KMS 金鑰時，於 CloudTrail 日誌項目中找到。
+ **Status** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定此全球資料庫的目前狀態。
+ **StorageEncrypted** – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
全球資料庫的儲存加密設定。
**錯誤**
+ [GlobalClusterNotFoundFault](api-faults.md#GlobalClusterNotFoundFault)
+ [InvalidGlobalClusterStateFault](api-faults.md#InvalidGlobalClusterStateFault)
## DescribeGlobalClusters (動作)
此 API 的 AWS CLI 名稱為：`describe-global-clusters`。
傳回 Neptune 全球資料庫叢集的相關資訊。此 API 支援分頁。
**請求**
+ **GlobalClusterIdentifier** (在 CLI 中：`--global-cluster-identifier`) – GlobalClusterIdentifier，類型為：`string` (UTF-8 編碼的字串)，不小於 1 或大於 255 ?st?s，符合此規則運算式：`[A-Za-z][0-9A-Za-z-:._]*`。
使用者提供的資料庫叢集識別符。如果指定此參數，則只會傳回所指定資料庫叢集的相關資訊。此參數不區分大小寫。
限制條件：如果提供，必須符合現有的資料庫叢集的識別符。
+ **Marker** (在 CLI 中：`--marker`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
(*選用*) 上次呼叫 `DescribeGlobalClusters` 所傳回的分頁權杖。如果指定此參數，則回應只會包含標記以外的記錄，直到 `MaxRecords` 指定的數字為止。
+ **MaxRecords** (在 CLI 中：`--max-records`) – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
要在回應中包含的記錄數量上限。如果存在的記錄比 `MaxRecords` 值指定的更多，則分頁標記權杖會包含在回應中，您可以用來擷取剩餘的結果。
預設：`100`
限制條件：最小 20，最大 100。
**回應**
+ **GlobalClusters** – 一個 [GlobalCluster](#GlobalCluster) 物件陣列。
此請求傳回的全球叢集和執行個體清單。
+ **Marker** – 字串，類型為：`string` (UTF-8 編碼的字串)。
分頁權杖。如果在回應中傳回此參數，則有更多記錄可用，這些記錄可以透過一個或多個對 `DescribeGlobalClusters` 的額外呼叫來擷取 。
**錯誤**
+ [GlobalClusterNotFoundFault](api-faults.md#GlobalClusterNotFoundFault)
## FailoverGlobalCluster (動作)
此 API 的 AWS CLI 名稱為：`failover-global-cluster`。
啟動 Neptune 全球資料庫的容錯移轉程序。
Neptune 全球資料庫的容錯移轉會將其中一個次要唯讀資料庫叢集提升為主要資料庫叢集，並將主要資料庫叢集降級為次要 (唯讀) 資料庫叢集。換句話說，會切換目前主要資料庫叢集和所選目標次要資料庫叢集的角色。選取的次要資料庫叢集會採用 Neptune 全球資料庫的完整讀取/寫入功能。
**注意**
此動作**僅**適用於 Neptune 全球資料庫。此動作旨在用於狀態良好的 Neptune DB 叢集，搭配狀態良好的 Neptune 全球資料庫，且沒有全區域中斷，以測試災難復原案例或重新設定全球資料庫拓撲。
**請求**
+ **GlobalClusterIdentifier** (在 CLI 中：`--global-cluster-identifier`) – *必要：*GlobalClusterIdentifier，類型為：`string` (UTF-8 編碼的字串)，不小於 1 或大於 255 ?st?s，符合此規則運算式：`[A-Za-z][0-9A-Za-z-:._]*`。
應容錯移轉的 Neptune 全球資料庫的識別符。識別符是在建立 Neptune 全球資料庫時，由使用者指派的唯一金鑰。換句話說，它是您要容錯移轉的全球資料庫名稱。
限制條件：必須符合現有 Neptune 全球資料庫的識別符。
+ **TargetDbClusterIdentifier** (在 CLI 中：`--target-db-cluster-identifier`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
次要 Neptune 資料庫叢集的 Amazon Resource Name (ARN)，您想要將此資料庫叢集提升為全球資料庫的主要資料庫叢集。
**回應**
包含 Amazon Neptune 全球資料庫的詳細資訊。
此資料類型會用作 [CreateGlobalCluster (動作)](#CreateGlobalCluster)、[DescribeGlobalClusters (動作)](#DescribeGlobalClusters)、[ModifyGlobalCluster (動作)](#ModifyGlobalCluster)、[DeleteGlobalCluster (動作)](#DeleteGlobalCluster)、[FailoverGlobalCluster (動作)](#FailoverGlobalCluster) 和 [RemoveFromGlobalCluster (動作)](#RemoveFromGlobalCluster) 的回應元素。
+ **DeletionProtection** – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
全球資料庫的刪除保護設定。
+ **Engine** – 字串，類型為：`string` (UTF-8 編碼的字串)。
全球資料庫所使用的 Neptune 資料庫引擎 (`"neptune"`)。
+ **EngineVersion** – 字串，類型為：`string` (UTF-8 編碼的字串)。
全球資料庫所使用的 Neptune 引擎版本。
+ **GlobalClusterArn** – 字串，類型為：`string` (UTF-8 編碼的字串)。
全球資料庫的 Amazon Resource Name (ARN)。
+ **GlobalClusterIdentifier** – GlobalClusterIdentifier，類型為：`string` (UTF-8 編碼的字串)，不小於 1 或大於 255 ?st?s，符合此規則運算式：`[A-Za-z][0-9A-Za-z-:._]*`。
包含使用者提供的全球資料庫叢集識別符。此識別符為可識別全球資料庫的唯一金鑰。
+ **GlobalClusterMembers** – 一個 [GlobalClusterMember](#GlobalClusterMember) 物件陣列。
屬於全球資料庫之所有資料庫叢集的叢集 ARN 和執行個體 ARN 清單。
+ **GlobalClusterResourceId** – 字串，類型為：`string` (UTF-8 編碼的字串)。
全球資料庫的不可變識別符，在所有區域內都是唯一的。此識別碼可在每次存取資料庫叢集的 KMS 金鑰時，於 CloudTrail 日誌項目中找到。
+ **Status** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定此全球資料庫的目前狀態。
+ **StorageEncrypted** – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
全球資料庫的儲存加密設定。
**錯誤**
+ [GlobalClusterNotFoundFault](api-faults.md#GlobalClusterNotFoundFault)
+ [InvalidGlobalClusterStateFault](api-faults.md#InvalidGlobalClusterStateFault)
+ [InvalidDBClusterStateFault](api-faults.md#InvalidDBClusterStateFault)
+ [DBClusterNotFoundFault](api-faults.md#DBClusterNotFoundFault)
## RemoveFromGlobalCluster (動作)
此 API 的 AWS CLI 名稱為：`remove-from-global-cluster`。
從 Neptune 全球資料庫分離 Neptune 資料庫叢集。次要叢集會變成具有讀寫功能而非唯讀功能的一般獨立叢集，且不再從主要叢集接收資料。
**請求**
+ **DbClusterIdentifier** (在 CLI 中：`--db-cluster-identifier`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
識別要從 Neptune 全球資料庫叢集中分離的 Amazon Resource Name (ARN)。
+ **GlobalClusterIdentifier** (在 CLI 中：`--global-cluster-identifier`) – *必要：*GlobalClusterIdentifier，類型為：`string` (UTF-8 編碼的字串)，不小於 1 或大於 255 ?st?s，符合此規則運算式：`[A-Za-z][0-9A-Za-z-:._]*`。
要從中分離所指定 Neptune 資料庫叢集的 Neptune 全球資料庫的識別符。
**回應**
包含 Amazon Neptune 全球資料庫的詳細資訊。
此資料類型會用作 [CreateGlobalCluster (動作)](#CreateGlobalCluster)、[DescribeGlobalClusters (動作)](#DescribeGlobalClusters)、[ModifyGlobalCluster (動作)](#ModifyGlobalCluster)、[DeleteGlobalCluster (動作)](#DeleteGlobalCluster)、[FailoverGlobalCluster (動作)](#FailoverGlobalCluster) 和 [RemoveFromGlobalCluster (動作)](#RemoveFromGlobalCluster) 的回應元素。
+ **DeletionProtection** – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
全球資料庫的刪除保護設定。
+ **Engine** – 字串，類型為：`string` (UTF-8 編碼的字串)。
全球資料庫所使用的 Neptune 資料庫引擎 (`"neptune"`)。
+ **EngineVersion** – 字串，類型為：`string` (UTF-8 編碼的字串)。
全球資料庫所使用的 Neptune 引擎版本。
+ **GlobalClusterArn** – 字串，類型為：`string` (UTF-8 編碼的字串)。
全球資料庫的 Amazon Resource Name (ARN)。
+ **GlobalClusterIdentifier** – GlobalClusterIdentifier，類型為：`string` (UTF-8 編碼的字串)，不小於 1 或大於 255 ?st?s，符合此規則運算式：`[A-Za-z][0-9A-Za-z-:._]*`。
包含使用者提供的全球資料庫叢集識別符。此識別符為可識別全球資料庫的唯一金鑰。
+ **GlobalClusterMembers** – 一個 [GlobalClusterMember](#GlobalClusterMember) 物件陣列。
屬於全球資料庫之所有資料庫叢集的叢集 ARN 和執行個體 ARN 清單。
+ **GlobalClusterResourceId** – 字串，類型為：`string` (UTF-8 編碼的字串)。
全球資料庫的不可變識別符，在所有區域內都是唯一的。此識別碼可在每次存取資料庫叢集的 KMS 金鑰時，於 CloudTrail 日誌項目中找到。
+ **Status** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定此全球資料庫的目前狀態。
+ **StorageEncrypted** – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
全球資料庫的儲存加密設定。
**錯誤**
+ [GlobalClusterNotFoundFault](api-faults.md#GlobalClusterNotFoundFault)
+ [InvalidGlobalClusterStateFault](api-faults.md#InvalidGlobalClusterStateFault)
+ [DBClusterNotFoundFault](api-faults.md#DBClusterNotFoundFault)
## *結構：*
## GlobalCluster (結構)
包含 Amazon Neptune 全球資料庫的詳細資訊。
此資料類型會用作 [CreateGlobalCluster (動作)](#CreateGlobalCluster)、[DescribeGlobalClusters (動作)](#DescribeGlobalClusters)、[ModifyGlobalCluster (動作)](#ModifyGlobalCluster)、[DeleteGlobalCluster (動作)](#DeleteGlobalCluster)、[FailoverGlobalCluster (動作)](#FailoverGlobalCluster) 和 [RemoveFromGlobalCluster (動作)](#RemoveFromGlobalCluster) 的回應元素。
**欄位**
+ **DeletionProtection** – 這是 BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
全球資料庫的刪除保護設定。
+ **Engine** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
全球資料庫所使用的 Neptune 資料庫引擎 (`"neptune"`)。
+ **EngineVersion** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
全球資料庫所使用的 Neptune 引擎版本。
+ **GlobalClusterArn** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
全球資料庫的 Amazon Resource Name (ARN)。
+ **GlobalClusterIdentifier** - 這是 GlobalClusterIdentifier，類型為：`string` (UTF-8 編碼的字串)，不小於 1 或大於 255 ?st?s，符合此規則運算式：`[A-Za-z][0-9A-Za-z-:._]*`。
包含使用者提供的全球資料庫叢集識別符。此識別符為可識別全球資料庫的唯一金鑰。
+ **GlobalClusterMembers** - 這是 [GlobalClusterMember](#GlobalClusterMember) 物件的陣列。
屬於全球資料庫之所有資料庫叢集的叢集 ARN 和執行個體 ARN 清單。
+ **GlobalClusterResourceId** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
全球資料庫的不可變識別符，在所有區域內都是唯一的。此識別碼可在每次存取資料庫叢集的 KMS 金鑰時，於 CloudTrail 日誌項目中找到。
+ **Status** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
指定此全球資料庫的目前狀態。
+ **StorageEncrypted** – 這是 BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
全球資料庫的儲存加密設定。
`GlobalCluster` 會用來做為以下項目的回應元素：
+ [CreateGlobalCluster](#CreateGlobalCluster)
+ [ModifyGlobalCluster](#ModifyGlobalCluster)
+ [DeleteGlobalCluster](#DeleteGlobalCluster)
+ [RemoveFromGlobalCluster](#RemoveFromGlobalCluster)
+ [FailoverGlobalCluster](#FailoverGlobalCluster)
## GlobalClusterMember (結構)
一種資料結構，其中包含與 Neptune 全球資料庫相關聯之任何主要和次要叢集的相關資訊。
**欄位**
+ **DBClusterArn** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
每個 Neptune 叢集的 Amazon Resource Name (ARN)。
+ **IsWriter** - 這是布林值，類型為：`boolean` (布林值 (true 或 false))。
指定 Neptune 叢集是否為與其相關聯之 Neptune 全球資料庫的主要叢集 (亦即，具有讀寫功能)。
+ **Readers** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
與 Neptune 全球資料庫相關聯的每個唯讀次要叢集的 Amazon Resource Name (ARN)。
# 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` \$1 `bring-your-own-license` \$1 `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
有效日：星期一 \$1 星期二 \$1 星期三 \$1 星期四 \$1 星期五 \$1 星期六 \$1 星期日
限制條件：必須至少 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)
# Neptune 參數 API
**動作:**
+ [CopyDBParameterGroup (動作)](#CopyDBParameterGroup)
+ [CopyDBClusterParameterGroup (動作)](#CopyDBClusterParameterGroup)
+ [CreateDBParameterGroup (動作)](#CreateDBParameterGroup)
+ [CreateDBClusterParameterGroup (動作)](#CreateDBClusterParameterGroup)
+ [DeleteDBParameterGroup (動作)](#DeleteDBParameterGroup)
+ [DeleteDBClusterParameterGroup (動作)](#DeleteDBClusterParameterGroup)
+ [ModifyDBParameterGroup (動作)](#ModifyDBParameterGroup)
+ [ModifyDBClusterParameterGroup (動作)](#ModifyDBClusterParameterGroup)
+ [ResetDBParameterGroup (動作)](#ResetDBParameterGroup)
+ [ResetDBClusterParameterGroup (動作)](#ResetDBClusterParameterGroup)
+ [DescribeDBParameters (動作)](#DescribeDBParameters)
+ [DescribeDBParameterGroups (動作)](#DescribeDBParameterGroups)
+ [DescribeDBClusterParameters (動作)](#DescribeDBClusterParameters)
+ [DescribeDBClusterParameterGroups (動作)](#DescribeDBClusterParameterGroups)
+ [DescribeEngineDefaultParameters (動作)](#DescribeEngineDefaultParameters)
+ [DescribeEngineDefaultClusterParameters (動作)](#DescribeEngineDefaultClusterParameters)
**結構：**
+ [Parameter (結構)](#Parameter)
+ [DBParameterGroup (結構)](#DBParameterGroup)
+ [DBClusterParameterGroup (結構)](#DBClusterParameterGroup)
+ [DBParameterGroupStatus (結構)](#DBParameterGroupStatus)
## CopyDBParameterGroup (動作)
此 API 的 AWS CLI 名稱為：`copy-db-parameter-group`。
複製指定的資料庫參數群組。
**請求**
+ **SourceDBParameterGroupIdentifier** (在 CLI 中：`--source-db-parameter-group-identifier`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
來源資料庫參數群組的識別符或 ARN。如需建立 ARN 的資訊，請參閱[建構 Amazon Resource Name (ARN)](https://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html#tagging.ARN.Constructing)。
約束:
+ 必須指定有效的資料庫參數群組。
+ 必須指定有效的資料庫參數群組識別符 (例如 `my-db-param-group`)，或有效的 ARN。
+ **Tags** (在 CLI 中：`--tags`) – [Tag](api-other-apis.md#Tag) 物件的陣列。
要指派給所複製資料庫參數群組的標籤。
+ **TargetDBParameterGroupDescription** (在 CLI 中：`--target-db-parameter-group-description`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
所複製資料庫參數群組的描述。
+ **TargetDBParameterGroupIdentifier** (在 CLI 中：`--target-db-parameter-group-identifier`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
所複製資料庫參數群組的識別符。
約束:
+ 不得為無效、空白或留空。
+ 必須包含 1 到 255 個字母、數字或連字號。
+ 第一個字元必須是字母。
+ 不能以連字號結尾或連續包含兩個連字號。
範例：`my-db-parameter-group`
**回應**
包含 Amazon Neptune 資料庫參數群組的詳細資訊。
此資料類型在 [DescribeDBParameterGroups (動作)](#DescribeDBParameterGroups) 動作中會用來作為回應元素。
+ **DBParameterGroupArn** – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫參數群組的 Amazon Resource Name (ARN)。
+ **DBParameterGroupFamily** – 字串，類型為：`string` (UTF-8 編碼的字串)。
提供此資料庫參數群組相容的資料庫參數群組系列名稱。
+ **DBParameterGroupName** – 字串，類型為：`string` (UTF-8 編碼的字串)。
提供資料庫參數群組的名稱。
+ **Description** – 字串，類型為：`string` (UTF-8 編碼的字串)。
提供此資料庫參數群組的客戶指定描述。
**錯誤**
+ [DBParameterGroupNotFoundFault](api-faults.md#DBParameterGroupNotFoundFault)
+ [DBParameterGroupAlreadyExistsFault](api-faults.md#DBParameterGroupAlreadyExistsFault)
+ [DBParameterGroupQuotaExceededFault](api-faults.md#DBParameterGroupQuotaExceededFault)
## CopyDBClusterParameterGroup (動作)
此 API 的 AWS CLI 名稱為：`copy-db-cluster-parameter-group`。
複製指定的資料庫叢集參數群組。
**請求**
+ **SourceDBClusterParameterGroupIdentifier** (在 CLI 中：`--source-db-cluster-parameter-group-identifier`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
來源資料庫叢集參數群組的識別符或 Amazon Resource Name (ARN)。如需建立 ARN 的資訊，請參閱[建構 Amazon Resource Name (ARN)](https://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html#tagging.ARN.Constructing)。
約束:
+ 必須指定有效的資料庫叢集參數群組。
+ 若來源資料庫叢集參數群組位於和複本相同的 Amazon 區域，請指定有效的資料庫參數群組識別符 (例如 `my-db-cluster-param-group`)，或有效的 ARN。
+ 若來源資料庫參數群組位於和複本不同的 Amazon 區域，請指定有效的資料庫叢集參數群組 ARN (例如 `arn:aws:rds:us-east-1:123456789012:cluster-pg:custom-cluster-group1`)。
+ **Tags** (在 CLI 中：`--tags`) – [Tag](api-other-apis.md#Tag) 物件的陣列。
要指派給所複製資料庫叢集參數群組的標籤。
+ **TargetDBClusterParameterGroupDescription** (在 CLI 中：`--target-db-cluster-parameter-group-description`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
所複製資料庫叢集參數群組的描述。
+ **TargetDBClusterParameterGroupIdentifier** (在 CLI 中：`--target-db-cluster-parameter-group-identifier`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
所複製資料庫叢集參數群組的識別符。
約束:
+ 不可為 null、空白或留空
+ 必須包含 1 到 255 個字母、數字或連字號
+ 第一個字元必須是字母
+ 不能以連字號結尾或連續包含兩個連字號
範例：`my-cluster-param-group1`
**回應**
包含 Amazon Neptune 資料庫叢集參數群組的詳細資訊。
此資料類型在 [DescribeDBClusterParameterGroups (動作)](#DescribeDBClusterParameterGroups) 動作中會用來作為回應元素。
+ **DBClusterParameterGroupArn** – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫叢集參數群組的 Amazon Resource Name (ARN)。
+ **DBClusterParameterGroupName** – 字串，類型為：`string` (UTF-8 編碼的字串)。
提供資料庫叢集參數群組的名稱。
+ **DBParameterGroupFamily** – 字串，類型為：`string` (UTF-8 編碼的字串)。
提供此資料庫叢集參數群組相容的資料庫參數群組系列名稱。
+ **Description** – 字串，類型為：`string` (UTF-8 編碼的字串)。
提供該客戶指定之此資料庫叢集參數群組的描述。
**錯誤**
+ [DBParameterGroupNotFoundFault](api-faults.md#DBParameterGroupNotFoundFault)
+ [DBParameterGroupQuotaExceededFault](api-faults.md#DBParameterGroupQuotaExceededFault)
+ [DBParameterGroupAlreadyExistsFault](api-faults.md#DBParameterGroupAlreadyExistsFault)
## CreateDBParameterGroup (動作)
此 API 的 AWS CLI 名稱為：`create-db-parameter-group`。
建立新的資料庫參數群組。
最初會為資料庫執行個體所使用的資料庫引擎，使用預設參數建立資料庫參數群組。若要為任何參數提供自訂值，您必須在使用 *ModifyDBParameterGroup* 建立它後修改群組。在您建立資料庫參數群組後，您需要使用 *ModifyDBInstance* 將它與您的資料庫執行個體建立關聯。當您將新的資料庫參數群組與執行中的資料庫執行個體建立關聯時，您需要在不使用容錯移轉的情況下重新開機資料庫執行個體，才能讓新的資料庫參數群組和相關聯的設定產生效果。
**重要**
建立資料庫參數群組之後，您至少應等待 5 分鐘，再使用該資料庫參數群組當作預設參數群組，建立第一個資料庫執行個體。這可讓 Amazon Neptune 在將參數群組用來做為新資料庫執行個體的預設前，完成建立動作。這對建立資料庫執行個體預設資料庫時的關鍵參數尤其重要，像是 `character_set_database` 參數所定義之預設資料庫的字元集。您可以使用 Amazon Neptune 主控台的「參數群組」**選項或 *DescribeDBParameters* 命令來驗證您的資料庫參數群組已建立或修改完成。
**請求**
+ **DBParameterGroupFamily** (在 CLI 中：`--db-parameter-group-family`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫參數群組系列名稱。資料庫參數群組可和一個，並且只能和一個資料庫參數群組系列建立關聯，並且只能套用到執行與該資料庫參數群組系列相容資料庫引擎和引擎版本的資料庫執行個體。
+ **DBParameterGroupName** (在 CLI 中：`--db-parameter-group-name`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫參數群組的名稱。
約束:
+ 必須為 1 到 255 個字母、數字或連字號。
+ 第一個字元必須是字母
+ 不能以連字號結尾或連續包含兩個連字號
**注意**
此值會以小寫字母字串的形式儲存。
+ **Description** (在 CLI 中：`--description`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫參數群組的描述。
+ **Tags** (在 CLI 中：`--tags`) – [Tag](api-other-apis.md#Tag) 物件的陣列。
要指派給新資料庫參數群組的標籤。
**回應**
包含 Amazon Neptune 資料庫參數群組的詳細資訊。
此資料類型在 [DescribeDBParameterGroups (動作)](#DescribeDBParameterGroups) 動作中會用來作為回應元素。
+ **DBParameterGroupArn** – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫參數群組的 Amazon Resource Name (ARN)。
+ **DBParameterGroupFamily** – 字串，類型為：`string` (UTF-8 編碼的字串)。
提供此資料庫參數群組相容的資料庫參數群組系列名稱。
+ **DBParameterGroupName** – 字串，類型為：`string` (UTF-8 編碼的字串)。
提供資料庫參數群組的名稱。
+ **Description** – 字串，類型為：`string` (UTF-8 編碼的字串)。
提供此資料庫參數群組的客戶指定描述。
**錯誤**
+ [DBParameterGroupQuotaExceededFault](api-faults.md#DBParameterGroupQuotaExceededFault)
+ [DBParameterGroupAlreadyExistsFault](api-faults.md#DBParameterGroupAlreadyExistsFault)
## CreateDBClusterParameterGroup (動作)
此 API 的 AWS CLI 名稱為：`create-db-cluster-parameter-group`。
建立新的資料庫叢集參數群組。
資料庫叢集參數群組中的參數會套用到資料庫叢集中的所有執行個體。
最初會為資料庫叢集中執行個體所使用的資料庫引擎，使用預設參數建立資料庫叢集參數群組。若要為任何參數提供自訂值，您必須在使用 [ModifyDBClusterParameterGroup (動作)](#ModifyDBClusterParameterGroup) 建立它後修改群組。在您建立資料庫叢集參數群組後，您需要使用 [ModifyDBCluster (動作)](api-clusters.md#ModifyDBCluster) 將它與您的資料庫叢集建立關聯。當您將新的資料庫叢集參數群組與執行中的資料庫叢集建立關聯時，您需要在不使用容錯移轉的情況下重新開機資料庫叢集中的資料庫執行個體，才能讓新的資料庫叢集參數群組和相關聯的設定產生效果。
**重要**
建立資料庫叢集參數群組後，您應等待至少 5 分鐘，然後再建立第一個使用該資料庫叢集參數群組做為預設參數群組的資料庫叢集。這可讓 Amazon Neptune 在將資料庫叢集參數群組用來做為新資料庫叢集的預設前，完成建立動作。這對建立資料庫叢集預設資料庫時的關鍵參數尤其重要，像是 `character_set_database` 參數所定義的預設資料庫字元集。您可以使用 [Amazon Neptune 主控台](https://console.aws.amazon.com/rds/)的「參數群組」**選項或 [DescribeDBClusterParameters (動作)](#DescribeDBClusterParameters) 命令，來驗證是否已建立或修改您的資料庫叢集參數群組。
**請求**
+ **DBClusterParameterGroupName** (在 CLI 中：`--db-cluster-parameter-group-name`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫叢集參數群組的名稱。
約束:
+ 必須符合現有 DBClusterParameterGroup 的名稱。
**注意**
此值會以小寫字母字串的形式儲存。
+ **DBParameterGroupFamily** (在 CLI 中：`--db-parameter-group-family`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫叢集參數群組的系列名稱。資料庫叢集參數群組可和一個，並且只能和一個資料庫叢集參數群組系列建立關聯，並且只能套用到執行與該資料庫叢集參數群組系列相容資料庫引擎和引擎版本的資料庫叢集。
+ **Description** (在 CLI 中：`--description`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫叢集參數群組的描述。
+ **Tags** (在 CLI 中：`--tags`) – [Tag](api-other-apis.md#Tag) 物件的陣列。
要指派給新資料庫叢集參數群組的標籤。
**回應**
包含 Amazon Neptune 資料庫叢集參數群組的詳細資訊。
此資料類型在 [DescribeDBClusterParameterGroups (動作)](#DescribeDBClusterParameterGroups) 動作中會用來作為回應元素。
+ **DBClusterParameterGroupArn** – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫叢集參數群組的 Amazon Resource Name (ARN)。
+ **DBClusterParameterGroupName** – 字串，類型為：`string` (UTF-8 編碼的字串)。
提供資料庫叢集參數群組的名稱。
+ **DBParameterGroupFamily** – 字串，類型為：`string` (UTF-8 編碼的字串)。
提供此資料庫叢集參數群組相容的資料庫參數群組系列名稱。
+ **Description** – 字串，類型為：`string` (UTF-8 編碼的字串)。
提供該客戶指定之此資料庫叢集參數群組的描述。
**錯誤**
+ [DBParameterGroupQuotaExceededFault](api-faults.md#DBParameterGroupQuotaExceededFault)
+ [DBParameterGroupAlreadyExistsFault](api-faults.md#DBParameterGroupAlreadyExistsFault)
## DeleteDBParameterGroup (動作)
此 API 的 AWS CLI 名稱為：`delete-db-parameter-group`。
刪除指定的 DBParameterGroup。要刪除的 DBParameterGroup 不可和任何資料庫執行個體建立關聯。
**請求**
+ **DBParameterGroupName** (在 CLI 中：`--db-parameter-group-name`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫參數群組的名稱。
約束:
+ 必須是現有資料庫參數群組的名稱
+ 您無法刪除預設資料庫參數群組
+ 不可和任何資料庫執行個體建立關聯
**回應**
+ *無回應參數。*
**錯誤**
+ [InvalidDBParameterGroupStateFault](api-faults.md#InvalidDBParameterGroupStateFault)
+ [DBParameterGroupNotFoundFault](api-faults.md#DBParameterGroupNotFoundFault)
## DeleteDBClusterParameterGroup (動作)
此 API 的 AWS CLI 名稱為：`delete-db-cluster-parameter-group`。
刪除指定的資料庫叢集參數群組。要刪除的資料庫叢集參數群組不可和任何資料庫叢集建立關聯。
**請求**
+ **DBClusterParameterGroupName** (在 CLI 中：`--db-cluster-parameter-group-name`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫叢集參數群組的名稱。
約束:
+ 必須是現有資料庫叢集參數群組的名稱。
+ 您無法刪除預設資料庫叢集參數群組。
+ 不可和任何資料庫叢集建立關聯
**回應**
+ *無回應參數。*
**錯誤**
+ [InvalidDBParameterGroupStateFault](api-faults.md#InvalidDBParameterGroupStateFault)
+ [DBParameterGroupNotFoundFault](api-faults.md#DBParameterGroupNotFoundFault)
## ModifyDBParameterGroup (動作)
此 API 的 AWS CLI 名稱為：`modify-db-parameter-group`。
修改資料庫參數群組的參數。若要修改超過一個參數，請提交下列項目的清單：`ParameterName`、`ParameterValue` 和 `ApplyMethod`。單一請求中最多可修改 20 個參數。
**注意**
動態參數的變更會立即套用。對靜態參數進行的變更，需要在不使用容錯移轉至與參數群組關聯資料庫執行個體的情況下重新開機，才能生效。
**重要**
修改資料庫參數群組之後，您應該等待至少5分鐘，然後再建立第一個使用該資料庫參數群組做為預設參數群組的資料庫執行個體。這可讓 Amazon Neptune 在將參數群組用來做為新資料庫執行個體的預設前，完成修改動作。這對建立資料庫執行個體預設資料庫時的關鍵參數尤其重要，像是 `character_set_database` 參數所定義之預設資料庫的字元集。您可以使用 Amazon Neptune 主控台的「參數群組」**選項或 *DescribeDBParameters* 命令來驗證您的資料庫參數群組已建立或修改完成。
**請求**
+ **DBParameterGroupName** (在 CLI 中：`--db-parameter-group-name`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫參數群組的名稱。
約束:
+ 若有提供，則必須符合現有 DBParameterGroup 的名稱。
+ **Parameters** (在 CLI 中：`--parameters`) – *必要：*[參數](#Parameter) 物件的陣列。
參數名稱、值，以及參數更新套用方法的陣列。必須至少提供一個參數名稱、值及套用方法；後續引數都是選用的。單一請求中最多可修改 20 個參數。
有效值 (針對套用方法)：`immediate | pending-reboot`
**注意**
您只能在搭配動態參數時使用 immediate 值。您可以針對動態和靜態參數使用 pending-reboot 值，並且變更會在您不使用容錯移轉重新開機資料庫執行個體時套用。
**回應**
+ **DBParameterGroupName** – 字串，類型為：`string` (UTF-8 編碼的字串)。
提供資料庫參數群組的名稱。
**錯誤**
+ [DBParameterGroupNotFoundFault](api-faults.md#DBParameterGroupNotFoundFault)
+ [InvalidDBParameterGroupStateFault](api-faults.md#InvalidDBParameterGroupStateFault)
## ModifyDBClusterParameterGroup (動作)
此 API 的 AWS CLI 名稱為：`modify-db-cluster-parameter-group`。
修改資料庫叢集參數群組的參數。若要修改超過一個參數，請提交下列項目的清單：`ParameterName`、`ParameterValue` 和 `ApplyMethod`。單一請求中最多可修改 20 個參數。
**注意**
動態參數的變更會立即套用。對靜態參數進行的變更，需要在不使用容錯移轉至與參數群組關聯資料庫叢集的情況下重新開機，才能生效。
**重要**
建立資料庫叢集參數群組後，您應等待至少 5 分鐘，然後再建立第一個使用該資料庫叢集參數群組做為預設參數群組的資料庫叢集。這可讓 Amazon Neptune 在將參數群組用來做為新資料庫叢集的預設前，完成建立動作。這對建立資料庫叢集預設資料庫時的關鍵參數尤其重要，像是 `character_set_database` 參數所定義的預設資料庫字元集。您可以使用 Amazon Neptune 主控台的「參數群組」**選項或 [DescribeDBClusterParameters (動作)](#DescribeDBClusterParameters) 命令來驗證您的資料庫叢集參數群組已建立或修改完成。
**請求**
+ **DBClusterParameterGroupName** (在 CLI 中：`--db-cluster-parameter-group-name`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
欲修改資料庫叢集參數群組的名稱。
+ **Parameters** (在 CLI 中：`--parameters`) – *必要：*[參數](#Parameter) 物件的陣列。
欲修改資料庫叢集參數群組中參數的清單。
**回應**
+ **DBClusterParameterGroupName** – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫叢集參數群組的名稱。
約束:
+ 必須為 1 到 255 個字母或數字。
+ 第一個字元必須是字母
+ 不能以連字號結尾或連續包含兩個連字號
**注意**
此值會以小寫字母字串的形式儲存。
**錯誤**
+ [DBParameterGroupNotFoundFault](api-faults.md#DBParameterGroupNotFoundFault)
+ [InvalidDBParameterGroupStateFault](api-faults.md#InvalidDBParameterGroupStateFault)
## ResetDBParameterGroup (動作)
此 API 的 AWS CLI 名稱為：`reset-db-parameter-group`。
將資料庫參數群組的參數修改為引擎/系統的預設值。若要重設特定參數，請提供下列項目的清單：`ParameterName` 和 `ApplyMethod`。若要重設整個資料庫參數群組，請指定 `DBParameterGroup` 名稱和 `ResetAllParameters` 參數。重設整個群組時，動態參數會立即更新，靜態參數則會設為 `pending-reboot`，並在下一次資料庫執行個體重新啟動或 `RebootDBInstance` 請求時生效。
**請求**
+ **DBParameterGroupName** (在 CLI 中：`--db-parameter-group-name`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫參數群組的名稱。
約束:
+ 必須符合現有 DBParameterGroup 的名稱。
+ **Parameters** (在 CLI 中：`--parameters`) – [參數](#Parameter) 物件的陣列。
若要重設整個資料庫參數群組，請指定 `DBParameterGroup` 名稱和 `ResetAllParameters` 參數。若要重設特定參數，請提供下列項目的清單：`ParameterName` 和 `ApplyMethod`。單一請求中最多可修改 20 個參數。
有效值 (針對套用方法)：`pending-reboot`
+ **ResetAllParameters** (在 CLI 中:`--reset-all-parameters`) – 布林值，類型為：`boolean` (布林值 (true 或 false))。
指定是 (`true`) 否 (`false`) 要將資料庫參數群組中的所有參數重設為預設值。
預設：`true`
**回應**
+ **DBParameterGroupName** – 字串，類型為：`string` (UTF-8 編碼的字串)。
提供資料庫參數群組的名稱。
**錯誤**
+ [InvalidDBParameterGroupStateFault](api-faults.md#InvalidDBParameterGroupStateFault)
+ [DBParameterGroupNotFoundFault](api-faults.md#DBParameterGroupNotFoundFault)
## ResetDBClusterParameterGroup (動作)
此 API 的 AWS CLI 名稱為：`reset-db-cluster-parameter-group`。
將資料庫叢集參數群組的參數修改為預設值。若要重設特定參數，請提交下列項目的清單：`ParameterName` 和 `ApplyMethod`。若要重設整個資料庫叢集參數群組，請指定 `DBClusterParameterGroupName` 名稱和 `ResetAllParameters` 參數。
重設整個群組時，動態參數會立即更新，靜態參數則會設為 `pending-reboot`，並在下一次資料庫執行個體重新啟動或 [RebootDBInstance (動作)](api-instances.md#RebootDBInstance) 請求時生效。您必須為您欲套用更新後靜態參數資料庫叢集中的每個資料庫執行個體呼叫 [RebootDBInstance (動作)](api-instances.md#RebootDBInstance)。
**請求**
+ **DBClusterParameterGroupName** (在 CLI 中：`--db-cluster-parameter-group-name`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
要重設的資料庫叢集參數群組名稱。
+ **Parameters** (在 CLI 中：`--parameters`) – [參數](#Parameter) 物件的陣列。
資料庫叢集參數群組中的參數名稱清單，會將此清單上的參數重設為其預設值。若將 `ResetAllParameters` 參數設為 `true`，您便無法使用此參數。
+ **ResetAllParameters** (在 CLI 中:`--reset-all-parameters`) – 布林值，類型為：`boolean` (布林值 (true 或 false))。
會在將資料庫叢集參數群組中所有參數重設為其預設值時設為 `true` 的值，否則為 `false`。若有為 `Parameters` 參數指定參數名稱清單，您便無法使用此參數。
**回應**
+ **DBClusterParameterGroupName** – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫叢集參數群組的名稱。
約束:
+ 必須為 1 到 255 個字母或數字。
+ 第一個字元必須是字母
+ 不能以連字號結尾或連續包含兩個連字號
**注意**
此值會以小寫字母字串的形式儲存。
**錯誤**
+ [InvalidDBParameterGroupStateFault](api-faults.md#InvalidDBParameterGroupStateFault)
+ [DBParameterGroupNotFoundFault](api-faults.md#DBParameterGroupNotFoundFault)
## DescribeDBParameters (動作)
此 API 的 AWS CLI 名稱為：`describe-db-parameters`。
傳回特定資料庫參數群組的詳細參數清單。
**請求**
+ **DBParameterGroupName** (在 CLI 中：`--db-parameter-group-name`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
要傳回其詳細資訊的特定資料庫參數群組名稱。
約束:
+ 若有提供，則必須符合現有 DBParameterGroup 的名稱。
+ **Filters** (在 CLI 中：`--filters`) – [篩選條件](api-datatypes.md#Filter) 物件的陣列。
目前不支援此參數。
+ **Marker** (在 CLI 中：`--marker`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
前一個 `DescribeDBParameters` 請求提供的選用分頁字符。若指定此參數，則回應只會包含超過標記的記錄，直到 `MaxRecords` 指定的值為止。
+ **MaxRecords** (在 CLI 中：`--max-records`) – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
要在回應中包含的記錄數量上限。若存在的記錄比 `MaxRecords` 值指定的更多，則稱為「標記」的分頁字符會包含在回應中，讓您可以擷取剩餘的結果。
預設：100
限制條件：最小 20，最大 100。
+ **Source** (在 CLI 中：`--source`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
要傳回的參數類型。
預設：傳回所有參數類型。
有效值:`user | system | engine-default`
**回應**
+ **Marker** – 字串，類型為：`string` (UTF-8 編碼的字串)。
前一個請求提供的選用分頁字符。若指定此參數，則回應只會包含超過標記的記錄，直到 `MaxRecords` 指定的值為止。
+ **Parameters** – 一個 [參數](#Parameter) 物件陣列。
[Parameter (結構)](#Parameter) 值的清單。
**錯誤**
+ [DBParameterGroupNotFoundFault](api-faults.md#DBParameterGroupNotFoundFault)
## DescribeDBParameterGroups (動作)
此 API 的 AWS CLI 名稱為：`describe-db-parameter-groups`。
傳回 `DBParameterGroup` 描述的清單。若有指定 `DBParameterGroupName`，則清單只會包含指定資料庫參數群組的描述。
**請求**
+ **DBParameterGroupName** (在 CLI 中：`--db-parameter-group-name`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
要傳回其詳細資訊的特定資料庫參數群組名稱。
約束:
+ 若有提供，則必須符合現有 DBClusterParameterGroup 的名稱。
+ **Filters** (在 CLI 中：`--filters`) – [篩選條件](api-datatypes.md#Filter) 物件的陣列。
目前不支援此參數。
+ **Marker** (在 CLI 中：`--marker`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
前一個 `DescribeDBParameterGroups` 請求提供的選用分頁字符。若指定此參數，則回應只會包含超過標記的記錄，直到 `MaxRecords` 指定的值為止。
+ **MaxRecords** (在 CLI 中：`--max-records`) – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
要在回應中包含的記錄數量上限。若存在的記錄比 `MaxRecords` 值指定的更多，則稱為「標記」的分頁字符會包含在回應中，讓您可以擷取剩餘的結果。
預設：100
限制條件：最小 20，最大 100。
**回應**
+ **DBParameterGroups** – 一個 [DBParameterGroup](#DBParameterGroup) 物件陣列。
[DBParameterGroup (結構)](#DBParameterGroup) 執行個體的清單。
+ **Marker** – 字串，類型為：`string` (UTF-8 編碼的字串)。
前一個請求提供的選用分頁字符。若指定此參數，則回應只會包含超過標記的記錄，直到 `MaxRecords` 指定的值為止。
**錯誤**
+ [DBParameterGroupNotFoundFault](api-faults.md#DBParameterGroupNotFoundFault)
## DescribeDBClusterParameters (動作)
此 API 的 AWS CLI 名稱為：`describe-db-cluster-parameters`。
傳回特定資料庫叢集參數群組的詳細參數清單。
**請求**
+ **DBClusterParameterGroupName** (在 CLI 中：`--db-cluster-parameter-group-name`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
要傳回其參數詳細資訊的特定資料庫叢集參數群組名稱。
約束:
+ 若有提供，則必須符合現有 DBClusterParameterGroup 的名稱。
+ **Filters** (在 CLI 中：`--filters`) – [篩選條件](api-datatypes.md#Filter) 物件的陣列。
目前不支援此參數。
+ **Marker** (在 CLI 中：`--marker`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
前一個 `DescribeDBClusterParameters` 請求提供的選用分頁字符。若指定此參數，則回應只會包含超過標記的記錄，直到 `MaxRecords` 指定的值為止。
+ **MaxRecords** (在 CLI 中：`--max-records`) – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
要在回應中包含的記錄數量上限。若存在的記錄比 `MaxRecords` 值指定的更多，則稱為「標記」的分頁字符會包含在回應中，讓您可以擷取剩餘的結果。
預設：100
限制條件：最小 20，最大 100。
+ **Source** (在 CLI 中：`--source`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
指出只傳回特定來源參數的值。參數來源可以是 `engine`、`service` 或 `customer`。
**回應**
+ **Marker** – 字串，類型為：`string` (UTF-8 編碼的字串)。
前一個 DescribeDBClusterParameters 請求提供的選用分頁字符。若指定此參數，則回應只會包含超過標記的記錄，直到 `MaxRecords` 指定的值為止。
+ **Parameters** – 一個 [參數](#Parameter) 物件陣列。
提供資料庫叢集參數群組的參數清單。
**錯誤**
+ [DBParameterGroupNotFoundFault](api-faults.md#DBParameterGroupNotFoundFault)
## DescribeDBClusterParameterGroups (動作)
此 API 的 AWS CLI 名稱為：`describe-db-cluster-parameter-groups`。
傳回 `DBClusterParameterGroup` 描述的清單。若有指定 `DBClusterParameterGroupName` 參數，則清單只會包含指定資料庫叢集參數群組的描述。
**請求**
+ **DBClusterParameterGroupName** (在 CLI 中：`--db-cluster-parameter-group-name`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
要傳回其詳細資訊的特定資料庫叢集參數群組名稱。
約束:
+ 若有提供，則必須符合現有 DBClusterParameterGroup 的名稱。
+ **Filters** (在 CLI 中：`--filters`) – [篩選條件](api-datatypes.md#Filter) 物件的陣列。
目前不支援此參數。
+ **Marker** (在 CLI 中：`--marker`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
前一個 `DescribeDBClusterParameterGroups` 請求提供的選用分頁字符。若指定此參數，則回應只會包含超過標記的記錄，直到 `MaxRecords` 指定的值為止。
+ **MaxRecords** (在 CLI 中：`--max-records`) – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
要在回應中包含的記錄數量上限。若存在的記錄比 `MaxRecords` 值指定的更多，則稱為「標記」的分頁字符會包含在回應中，讓您可以擷取剩餘的結果。
預設：100
限制條件：最小 20，最大 100。
**回應**
+ **DBClusterParameterGroups** – 一個 [DBClusterParameterGroup](#DBClusterParameterGroup) 物件陣列。
資料庫叢集參數群組的清單。
+ **Marker** – 字串，類型為：`string` (UTF-8 編碼的字串)。
前一個 `DescribeDBClusterParameterGroups` 請求提供的選用分頁字符。若指定此參數，則回應只會包含超過標記的記錄，直到 `MaxRecords` 指定的值為止。
**錯誤**
+ [DBParameterGroupNotFoundFault](api-faults.md#DBParameterGroupNotFoundFault)
## DescribeEngineDefaultParameters (動作)
此 API 的 AWS CLI 名稱為：`describe-engine-default-parameters`。
傳回指定資料庫引擎的預設引擎和系統參數資訊。
**請求**
+ **DBParameterGroupFamily** (在 CLI 中：`--db-parameter-group-family`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫參數群組系列的名稱。
+ **Filters** (在 CLI 中：`--filters`) – [篩選條件](api-datatypes.md#Filter) 物件的陣列。
目前不支援。
+ **Marker** (在 CLI 中：`--marker`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
前一個 `DescribeEngineDefaultParameters` 請求提供的選用分頁字符。若指定此參數，則回應只會包含超過標記的記錄，直到 `MaxRecords` 指定的值為止。
+ **MaxRecords** (在 CLI 中：`--max-records`) – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
要在回應中包含的記錄數量上限。若存在的記錄比 `MaxRecords` 值指定的更多，則稱為「標記」的分頁字符會包含在回應中，讓您可以擷取剩餘的結果。
預設：100
限制條件：最小 20，最大 100。
**回應**
包含成功呼叫 [DescribeEngineDefaultParameters (動作)](#DescribeEngineDefaultParameters) 動作的結果。
+ **DBParameterGroupFamily** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定要套用引擎預設參數的資料庫參數群組系列名稱。
+ **Marker** – 字串，類型為：`string` (UTF-8 編碼的字串)。
前一個 EngineDefaults 請求提供的選用分頁字符。若指定此參數，則回應只會包含超過標記的記錄，直到 `MaxRecords` 指定的值為止。
+ **Parameters** – 一個 [參數](#Parameter) 物件陣列。
包含引擎預設參數的清單。
## DescribeEngineDefaultClusterParameters (動作)
此 API 的 AWS CLI 名稱為：`describe-engine-default-cluster-parameters`。
傳回叢集資料庫引擎的預設引擎和系統參數資訊。
**請求**
+ **DBParameterGroupFamily** (在 CLI 中：`--db-parameter-group-family`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
要傳回其引擎參數資訊的資料庫叢集參數群組系列名稱。
+ **Filters** (在 CLI 中：`--filters`) – [篩選條件](api-datatypes.md#Filter) 物件的陣列。
目前不支援此參數。
+ **Marker** (在 CLI 中：`--marker`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
前一個 `DescribeEngineDefaultClusterParameters` 請求提供的選用分頁字符。若指定此參數，則回應只會包含超過標記的記錄，直到 `MaxRecords` 指定的值為止。
+ **MaxRecords** (在 CLI 中：`--max-records`) – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
要在回應中包含的記錄數量上限。若存在的記錄比 `MaxRecords` 值指定的更多，則稱為「標記」的分頁字符會包含在回應中，讓您可以擷取剩餘的結果。
預設：100
限制條件：最小 20，最大 100。
**回應**
包含成功呼叫 [DescribeEngineDefaultParameters (動作)](#DescribeEngineDefaultParameters) 動作的結果。
+ **DBParameterGroupFamily** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定要套用引擎預設參數的資料庫參數群組系列名稱。
+ **Marker** – 字串，類型為：`string` (UTF-8 編碼的字串)。
前一個 EngineDefaults 請求提供的選用分頁字符。若指定此參數，則回應只會包含超過標記的記錄，直到 `MaxRecords` 指定的值為止。
+ **Parameters** – 一個 [參數](#Parameter) 物件陣列。
包含引擎預設參數的清單。
## *結構：*
## Parameter (結構)
指定參數。
**欄位**
+ **AllowedValues** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
指定參數值的有效範圍。
+ **ApplyMethod** - 這是 ApplyMethod，類型為：`string` (UTF-8 編碼字串)。
指出何時套用參數更新。
+ **ApplyType** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
指定引擎限定的參數類型。
+ **DataType** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
指定參數的有效資料類型。
+ **Description** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
提供參數的描述。
+ **IsModifiable** - 這是布林值，類型為：`boolean` (布林值 (true 或 false))。
指出是 (`true`) 否 (`false`) 可以修改參數。有些參數具有安全或操作上的隱含式，防止他們遭到變更。
+ **MinimumEngineVersion** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
可套用參數的最早引擎版本。
+ **ParameterName** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
指定參數的名稱。
+ **ParameterValue** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
指定參數的值。
+ **Source** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
指出參數值的來源。
## DBParameterGroup (結構)
包含 Amazon Neptune 資料庫參數群組的詳細資訊。
此資料類型在 [DescribeDBParameterGroups (動作)](#DescribeDBParameterGroups) 動作中會用來作為回應元素。
**欄位**
+ **DBParameterGroupArn** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫參數群組的 Amazon Resource Name (ARN)。
+ **DBParameterGroupFamily** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
提供此資料庫參數群組相容的資料庫參數群組系列名稱。
+ **DBParameterGroupName** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
提供資料庫參數群組的名稱。
+ **Description** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
提供此資料庫參數群組的客戶指定描述。
`DBParameterGroup` 會用來做為以下項目的回應元素：
+ [CopyDBParameterGroup](#CopyDBParameterGroup)
+ [CreateDBParameterGroup](#CreateDBParameterGroup)
## DBClusterParameterGroup (結構)
包含 Amazon Neptune 資料庫叢集參數群組的詳細資訊。
此資料類型在 [DescribeDBClusterParameterGroups (動作)](#DescribeDBClusterParameterGroups) 動作中會用來作為回應元素。
**欄位**
+ **DBClusterParameterGroupArn** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫叢集參數群組的 Amazon Resource Name (ARN)。
+ **DBClusterParameterGroupName** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
提供資料庫叢集參數群組的名稱。
+ **DBParameterGroupFamily** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
提供此資料庫叢集參數群組相容的資料庫參數群組系列名稱。
+ **Description** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
提供該客戶指定之此資料庫叢集參數群組的描述。
`DBClusterParameterGroup` 會用來做為以下項目的回應元素：
+ [CopyDBClusterParameterGroup](#CopyDBClusterParameterGroup)
+ [CreateDBClusterParameterGroup](#CreateDBClusterParameterGroup)
## DBParameterGroupStatus (結構)
資料庫參數群組的狀態。
此資料類型在下列動作中會用來做為回應元素：
+ [CreateDBInstance (動作)](api-instances.md#CreateDBInstance)
+ [DeleteDBInstance (動作)](api-instances.md#DeleteDBInstance)
+ [ModifyDBInstance (動作)](api-instances.md#ModifyDBInstance)
+ [RebootDBInstance (動作)](api-instances.md#RebootDBInstance)
**欄位**
+ **DBParameterGroupName** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫參數群組的名稱。
+ **ParameterApplyStatus** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
參數更新的狀態。
# Neptune 子網路 API
**動作:**
+ [CreateDBSubnetGroup (動作)](#CreateDBSubnetGroup)
+ [DeleteDBSubnetGroup (動作)](#DeleteDBSubnetGroup)
+ [ModifyDBSubnetGroup (動作)](#ModifyDBSubnetGroup)
+ [DescribeDBSubnetGroups (動作)](#DescribeDBSubnetGroups)
**結構：**
+ [Subnet (結構)](#Subnet)
+ [DBSubnetGroup (結構)](#DBSubnetGroup)
## CreateDBSubnetGroup (動作)
此 API 的 AWS CLI 名稱為：`create-db-subnet-group`。
建立新的資料庫子網路群組。資料庫子網路群組必須在 Amazon 區域中至少兩個可用區域內包含一個子網路。
**請求**
+ **DBSubnetGroupDescription** (在 CLI 中：`--db-subnet-group-description`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫子網路群組的描述。
+ **DBSubnetGroupName** (在 CLI 中：`--db-subnet-group-name`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫子網路群組的名稱。此值會以小寫字母字串的形式儲存。
限制條件：包含的內容絕不能超過 255 個字母、數字、句號、底線、空格或連字號。絕不能為預設值。
範例：`mySubnetgroup`
+ **SubnetIds** (在 CLI 中：`--subnet-ids`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫子網路群組的 EC2 子網路 ID。
+ **Tags** (在 CLI 中：`--tags`) – [Tag](api-other-apis.md#Tag) 物件的陣列。
要指派給新資料庫子網路群組的標籤。
**回應**
包含 Amazon Neptune 子網路群組的詳細資訊。
此資料類型在 [DescribeDBSubnetGroups (動作)](#DescribeDBSubnetGroups) 動作中會用來作為回應元素。
+ **DBSubnetGroupArn** – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫子網路群組的 Amazon Resource Name (ARN)。
+ **DBSubnetGroupDescription** – 字串，類型為：`string` (UTF-8 編碼的字串)。
提供資料庫子網路群組的描述。
+ **DBSubnetGroupName** – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫子網路群組的名稱。
+ **SubnetGroupStatus** – 字串，類型為：`string` (UTF-8 編碼的字串)。
提供資料庫子網路群組的狀態。
+ **Subnets** – 一個 [子網路](#Subnet) 物件陣列。
包含 [Subnet (結構)](#Subnet) 元素的清單。
+ **VpcId** – 字串，類型為：`string` (UTF-8 編碼的字串)。
提供資料庫子網路群組的 VpcId。
**錯誤**
+ [DBSubnetGroupAlreadyExistsFault](api-faults.md#DBSubnetGroupAlreadyExistsFault)
+ [DBSubnetGroupQuotaExceededFault](api-faults.md#DBSubnetGroupQuotaExceededFault)
+ [DBSubnetQuotaExceededFault](api-faults.md#DBSubnetQuotaExceededFault)
+ [DBSubnetGroupDoesNotCoverEnoughAZs](api-faults.md#DBSubnetGroupDoesNotCoverEnoughAZs)
+ [InvalidSubnet](api-faults.md#InvalidSubnet)
## DeleteDBSubnetGroup (動作)
此 API 的 AWS CLI 名稱為：`delete-db-subnet-group`。
刪除資料庫子網路群組。
**注意**
指定的資料庫子網路群組不能和任何資料庫執行個體建立關聯。
**請求**
+ **DBSubnetGroupName** (在 CLI 中：`--db-subnet-group-name`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
要刪除的資料庫子網路群組名稱。
**注意**
您無法刪除預設子網路群組。
約束:
限制條件：必須符合現有 DBSubnetGroup 的名稱。絕不能為預設值。
範例：`mySubnetgroup`
**回應**
+ *無回應參數。*
**錯誤**
+ [InvalidDBSubnetGroupStateFault](api-faults.md#InvalidDBSubnetGroupStateFault)
+ [InvalidDBSubnetStateFault](api-faults.md#InvalidDBSubnetStateFault)
+ [DBSubnetGroupNotFoundFault](api-faults.md#DBSubnetGroupNotFoundFault)
## ModifyDBSubnetGroup (動作)
此 API 的 AWS CLI 名稱為：`modify-db-subnet-group`。
修改現有的資料庫子網路群組。資料庫子網路群組必須在 Amazon 區域中至少兩個可用區域內包含一個子網路。
**請求**
+ **DBSubnetGroupDescription** (在 CLI 中：`--db-subnet-group-description`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫子網路群組的描述。
+ **DBSubnetGroupName** (在 CLI 中：`--db-subnet-group-name`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫子網路群組的名稱。此值會以小寫字母字串的形式儲存。您無法修改預設子網路群組。
限制條件：必須符合現有 DBSubnetGroup 的名稱。絕不能為預設值。
範例：`mySubnetgroup`
+ **SubnetIds** (在 CLI 中：`--subnet-ids`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫子網路群組的 EC2 子網路 ID。
**回應**
包含 Amazon Neptune 子網路群組的詳細資訊。
此資料類型在 [DescribeDBSubnetGroups (動作)](#DescribeDBSubnetGroups) 動作中會用來作為回應元素。
+ **DBSubnetGroupArn** – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫子網路群組的 Amazon Resource Name (ARN)。
+ **DBSubnetGroupDescription** – 字串，類型為：`string` (UTF-8 編碼的字串)。
提供資料庫子網路群組的描述。
+ **DBSubnetGroupName** – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫子網路群組的名稱。
+ **SubnetGroupStatus** – 字串，類型為：`string` (UTF-8 編碼的字串)。
提供資料庫子網路群組的狀態。
+ **Subnets** – 一個 [子網路](#Subnet) 物件陣列。
包含 [Subnet (結構)](#Subnet) 元素的清單。
+ **VpcId** – 字串，類型為：`string` (UTF-8 編碼的字串)。
提供資料庫子網路群組的 VpcId。
**錯誤**
+ [DBSubnetGroupNotFoundFault](api-faults.md#DBSubnetGroupNotFoundFault)
+ [DBSubnetQuotaExceededFault](api-faults.md#DBSubnetQuotaExceededFault)
+ [SubnetAlreadyInUse](api-faults.md#SubnetAlreadyInUse)
+ [DBSubnetGroupDoesNotCoverEnoughAZs](api-faults.md#DBSubnetGroupDoesNotCoverEnoughAZs)
+ [InvalidSubnet](api-faults.md#InvalidSubnet)
## DescribeDBSubnetGroups (動作)
此 API 的 AWS CLI 名稱為：`describe-db-subnet-groups`。
傳回 DBSubnetGroup 描述的清單。若指定 DBSubnetGroupName，則清單只會包含指定 DBSubnetGroup 的描述。
如需 CIDR 範圍的概觀，請前往 [Wikipedia Tutorial](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)。
**請求**
+ **DBSubnetGroupName** (在 CLI 中：`--db-subnet-group-name`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
要傳回其詳細資訊的資料庫子網路群組名稱。
+ **Filters** (在 CLI 中：`--filters`) – [篩選條件](api-datatypes.md#Filter) 物件的陣列。
目前不支援此參數。
+ **Marker** (在 CLI 中：`--marker`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
前一個 DescribeDBSubnetGroups 請求提供的選用分頁字符。若指定此參數，則回應只會包含超過標記的記錄，直到 `MaxRecords` 指定的值為止。
+ **MaxRecords** (在 CLI 中：`--max-records`) – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
要在回應中包含的記錄數量上限。若存在的記錄比 `MaxRecords` 值指定的更多，則稱為「標記」的分頁字符會包含在回應中，讓您可以擷取剩餘的結果。
預設：100
限制條件：最小 20，最大 100。
**回應**
+ **DBSubnetGroups** – 一個 [DBSubnetGroup](#DBSubnetGroup) 物件陣列。
[DBSubnetGroup (結構)](#DBSubnetGroup) 執行個體的清單。
+ **Marker** – 字串，類型為：`string` (UTF-8 編碼的字串)。
前一個請求提供的選用分頁字符。若指定此參數，則回應只會包含超過標記的記錄，直到 `MaxRecords` 指定的值為止。
**錯誤**
+ [DBSubnetGroupNotFoundFault](api-faults.md#DBSubnetGroupNotFoundFault)
## *結構：*
## Subnet (結構)
指定子網路。
此資料類型在 [DescribeDBSubnetGroups (動作)](#DescribeDBSubnetGroups) 動作中會用來作為回應元素。
**欄位**
+ **SubnetAvailabilityZone** - 這是一個 [AvailabilityZone](api-datatypes.md#AvailabilityZone) 物件。
指定子網路所在的 EC2 可用區域。
+ **SubnetIdentifier** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
指定子網路的識別符。
+ **SubnetStatus** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
指定子網路的狀態。
## DBSubnetGroup (結構)
包含 Amazon Neptune 子網路群組的詳細資訊。
此資料類型在 [DescribeDBSubnetGroups (動作)](#DescribeDBSubnetGroups) 動作中會用來作為回應元素。
**欄位**
+ **DBSubnetGroupArn** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫子網路群組的 Amazon Resource Name (ARN)。
+ **DBSubnetGroupDescription** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
提供資料庫子網路群組的描述。
+ **DBSubnetGroupName** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫子網路群組的名稱。
+ **SubnetGroupStatus** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
提供資料庫子網路群組的狀態。
+ **Subnets** - 這是 [子網路](#Subnet) 物件的陣列。
包含 [Subnet (結構)](#Subnet) 元素的清單。
+ **VpcId** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
提供資料庫子網路群組的 VpcId。
`DBSubnetGroup` 會用來做為以下項目的回應元素：
+ [CreateDBSubnetGroup](#CreateDBSubnetGroup)
+ [ModifyDBSubnetGroup](#ModifyDBSubnetGroup)
# Neptune 快照 API
**動作:**
+ [CreateDBClusterSnapshot (動作)](#CreateDBClusterSnapshot)
+ [DeleteDBClusterSnapshot (動作)](#DeleteDBClusterSnapshot)
+ [CopyDBClusterSnapshot (動作)](#CopyDBClusterSnapshot)
+ [ModifyDBClusterSnapshotAttribute (動作)](#ModifyDBClusterSnapshotAttribute)
+ [RestoreDBClusterFromSnapshot (動作)](#RestoreDBClusterFromSnapshot)
+ [RestoreDBClusterToPointInTime (動作)](#RestoreDBClusterToPointInTime)
+ [DescribeDBClusterSnapshots (動作)](#DescribeDBClusterSnapshots)
+ [DescribeDBClusterSnapshotAttributes (動作)](#DescribeDBClusterSnapshotAttributes)
**結構：**
+ [DBClusterSnapshot (結構)](#DBClusterSnapshot)
+ [DBClusterSnapshotAttribute (結構)](#DBClusterSnapshotAttribute)
+ [DBClusterSnapshotAttributesResult (結構)](#DBClusterSnapshotAttributesResult)
## CreateDBClusterSnapshot (動作)
此 API 的 AWS CLI 名稱為：`create-db-cluster-snapshot`。
建立資料庫叢集的快照。
**請求**
+ **DBClusterIdentifier** (在 CLI 中：`--db-cluster-identifier`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
要建立快照之資料庫叢集的識別符。此參數不區分大小寫。
約束:
+ 必須符合現有 DBCluster 的識別碼。
範例：`my-cluster1`
+ **DBClusterSnapshotIdentifier** (在 CLI 中：`--db-cluster-snapshot-identifier`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫叢集快照的識別符。此參數是以小寫字母字串的形式儲存。
約束:
+ 必須包含 1 到 63 個字母、數字或連字號。
+ 第一個字元必須是字母。
+ 不能以連字號結尾或連續包含兩個連字號。
範例：`my-cluster1-snapshot1`
+ **Tags** (在 CLI 中：`--tags`) – [Tag](api-other-apis.md#Tag) 物件的陣列。
要指派給資料庫叢集快照的標籤。
**回應**
包含 Amazon Neptune 資料庫叢集快照的詳細資訊
此資料類型在 [DescribeDBClusterSnapshots (動作)](#DescribeDBClusterSnapshots) 動作中會用來作為回應元素。
+ **AllocatedStorage** – 整數，類型為：`integer` (帶正負號的 32 位元整數)。
以 GiB 為單位指定分配的儲存體大小。
+ **AvailabilityZones** – 字串，類型為：`string` (UTF-8 編碼的字串)。
提供 EC2 可用區域清單，您可以在此還原資料庫叢集快照中的執行個體。
+ **ClusterCreateTime** – TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
指定建立資料庫叢集的時間，以國際標準時間 (UTC) 表示。
+ **DBClusterIdentifier** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定資料庫叢集的資料庫叢集識別符，此即建立此資料庫叢集快照的資料庫叢集。
+ **DBClusterSnapshotArn** – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫叢集快照的 Amazon Resource Name (ARN)。
+ **DBClusterSnapshotIdentifier** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定資料庫叢集快照的識別碼。必須符合現有快照的識別碼。
使用 `DBClusterSnapshotIdentifier` 還原資料庫叢集之後，您必須為資料庫叢集未來的任何更新指定相同的 `DBClusterSnapshotIdentifier`。當您為更新指定此屬性時，資料庫叢集不會再次從快照還原，且資料庫中的資料不會變更。
不過，如果您未指定 `DBClusterSnapshotIdentifier`，則會建立空的資料庫叢集，並刪除原始資料庫叢集。如果您指定的屬性與先前的快照還原屬性不同，則會從 `DBClusterSnapshotIdentifier` 指定的快照還原資料庫叢集，並刪除原始資料庫叢集。
+ **Engine** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定資料庫引擎的名稱。
+ **EngineVersion** – 字串，類型為：`string` (UTF-8 編碼的字串)。
提供此資料庫叢集快照的資料庫引擎版本。
+ **IAMDatabaseAuthenticationEnabled** – 布林值，類型為：`boolean` (布林值 (true 或 false))。
若有啟用 Amazon Identity and Access Management (IAM) 帳戶對資料庫帳戶的映射，則為 true，否則為 false。
+ **KmsKeyId** – 字串，類型為：`string` (UTF-8 編碼的字串)。
若 `StorageEncrypted` 為 true，則為加密資料庫叢集快照的 Amazon KMS 金鑰識別符。
+ **LicenseModel** – 字串，類型為：`string` (UTF-8 編碼的字串)。
提供此資料庫叢集快照的授權模式資訊。
+ **PercentProgress** – 整數，類型為：`integer` (帶正負號的 32 位元整數)。
指定已傳輸的估計資料百分比。
+ **Port** – 整數，類型為：`integer` (帶正負號的 32 位元整數)。
指定資料庫叢集在快照時接聽的連接埠。
+ **SnapshotCreateTime** – TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
提供快照拍攝的時間，使用供國際標準時間 (UTC)。
+ **SnapshotType** – 字串，類型為：`string` (UTF-8 編碼的字串)。
提供資料庫叢集快照的類型。
+ **SourceDBClusterSnapshotArn** – 字串，類型為：`string` (UTF-8 編碼的字串)。
如果資料庫叢集快照複製自來源資料庫叢集快照，則為來源資料庫叢集快照的 Amazon Resource Name (ARN)，否則為空值。
+ **Status** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定此資料庫叢集快照的狀態。
+ **StorageEncrypted** – 布林值，類型為：`boolean` (布林值 (true 或 false))。
指定資料庫叢集快照是否加密。
+ **StorageType** – 字串，類型為：`string` (UTF-8 編碼的字串)。
與資料庫叢集快照相關聯的儲存類型。
+ **VpcId** – 字串，類型為：`string` (UTF-8 編碼的字串)。
提供與資料庫叢集快照關聯的 VPC ID。
**錯誤**
+ [DBClusterSnapshotAlreadyExistsFault](api-faults.md#DBClusterSnapshotAlreadyExistsFault)
+ [InvalidDBClusterStateFault](api-faults.md#InvalidDBClusterStateFault)
+ [DBClusterNotFoundFault](api-faults.md#DBClusterNotFoundFault)
+ [SnapshotQuotaExceededFault](api-faults.md#SnapshotQuotaExceededFault)
+ [InvalidDBClusterSnapshotStateFault](api-faults.md#InvalidDBClusterSnapshotStateFault)
## DeleteDBClusterSnapshot (動作)
此 API 的 AWS CLI 名稱為：`delete-db-cluster-snapshot`。
刪除資料庫叢集快照。如果正在複製快照，即會終止複製操作。
**注意**
資料庫叢集快照必須為 `available` 狀態才能刪除。
**請求**
+ **DBClusterSnapshotIdentifier** (在 CLI 中：`--db-cluster-snapshot-identifier`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
要刪除之資料庫叢集快照的識別符。
限制條件：必須是 `available` 狀態的現有資料庫叢集快照名稱。
**回應**
包含 Amazon Neptune 資料庫叢集快照的詳細資訊
此資料類型在 [DescribeDBClusterSnapshots (動作)](#DescribeDBClusterSnapshots) 動作中會用來作為回應元素。
+ **AllocatedStorage** – 整數，類型為：`integer` (帶正負號的 32 位元整數)。
以 GiB 為單位指定分配的儲存體大小。
+ **AvailabilityZones** – 字串，類型為：`string` (UTF-8 編碼的字串)。
提供 EC2 可用區域清單，您可以在此還原資料庫叢集快照中的執行個體。
+ **ClusterCreateTime** – TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
指定建立資料庫叢集的時間，以國際標準時間 (UTC) 表示。
+ **DBClusterIdentifier** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定資料庫叢集的資料庫叢集識別符，此即建立此資料庫叢集快照的資料庫叢集。
+ **DBClusterSnapshotArn** – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫叢集快照的 Amazon Resource Name (ARN)。
+ **DBClusterSnapshotIdentifier** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定資料庫叢集快照的識別碼。必須符合現有快照的識別碼。
使用 `DBClusterSnapshotIdentifier` 還原資料庫叢集之後，您必須為資料庫叢集未來的任何更新指定相同的 `DBClusterSnapshotIdentifier`。當您為更新指定此屬性時，資料庫叢集不會再次從快照還原，且資料庫中的資料不會變更。
不過，如果您未指定 `DBClusterSnapshotIdentifier`，則會建立空的資料庫叢集，並刪除原始資料庫叢集。如果您指定的屬性與先前的快照還原屬性不同，則會從 `DBClusterSnapshotIdentifier` 指定的快照還原資料庫叢集，並刪除原始資料庫叢集。
+ **Engine** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定資料庫引擎的名稱。
+ **EngineVersion** – 字串，類型為：`string` (UTF-8 編碼的字串)。
提供此資料庫叢集快照的資料庫引擎版本。
+ **IAMDatabaseAuthenticationEnabled** – 布林值，類型為：`boolean` (布林值 (true 或 false))。
若有啟用 Amazon Identity and Access Management (IAM) 帳戶對資料庫帳戶的映射，則為 true，否則為 false。
+ **KmsKeyId** – 字串，類型為：`string` (UTF-8 編碼的字串)。
若 `StorageEncrypted` 為 true，則為加密資料庫叢集快照的 Amazon KMS 金鑰識別符。
+ **LicenseModel** – 字串，類型為：`string` (UTF-8 編碼的字串)。
提供此資料庫叢集快照的授權模式資訊。
+ **PercentProgress** – 整數，類型為：`integer` (帶正負號的 32 位元整數)。
指定已傳輸的估計資料百分比。
+ **Port** – 整數，類型為：`integer` (帶正負號的 32 位元整數)。
指定資料庫叢集在快照時接聽的連接埠。
+ **SnapshotCreateTime** – TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
提供快照拍攝的時間，使用供國際標準時間 (UTC)。
+ **SnapshotType** – 字串，類型為：`string` (UTF-8 編碼的字串)。
提供資料庫叢集快照的類型。
+ **SourceDBClusterSnapshotArn** – 字串，類型為：`string` (UTF-8 編碼的字串)。
如果資料庫叢集快照複製自來源資料庫叢集快照，則為來源資料庫叢集快照的 Amazon Resource Name (ARN)，否則為空值。
+ **Status** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定此資料庫叢集快照的狀態。
+ **StorageEncrypted** – 布林值，類型為：`boolean` (布林值 (true 或 false))。
指定資料庫叢集快照是否加密。
+ **StorageType** – 字串，類型為：`string` (UTF-8 編碼的字串)。
與資料庫叢集快照相關聯的儲存類型。
+ **VpcId** – 字串，類型為：`string` (UTF-8 編碼的字串)。
提供與資料庫叢集快照關聯的 VPC ID。
**錯誤**
+ [InvalidDBClusterSnapshotStateFault](api-faults.md#InvalidDBClusterSnapshotStateFault)
+ [DBClusterSnapshotNotFoundFault](api-faults.md#DBClusterSnapshotNotFoundFault)
## CopyDBClusterSnapshot (動作)
此 API 的 AWS CLI 名稱為：`copy-db-cluster-snapshot`。
複製資料庫叢集的快照。
若要從共享的手動資料庫叢集快照複製資料庫叢集快照，`SourceDBClusterSnapshotIdentifier` 必須是共享資料庫叢集快照的 Amazon Resource Name (ARN)。
**請求**
+ **CopyTags** (在 CLI 中:`--copy-tags`) – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
True，則將來源資料庫叢集快照的所有標籤複製到目標資料庫叢集快照，否則為 false。預設值為 false。
+ **KmsKeyId** (在 CLI 中：`--kms-key-id`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
已加密資料庫叢集快照的 Amazon KMS 金鑰 ID。KMS 金鑰 ID 是 KMS 加密金鑰的 Amazon Resource Name (ARN)、KMS 金鑰識別符或 KMS 金鑰別名。
如果您從 Amazon 帳戶複製加密的資料庫叢集快照，您可以指定 `KmsKeyId` 的值，以新的 KMS 加密金鑰來加密副本。如果不指定 `KmsKeyId` 的值，則會使用與來源資料庫叢集快照相同的 KMS 金鑰，加密資料庫叢集快照的副本。
如果您複製另一個 Amazon 帳戶所共用的加密資料庫叢集快照，則必須指定 `KmsKeyId` 的值。
KMS 加密金鑰專用於其建立時所在的 Amazon 區域，您無法將一個 Amazon 區域的加密金鑰用在另一個 Amazon 區域。
複製時，您不能加密未加密的資料庫叢集快照。如果您嘗試複製未加密的資料庫叢集快照並指定 KmsKeyId 參數的值，會傳回錯誤。
+ **PreSignedUrl** (在 CLI 中：`--pre-signed-url`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
目前不支援。
+ **SourceDBClusterSnapshotIdentifier** (在 CLI 中：`--source-db-cluster-snapshot-identifier`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
要複製之資料庫叢集快照的識別符。此參數不區分大小寫。
約束:
+ 必須指定「可用」狀態下的有效系統快照。
+ 指定有效的資料庫快照識別符。
範例：`my-cluster-snapshot1`
+ **Tags** (在 CLI 中：`--tags`) – [Tag](api-other-apis.md#Tag) 物件的陣列。
要指派給新資料庫叢集快照副本的標籤。
+ **TargetDBClusterSnapshotIdentifier** (在 CLI 中：`--target-db-cluster-snapshot-identifier`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
要從來源資料庫叢集快照建立之新資料庫叢集快照的識別符。此參數不區分大小寫。
約束:
+ 必須包含 1 到 63 個字母、數字或連字號。
+ 第一個字元必須是字母。
+ 不能以連字號結尾或連續包含兩個連字號。
範例：`my-cluster-snapshot2`
**回應**
包含 Amazon Neptune 資料庫叢集快照的詳細資訊
此資料類型在 [DescribeDBClusterSnapshots (動作)](#DescribeDBClusterSnapshots) 動作中會用來作為回應元素。
+ **AllocatedStorage** – 整數，類型為：`integer` (帶正負號的 32 位元整數)。
以 GiB 為單位指定分配的儲存體大小。
+ **AvailabilityZones** – 字串，類型為：`string` (UTF-8 編碼的字串)。
提供 EC2 可用區域清單，您可以在此還原資料庫叢集快照中的執行個體。
+ **ClusterCreateTime** – TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
指定建立資料庫叢集的時間，以國際標準時間 (UTC) 表示。
+ **DBClusterIdentifier** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定資料庫叢集的資料庫叢集識別符，此即建立此資料庫叢集快照的資料庫叢集。
+ **DBClusterSnapshotArn** – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫叢集快照的 Amazon Resource Name (ARN)。
+ **DBClusterSnapshotIdentifier** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定資料庫叢集快照的識別碼。必須符合現有快照的識別碼。
使用 `DBClusterSnapshotIdentifier` 還原資料庫叢集之後，您必須為資料庫叢集未來的任何更新指定相同的 `DBClusterSnapshotIdentifier`。當您為更新指定此屬性時，資料庫叢集不會再次從快照還原，且資料庫中的資料不會變更。
不過，如果您未指定 `DBClusterSnapshotIdentifier`，則會建立空的資料庫叢集，並刪除原始資料庫叢集。如果您指定的屬性與先前的快照還原屬性不同，則會從 `DBClusterSnapshotIdentifier` 指定的快照還原資料庫叢集，並刪除原始資料庫叢集。
+ **Engine** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定資料庫引擎的名稱。
+ **EngineVersion** – 字串，類型為：`string` (UTF-8 編碼的字串)。
提供此資料庫叢集快照的資料庫引擎版本。
+ **IAMDatabaseAuthenticationEnabled** – 布林值，類型為：`boolean` (布林值 (true 或 false))。
若有啟用 Amazon Identity and Access Management (IAM) 帳戶對資料庫帳戶的映射，則為 true，否則為 false。
+ **KmsKeyId** – 字串，類型為：`string` (UTF-8 編碼的字串)。
若 `StorageEncrypted` 為 true，則為加密資料庫叢集快照的 Amazon KMS 金鑰識別符。
+ **LicenseModel** – 字串，類型為：`string` (UTF-8 編碼的字串)。
提供此資料庫叢集快照的授權模式資訊。
+ **PercentProgress** – 整數，類型為：`integer` (帶正負號的 32 位元整數)。
指定已傳輸的估計資料百分比。
+ **Port** – 整數，類型為：`integer` (帶正負號的 32 位元整數)。
指定資料庫叢集在快照時接聽的連接埠。
+ **SnapshotCreateTime** – TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
提供快照拍攝的時間，使用供國際標準時間 (UTC)。
+ **SnapshotType** – 字串，類型為：`string` (UTF-8 編碼的字串)。
提供資料庫叢集快照的類型。
+ **SourceDBClusterSnapshotArn** – 字串，類型為：`string` (UTF-8 編碼的字串)。
如果資料庫叢集快照複製自來源資料庫叢集快照，則為來源資料庫叢集快照的 Amazon Resource Name (ARN)，否則為空值。
+ **Status** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定此資料庫叢集快照的狀態。
+ **StorageEncrypted** – 布林值，類型為：`boolean` (布林值 (true 或 false))。
指定資料庫叢集快照是否加密。
+ **StorageType** – 字串，類型為：`string` (UTF-8 編碼的字串)。
與資料庫叢集快照相關聯的儲存類型。
+ **VpcId** – 字串，類型為：`string` (UTF-8 編碼的字串)。
提供與資料庫叢集快照關聯的 VPC ID。
**錯誤**
+ [DBClusterSnapshotAlreadyExistsFault](api-faults.md#DBClusterSnapshotAlreadyExistsFault)
+ [DBClusterSnapshotNotFoundFault](api-faults.md#DBClusterSnapshotNotFoundFault)
+ [InvalidDBClusterStateFault](api-faults.md#InvalidDBClusterStateFault)
+ [InvalidDBClusterSnapshotStateFault](api-faults.md#InvalidDBClusterSnapshotStateFault)
+ [SnapshotQuotaExceededFault](api-faults.md#SnapshotQuotaExceededFault)
+ [KMSKeyNotAccessibleFault](api-faults.md#KMSKeyNotAccessibleFault)
## ModifyDBClusterSnapshotAttribute (動作)
此 API 的 AWS CLI 名稱為：`modify-db-cluster-snapshot-attribute`。
在手動資料庫叢集快照中新增或移除屬性和值。
若要與其他 Amazon 帳戶共用手動資料庫叢集快照，請指定 `restore` 做為 `AttributeName`，並使用 `ValuesToAdd` 參數新增 Amazon 帳戶 ID 清單，這些帳戶有權還原手動資料庫叢集快照。使用值 `all` 讓手動資料庫叢集快照成為公有的，這表示所有 Amazon 帳戶都可以複製或還原它。如有不想讓所有 Amazon 帳戶取得的私人資訊，請不要新增任何包含此資訊之手動資料庫叢集快照的 `all` 值。如果手動資料庫叢集快照已加密，它可以共用，但只能透過 `ValuesToAdd` 參數指定授權的 Amazon 帳戶 ID 清單。本例中無法使用 `all` 做為該參數的值。
若要檢視哪些 Amazon 帳戶有權複製或還原手動資料庫叢集快照，或手動資料庫叢集快照為公有或私有，請使用 [DescribeDBClusterSnapshotAttributes (動作)](#DescribeDBClusterSnapshotAttributes) API 動作。
**請求**
+ **AttributeName** (在 CLI 中：`--attribute-name`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
要修改之資料庫叢集快照屬性的名稱。
若要管理其他 Amazon 帳戶的授權，以複製或還原手動資料庫叢集快照，請將此值設定為 `restore`。
+ **DBClusterSnapshotIdentifier** (在 CLI 中：`--db-cluster-snapshot-identifier`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
要修改屬性之資料庫叢集快照的識別符。
+ **ValuesToAdd** (在 CLI 中：`--values-to-add`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫叢集快照屬性清單，新增 `AttributeName` 指定的屬性。
若要授權其他 Amazon 帳戶以複製或還原手動資料庫叢集快照，請設定此清單包含一或多個 Amazon 帳戶 ID，或設為 `all` 讓任何 Amazon 帳戶都能還原手動資料庫叢集快照。如有不想讓所有 Amazon 帳戶取得的私人資訊，請不要新增任何包含此資訊之手動資料庫叢集快照的 `all` 值。
+ **ValuesToRemove** (在 CLI 中：`--values-to-remove`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫叢集快照屬性清單，移除 `AttributeName` 指定的屬性。
若要移除其他 Amazon 帳戶的授權，使無法複製或還原手動資料庫叢集快照，請設定此清單包含一或多個 Amazon 帳戶識別符，或設為 `all` 移除任何 Amazon 帳戶的授權，使不能複製或還原資料庫叢集快照。如果指定 `all`，則帳戶 ID 明確新增至 `restore` 屬性的 Amazon 帳戶，仍然可以複製或還原手動資料庫叢集快照。
**回應**
包含成功呼叫 [DescribeDBClusterSnapshotAttributes (動作)](#DescribeDBClusterSnapshotAttributes) API 動作的結果。
手動資料庫叢集快照屬性是用於授權其他 Amazon 帳戶以複製或還原手動資料庫叢集快照。如需詳細資訊，請參閱 [ModifyDBClusterSnapshotAttribute (動作)](#ModifyDBClusterSnapshotAttribute) API 動作。
+ **DBClusterSnapshotAttributes** – 一個 [DBClusterSnapshotAttribute](#DBClusterSnapshotAttribute) 物件陣列。
手動資料庫叢集快照的屬性和值清單。
+ **DBClusterSnapshotIdentifier** – 字串，類型為：`string` (UTF-8 編碼的字串)。
屬性套用目標之手動資料庫叢集快照的識別符。
**錯誤**
+ [DBClusterSnapshotNotFoundFault](api-faults.md#DBClusterSnapshotNotFoundFault)
+ [InvalidDBClusterSnapshotStateFault](api-faults.md#InvalidDBClusterSnapshotStateFault)
+ [SharedSnapshotQuotaExceededFault](api-faults.md#SharedSnapshotQuotaExceededFault)
## RestoreDBClusterFromSnapshot (動作)
此 API 的 AWS CLI 名稱為：`restore-db-cluster-from-snapshot`。
從資料庫快照或資料庫叢集快照建立新的資料庫叢集。
如已指定資料庫快照，則會從具有預設組態和預設安全群組的來源資料庫快照建立目標資料庫叢集。
如已指定資料庫叢集快照，則會從與原始來源資料庫叢集有相同組態之來源資料庫叢集還原點建立目標資料庫叢集，但新的資料庫叢集使用預設安全群組建立時除外。
**請求**
+ **AvailabilityZones** (在 CLI 中：`--availability-zones`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
提供 EC2 可用區域清單，已還原資料庫叢集中的執行個體可在這些可用區域中建立。
+ **CopyTagsToSnapshot** (在 CLI 中:`--copy-tags-to-snapshot`) – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
*如果設定為 `true`，則會將標籤複製到所建立之已還原資料庫叢集的任何快照。*
+ **DatabaseName** (在 CLI 中：`--database-name`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
不支援。
+ **DBClusterIdentifier** (在 CLI 中：`--db-cluster-identifier`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
要從資料庫快照或資料庫叢集快照建立之資料庫叢集的名稱。此參數沒有大小寫之分。
約束:
+ 必須包含 1 到 63 個字母、數字或連字號
+ 第一個字元必須是字母
+ 不能以連字號結尾或連續包含兩個連字號
範例：`my-snapshot-id`
+ **DBClusterParameterGroupName** (在 CLI 中：`--db-cluster-parameter-group-name`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
要與新資料庫叢集建立關聯的資料庫叢集參數群組名稱。
約束:
+ 若有提供，則必須符合現有 DBClusterParameterGroup 的名稱。
+ **DBSubnetGroupName** (在 CLI 中：`--db-subnet-group-name`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
要用於新資料庫叢集的資料庫子網路群組名稱。
限制條件：若有提供，則必須符合現有 DBSubnetGroup 的名稱。
範例：`mySubnetgroup`
+ **DeletionProtection** (在 CLI 中:`--deletion-protection`) – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
指示資料庫叢集是否已啟用刪除保護的值。啟用刪除保護時無法刪除資料庫。根據預設，刪除保護是停用的。
+ **EnableCloudwatchLogsExports** (在 CLI 中：`--enable-cloudwatch-logs-exports`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
還原的資料庫叢集將匯出到 Amazon CloudWatch Logs 的日誌清單。
+ **EnableIAMDatabaseAuthentication** (在 CLI 中:`--enable-iam-database-authentication`) – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
設為 True 以啟用 Amazon Identity and Access Management (IAM) 帳戶對資料庫帳戶的對應，否則為 false。
預設：`false`
+ **Engine** (在 CLI 中：`--engine`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
要用於新資料庫叢集的資料庫引擎。
預設值：與來源相同
限制：必須與來源引擎相容
+ **EngineVersion** (在 CLI 中：`--engine-version`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
要用於新資料庫叢集的資料庫引擎版本。
+ **KmsKeyId** (在 CLI 中：`--kms-key-id`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
從資料庫快照或資料庫叢集快照還原加密資料庫叢集時要使用的 Amazon KMS 金鑰識別符。
KMS 金鑰識別符是 KMS 加密金鑰的 Amazon Resource Name (ARN)。如果正在還原的資料庫叢集，與擁有用於加密新資料庫叢集之 KMS 加密金鑰有相同的 Amazon 帳戶，則您可使用 KMS 金鑰別名，而非 KMS 加密金鑰的 ARN。
如不指定 `KmsKeyId` 參數值，會發生以下情況：
+ 如已加密 `SnapshotIdentifier` 中的資料庫快照或資料庫叢集快照，則會使用用來加密資料庫快照或資料庫叢集快照的 KMS 金鑰，加密還原的資料庫叢集。
+ 如未加密 `SnapshotIdentifier` 中的資料庫快照或資料庫叢集快照，則不加密還原的資料庫叢集。
+ **Port** (在 CLI 中：`--port`) – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
新資料庫叢集接受連線的連接埠號碼。
限制條件：值必須為 `1150-65535`
預設值：與原始資料庫叢集相同的連接埠。
+ **ServerlessV2ScalingConfiguration** (在 CLI 中：`--serverless-v2-scaling-configuration`) – [ServerlessV2ScalingConfiguration](api-datatypes.md#ServerlessV2ScalingConfiguration) 物件。
包含 Neptune Serverless 資料庫叢集的擴展組態。
如需詳細資訊，請參閱《Amazon Neptune 使用者指南》**中的[使用 Amazon Neptune Serverless](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html)。
+ **SnapshotIdentifier** (在 CLI 中：`--snapshot-identifier`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
還原來源的資料庫快照或資料庫叢集快照識別碼。
您可以使用名稱或 Amazon Resource Name (ARN) 指定資料庫叢集快照。不過，您只能使用 ARN 指定資料庫快照。
約束:
+ 必須符合現有快照的識別碼。
+ **StorageType** (在 CLI 中：`--storage-type`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定要和資料庫叢集建立關聯的儲存類型。
有效值：`standard`、`iopt1`
預設：`standard`
+ **Tags** (在 CLI 中：`--tags`) – [Tag](api-other-apis.md#Tag) 物件的陣列。
要指派給已還原資料庫叢集的標籤。
+ **VpcSecurityGroupIds** (在 CLI 中：`--vpc-security-group-ids`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
新資料庫叢集將歸屬之 VPC 安全群組清單。
**回應**
包含 Amazon Neptune 資料庫叢集的詳細資訊。
此資料類型會在 [DescribeDBClusters (動作)](api-clusters.md#DescribeDBClusters) 動作中用作回應元素。
+ **AllocatedStorage** – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
`AllocatedStorage` 一律會傳回 1，因為 Neptune 資料庫叢集儲存體大小並非固定，而是會視需要自動調整。
+ **AssociatedRoles** – 一個 [DBClusterRole](api-clusters.md#DBClusterRole) 物件陣列。
提供與資料庫叢集相關聯的 Amazon Identity and Access Management (IAM) 角色清單。與資料庫叢集相關聯的 IAM 角色，會授予資料庫叢集代您存取其他 Amazon 服務的許可。
+ **AutomaticRestartTime** – TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
資料庫叢集將自動重新啟動的時間。
+ **AvailabilityZones** – 字串，類型為：`string` (UTF-8 編碼的字串)。
提供可在其中建立資料庫叢集內執行個體的 EC2 可用區域清單。
+ **BacktrackConsumedChangeRecords** - LongOptional，類型為：`long` (帶正負號的 64 位元整數)。
Neptune 不提供支援。
+ **BacktrackWindow** - LongOptional，類型為：`long` (帶正負號的 64 位元整數)。
Neptune 不提供支援。
+ **BackupRetentionPeriod** – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
指定保留自動資料庫快照的天數。
+ **Capacity** – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
Neptune 不提供支援。
+ **CloneGroupId** – 字串，類型為：`string` (UTF-8 編碼的字串)。
識別與資料庫叢集建立關聯的複製群組。
+ **ClusterCreateTime** – TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
指定建立資料庫叢集的時間，以國際標準時間 (UTC) 表示。
+ **CopyTagsToSnapshot** – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
*如果設定為 `true`，則會將標籤複製到所建立之資料庫叢集的任何快照。*
+ **CrossAccountClone** – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
如果設定為 `true`，則可跨帳戶複製資料庫叢集。
+ **DatabaseName** – 字串，類型為：`string` (UTF-8 編碼的字串)。
包含此資料庫叢集初始資料庫的名稱，該資料庫是在建立時提供的 (若建立資料庫叢集時有指定的話)。在資料庫叢集使用期間，會傳回此名稱。
+ **DBClusterArn** – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫叢集的 Amazon Resource Name (ARN)。
+ **DBClusterIdentifier** – 字串，類型為：`string` (UTF-8 編碼的字串)。
包含使用者提供的資料庫叢集識別碼。此識別碼為可識別資料庫叢集的唯一金鑰。
+ **DBClusterMembers** – 一個 [DBClusterMember](api-clusters.md#DBClusterMember) 物件陣列。
提供組成資料庫叢集的執行個體清單。
+ **DBClusterParameterGroup** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定資料庫叢集的資料庫叢集參數群組名稱。
+ **DbClusterResourceId** – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫叢集的 Amazon 區域唯一、固定識別符。此識別符可在每次存取資料庫叢集的 Amazon KMS 金鑰時，於 Amazon CloudTrail 日誌項目中找到。
+ **DBSubnetGroup** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定與資料庫叢集建立關聯子網路群組的資訊，包括名稱、描述，以及子網路群組中的子網路。
+ **DeletionProtection** – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
指示資料庫叢集是否已啟用刪除保護。啟用刪除保護時無法刪除資料庫。
+ **EarliestBacktrackTime** – TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
Neptune 不提供支援。
+ **EarliestRestorableTime** – TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
指定可透過 point-in-time 還原還原資料庫的最早時間。
+ **EnabledCloudwatchLogsExports** – 字串，類型為：`string` (UTF-8 編碼的字串)。
此資料庫叢集已設為匯出至 CloudWatch Logs 的日誌類型清單。有效的日誌類型為：`audit` (用來將稽核日誌發佈至 CloudWatch) 和 slowquery (用來將慢查詢日誌發佈至 CloudWatch)。請參閱[將 Neptune 日誌發佈至 Amazon CloudWatch Logs](https://docs.aws.amazon.com/neptune/latest/userguide/cloudwatch-logs.html)。
+ **Endpoint** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定資料庫叢集主要執行個體的連線端點。
+ **Engine** – 字串，類型為：`string` (UTF-8 編碼的字串)。
提供要用於此資料庫叢集的資料庫引擎名稱。
+ **EngineVersion** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指示資料庫引擎版本。
+ **GlobalClusterIdentifier** – GlobalClusterIdentifier，類型為：`string` (UTF-8 編碼的字串)，不小於 1 或大於 255 ?st?s，符合此規則運算式：`[A-Za-z][0-9A-Za-z-:._]*`。
包含使用者提供的全球資料庫叢集識別符。此識別符為可識別全球資料庫的唯一金鑰。
+ **HostedZoneId** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定當您建立託管區域時，Amazon Route 53 指派的 ID。
+ **IAMDatabaseAuthenticationEnabled** – 布林值，類型為：`boolean` (布林值 (true 或 false))。
若有啟用 Amazon Identity and Access Management (IAM) 帳戶對資料庫帳戶的映射，則為 true，否則為 false。
+ **IOOptimizedNextAllowedModificationTime** – TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
下次您可以修改資料庫叢集以使用 `iopt1` 儲存類型。
+ **KmsKeyId** – 字串，類型為：`string` (UTF-8 編碼的字串)。
若 `StorageEncrypted` 為 true，則為加密資料庫叢集的 Amazon KMS 金鑰識別碼。
+ **LatestRestorableTime** – TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
指定可透過 point-in-time 還原還原資料庫的最新時間。
+ **MultiAZ** – 布林值，類型為：`boolean` (布林值 (true 或 false))。
指定資料庫叢集是否在多個可用區域中擁有執行個體。
+ **PendingModifiedValues** – [ClusterPendingModifiedValues](api-clusters.md#ClusterPendingModifiedValues) 物件。
此資料類型會在 `ModifyDBCluster` 操作中用作回應元素，並包含將在下一個維護時段期間套用的變更。
+ **PercentProgress** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定操作的進度 (百分比)。
+ **Port** – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
指定資料庫引擎接聽的連接埠。
+ **PreferredBackupWindow** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定每日的時間範圍，若有啟用自動化備份 (由 `BackupRetentionPeriod` 決定)，則自動化備份會在此期間建立。
+ **PreferredMaintenanceWindow** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定每週可能進行系統維護的時段，以世界協調時間 (UTC) 表示。
+ **ReaderEndpoint** – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫叢集的讀取器端點。資料庫叢集的讀取器端點，用來針對資料庫叢集中可用僅供讀取複本的連線進行負載平衡。當用戶端向讀取器端點請求新連線時，Neptune 會在資料庫叢集中的僅供讀取複本間分散連線請求。此功能有助於在您資料庫叢集中的多個僅供讀取複本間平衡您的讀取工作負載。
若發生容錯移轉，且您連線的僅供讀取複本提升為主要執行個體，則會中斷您的連線。若要繼續將您的讀取工作負載傳送到叢集內的其他僅供讀取複本，您可以接著重新連線到讀取器端點。
+ **ReadReplicaIdentifiers** – 字串，類型為：`string` (UTF-8 編碼的字串)。
包含與此資料庫叢集相關聯的一或多個僅供讀取複本識別符。
+ **ReplicationSourceIdentifier** – 字串，類型為：`string` (UTF-8 編碼的字串)。
Neptune 不提供支援。
+ **ReplicationType** – 字串，類型為：`string` (UTF-8 編碼的字串)。
Neptune 不提供支援。
+ **ServerlessV2ScalingConfiguration** – [ServerlessV2ScalingConfigurationInfo](api-datatypes.md#ServerlessV2ScalingConfigurationInfo) 物件。
顯示 Neptune Serverless 資料庫叢集的擴展組態。
如需詳細資訊，請參閱《Amazon Neptune 使用者指南》**中的[使用 Amazon Neptune Serverless](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html)。
+ **Status** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定此資料庫叢集的目前狀態。
+ **StorageEncrypted** – 布林值，類型為：`boolean` (布林值 (true 或 false))。
指定是否要加密資料庫叢集。
+ **StorageType** – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫叢集使用的儲存類型。
有效值：
+ **`standard`** – (*預設值*) 針對具有中至低 I/O 使用量的應用程式提供具成本效益的資料庫儲存體。
+ **`iopt1`** – 啟用 [I/O 優化儲存](https://docs.aws.amazon.com/neptune/latest/userguide/storage-types.html#provisioned-iops-storage)，旨在符合 I/O 密集型圖形工作負載的需求，而這些工作負載則需要可預測的定價、低 I/O 延遲和一致的 I/O 輸送量。
僅引擎版本 1.3.0.0 開始提供 Neptune I/O 優化儲存。
+ **VpcSecurityGroups** – 一個 [VpcSecurityGroupMembership](api-datatypes.md#VpcSecurityGroupMembership) 物件陣列。
提供資料庫叢集歸屬的 VPC 安全群組清單。
**錯誤**
+ [DBClusterAlreadyExistsFault](api-faults.md#DBClusterAlreadyExistsFault)
+ [DBClusterQuotaExceededFault](api-faults.md#DBClusterQuotaExceededFault)
+ [StorageQuotaExceededFault](api-faults.md#StorageQuotaExceededFault)
+ [DBSubnetGroupNotFoundFault](api-faults.md#DBSubnetGroupNotFoundFault)
+ [DBSnapshotNotFoundFault](api-faults.md#DBSnapshotNotFoundFault)
+ [DBClusterSnapshotNotFoundFault](api-faults.md#DBClusterSnapshotNotFoundFault)
+ [InsufficientDBClusterCapacityFault](api-faults.md#InsufficientDBClusterCapacityFault)
+ [InsufficientStorageClusterCapacityFault](api-faults.md#InsufficientStorageClusterCapacityFault)
+ [InvalidDBSnapshotStateFault](api-faults.md#InvalidDBSnapshotStateFault)
+ [InvalidDBClusterSnapshotStateFault](api-faults.md#InvalidDBClusterSnapshotStateFault)
+ [StorageQuotaExceededFault](api-faults.md#StorageQuotaExceededFault)
+ [InvalidVPCNetworkStateFault](api-faults.md#InvalidVPCNetworkStateFault)
+ [InvalidRestoreFault](api-faults.md#InvalidRestoreFault)
+ [DBSubnetGroupNotFoundFault](api-faults.md#DBSubnetGroupNotFoundFault)
+ [InvalidSubnet](api-faults.md#InvalidSubnet)
+ [OptionGroupNotFoundFault](api-faults.md#OptionGroupNotFoundFault)
+ [KMSKeyNotAccessibleFault](api-faults.md#KMSKeyNotAccessibleFault)
+ [DBClusterParameterGroupNotFoundFault](api-faults.md#DBClusterParameterGroupNotFoundFault)
## RestoreDBClusterToPointInTime (動作)
此 API 的 AWS CLI 名稱為：`restore-db-cluster-to-point-in-time`。
將資料庫叢集還原到任意時間點。使用者可以還原到 `LatestRestorableTime` 之前的任意時間點，最多 `BackupRetentionPeriod` 天。目標資料庫叢集使用與原始資料庫叢集有相同組態之來源資料庫叢集建立，但新的資料庫叢集使用預設資料庫安全群組建立時除外。
**注意**
這個動作只會還原資料庫叢集，不會還原該資料庫叢集的資料庫執行個體。您必須呼叫 [CreateDBInstance (動作)](api-instances.md#CreateDBInstance) 動作，為還原的資料庫叢集建立資料庫執行個體，並且在 `DBClusterIdentifier` 中指定所還原資料庫叢集的識別符。只有在 `RestoreDBClusterToPointInTime` 動作完成後，且資料庫叢集為可用時，您才能建立資料庫執行個體。
**請求**
+ **DBClusterIdentifier** (在 CLI 中：`--db-cluster-identifier`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
要建立之新資料庫叢集的名稱。
約束:
+ 必須包含 1 到 63 個字母、數字或連字號
+ 第一個字元必須是字母
+ 不能以連字號結尾或連續包含兩個連字號
+ **DBClusterParameterGroupName** (在 CLI 中：`--db-cluster-parameter-group-name`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
要與新資料庫叢集建立關聯的資料庫叢集參數群組名稱。
約束:
+ 若有提供，則必須符合現有 DBClusterParameterGroup 的名稱。
+ **DBSubnetGroupName** (在 CLI 中：`--db-subnet-group-name`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
要用於新資料庫叢集的資料庫子網路群組名稱。
限制條件：若有提供，則必須符合現有 DBSubnetGroup 的名稱。
範例：`mySubnetgroup`
+ **DeletionProtection** (在 CLI 中:`--deletion-protection`) – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
指示資料庫叢集是否已啟用刪除保護的值。啟用刪除保護時無法刪除資料庫。根據預設，刪除保護是停用的。
+ **EnableCloudwatchLogsExports** (在 CLI 中：`--enable-cloudwatch-logs-exports`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
還原的資料庫叢集將匯出到 CloudWatch Logs 的日誌清單。
+ **EnableIAMDatabaseAuthentication** (在 CLI 中:`--enable-iam-database-authentication`) – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
設為 True 以啟用 Amazon Identity and Access Management (IAM) 帳戶對資料庫帳戶的對應，否則為 false。
預設：`false`
+ **KmsKeyId** (在 CLI 中：`--kms-key-id`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
從加密資料庫叢集還原加密資料庫叢集時要使用的 Amazon KMS 金鑰識別符。
KMS 金鑰識別符是 KMS 加密金鑰的 Amazon Resource Name (ARN)。如果正在還原的資料庫叢集，與擁有用於加密新資料庫叢集之 KMS 加密金鑰有相同的 Amazon 帳戶，則您可使用 KMS 金鑰別名，而非 KMS 加密金鑰的 ARN。
您可還原至新的資料庫叢集，並使用和加密來源資料庫叢集不同的 KMS 金鑰，加密新的資料庫叢集。新資料庫叢集使用 `KmsKeyId` 參數識別的 KMS 金鑰加密。
如不指定 `KmsKeyId` 參數值，會發生以下情況：
+ 如已加密資料庫叢集，則已還原的資料庫叢集會使用加密來源資料庫叢集的 KMS 金鑰加密。
+ 如未加密資料庫叢集，則不會加密已還原的資料庫叢集。
如果 `DBClusterIdentifier` 是指未加密的資料庫叢集，則拒絕還原請求。
+ **Port** (在 CLI 中：`--port`) – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
新資料庫叢集接受連線的連接埠號碼。
限制條件：值必須為 `1150-65535`
預設值：與原始資料庫叢集相同的連接埠。
+ **RestoreToTime** (在 CLI 中：`--restore-to-time`) – TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
將資料庫叢集還原至此日期和時間。
有效值：值必須為國際標準時間 (UTC) 格式的時間
約束:
+ 必須在資料庫執行個體最近一次可還原時間之前。
+ 如未提供 `UseLatestRestorableTime` 參數，則必須指定。
+ 如果 `UseLatestRestorableTime` 參數為 true，則無法指定
+ 如果 `RestoreType` 參數為 `copy-on-write`，則無法指定
範例：`2015-03-07T23:45:00Z`
+ **RestoreType** (在 CLI 中：`--restore-type`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
要執行的還原類型。您可以指定下列其中一個值：
+ `full-copy` - 新資料庫叢集將還原為來源資料庫叢集的完整複本。
+ `copy-on-write` - 新資料庫叢集將還原為來源資料庫叢集的複製品。
如果您不指定 `RestoreType` 值，則新資料庫叢集會還原為來源資料庫叢集的完整複本。
+ **ServerlessV2ScalingConfiguration** (在 CLI 中：`--serverless-v2-scaling-configuration`) – [ServerlessV2ScalingConfiguration](api-datatypes.md#ServerlessV2ScalingConfiguration) 物件。
包含 Neptune Serverless 資料庫叢集的擴展組態。
如需詳細資訊，請參閱《Amazon Neptune 使用者指南》**中的[使用 Amazon Neptune Serverless](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html)。
+ **SourceDBClusterIdentifier** (在 CLI 中：`--source-db-cluster-identifier`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
還原來源之來源資料庫叢集的識別符。
約束:
+ 必須符合現有 DBCluster 的識別碼。
+ **StorageType** (在 CLI 中：`--storage-type`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定要和資料庫叢集建立關聯的儲存類型。
有效值：`standard`、`iopt1`
預設：`standard`
+ **Tags** (在 CLI 中：`--tags`) – [Tag](api-other-apis.md#Tag) 物件的陣列。
要套用到已還原資料庫叢集的標籤。
+ **UseLatestRestorableTime** (在 CLI 中:`--use-latest-restorable-time`) – 布林值，類型為：`boolean` (布林值 (true 或 false))。
值設定為 `true` 可將資料庫叢集還原到最近可還原的備份時間，否則為 `false`。
預設：`false`
限制條件：如果提供 `RestoreToTime` 參數，則無法指定。
+ **VpcSecurityGroupIds** (在 CLI 中：`--vpc-security-group-ids`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
新資料庫叢集所屬之 VPC 安全群組清單。
**回應**
包含 Amazon Neptune 資料庫叢集的詳細資訊。
此資料類型會在 [DescribeDBClusters (動作)](api-clusters.md#DescribeDBClusters) 動作中用作回應元素。
+ **AllocatedStorage** – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
`AllocatedStorage` 一律會傳回 1，因為 Neptune 資料庫叢集儲存體大小並非固定，而是會視需要自動調整。
+ **AssociatedRoles** – 一個 [DBClusterRole](api-clusters.md#DBClusterRole) 物件陣列。
提供與資料庫叢集相關聯的 Amazon Identity and Access Management (IAM) 角色清單。與資料庫叢集相關聯的 IAM 角色，會授予資料庫叢集代您存取其他 Amazon 服務的許可。
+ **AutomaticRestartTime** – TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
資料庫叢集將自動重新啟動的時間。
+ **AvailabilityZones** – 字串，類型為：`string` (UTF-8 編碼的字串)。
提供可在其中建立資料庫叢集內執行個體的 EC2 可用區域清單。
+ **BacktrackConsumedChangeRecords** - LongOptional，類型為：`long` (帶正負號的 64 位元整數)。
Neptune 不提供支援。
+ **BacktrackWindow** - LongOptional，類型為：`long` (帶正負號的 64 位元整數)。
Neptune 不提供支援。
+ **BackupRetentionPeriod** – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
指定保留自動資料庫快照的天數。
+ **Capacity** – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
Neptune 不提供支援。
+ **CloneGroupId** – 字串，類型為：`string` (UTF-8 編碼的字串)。
識別與資料庫叢集建立關聯的複製群組。
+ **ClusterCreateTime** – TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
指定建立資料庫叢集的時間，以國際標準時間 (UTC) 表示。
+ **CopyTagsToSnapshot** – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
*如果設定為 `true`，則會將標籤複製到所建立之資料庫叢集的任何快照。*
+ **CrossAccountClone** – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
如果設定為 `true`，則可跨帳戶複製資料庫叢集。
+ **DatabaseName** – 字串，類型為：`string` (UTF-8 編碼的字串)。
包含此資料庫叢集初始資料庫的名稱，該資料庫是在建立時提供的 (若建立資料庫叢集時有指定的話)。在資料庫叢集使用期間，會傳回此名稱。
+ **DBClusterArn** – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫叢集的 Amazon Resource Name (ARN)。
+ **DBClusterIdentifier** – 字串，類型為：`string` (UTF-8 編碼的字串)。
包含使用者提供的資料庫叢集識別碼。此識別碼為可識別資料庫叢集的唯一金鑰。
+ **DBClusterMembers** – 一個 [DBClusterMember](api-clusters.md#DBClusterMember) 物件陣列。
提供組成資料庫叢集的執行個體清單。
+ **DBClusterParameterGroup** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定資料庫叢集的資料庫叢集參數群組名稱。
+ **DbClusterResourceId** – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫叢集的 Amazon 區域唯一、固定識別符。此識別符可在每次存取資料庫叢集的 Amazon KMS 金鑰時，於 Amazon CloudTrail 日誌項目中找到。
+ **DBSubnetGroup** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定與資料庫叢集建立關聯子網路群組的資訊，包括名稱、描述，以及子網路群組中的子網路。
+ **DeletionProtection** – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
指示資料庫叢集是否已啟用刪除保護。啟用刪除保護時無法刪除資料庫。
+ **EarliestBacktrackTime** – TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
Neptune 不提供支援。
+ **EarliestRestorableTime** – TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
指定可透過 point-in-time 還原還原資料庫的最早時間。
+ **EnabledCloudwatchLogsExports** – 字串，類型為：`string` (UTF-8 編碼的字串)。
此資料庫叢集已設為匯出至 CloudWatch Logs 的日誌類型清單。有效的日誌類型為：`audit` (用來將稽核日誌發佈至 CloudWatch) 和 slowquery (用來將慢查詢日誌發佈至 CloudWatch)。請參閱[將 Neptune 日誌發佈至 Amazon CloudWatch Logs](https://docs.aws.amazon.com/neptune/latest/userguide/cloudwatch-logs.html)。
+ **Endpoint** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定資料庫叢集主要執行個體的連線端點。
+ **Engine** – 字串，類型為：`string` (UTF-8 編碼的字串)。
提供要用於此資料庫叢集的資料庫引擎名稱。
+ **EngineVersion** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指示資料庫引擎版本。
+ **GlobalClusterIdentifier** – GlobalClusterIdentifier，類型為：`string` (UTF-8 編碼的字串)，不小於 1 或大於 255 ?st?s，符合此規則運算式：`[A-Za-z][0-9A-Za-z-:._]*`。
包含使用者提供的全球資料庫叢集識別符。此識別符為可識別全球資料庫的唯一金鑰。
+ **HostedZoneId** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定當您建立託管區域時，Amazon Route 53 指派的 ID。
+ **IAMDatabaseAuthenticationEnabled** – 布林值，類型為：`boolean` (布林值 (true 或 false))。
若有啟用 Amazon Identity and Access Management (IAM) 帳戶對資料庫帳戶的映射，則為 true，否則為 false。
+ **IOOptimizedNextAllowedModificationTime** – TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
下次您可以修改資料庫叢集以使用 `iopt1` 儲存類型。
+ **KmsKeyId** – 字串，類型為：`string` (UTF-8 編碼的字串)。
若 `StorageEncrypted` 為 true，則為加密資料庫叢集的 Amazon KMS 金鑰識別碼。
+ **LatestRestorableTime** – TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
指定可透過 point-in-time 還原還原資料庫的最新時間。
+ **MultiAZ** – 布林值，類型為：`boolean` (布林值 (true 或 false))。
指定資料庫叢集是否在多個可用區域中擁有執行個體。
+ **PendingModifiedValues** – [ClusterPendingModifiedValues](api-clusters.md#ClusterPendingModifiedValues) 物件。
此資料類型會在 `ModifyDBCluster` 操作中用作回應元素，並包含將在下一個維護時段期間套用的變更。
+ **PercentProgress** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定操作的進度 (百分比)。
+ **Port** – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
指定資料庫引擎接聽的連接埠。
+ **PreferredBackupWindow** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定每日的時間範圍，若有啟用自動化備份 (由 `BackupRetentionPeriod` 決定)，則自動化備份會在此期間建立。
+ **PreferredMaintenanceWindow** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定每週可能進行系統維護的時段，以世界協調時間 (UTC) 表示。
+ **ReaderEndpoint** – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫叢集的讀取器端點。資料庫叢集的讀取器端點，用來針對資料庫叢集中可用僅供讀取複本的連線進行負載平衡。當用戶端向讀取器端點請求新連線時，Neptune 會在資料庫叢集中的僅供讀取複本間分散連線請求。此功能有助於在您資料庫叢集中的多個僅供讀取複本間平衡您的讀取工作負載。
若發生容錯移轉，且您連線的僅供讀取複本提升為主要執行個體，則會中斷您的連線。若要繼續將您的讀取工作負載傳送到叢集內的其他僅供讀取複本，您可以接著重新連線到讀取器端點。
+ **ReadReplicaIdentifiers** – 字串，類型為：`string` (UTF-8 編碼的字串)。
包含與此資料庫叢集相關聯的一或多個僅供讀取複本識別符。
+ **ReplicationSourceIdentifier** – 字串，類型為：`string` (UTF-8 編碼的字串)。
Neptune 不提供支援。
+ **ReplicationType** – 字串，類型為：`string` (UTF-8 編碼的字串)。
Neptune 不提供支援。
+ **ServerlessV2ScalingConfiguration** – [ServerlessV2ScalingConfigurationInfo](api-datatypes.md#ServerlessV2ScalingConfigurationInfo) 物件。
顯示 Neptune Serverless 資料庫叢集的擴展組態。
如需詳細資訊，請參閱《Amazon Neptune 使用者指南》**中的[使用 Amazon Neptune Serverless](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html)。
+ **Status** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定此資料庫叢集的目前狀態。
+ **StorageEncrypted** – 布林值，類型為：`boolean` (布林值 (true 或 false))。
指定是否要加密資料庫叢集。
+ **StorageType** – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫叢集使用的儲存類型。
有效值：
+ **`standard`** – (*預設值*) 針對具有中至低 I/O 使用量的應用程式提供具成本效益的資料庫儲存體。
+ **`iopt1`** – 啟用 [I/O 優化儲存](https://docs.aws.amazon.com/neptune/latest/userguide/storage-types.html#provisioned-iops-storage)，旨在符合 I/O 密集型圖形工作負載的需求，而這些工作負載則需要可預測的定價、低 I/O 延遲和一致的 I/O 輸送量。
僅引擎版本 1.3.0.0 開始提供 Neptune I/O 優化儲存。
+ **VpcSecurityGroups** – 一個 [VpcSecurityGroupMembership](api-datatypes.md#VpcSecurityGroupMembership) 物件陣列。
提供資料庫叢集歸屬的 VPC 安全群組清單。
**錯誤**
+ [DBClusterAlreadyExistsFault](api-faults.md#DBClusterAlreadyExistsFault)
+ [DBClusterNotFoundFault](api-faults.md#DBClusterNotFoundFault)
+ [DBClusterQuotaExceededFault](api-faults.md#DBClusterQuotaExceededFault)
+ [DBClusterSnapshotNotFoundFault](api-faults.md#DBClusterSnapshotNotFoundFault)
+ [DBSubnetGroupNotFoundFault](api-faults.md#DBSubnetGroupNotFoundFault)
+ [InsufficientDBClusterCapacityFault](api-faults.md#InsufficientDBClusterCapacityFault)
+ [InsufficientStorageClusterCapacityFault](api-faults.md#InsufficientStorageClusterCapacityFault)
+ [InvalidDBClusterSnapshotStateFault](api-faults.md#InvalidDBClusterSnapshotStateFault)
+ [InvalidDBClusterStateFault](api-faults.md#InvalidDBClusterStateFault)
+ [InvalidDBSnapshotStateFault](api-faults.md#InvalidDBSnapshotStateFault)
+ [InvalidRestoreFault](api-faults.md#InvalidRestoreFault)
+ [InvalidSubnet](api-faults.md#InvalidSubnet)
+ [InvalidVPCNetworkStateFault](api-faults.md#InvalidVPCNetworkStateFault)
+ [KMSKeyNotAccessibleFault](api-faults.md#KMSKeyNotAccessibleFault)
+ [OptionGroupNotFoundFault](api-faults.md#OptionGroupNotFoundFault)
+ [StorageQuotaExceededFault](api-faults.md#StorageQuotaExceededFault)
+ [DBClusterParameterGroupNotFoundFault](api-faults.md#DBClusterParameterGroupNotFoundFault)
## DescribeDBClusterSnapshots (動作)
此 API 的 AWS CLI 名稱為：`describe-db-cluster-snapshots`。
傳回資料庫叢集快照的相關資訊。此 API 動作支援分頁。
**請求**
+ **DBClusterIdentifier** (在 CLI 中：`--db-cluster-identifier`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
擷取資料庫叢集快照清單的資料庫叢集 ID。此參數無法與 `DBClusterSnapshotIdentifier` 參數一起使用。此參數不區分大小寫。
約束:
+ 如果提供，必須符合現有 DBCluster 的識別符。
+ **DBClusterSnapshotIdentifier** (在 CLI 中：`--db-cluster-snapshot-identifier`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
描述特定的資料庫叢集快照識別符。此參數無法與 `DBClusterIdentifier` 參數一起使用。此值會以小寫字母字串的形式儲存。
約束:
+ 如果提供，必須符合現有 DBClusterSnapshot 的識別符。
+ 如果這是用於自動快照的識別符，也必須指定 `SnapshotType` 參數。
+ **Filters** (在 CLI 中：`--filters`) – [篩選條件](api-datatypes.md#Filter) 物件的陣列。
目前不支援此參數。
+ **IncludePublic** (在 CLI 中:`--include-public`) – 布林值，類型為：`boolean` (布林值 (true 或 false))。
True 則包含可由任何 Amazon 帳戶複製或還原的公有手動資料庫叢集快照，否則為 false。預設值為 `false`。預設值為 false。
您可以使用 [ModifyDBClusterSnapshotAttribute (動作)](#ModifyDBClusterSnapshotAttribute) API 動作，以公有狀態共享手動的資料庫叢集快照。
+ **IncludeShared** (在 CLI 中:`--include-shared`) – 布林值，類型為：`boolean` (布林值 (true 或 false))。
True 則包含來自其他 Amazon 帳戶的共用手動資料庫叢集快照，且此 Amazon 帳戶具有複製或還原的許可，否則為 false。預設值為 `false`。
您可以使用 [ModifyDBClusterSnapshotAttribute (動作)](#ModifyDBClusterSnapshotAttribute) API 動作，授予 Amazon 帳戶還原來自其他 Amazon 帳戶的手動資料庫叢集快照的許可。
+ **Marker** (在 CLI 中：`--marker`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
前一個 `DescribeDBClusterSnapshots` 請求提供的選用分頁字符。若指定此參數，則回應只會包含超過標記的記錄，直到 `MaxRecords` 指定的值為止。
+ **MaxRecords** (在 CLI 中：`--max-records`) – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
要在回應中包含的記錄數量上限。若存在的記錄比 `MaxRecords` 值指定的更多，則稱為「標記」的分頁字符會包含在回應中，讓您可以擷取剩餘的結果。
預設：100
限制條件：最小 20，最大 100。
+ **SnapshotType** (在 CLI 中：`--snapshot-type`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
要傳回的資料庫叢集快照類型。您可以指定下列其中一個值：
+ `automated` - 傳回 Amazon Neptune 針對我的 Amazon 帳戶自動建立的所有資料庫叢集快照。
+ `manual` - 傳回我的 Amazon 帳戶建立的所有資料庫叢集快照。
+ `shared` - 傳回與我的 Amazon 帳戶共用的所有手動資料庫叢集快照。
+ `public` - 傳回已標記為公有的所有資料庫叢集快照。
如不指定 `SnapshotType` 值，則會傳回自動和手動的資料庫叢集快照。您可以將 `IncludeShared` 參數設成 `true`，納入具有這些結果的共享資料庫叢集快照。您可以將 `IncludePublic` 參數設成 `true`，納入具有這些結果的公有資料庫叢集快照。
`IncludeShared` 和 `IncludePublic` 參數不適用於值為 `SnapshotType` 的 `manual` 或 `automated`。當 `SnapshotType` 設為 `shared` 時，不適用 `IncludePublic` 參數。當 `SnapshotType` 設為 `public` 時，不適用 `IncludeShared` 參數。
**回應**
+ **DBClusterSnapshots** – 一個 [DBClusterSnapshot](#DBClusterSnapshot) 物件陣列。
為使用者提供資料庫叢集快照的清單。
+ **Marker** – 字串，類型為：`string` (UTF-8 編碼的字串)。
前一個 [DescribeDBClusterSnapshots (動作)](#DescribeDBClusterSnapshots) 請求提供的選用分頁字符。若指定此參數，則回應只會包含超過標記的記錄，直到 `MaxRecords` 指定的值為止。
**錯誤**
+ [DBClusterSnapshotNotFoundFault](api-faults.md#DBClusterSnapshotNotFoundFault)
## DescribeDBClusterSnapshotAttributes (動作)
此 API 的 AWS CLI 名稱為：`describe-db-cluster-snapshot-attributes`。
傳回手動資料庫叢集快照之資料庫叢集快照屬性名稱和值的清單。
與其他 Amazon 帳戶共用快照時，`DescribeDBClusterSnapshotAttributes` 會傳回 `restore` 屬性和 Amazon 帳戶的 ID 清單，此 Amazon 帳戶有權複製或還原手動資料庫叢集快照。如果 `all` 包含在 `restore` 屬性的值清單中，則手動資料庫叢集快照為公有，且所有 Amazon 帳戶都可以複製或還原它。
若要新增或移除 Amazon 帳戶複製或還原手動資料庫叢集快照的許可，或使手動資料庫叢集快照成為公有或私有的，請使用 [ModifyDBClusterSnapshotAttribute (動作)](#ModifyDBClusterSnapshotAttribute) API 動作。
**請求**
+ **DBClusterSnapshotIdentifier** (在 CLI 中：`--db-cluster-snapshot-identifier`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
要描述屬性之資料庫叢集快照的識別符。
**回應**
包含成功呼叫 [DescribeDBClusterSnapshotAttributes (動作)](#DescribeDBClusterSnapshotAttributes) API 動作的結果。
手動資料庫叢集快照屬性是用於授權其他 Amazon 帳戶以複製或還原手動資料庫叢集快照。如需詳細資訊，請參閱 [ModifyDBClusterSnapshotAttribute (動作)](#ModifyDBClusterSnapshotAttribute) API 動作。
+ **DBClusterSnapshotAttributes** – 一個 [DBClusterSnapshotAttribute](#DBClusterSnapshotAttribute) 物件陣列。
手動資料庫叢集快照的屬性和值清單。
+ **DBClusterSnapshotIdentifier** – 字串，類型為：`string` (UTF-8 編碼的字串)。
屬性套用目標之手動資料庫叢集快照的識別符。
**錯誤**
+ [DBClusterSnapshotNotFoundFault](api-faults.md#DBClusterSnapshotNotFoundFault)
## *結構：*
## DBClusterSnapshot (結構)
包含 Amazon Neptune 資料庫叢集快照的詳細資訊
此資料類型在 [DescribeDBClusterSnapshots (動作)](#DescribeDBClusterSnapshots) 動作中會用來作為回應元素。
**欄位**
+ **AllocatedStorage** - 這是整數，類型為：`integer` (帶正負號的 32 位元整數)。
以 GiB 為單位指定分配的儲存體大小。
+ **AvailabilityZones** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
提供 EC2 可用區域清單，您可以在此還原資料庫叢集快照中的執行個體。
+ **ClusterCreateTime** - 這是 TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
指定建立資料庫叢集的時間，以國際標準時間 (UTC) 表示。
+ **DBClusterIdentifier** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
指定資料庫叢集的資料庫叢集識別符，此即建立此資料庫叢集快照的資料庫叢集。
+ **DBClusterSnapshotArn** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫叢集快照的 Amazon Resource Name (ARN)。
+ **DBClusterSnapshotIdentifier** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
指定資料庫叢集快照的識別碼。必須符合現有快照的識別碼。
使用 `DBClusterSnapshotIdentifier` 還原資料庫叢集之後，您必須為資料庫叢集未來的任何更新指定相同的 `DBClusterSnapshotIdentifier`。當您為更新指定此屬性時，資料庫叢集不會再次從快照還原，且資料庫中的資料不會變更。
不過，如果您未指定 `DBClusterSnapshotIdentifier`，則會建立空的資料庫叢集，並刪除原始資料庫叢集。如果您指定的屬性與先前的快照還原屬性不同，則會從 `DBClusterSnapshotIdentifier` 指定的快照還原資料庫叢集，並刪除原始資料庫叢集。
+ **Engine** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
指定資料庫引擎的名稱。
+ **EngineVersion** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
提供此資料庫叢集快照的資料庫引擎版本。
+ **IAMDatabaseAuthenticationEnabled** - 這是布林值，類型為：`boolean` (布林值 (true 或 false))。
若有啟用 Amazon Identity and Access Management (IAM) 帳戶對資料庫帳戶的映射，則為 true，否則為 false。
+ **KmsKeyId** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
若 `StorageEncrypted` 為 true，則為加密資料庫叢集快照的 Amazon KMS 金鑰識別符。
+ **LicenseModel** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
提供此資料庫叢集快照的授權模式資訊。
+ **PercentProgress** - 這是整數，類型為：`integer` (帶正負號的 32 位元整數)。
指定已傳輸的估計資料百分比。
+ **Port** - 這是整數，類型為：`integer` (帶正負號的 32 位元整數)。
指定資料庫叢集在快照時接聽的連接埠。
+ **SnapshotCreateTime** - 這是 TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
提供快照拍攝的時間，使用供國際標準時間 (UTC)。
+ **SnapshotType** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
提供資料庫叢集快照的類型。
+ **SourceDBClusterSnapshotArn** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
如果資料庫叢集快照複製自來源資料庫叢集快照，則為來源資料庫叢集快照的 Amazon Resource Name (ARN)，否則為空值。
+ **Status** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
指定此資料庫叢集快照的狀態。
+ **StorageEncrypted** - 這是布林值，類型為：`boolean` (布林值 (true 或 false))。
指定資料庫叢集快照是否加密。
+ **StorageType** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
與資料庫叢集快照相關聯的儲存類型。
+ **VpcId** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
提供與資料庫叢集快照關聯的 VPC ID。
`DBClusterSnapshot` 會用來做為以下項目的回應元素：
+ [CreateDBClusterSnapshot](#CreateDBClusterSnapshot)
+ [CopyDBClusterSnapshot](#CopyDBClusterSnapshot)
+ [DeleteDBClusterSnapshot](#DeleteDBClusterSnapshot)
## DBClusterSnapshotAttribute (結構)
包含手動資料庫叢集快照屬性的名稱和值。
手動資料庫叢集快照屬性是用於授權其他 Amazon 帳戶以還原手動資料庫叢集快照。如需詳細資訊，請參閱 [ModifyDBClusterSnapshotAttribute (動作)](#ModifyDBClusterSnapshotAttribute) API 動作。
**欄位**
+ **AttributeName** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
手動資料庫叢集快照屬性的名稱。
名為 `restore` 的屬性是指具有複製或還原手動資料庫叢集快照許可的 Amazon 帳戶清單。如需詳細資訊，請參閱 [ModifyDBClusterSnapshotAttribute (動作)](#ModifyDBClusterSnapshotAttribute) API 動作。
+ **AttributeValues** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
手動資料庫叢集快照屬性的值。
如果 `AttributeName` 欄位設為 `restore`，則此元素會傳回 Amazon 帳戶 ID 的清單，這些帳戶有權複製或還原手動資料庫叢集快照。如果清單中有 `all` 值，則手動資料庫叢集快照為公有，且可供任何 Amazon 帳戶複製或還原。
## DBClusterSnapshotAttributesResult (結構)
包含成功呼叫 [DescribeDBClusterSnapshotAttributes (動作)](#DescribeDBClusterSnapshotAttributes) API 動作的結果。
手動資料庫叢集快照屬性是用於授權其他 Amazon 帳戶以複製或還原手動資料庫叢集快照。如需詳細資訊，請參閱 [ModifyDBClusterSnapshotAttribute (動作)](#ModifyDBClusterSnapshotAttribute) API 動作。
**欄位**
+ **DBClusterSnapshotAttributes** - 這是 [DBClusterSnapshotAttribute](#DBClusterSnapshotAttribute) 物件的陣列。
手動資料庫叢集快照的屬性和值清單。
+ **DBClusterSnapshotIdentifier** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
屬性套用目標之手動資料庫叢集快照的識別符。
`DBClusterSnapshotAttributesResult` 會用來做為以下項目的回應元素：
+ [DescribeDBClusterSnapshotAttributes](#DescribeDBClusterSnapshotAttributes)
+ [ModifyDBClusterSnapshotAttribute](#ModifyDBClusterSnapshotAttribute)
# Neptune 事件 API
**動作:**
+ [CreateEventSubscription (動作)](#CreateEventSubscription)
+ [DeleteEventSubscription (動作)](#DeleteEventSubscription)
+ [ModifyEventSubscription (動作)](#ModifyEventSubscription)
+ [DescribeEventSubscriptions (動作)](#DescribeEventSubscriptions)
+ [AddSourceIdentifierToSubscription (動作)](#AddSourceIdentifierToSubscription)
+ [RemoveSourceIdentifierFromSubscription (動作)](#RemoveSourceIdentifierFromSubscription)
+ [DescribeEvents (動作)](#DescribeEvents)
+ [DescribeEventCategories (動作)](#DescribeEventCategories)
**結構：**
+ [Event (結構)](#Event)
+ [EventCategoriesMap (結構)](#EventCategoriesMap)
+ [EventSubscription (結構)](#EventSubscription)
## CreateEventSubscription (動作)
此 API 的 AWS CLI 名稱為：`create-event-subscription`。
建立事件通知訂閱。這個動作需要 Neptune 主控台、SNS 主控台或 SNS API 建立的主題 ARN (Amazon Resource Name)。若要使用 SNS 取得 ARN，您必須在 Amazon SNS 中建立一個主題並訂閱該主題。SNS 主控台中會顯示 ARN。
您可以指定想要接到通知的來源類型 (SourceType)、提供觸發事件的 Neptune 來源清單 (SourceIds)，以及提供想要接到通知的事件類別 (EventCategories) 清單。例如，您可以指定 SourceType = db-instance；SourceIds = mydbinstance1、mydbinstance2；以及 EventCategories = Availability、Backup。
如果您同時指定 SourceType 和 SourceIds，例如 SourceType = db-instance 和 SourceIdentifier = myDBInstance1，則會收到指定來源所有 db-instance 事件的通知。如果您指定 SourceType 但未指定 SourceIdentifier，則會收到所有 Neptune 來源之該來源類型事件的通知。如果您不指定 SourceType 也不指定 SourceIdentifier，則會屬於您客戶帳戶之所有 Neptune 來源產生的事件通知。
**請求**
+ **Enabled** (在 CLI 中:`--enabled`) – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
布林值；設為 **true** 啟用訂閱，設為 **false** 建立訂閱，但不啟動訂閱。
+ **EventCategories** (在 CLI 中：`--event-categories`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
您想要訂閱的 SourceType 事件類別清單。您可以使用 **DescribeEventCategories** 動作查看指定 SourceType 的類別清單。
+ **SnsTopicArn** (在 CLI 中：`--sns-topic-arn`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
針對事件通知所建立 SNS 主題的 Amazon Resource Name (ARN)。此 ARN 是當您建立並訂閱主題時由 Amazon SNS 所建立。
+ **SourceIds** (在 CLI 中：`--source-ids`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
傳回事件的事件來源識別碼清單。如未指定，回應中會包含所有來源。識別碼必須以字母開頭，只能包含 ASCII 字母、數字和連字號，而且不得以連字號結尾，或連續包含兩個連字號。
約束:
+ 如果提供 SourceIds，也必須提供 SourceType。
+ 如果來源類型是資料庫執行個體，則必須提供 `DBInstanceIdentifier`。
+ 如果來源類型是資料庫安全群組，則必須提供 `DBSecurityGroupName`。
+ 如果來源類型是資料庫參數群組，則必須提供 `DBParameterGroupName`。
+ 如果來源類型是資料庫快照，則必須提供 `DBSnapshotIdentifier`。
+ **SourceType** (在 CLI 中：`--source-type`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
產生事件的來源類型。例如，如果您希望接到資料庫執行個體所產生的事件通知，請將此參數設為 db-instance。如未指定此值，則會傳回所有事件。
有效值：`db-instance` \$1 `db-cluster` \$1 `db-parameter-group` \$1 `db-security-group` \$1 `db-snapshot` \$1 `db-cluster-snapshot`
+ **SubscriptionName** (在 CLI 中：`--subscription-name`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
訂閱的名稱。
限制條件：名稱必須少於 255 個字元。
+ **Tags** (在 CLI 中：`--tags`) – [Tag](api-other-apis.md#Tag) 物件的陣列。
要套用到新事件訂閱的標籤。
**回應**
包含成功呼叫 [DescribeEventSubscriptions (動作)](#DescribeEventSubscriptions) 動作的結果。
+ **CustomerAwsId** – 字串，類型為：`string` (UTF-8 編碼的字串)。
與事件通知訂閱相關聯的 Amazon 客戶帳戶。
+ **CustSubscriptionId** – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫事件通知訂閱 ID。
+ **Enabled** – 布林值，類型為：`boolean` (布林值 (true 或 false))。
布林值指出訂閱是否啟用。True 指出訂閱已啟用。
+ **EventCategoriesList** – 字串，類型為：`string` (UTF-8 編碼的字串)。
事件通知訂閱事件類別的清單。
+ **EventSubscriptionArn** – 字串，類型為：`string` (UTF-8 編碼的字串)。
事件訂閱的 Amazon Resource Name (ARN)。
+ **SnsTopicArn** – 字串，類型為：`string` (UTF-8 編碼的字串)。
事件通知訂閱的主題 ARN。
+ **SourceIdsList** – 字串，類型為：`string` (UTF-8 編碼的字串)。
事件通知訂閱來源 ID 的清單。
+ **SourceType** – 字串，類型為：`string` (UTF-8 編碼的字串)。
事件通知訂閱的來源類型。
+ **Status** – 字串，類型為：`string` (UTF-8 編碼的字串)。
事件通知訂閱的狀態。
約束:
可以是下列其中之一：建立 \$1 修改 \$1 刪除 \$1 作用中 \$1 無許可 \$1 主題不存在
狀態「無許可」表示 Neptune 不再具有發佈 SNS 主題的許可。狀態「主題不存在」表示主題在訂閱建立後已遭刪除。
+ **SubscriptionCreationTime** – 字串，類型為：`string` (UTF-8 編碼的字串)。
事件通知訂閱建立的時間。
**錯誤**
+ [EventSubscriptionQuotaExceededFault](api-faults.md#EventSubscriptionQuotaExceededFault)
+ [SubscriptionAlreadyExistFault](api-faults.md#SubscriptionAlreadyExistFault)
+ [SNSInvalidTopicFault](api-faults.md#SNSInvalidTopicFault)
+ [SNSNoAuthorizationFault](api-faults.md#SNSNoAuthorizationFault)
+ [SNSTopicArnNotFoundFault](api-faults.md#SNSTopicArnNotFoundFault)
+ [SubscriptionCategoryNotFoundFault](api-faults.md#SubscriptionCategoryNotFoundFault)
+ [SourceNotFoundFault](api-faults.md#SourceNotFoundFault)
## DeleteEventSubscription (動作)
此 API 的 AWS CLI 名稱為：`delete-event-subscription`。
刪除事件通知訂閱。
**請求**
+ **SubscriptionName** (在 CLI 中：`--subscription-name`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
您要刪除的事件通知訂閱名稱。
**回應**
包含成功呼叫 [DescribeEventSubscriptions (動作)](#DescribeEventSubscriptions) 動作的結果。
+ **CustomerAwsId** – 字串，類型為：`string` (UTF-8 編碼的字串)。
與事件通知訂閱相關聯的 Amazon 客戶帳戶。
+ **CustSubscriptionId** – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫事件通知訂閱 ID。
+ **Enabled** – 布林值，類型為：`boolean` (布林值 (true 或 false))。
布林值指出訂閱是否啟用。True 指出訂閱已啟用。
+ **EventCategoriesList** – 字串，類型為：`string` (UTF-8 編碼的字串)。
事件通知訂閱事件類別的清單。
+ **EventSubscriptionArn** – 字串，類型為：`string` (UTF-8 編碼的字串)。
事件訂閱的 Amazon Resource Name (ARN)。
+ **SnsTopicArn** – 字串，類型為：`string` (UTF-8 編碼的字串)。
事件通知訂閱的主題 ARN。
+ **SourceIdsList** – 字串，類型為：`string` (UTF-8 編碼的字串)。
事件通知訂閱來源 ID 的清單。
+ **SourceType** – 字串，類型為：`string` (UTF-8 編碼的字串)。
事件通知訂閱的來源類型。
+ **Status** – 字串，類型為：`string` (UTF-8 編碼的字串)。
事件通知訂閱的狀態。
約束:
可以是下列其中之一：建立 \$1 修改 \$1 刪除 \$1 作用中 \$1 無許可 \$1 主題不存在
狀態「無許可」表示 Neptune 不再具有發佈 SNS 主題的許可。狀態「主題不存在」表示主題在訂閱建立後已遭刪除。
+ **SubscriptionCreationTime** – 字串，類型為：`string` (UTF-8 編碼的字串)。
事件通知訂閱建立的時間。
**錯誤**
+ [SubscriptionNotFoundFault](api-faults.md#SubscriptionNotFoundFault)
+ [InvalidEventSubscriptionStateFault](api-faults.md#InvalidEventSubscriptionStateFault)
## ModifyEventSubscription (動作)
此 API 的 AWS CLI 名稱為：`modify-event-subscription`。
修改現有的事件通知訂閱。請注意，您無法使用此呼叫修改來源識別符；若要變更訂閱的來源識別符，請使用 [AddSourceIdentifierToSubscription (動作)](#AddSourceIdentifierToSubscription) 和 [RemoveSourceIdentifierFromSubscription (動作)](#RemoveSourceIdentifierFromSubscription) 呼叫。
您可以使用 **DescribeEventCategories** 動作查看指定 SourceType 的事件類別清單。
**請求**
+ **Enabled** (在 CLI 中:`--enabled`) – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
布林值；設為 **true** 啟用訂閱。
+ **EventCategories** (在 CLI 中：`--event-categories`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
您想要訂閱的 SourceType 事件類別清單。您可以使用 **DescribeEventCategories** 動作查看指定 SourceType 的類別清單。
+ **SnsTopicArn** (在 CLI 中：`--sns-topic-arn`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
針對事件通知所建立 SNS 主題的 Amazon Resource Name (ARN)。此 ARN 是當您建立並訂閱主題時由 Amazon SNS 所建立。
+ **SourceType** (在 CLI 中：`--source-type`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
產生事件的來源類型。例如，如果您希望接到資料庫執行個體所產生的事件通知，請將此參數設為 db-instance。如未指定此值，則會傳回所有事件。
有效值：db-instance \$1 db-parameter-group \$1 db-security-group \$1 db-snapshot
+ **SubscriptionName** (在 CLI 中：`--subscription-name`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
事件通知訂閱的名稱。
**回應**
包含成功呼叫 [DescribeEventSubscriptions (動作)](#DescribeEventSubscriptions) 動作的結果。
+ **CustomerAwsId** – 字串，類型為：`string` (UTF-8 編碼的字串)。
與事件通知訂閱相關聯的 Amazon 客戶帳戶。
+ **CustSubscriptionId** – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫事件通知訂閱 ID。
+ **Enabled** – 布林值，類型為：`boolean` (布林值 (true 或 false))。
布林值指出訂閱是否啟用。True 指出訂閱已啟用。
+ **EventCategoriesList** – 字串，類型為：`string` (UTF-8 編碼的字串)。
事件通知訂閱事件類別的清單。
+ **EventSubscriptionArn** – 字串，類型為：`string` (UTF-8 編碼的字串)。
事件訂閱的 Amazon Resource Name (ARN)。
+ **SnsTopicArn** – 字串，類型為：`string` (UTF-8 編碼的字串)。
事件通知訂閱的主題 ARN。
+ **SourceIdsList** – 字串，類型為：`string` (UTF-8 編碼的字串)。
事件通知訂閱來源 ID 的清單。
+ **SourceType** – 字串，類型為：`string` (UTF-8 編碼的字串)。
事件通知訂閱的來源類型。
+ **Status** – 字串，類型為：`string` (UTF-8 編碼的字串)。
事件通知訂閱的狀態。
約束:
可以是下列其中之一：建立 \$1 修改 \$1 刪除 \$1 作用中 \$1 無許可 \$1 主題不存在
狀態「無許可」表示 Neptune 不再具有發佈 SNS 主題的許可。狀態「主題不存在」表示主題在訂閱建立後已遭刪除。
+ **SubscriptionCreationTime** – 字串，類型為：`string` (UTF-8 編碼的字串)。
事件通知訂閱建立的時間。
**錯誤**
+ [EventSubscriptionQuotaExceededFault](api-faults.md#EventSubscriptionQuotaExceededFault)
+ [SubscriptionNotFoundFault](api-faults.md#SubscriptionNotFoundFault)
+ [SNSInvalidTopicFault](api-faults.md#SNSInvalidTopicFault)
+ [SNSNoAuthorizationFault](api-faults.md#SNSNoAuthorizationFault)
+ [SNSTopicArnNotFoundFault](api-faults.md#SNSTopicArnNotFoundFault)
+ [SubscriptionCategoryNotFoundFault](api-faults.md#SubscriptionCategoryNotFoundFault)
## DescribeEventSubscriptions (動作)
此 API 的 AWS CLI 名稱為：`describe-event-subscriptions`。
列出客戶帳戶的所有訂閱描述。訂閱描述包含 SubscriptionName、SNSTopicARN、CustomerID、SourceType、SourceID、CreationTime 和 Status。
如果您指定 SubscriptionName，請列出該訂閱的描述。
**請求**
+ **Filters** (在 CLI 中：`--filters`) – [篩選條件](api-datatypes.md#Filter) 物件的陣列。
目前不支援此參數。
+ **Marker** (在 CLI 中：`--marker`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
前一個 DescribeOrderableDBInstanceOptions 請求提供的選用分頁字符。若指定此參數，則回應只會包含超過標記的記錄，直到 `MaxRecords` 指定的值為止。
+ **MaxRecords** (在 CLI 中：`--max-records`) – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
要在回應中包含的記錄數量上限。若存在的記錄比 `MaxRecords` 值指定的更多，則稱為「標記」的分頁字符會包含在回應中，讓您可以擷取剩餘的結果。
預設：100
限制條件：最小 20，最大 100。
+ **SubscriptionName** (在 CLI 中：`--subscription-name`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
您要描述的事件通知訂閱名稱。
**回應**
+ **EventSubscriptionsList** – 一個 [EventSubscription](#EventSubscription) 物件陣列。
如 EventSubscriptions 資料類型的清單。
+ **Marker** – 字串，類型為：`string` (UTF-8 編碼的字串)。
前一個 DescribeOrderableDBInstanceOptions 請求提供的選用分頁字符。若指定此參數，則回應只會包含超過標記的記錄，直到 `MaxRecords` 指定的值為止。
**錯誤**
+ [SubscriptionNotFoundFault](api-faults.md#SubscriptionNotFoundFault)
## AddSourceIdentifierToSubscription (動作)
此 API 的 AWS CLI 名稱為：`add-source-identifier-to-subscription`。
將來源識別符新增至現有的事件通知訂閱。
**請求**
+ **SourceIdentifier** (在 CLI 中：`--source-identifier`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
要新增之事件來源的識別符。
約束:
+ 如果來源類型是資料庫執行個體，則必須提供 `DBInstanceIdentifier`。
+ 如果來源類型是資料庫安全群組，則必須提供 `DBSecurityGroupName`。
+ 如果來源類型是資料庫參數群組，則必須提供 `DBParameterGroupName`。
+ 如果來源類型是資料庫快照，則必須提供 `DBSnapshotIdentifier`。
+ **SubscriptionName** (在 CLI 中：`--subscription-name`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
您想要新增來源識別符之事件通知訂閱的名稱。
**回應**
包含成功呼叫 [DescribeEventSubscriptions (動作)](#DescribeEventSubscriptions) 動作的結果。
+ **CustomerAwsId** – 字串，類型為：`string` (UTF-8 編碼的字串)。
與事件通知訂閱相關聯的 Amazon 客戶帳戶。
+ **CustSubscriptionId** – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫事件通知訂閱 ID。
+ **Enabled** – 布林值，類型為：`boolean` (布林值 (true 或 false))。
布林值指出訂閱是否啟用。True 指出訂閱已啟用。
+ **EventCategoriesList** – 字串，類型為：`string` (UTF-8 編碼的字串)。
事件通知訂閱事件類別的清單。
+ **EventSubscriptionArn** – 字串，類型為：`string` (UTF-8 編碼的字串)。
事件訂閱的 Amazon Resource Name (ARN)。
+ **SnsTopicArn** – 字串，類型為：`string` (UTF-8 編碼的字串)。
事件通知訂閱的主題 ARN。
+ **SourceIdsList** – 字串，類型為：`string` (UTF-8 編碼的字串)。
事件通知訂閱來源 ID 的清單。
+ **SourceType** – 字串，類型為：`string` (UTF-8 編碼的字串)。
事件通知訂閱的來源類型。
+ **Status** – 字串，類型為：`string` (UTF-8 編碼的字串)。
事件通知訂閱的狀態。
約束:
可以是下列其中之一：建立 \$1 修改 \$1 刪除 \$1 作用中 \$1 無許可 \$1 主題不存在
狀態「無許可」表示 Neptune 不再具有發佈 SNS 主題的許可。狀態「主題不存在」表示主題在訂閱建立後已遭刪除。
+ **SubscriptionCreationTime** – 字串，類型為：`string` (UTF-8 編碼的字串)。
事件通知訂閱建立的時間。
**錯誤**
+ [SubscriptionNotFoundFault](api-faults.md#SubscriptionNotFoundFault)
+ [SourceNotFoundFault](api-faults.md#SourceNotFoundFault)
## RemoveSourceIdentifierFromSubscription (動作)
此 API 的 AWS CLI 名稱為：`remove-source-identifier-from-subscription`。
從現有的事件通知訂閱移除來源識別符。
**請求**
+ **SourceIdentifier** (在 CLI 中：`--source-identifier`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
訂閱要移除的來源識別符，例如資料庫執行個體的**資料庫執行個體識別符**或安全群組的名稱。
+ **SubscriptionName** (在 CLI 中：`--subscription-name`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
您想要移除來源識別符之事件通知訂閱的名稱。
**回應**
包含成功呼叫 [DescribeEventSubscriptions (動作)](#DescribeEventSubscriptions) 動作的結果。
+ **CustomerAwsId** – 字串，類型為：`string` (UTF-8 編碼的字串)。
與事件通知訂閱相關聯的 Amazon 客戶帳戶。
+ **CustSubscriptionId** – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫事件通知訂閱 ID。
+ **Enabled** – 布林值，類型為：`boolean` (布林值 (true 或 false))。
布林值指出訂閱是否啟用。True 指出訂閱已啟用。
+ **EventCategoriesList** – 字串，類型為：`string` (UTF-8 編碼的字串)。
事件通知訂閱事件類別的清單。
+ **EventSubscriptionArn** – 字串，類型為：`string` (UTF-8 編碼的字串)。
事件訂閱的 Amazon Resource Name (ARN)。
+ **SnsTopicArn** – 字串，類型為：`string` (UTF-8 編碼的字串)。
事件通知訂閱的主題 ARN。
+ **SourceIdsList** – 字串，類型為：`string` (UTF-8 編碼的字串)。
事件通知訂閱來源 ID 的清單。
+ **SourceType** – 字串，類型為：`string` (UTF-8 編碼的字串)。
事件通知訂閱的來源類型。
+ **Status** – 字串，類型為：`string` (UTF-8 編碼的字串)。
事件通知訂閱的狀態。
約束:
可以是下列其中之一：建立 \$1 修改 \$1 刪除 \$1 作用中 \$1 無許可 \$1 主題不存在
狀態「無許可」表示 Neptune 不再具有發佈 SNS 主題的許可。狀態「主題不存在」表示主題在訂閱建立後已遭刪除。
+ **SubscriptionCreationTime** – 字串，類型為：`string` (UTF-8 編碼的字串)。
事件通知訂閱建立的時間。
**錯誤**
+ [SubscriptionNotFoundFault](api-faults.md#SubscriptionNotFoundFault)
+ [SourceNotFoundFault](api-faults.md#SourceNotFoundFault)
## DescribeEvents (動作)
此 API 的 AWS CLI 名稱為：`describe-events`。
傳回過去 14 天與資料庫執行個體、資料庫安全群組、資料庫快照和資料庫參數群組有關的事件。提供名稱做為參數可取得特定資料庫執行個體、資料庫安全群組、資料庫快照或資料庫參數群組的專屬事件。根據預設，會傳回過去一小時的事件。
**請求**
+ **Duration** (在 CLI 中：`--duration`) – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
擷取事件的分鐘數。
預設：60
+ **EndTime** (在 CLI 中：`--end-time`) – TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
擷取事件的時間間隔終點，以 ISO 8601 格式指定。如需 ISO 8601 的詳細資訊，請前往 [ISO8601 Wikipedia 頁面](http://en.wikipedia.org/wiki/ISO_8601)。
範例：2009-07-08T18:00Z
+ **EventCategories** (在 CLI 中：`--event-categories`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
觸發事件通知訂閱通知的事件類別清單。
+ **Filters** (在 CLI 中：`--filters`) – [篩選條件](api-datatypes.md#Filter) 物件的陣列。
目前不支援此參數。
+ **Marker** (在 CLI 中：`--marker`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
前一個 DescribeEvents 請求提供的選用分頁字符。若指定此參數，則回應只會包含超過標記的記錄，直到 `MaxRecords` 指定的值為止。
+ **MaxRecords** (在 CLI 中：`--max-records`) – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
要在回應中包含的記錄數量上限。若存在的記錄比 `MaxRecords` 值指定的更多，則稱為「標記」的分頁字符會包含在回應中，讓您可以擷取剩餘的結果。
預設：100
限制條件：最小 20，最大 100。
+ **SourceIdentifier** (在 CLI 中：`--source-identifier`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
要傳回其事件的事件來源識別碼。如未指定，回應中會包含所有來源。
約束:
+ 如果提供 SourceIdentifier，也必須提供 SourceType。
+ 如果來源類型是 `DBInstance`，則必須提供 `DBInstanceIdentifier`。
+ 如果來源類型是 `DBSecurityGroup`，則必須提供 `DBSecurityGroupName`。
+ 如果來源類型是 `DBParameterGroup`，則必須提供 `DBParameterGroupName`。
+ 如果來源類型是 `DBSnapshot`，則必須提供 `DBSnapshotIdentifier`。
+ 不能以連字號結尾或連續包含兩個連字號。
+ **SourceType** (在 CLI 中：`--source-type`) – SourceType，類型為：`string` (UTF-8 編碼的字串)。
事件擷取來源的事件來源。如未指定任何值，則會傳回所有事件。
+ **StartTime** (在 CLI 中：`--start-time`) – TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
擷取事件的時間間隔起點，以 ISO 8601 格式指定。如需 ISO 8601 的詳細資訊，請前往 [ISO8601 Wikipedia 頁面](http://en.wikipedia.org/wiki/ISO_8601)。
範例：2009-07-08T18:00Z
**回應**
+ **Events** – 一個 [事件](#Event) 物件陣列。
[Event (結構)](#Event) 執行個體的清單。
+ **Marker** – 字串，類型為：`string` (UTF-8 編碼的字串)。
前一個 Events 請求提供的選用分頁字符。若指定此參數，則回應只會包含超過標記的記錄，直到 `MaxRecords` 指定的值為止。
## DescribeEventCategories (動作)
此 API 的 AWS CLI 名稱為：`describe-event-categories`。
顯示所有事件來源類型或特定來源類型 (如果指定) 的類別清單。
**請求**
+ **Filters** (在 CLI 中：`--filters`) – [篩選條件](api-datatypes.md#Filter) 物件的陣列。
目前不支援此參數。
+ **SourceType** (在 CLI 中：`--source-type`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
產生事件的來源類型。
有效值：db-instance \$1 db-parameter-group \$1 db-security-group \$1 db-snapshot
**回應**
+ **EventCategoriesMapList** – 一個 [EventCategoriesMap](#EventCategoriesMap) 物件陣列。
EventCategoriesMap 資料類型的清單。
## *結構：*
## Event (結構)
此資料類型在 [DescribeEvents (動作)](#DescribeEvents) 動作中會用來作為回應元素。
**欄位**
+ **Date** - 這是 TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
指定事件的日期和時間。
+ **EventCategories** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
指定事件類別。
+ **Message** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
提供此事件的文字。
+ **SourceArn** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
事件的 Amazon Resource Name (ARN)。
+ **SourceIdentifier** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
提供事件來源的識別符。
+ **SourceType** - 這是 SourceType，類型為：`string` (UTF-8 編碼的字串)。
指定此事件的來源類型。
## EventCategoriesMap (結構)
包含成功呼叫 [DescribeEventCategories (動作)](#DescribeEventCategories) 動作的結果。
**欄位**
+ **EventCategories** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
指定的來源類型事件類別
+ **SourceType** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
傳回類別所屬之來源類型
## EventSubscription (結構)
包含成功呼叫 [DescribeEventSubscriptions (動作)](#DescribeEventSubscriptions) 動作的結果。
**欄位**
+ **CustomerAwsId** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
與事件通知訂閱相關聯的 Amazon 客戶帳戶。
+ **CustSubscriptionId** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫事件通知訂閱 ID。
+ **Enabled** - 這是布林值，類型為：`boolean` (布林值 (true 或 false))。
布林值指出訂閱是否啟用。True 指出訂閱已啟用。
+ **EventCategoriesList** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
事件通知訂閱事件類別的清單。
+ **EventSubscriptionArn** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
事件訂閱的 Amazon Resource Name (ARN)。
+ **SnsTopicArn** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
事件通知訂閱的主題 ARN。
+ **SourceIdsList** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
事件通知訂閱來源 ID 的清單。
+ **SourceType** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
事件通知訂閱的來源類型。
+ **Status** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
事件通知訂閱的狀態。
約束:
可以是下列其中之一：建立 \$1 修改 \$1 刪除 \$1 作用中 \$1 無許可 \$1 主題不存在
狀態「無許可」表示 Neptune 不再具有發佈 SNS 主題的許可。狀態「主題不存在」表示主題在訂閱建立後已遭刪除。
+ **SubscriptionCreationTime** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
事件通知訂閱建立的時間。
`EventSubscription` 會用來做為以下項目的回應元素：
+ [CreateEventSubscription](#CreateEventSubscription)
+ [ModifyEventSubscription](#ModifyEventSubscription)
+ [AddSourceIdentifierToSubscription](#AddSourceIdentifierToSubscription)
+ [RemoveSourceIdentifierFromSubscription](#RemoveSourceIdentifierFromSubscription)
+ [DeleteEventSubscription](#DeleteEventSubscription)
# 其他 Neptune API
**動作:**
+ [AddTagsToResource (動作)](#AddTagsToResource)
+ [ListTagsForResource (動作)](#ListTagsForResource)
+ [RemoveTagsFromResource (動作)](#RemoveTagsFromResource)
+ [ApplyPendingMaintenanceAction (動作)](#ApplyPendingMaintenanceAction)
+ [DescribePendingMaintenanceActions (動作)](#DescribePendingMaintenanceActions)
+ [DescribeDBEngineVersions (動作)](#DescribeDBEngineVersions)
**結構：**
+ [DBEngineVersion (結構)](#DBEngineVersion)
+ [EngineDefaults (結構)](#EngineDefaults)
+ [PendingMaintenanceAction (結構)](#PendingMaintenanceAction)
+ [ResourcePendingMaintenanceActions (結構)](#ResourcePendingMaintenanceActions)
+ [UpgradeTarget (結構)](#UpgradeTarget)
+ [Tag (結構)](#Tag)
## AddTagsToResource (動作)
此 API 的 AWS CLI 名稱為：`add-tags-to-resource`。
將中繼資料標籤新增到 Amazon Neptune 資源。這些標籤也可以搭配成本分配報告，用來追蹤與 Amazon Neptune 資源相關聯的成本，或用在 Amazon Neptune 之 IAM 政策的條件陳述式中。
**請求**
+ **ResourceName** (在 CLI 中：`--resource-name`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
要新增標籤的 Amazon Neptune 資源。這個值是 Amazon Resource Name (ARN)。如需建立 ARN 的資訊，請參閱[建構 Amazon Resource Name (ARN)](https://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html#tagging.ARN.Constructing)。
+ **Tags** (在 CLI 中：`--tags`) – *必要：*[Tag](#Tag) 物件的陣列。
要指派給 Amazon Neptune 資源的標籤。
**回應**
+ *無回應參數。*
**錯誤**
+ [DBInstanceNotFoundFault](api-faults.md#DBInstanceNotFoundFault)
+ [DBSnapshotNotFoundFault](api-faults.md#DBSnapshotNotFoundFault)
+ [DBClusterNotFoundFault](api-faults.md#DBClusterNotFoundFault)
## ListTagsForResource (動作)
此 API 的 AWS CLI 名稱為：`list-tags-for-resource`。
列出 Amazon Neptune 資源的所有標籤。
**請求**
+ **Filters** (在 CLI 中：`--filters`) – [篩選條件](api-datatypes.md#Filter) 物件的陣列。
目前不支援此參數。
+ **ResourceName** (在 CLI 中：`--resource-name`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
具有要列出之標籤的 Amazon Neptune 資源。這個值是 Amazon Resource Name (ARN)。如需建立 ARN 的資訊，請參閱[建構 Amazon Resource Name (ARN)](https://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html#tagging.ARN.Constructing)。
**回應**
+ **TagList** – 一個 [Tag](#Tag) 物件陣列。
ListTagsForResource 操作傳回的標籤清單。
**錯誤**
+ [DBInstanceNotFoundFault](api-faults.md#DBInstanceNotFoundFault)
+ [DBSnapshotNotFoundFault](api-faults.md#DBSnapshotNotFoundFault)
+ [DBClusterNotFoundFault](api-faults.md#DBClusterNotFoundFault)
## RemoveTagsFromResource (動作)
此 API 的 AWS CLI 名稱為：`remove-tags-from-resource`。
移除 Amazon Neptune 資源中的中繼資料標籤。
**請求**
+ **ResourceName** (在 CLI 中：`--resource-name`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
要移除標籤的 Amazon Neptune 資源。這個值是 Amazon Resource Name (ARN)。如需建立 ARN 的資訊，請參閱[建構 Amazon Resource Name (ARN)](https://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html#tagging.ARN.Constructing)。
+ **TagKeys** (在 CLI 中：`--tag-keys`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
要移除之標籤的標籤金鑰 (名稱)。
**回應**
+ *無回應參數。*
**錯誤**
+ [DBInstanceNotFoundFault](api-faults.md#DBInstanceNotFoundFault)
+ [DBSnapshotNotFoundFault](api-faults.md#DBSnapshotNotFoundFault)
+ [DBClusterNotFoundFault](api-faults.md#DBClusterNotFoundFault)
## ApplyPendingMaintenanceAction (動作)
此 API 的 AWS CLI 名稱為：`apply-pending-maintenance-action`。
將待處理維護動作套用到資源 (例如，資料庫執行個體)。
**請求**
+ **ApplyAction** (在 CLI 中：`--apply-action`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
要套用至此資源的待處理維護動作。
有效值：`system-update`、`db-upgrade`
+ **OptInType** (在 CLI 中：`--opt-in-type`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
值，指定選擇使用請求的類型，或復原選擇使用請求。無法復原 `immediate` 類型的選擇使用請求。
有效值：
+ `immediate` - 立即套用維護動作。
+ `next-maintenance` - 在下次資源維護時段期間套用維護動作。
+ `undo-opt-in` - 取消任何現有的 `next-maintenance` 選擇使用請求。
+ **ResourceIdentifier** (在 CLI 中：`--resource-identifier`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
要套用待處理維護動作之資源的 Amazon Resource Name (ARN)。如需建立 ARN 的資訊，請參閱[建構 Amazon Resource Name (ARN)](https://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html#tagging.ARN.Constructing)。
**回應**
描述資源的待處理維護動作。
+ **PendingMaintenanceActionDetails** – 一個 [PendingMaintenanceAction](#PendingMaintenanceAction) 物件陣列。
清單，提供資源待處理維護動作的詳細資訊。
+ **ResourceIdentifier** – 字串，類型為：`string` (UTF-8 編碼的字串)。
具有待處理維護動作的資源 ARN。
**錯誤**
+ [ResourceNotFoundFault](api-faults.md#ResourceNotFoundFault)
## DescribePendingMaintenanceActions (動作)
此 API 的 AWS CLI 名稱為：`describe-pending-maintenance-actions`。
傳回至少有一個待處理維護動作的資源清單 (例如，資料庫執行個體)。
**請求**
+ **Filters** (在 CLI 中：`--filters`) – [篩選條件](api-datatypes.md#Filter) 物件的陣列。
篩選條件，指定傳回待處理維護動作的一或多種資源。
支援的篩選條件：
+ `db-cluster-id` - 接受資料庫叢集識別符及資料庫叢集 Amazon Resource Name (ARN)。結果清單只包含這些 ARN 找到的資料庫叢集待處理維護動作。
+ `db-instance-id` - 接受資料庫執行個體識別符和資料庫執行個體 ARN。結果清單只包含這些 ARN 找到的資料庫執行個體待處理維護動作。
+ **Marker** (在 CLI 中：`--marker`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
前一個 `DescribePendingMaintenanceActions` 請求提供的選用分頁字符。如已指定此參數，則回應僅包含超出標記的記錄，不超過 `MaxRecords` 指定的記錄數量。
+ **MaxRecords** (在 CLI 中：`--max-records`) – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
要在回應中包含的記錄數量上限。若存在的記錄比 `MaxRecords` 值指定的更多，則稱為「標記」的分頁字符會包含在回應中，讓您可以擷取剩餘的結果。
預設：100
限制條件：最小 20，最大 100。
+ **ResourceIdentifier** (在 CLI 中：`--resource-identifier`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
傳回待處理維護動作的資源 ARN。
**回應**
+ **Marker** – 字串，類型為：`string` (UTF-8 編碼的字串)。
前一個 `DescribePendingMaintenanceActions` 請求提供的選用分頁字符。如已指定此參數，則回應僅包含超出標記的記錄，不超過 `MaxRecords` 指定的記錄數量。
+ **PendingMaintenanceActions** – 一個 [ResourcePendingMaintenanceActions](#ResourcePendingMaintenanceActions) 物件陣列。
資源的待處理維護動作清單。
**錯誤**
+ [ResourceNotFoundFault](api-faults.md#ResourceNotFoundFault)
## DescribeDBEngineVersions (動作)
此 API 的 AWS CLI 名稱為：`describe-db-engine-versions`。
傳回可用的資料庫引擎清單。
**請求**
+ **DBParameterGroupFamily** (在 CLI 中：`--db-parameter-group-family`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
要傳回詳細資訊的特定資料庫參數群組系列名稱。
約束:
+ 如果提供，則必須符合現有的 DBParameterGroupFamily。
+ **DefaultOnly** (在 CLI 中:`--default-only`) – 布林值，類型為：`boolean` (布林值 (true 或 false))。
指出只會傳回指定引擎或引擎預設版本和主要版本的組合。
+ **Engine** (在 CLI 中：`--engine`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
要傳回的資料庫引擎。
+ **EngineVersion** (在 CLI 中：`--engine-version`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
要傳回的資料庫引擎版本。
範例：`5.1.49`
+ **Filters** (在 CLI 中：`--filters`) – [篩選條件](api-datatypes.md#Filter) 物件的陣列。
目前不支援。
+ **ListSupportedCharacterSets** (在 CLI 中:`--list-supported-character-sets`) – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
如已指定此參數，而請求的引擎支援 `CreateDBInstance` 的 `CharacterSetName` 參數，則回應會包含每個引擎版本支援的字元集清單。
+ **ListSupportedTimezones** (在 CLI 中:`--list-supported-timezones`) – BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
如已指定此參數，而請求的引擎支援 `CreateDBInstance` 的 `TimeZone` 參數，則回應會包含每個引擎版本支援的時區清單。
+ **Marker** (在 CLI 中：`--marker`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
前一個請求提供的選用分頁字符。若指定此參數，則回應只會包含超過標記的記錄，直到 `MaxRecords` 指定的值為止。
+ **MaxRecords** (在 CLI 中：`--max-records`) – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
要在回應中包含的記錄數量上限。如有 `MaxRecords` 以上的值可用，則稱為標記的分頁字符會包含在回應中，以便擷取下列結果。
預設：100
限制條件：最小 20，最大 100。
**回應**
+ **DBEngineVersions** – 一個 [DBEngineVersion](#DBEngineVersion) 物件陣列。
`DBEngineVersion` 元素的清單。
+ **Marker** – 字串，類型為：`string` (UTF-8 編碼的字串)。
前一個請求提供的選用分頁字符。若指定此參數，則回應只會包含超過標記的記錄，直到 `MaxRecords` 指定的值為止。
## *結構：*
## DBEngineVersion (結構)
此資料類型在 [DescribeDBEngineVersions (動作)](#DescribeDBEngineVersions) 動作中會用來作為回應元素。
**欄位**
+ **DBEngineDescription** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫引擎描述。
+ **DBEngineVersionDescription** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫引擎版本描述。
+ **DBParameterGroupFamily** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫引擎的資料庫參數群組系列名稱。
+ **Engine** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫引擎名稱。
+ **EngineVersion** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫引擎版本編號。
+ **ExportableLogTypes** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫引擎能提供匯出到 CloudWatch Logs 的日誌類型。
+ **SupportedTimezones** - 這是 [時區](api-datatypes.md#Timezone) 物件的陣列。
此引擎針對 `CreateDBInstance` 動作之 `Timezone` 參數支援的時區清單。
+ **SupportsGlobalDatabases** - 這是布林值，類型為：`boolean` (布林值 (true 或 false))。
一值，指示您是否可以使用 Aurora 全球資料庫，搭配特定的資料庫引擎版本。
+ **SupportsLogExportsToCloudwatchLogs** - 這是布林值，類型為：`boolean` (布林值 (true 或 false))。
值，指出引擎版本是否支援將 ExportableLogTypes 提定的日誌類型匯出到 CloudWatch Logs。
+ **SupportsReadReplica** - 這是布林值，類型為：`boolean` (布林值 (true 或 false))。
指出資料庫引擎版本是否支援僅供讀取複本。
+ **ValidUpgradeTarget** - 這是 [UpgradeTarget](#UpgradeTarget) 物件的陣列。
此資料庫引擎版本可升級的引擎版本清單。
## EngineDefaults (結構)
包含成功呼叫 [DescribeEngineDefaultParameters (動作)](api-parameters.md#DescribeEngineDefaultParameters) 動作的結果。
**欄位**
+ **DBParameterGroupFamily** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
指定要套用引擎預設參數的資料庫參數群組系列名稱。
+ **Marker** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
前一個 EngineDefaults 請求提供的選用分頁字符。若指定此參數，則回應只會包含超過標記的記錄，直到 `MaxRecords` 指定的值為止。
+ **Parameters** - 這是 [參數](api-parameters.md#Parameter) 物件的陣列。
包含引擎預設參數的清單。
`EngineDefaults` 會用來做為以下項目的回應元素：
+ [DescribeEngineDefaultParameters](api-parameters.md#DescribeEngineDefaultParameters)
+ [DescribeEngineDefaultClusterParameters](api-parameters.md#DescribeEngineDefaultClusterParameters)
## PendingMaintenanceAction (結構)
提供資源待處理維護動作的資訊。
**欄位**
+ **Action** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
可供資源使用的待處理維護動作類型。
+ **AutoAppliedAfterDate** - 這是 TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
套用動作時的維護時段日期。維護動作會在此日期後的第一個維護時段中，套用到資源。如已指定此日期，則忽略任何 `next-maintenance` 選擇使用請求。
+ **CurrentApplyDate** - 這是 TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
待處理維護動作套用至資源時的有效日期。此日期會考慮從 [ApplyPendingMaintenanceAction (動作)](#ApplyPendingMaintenanceAction) API、`AutoAppliedAfterDate` 和 `ForcedApplyDate` 收到的選擇使用請求。如未收到選擇使用請求，且沒有任何項目指定為 `AutoAppliedAfterDate` 或 `ForcedApplyDate`，則此值為空白。
+ **Description** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
提供維護動作更多詳細資訊的描述。
+ **ForcedApplyDate** - 這是 TStamp，類型為：`timestamp` (一個時間點，通常定義為 1970-01-01 午夜的偏移量)。
自動套用維護動作時的日期。維護動作會在此日期套用至資源，無論資源的維護時段為何。如已指定此日期，則忽略任何 `immediate` 選擇使用請求。
+ **OptInStatus** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
指出資源已收到的選擇使用請求類型。
## ResourcePendingMaintenanceActions (結構)
描述資源的待處理維護動作。
**欄位**
+ **PendingMaintenanceActionDetails** - 這是 [PendingMaintenanceAction](#PendingMaintenanceAction) 物件的陣列。
清單，提供資源待處理維護動作的詳細資訊。
+ **ResourceIdentifier** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
具有待處理維護動作的資源 ARN。
`ResourcePendingMaintenanceActions` 會用來做為以下項目的回應元素：
+ [ApplyPendingMaintenanceAction](#ApplyPendingMaintenanceAction)
## UpgradeTarget (結構)
資料庫執行個體可升級的資料庫引擎版本。
**欄位**
+ **AutoUpgrade** - 這是布林值，類型為：`boolean` (布林值 (true 或 false))。
值，指出目標版本是否套用到已將 AutoMinorVersionUpgrade 設定為 true 的任何來源資料庫執行個體。
+ **Description** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫執行個體可升級的資料庫引擎版本。
+ **Engine** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
升級目標資料庫引擎名稱。
+ **EngineVersion** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
升級目標資料庫引擎的版本編號。
+ **IsMajorVersionUpgrade** - 這是布林值，類型為：`boolean` (布林值 (true 或 false))。
值，指出資料庫引擎是否升級到主要版本。
+ **SupportsGlobalDatabases** – 這是 BooleanOptional，類型為：`boolean` (布林值 (true 或 false))。
一值，指示您是否可以使用 Neptune 全球資料庫，搭配目標引擎版本。
## Tag (結構)
中繼資料，指派給由金鑰/值對組成的 Amazon Neptune 資源。
**欄位**
+ **Key** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
鍵是標籤的必要名稱。字串值長度可以是 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** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
值是標籤的選用值。字串值長度可以是 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")。
# 常見的 Neptune 資料類型
**結構：**
+ [AvailabilityZone (結構)](#AvailabilityZone)
+ [DBSecurityGroupMembership (結構)](#DBSecurityGroupMembership)
+ [DomainMembership (結構)](#DomainMembership)
+ [DoubleRange (結構)](#DoubleRange)
+ [Endpoint (結構)](#Endpoint)
+ [Filter (結構)](#Filter)
+ [Range (結構)](#Range)
+ [ServerlessV2ScalingConfiguration (結構)](#ServerlessV2ScalingConfiguration)
+ [ServerlessV2ScalingConfigurationInfo (結構)](#ServerlessV2ScalingConfigurationInfo)
+ [Timezone (結構)](#Timezone)
+ [VpcSecurityGroupMembership (結構)](#VpcSecurityGroupMembership)
## AvailabilityZone (結構)
指定可用區域。
**欄位**
+ **Name** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
可用區域的名稱。
## DBSecurityGroupMembership (結構)
指定指定資料庫安全群組中的成員資格。
**欄位**
+ **DBSecurityGroupName** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫安全群組的名稱。
+ **Status** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫安全群組的狀態。
## DomainMembership (結構)
與資料庫執行個體相關聯的 Active Directory 網域成員資格記錄。
**欄位**
+ **Domain** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
Active Directory 網域的識別符。
+ **FQDN** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
Active Directory 網域的完整網域名稱。
+ **IAMRoleName** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
對 Directory Service 執行 API 呼叫時要使用的 IAM 角色名稱。
+ **Status** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫執行個體 Active Directory 網域成員資格的狀態，例如已加入、加入待定、故障等等。
## DoubleRange (結構)
double 值的範圍。
**欄位**
+ **From** - 這是 Double，類型為：`double` (雙精度 IEEE 754 浮點數)。
範圍內的最小值。
+ **To** - 這是 Double，類型為：`double` (雙精度 IEEE 754 浮點數)。
範圍內的最大值。
## Endpoint (結構)
指定連線端點。
如需代表 Amazon Neptune 資料庫叢集端點的資料結構，請參閱 `DBClusterEndpoint`。
**欄位**
+ **Address** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
指定資料庫執行個體的 DNS 地址。
+ **HostedZoneId** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
指定當您建立託管區域時，Amazon Route 53 指派的 ID。
+ **Port** - 這是整數，類型為：`integer` (帶正負號的 32 位元整數)。
指定資料庫引擎接聽的連接埠。
## Filter (結構)
目前不支援此類型。
**欄位**
+ **Name** - 這是*必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
目前不支援此參數。
+ **Values** - 這是*必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
目前不支援此參數。
## Range (結構)
整數值範圍。
**欄位**
+ **From** - 這是整數，類型為：`integer` (帶正負號的 32 位元整數)。
範圍內的最小值。
+ **Step** – 這是 IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
範圍的間距值。例如，如果範圍是從 5,000 到 10,000，間距值為 1,000，則有效值為自 5,000 開始，每次加 1,000 的值。即使 7,500 在範圍內，卻不是範圍內的有效值。有效值為 5,000、6,000、7,000、8,000...
+ **To** - 這是整數，類型為：`integer` (帶正負號的 32 位元整數)。
範圍內的最大值。
## ServerlessV2ScalingConfiguration (結構)
包含 Neptune Serverless 資料庫叢集的擴展組態。
如需詳細資訊，請參閱《Amazon Neptune 使用者指南》**中的[使用 Amazon Neptune Serverless](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html)。
**欄位**
+ **MaxCapacity** - 這是 DoubleOptional，類型為：`double` (雙精度 IEEE 754 浮點數)。
Neptune Serverless 叢集中資料庫執行個體的 Neptune 容量單位 (NCU) 數量上限。指定 NCU 值時可使用 0.5 的增量，例如 40、40.5、41 等。
+ **MinCapacity** - 這是 DoubleOptional，類型為：`double` (雙精度 IEEE 754 浮點數)。
Neptune Serverless 叢集中資料庫執行個體的 Neptune 容量單位 (NCU) 數量下限。指定 NCU 值時可使用 0.5 的增量，例如 8、8.5、9 等。
## ServerlessV2ScalingConfigurationInfo (結構)
顯示 Neptune Serverless 資料庫叢集的擴展組態。
如需詳細資訊，請參閱《Amazon Neptune 使用者指南》**中的[使用 Amazon Neptune Serverless](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html)。
**欄位**
+ **MaxCapacity** - 這是 DoubleOptional，類型為：`double` (雙精度 IEEE 754 浮點數)。
Neptune Serverless 叢集中資料庫執行個體的 Neptune 容量單位 (NCU) 數量上限。指定 NCU 值時可使用 0.5 的增量，例如 40、40.5、41 等。
+ **MinCapacity** - 這是 DoubleOptional，類型為：`double` (雙精度 IEEE 754 浮點數)。
Neptune Serverless 叢集中資料庫執行個體的 Neptune 容量單位 (NCU) 數量下限。指定 NCU 值時可使用 0.5 的增量，例如 8、8.5、9 等。
## Timezone (結構)
與 [DBInstance (結構)](api-instances.md#DBInstance) 相關聯的時區。
**欄位**
+ **TimezoneName** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
時區的名稱。
## VpcSecurityGroupMembership (結構)
此資料類型在 VPC 安全群組成員資格中用為查詢的回應元素。
**欄位**
+ **Status** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
VPC 安全群組的狀態。
+ **VpcSecurityGroupId** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
VPC 安全群組的名稱。
# 針對個別 API 的 Neptune 例外狀況
**例外狀況：**
+ [AuthorizationAlreadyExistsFault (結構)](#AuthorizationAlreadyExistsFault)
+ [AuthorizationNotFoundFault (結構)](#AuthorizationNotFoundFault)
+ [AuthorizationQuotaExceededFault (結構)](#AuthorizationQuotaExceededFault)
+ [CertificateNotFoundFault (結構)](#CertificateNotFoundFault)
+ [DBClusterAlreadyExistsFault (結構)](#DBClusterAlreadyExistsFault)
+ [DBClusterNotFoundFault (結構)](#DBClusterNotFoundFault)
+ [DBClusterParameterGroupNotFoundFault (結構)](#DBClusterParameterGroupNotFoundFault)
+ [DBClusterQuotaExceededFault (結構)](#DBClusterQuotaExceededFault)
+ [DBClusterRoleAlreadyExistsFault (結構)](#DBClusterRoleAlreadyExistsFault)
+ [DBClusterRoleNotFoundFault (結構)](#DBClusterRoleNotFoundFault)
+ [DBClusterRoleQuotaExceededFault (結構)](#DBClusterRoleQuotaExceededFault)
+ [DBClusterSnapshotAlreadyExistsFault (結構)](#DBClusterSnapshotAlreadyExistsFault)
+ [DBClusterSnapshotNotFoundFault (結構)](#DBClusterSnapshotNotFoundFault)
+ [DBInstanceAlreadyExistsFault (結構)](#DBInstanceAlreadyExistsFault)
+ [DBInstanceNotFoundFault (結構)](#DBInstanceNotFoundFault)
+ [DBLogFileNotFoundFault (結構)](#DBLogFileNotFoundFault)
+ [DBParameterGroupAlreadyExistsFault (結構)](#DBParameterGroupAlreadyExistsFault)
+ [DBParameterGroupNotFoundFault (結構)](#DBParameterGroupNotFoundFault)
+ [DBParameterGroupQuotaExceededFault (結構)](#DBParameterGroupQuotaExceededFault)
+ [DBSecurityGroupAlreadyExistsFault (結構)](#DBSecurityGroupAlreadyExistsFault)
+ [DBSecurityGroupNotFoundFault (結構)](#DBSecurityGroupNotFoundFault)
+ [DBSecurityGroupNotSupportedFault (結構)](#DBSecurityGroupNotSupportedFault)
+ [DBSecurityGroupQuotaExceededFault (結構)](#DBSecurityGroupQuotaExceededFault)
+ [DBSnapshotAlreadyExistsFault (結構)](#DBSnapshotAlreadyExistsFault)
+ [DBSnapshotNotFoundFault (結構)](#DBSnapshotNotFoundFault)
+ [DBSubnetGroupAlreadyExistsFault (結構)](#DBSubnetGroupAlreadyExistsFault)
+ [DBSubnetGroupDoesNotCoverEnoughAZs (結構)](#DBSubnetGroupDoesNotCoverEnoughAZs)
+ [DBSubnetGroupNotAllowedFault (結構)](#DBSubnetGroupNotAllowedFault)
+ [DBSubnetGroupNotFoundFault (結構)](#DBSubnetGroupNotFoundFault)
+ [DBSubnetGroupQuotaExceededFault (結構)](#DBSubnetGroupQuotaExceededFault)
+ [DBSubnetQuotaExceededFault (結構)](#DBSubnetQuotaExceededFault)
+ [DBUpgradeDependencyFailureFault (結構)](#DBUpgradeDependencyFailureFault)
+ [DomainNotFoundFault (結構)](#DomainNotFoundFault)
+ [EventSubscriptionQuotaExceededFault (結構)](#EventSubscriptionQuotaExceededFault)
+ [GlobalClusterAlreadyExistsFault (結構)](#GlobalClusterAlreadyExistsFault)
+ [GlobalClusterNotFoundFault (結構)](#GlobalClusterNotFoundFault)
+ [GlobalClusterQuotaExceededFault (結構)](#GlobalClusterQuotaExceededFault)
+ [InstanceQuotaExceededFault (結構)](#InstanceQuotaExceededFault)
+ [InsufficientDBClusterCapacityFault (結構)](#InsufficientDBClusterCapacityFault)
+ [InsufficientDBInstanceCapacityFault (結構)](#InsufficientDBInstanceCapacityFault)
+ [InsufficientStorageClusterCapacityFault (結構)](#InsufficientStorageClusterCapacityFault)
+ [InvalidDBClusterEndpointStateFault (結構)](#InvalidDBClusterEndpointStateFault)
+ [InvalidDBClusterSnapshotStateFault (結構)](#InvalidDBClusterSnapshotStateFault)
+ [InvalidDBClusterStateFault (結構)](#InvalidDBClusterStateFault)
+ [InvalidDBInstanceStateFault (結構)](#InvalidDBInstanceStateFault)
+ [InvalidDBParameterGroupStateFault (結構)](#InvalidDBParameterGroupStateFault)
+ [InvalidDBSecurityGroupStateFault (結構)](#InvalidDBSecurityGroupStateFault)
+ [InvalidDBSnapshotStateFault (結構)](#InvalidDBSnapshotStateFault)
+ [InvalidDBSubnetGroupFault (結構)](#InvalidDBSubnetGroupFault)
+ [InvalidDBSubnetGroupStateFault (結構)](#InvalidDBSubnetGroupStateFault)
+ [InvalidDBSubnetStateFault (結構)](#InvalidDBSubnetStateFault)
+ [InvalidEventSubscriptionStateFault (結構)](#InvalidEventSubscriptionStateFault)
+ [InvalidGlobalClusterStateFault (結構)](#InvalidGlobalClusterStateFault)
+ [InvalidOptionGroupStateFault (結構)](#InvalidOptionGroupStateFault)
+ [InvalidRestoreFault (結構)](#InvalidRestoreFault)
+ [InvalidSubnet (結構)](#InvalidSubnet)
+ [InvalidVPCNetworkStateFault (結構)](#InvalidVPCNetworkStateFault)
+ [KMSKeyNotAccessibleFault (結構)](#KMSKeyNotAccessibleFault)
+ [OptionGroupNotFoundFault (結構)](#OptionGroupNotFoundFault)
+ [PointInTimeRestoreNotEnabledFault (結構)](#PointInTimeRestoreNotEnabledFault)
+ [ProvisionedIopsNotAvailableInAZFault (結構)](#ProvisionedIopsNotAvailableInAZFault)
+ [ResourceNotFoundFault (結構)](#ResourceNotFoundFault)
+ [SNSInvalidTopicFault (結構)](#SNSInvalidTopicFault)
+ [SNSNoAuthorizationFault (結構)](#SNSNoAuthorizationFault)
+ [SNSTopicArnNotFoundFault (結構)](#SNSTopicArnNotFoundFault)
+ [SharedSnapshotQuotaExceededFault (結構)](#SharedSnapshotQuotaExceededFault)
+ [SnapshotQuotaExceededFault (結構)](#SnapshotQuotaExceededFault)
+ [SourceNotFoundFault (結構)](#SourceNotFoundFault)
+ [StorageQuotaExceededFault (結構)](#StorageQuotaExceededFault)
+ [StorageTypeNotSupportedFault (結構)](#StorageTypeNotSupportedFault)
+ [SubnetAlreadyInUse (結構)](#SubnetAlreadyInUse)
+ [SubscriptionAlreadyExistFault (結構)](#SubscriptionAlreadyExistFault)
+ [SubscriptionCategoryNotFoundFault (結構)](#SubscriptionCategoryNotFoundFault)
+ [SubscriptionNotFoundFault (結構)](#SubscriptionNotFoundFault)
## AuthorizationAlreadyExistsFault (結構)
**傳回的 HTTP 狀態碼：**400。
指定的 CIDRIP 或 EC2 安全群組已獲指定的資料庫安全群組授權。
**欄位**
+ **message** - 這是 ExceptionMessage，類型:`string` (UTF-8 編碼的字串)。
說明問題詳細資訊的訊息。
## AuthorizationNotFoundFault (結構)
**傳回的 HTTP 狀態碼：**404。
指定的 CIDRIP 或 EC2 安全群組未獲指定的資料庫安全群組授權。
Neptune 可能不會透過 IAM 授權代您執行必要的動作。
**欄位**
+ **message** - 這是 ExceptionMessage，類型:`string` (UTF-8 編碼的字串)。
說明問題詳細資訊的訊息。
## AuthorizationQuotaExceededFault (結構)
**傳回的 HTTP 狀態碼：**400。
已達到資料庫安全群組授權配額。
**欄位**
+ **message** - 這是 ExceptionMessage，類型:`string` (UTF-8 編碼的字串)。
說明問題詳細資訊的訊息。
## CertificateNotFoundFault (結構)
**傳回的 HTTP 狀態碼：**404。
*CertificateIdentifier* 不代表現有的憑證。
**欄位**
+ **message** - 這是 ExceptionMessage，類型:`string` (UTF-8 編碼的字串)。
說明問題詳細資訊的訊息。
## DBClusterAlreadyExistsFault (結構)
**傳回的 HTTP 狀態碼：**400。
使用者的資料庫叢集已有指定的識別符。
**欄位**
+ **message** - 這是 ExceptionMessage，類型:`string` (UTF-8 編碼的字串)。
說明問題詳細資訊的訊息。
## DBClusterNotFoundFault (結構)
**傳回的 HTTP 狀態碼：**404。
*DBClusterIdentifier* 不代表現有的資料庫叢集。
**欄位**
+ **message** - 這是 ExceptionMessage，類型:`string` (UTF-8 編碼的字串)。
說明問題詳細資訊的訊息。
## DBClusterParameterGroupNotFoundFault (結構)
**傳回的 HTTP 狀態碼：**404。
*DBClusterParameterGroupName* 不代表現有的資料庫叢集參數群組。
**欄位**
+ **message** - 這是 ExceptionMessage，類型:`string` (UTF-8 編碼的字串)。
說明問題詳細資訊的訊息。
## DBClusterQuotaExceededFault (結構)
**傳回的 HTTP 狀態碼：**403。
使用者嘗試建立新的資料庫叢集，但使用者已經達到允許的資料庫叢集配額上限。
**欄位**
+ **message** - 這是 ExceptionMessage，類型:`string` (UTF-8 編碼的字串)。
說明問題詳細資訊的訊息。
## DBClusterRoleAlreadyExistsFault (結構)
**傳回的 HTTP 狀態碼：**400。
指定的 IAM 角色 Amazon Resource Name (ARN) 與指定的資料庫叢集相關聯。
**欄位**
+ **message** - 這是 ExceptionMessage，類型:`string` (UTF-8 編碼的字串)。
說明問題詳細資訊的訊息。
## DBClusterRoleNotFoundFault (結構)
**傳回的 HTTP 狀態碼：**404。
指定的 IAM 角色 Amazon Resource Name (ARN) 與指定的資料庫叢集不相關聯。
**欄位**
+ **message** - 這是 ExceptionMessage，類型:`string` (UTF-8 編碼的字串)。
說明問題詳細資訊的訊息。
## DBClusterRoleQuotaExceededFault (結構)
**傳回的 HTTP 狀態碼：**400。
您已超過可與指定資料庫叢集相關聯之 IAM 角色的最大數量。
**欄位**
+ **message** - 這是 ExceptionMessage，類型:`string` (UTF-8 編碼的字串)。
說明問題詳細資訊的訊息。
## DBClusterSnapshotAlreadyExistsFault (結構)
**傳回的 HTTP 狀態碼：**400。
使用者的資料庫叢集快照已有指定的識別符。
**欄位**
+ **message** - 這是 ExceptionMessage，類型:`string` (UTF-8 編碼的字串)。
說明問題詳細資訊的訊息。
## DBClusterSnapshotNotFoundFault (結構)
**傳回的 HTTP 狀態碼：**404。
*DBClusterSnapshotIdentifier* 不代表現有的資料庫叢集快照。
**欄位**
+ **message** - 這是 ExceptionMessage，類型:`string` (UTF-8 編碼的字串)。
說明問題詳細資訊的訊息。
## DBInstanceAlreadyExistsFault (結構)
**傳回的 HTTP 狀態碼：**400。
使用者的資料庫執行個體已有指定的識別符。
**欄位**
+ **message** - 這是 ExceptionMessage，類型:`string` (UTF-8 編碼的字串)。
說明問題詳細資訊的訊息。
## DBInstanceNotFoundFault (結構)
**傳回的 HTTP 狀態碼：**404。
*DBInstanceIdentifier* 不代表現有的資料庫執行個體。
**欄位**
+ **message** - 這是 ExceptionMessage，類型:`string` (UTF-8 編碼的字串)。
說明問題詳細資訊的訊息。
## DBLogFileNotFoundFault (結構)
**傳回的 HTTP 狀態碼：**404。
*LogFileName* 不代表現有的資料庫日誌檔案。
**欄位**
+ **message** - 這是 ExceptionMessage，類型:`string` (UTF-8 編碼的字串)。
說明問題詳細資訊的訊息。
## DBParameterGroupAlreadyExistsFault (結構)
**傳回的 HTTP 狀態碼：**400。
有同名的資料庫參數群組。
**欄位**
+ **message** - 這是 ExceptionMessage，類型:`string` (UTF-8 編碼的字串)。
說明問題詳細資訊的訊息。
## DBParameterGroupNotFoundFault (結構)
**傳回的 HTTP 狀態碼：**404。
*DBParameterGroupName* 不代表現有的資料庫參數群組。
**欄位**
+ **message** - 這是 ExceptionMessage，類型:`string` (UTF-8 編碼的字串)。
說明問題詳細資訊的訊息。
## DBParameterGroupQuotaExceededFault (結構)
**傳回的 HTTP 狀態碼：**400。
請求會造成使用者超出允許的資料庫參數群組數目。
**欄位**
+ **message** - 這是 ExceptionMessage，類型:`string` (UTF-8 編碼的字串)。
說明問題詳細資訊的訊息。
## DBSecurityGroupAlreadyExistsFault (結構)
**傳回的 HTTP 狀態碼：**400。
已有 *DBSecurityGroupName* 指定名稱的資料庫安全群組。
**欄位**
+ **message** - 這是 ExceptionMessage，類型:`string` (UTF-8 編碼的字串)。
說明問題詳細資訊的訊息。
## DBSecurityGroupNotFoundFault (結構)
**傳回的 HTTP 狀態碼：**404。
*DBSecurityGroupName* 不代表現有的資料庫安全群組。
**欄位**
+ **message** - 這是 ExceptionMessage，類型:`string` (UTF-8 編碼的字串)。
說明問題詳細資訊的訊息。
## DBSecurityGroupNotSupportedFault (結構)
**傳回的 HTTP 狀態碼：**400。
資料庫安全群組不允許此動作。
**欄位**
+ **message** - 這是 ExceptionMessage，類型:`string` (UTF-8 編碼的字串)。
說明問題詳細資訊的訊息。
## DBSecurityGroupQuotaExceededFault (結構)
**傳回的 HTTP 狀態碼：**400。
請求會造成使用者超出允許的資料庫安全群組數目。
**欄位**
+ **message** - 這是 ExceptionMessage，類型:`string` (UTF-8 編碼的字串)。
說明問題詳細資訊的訊息。
## DBSnapshotAlreadyExistsFault (結構)
**傳回的 HTTP 狀態碼：**400。
現有的快照已使用 *DBSnapshotIdentifier*。
**欄位**
+ **message** - 這是 ExceptionMessage，類型:`string` (UTF-8 編碼的字串)。
說明問題詳細資訊的訊息。
## DBSnapshotNotFoundFault (結構)
**傳回的 HTTP 狀態碼：**404。
*DBSnapshotIdentifier* 不代表現有的資料庫快照。
**欄位**
+ **message** - 這是 ExceptionMessage，類型:`string` (UTF-8 編碼的字串)。
說明問題詳細資訊的訊息。
## DBSubnetGroupAlreadyExistsFault (結構)
**傳回的 HTTP 狀態碼：**400。
現有的資料庫子網路群組已使用 *DBSubnetGroupName*。
**欄位**
+ **message** - 這是 ExceptionMessage，類型:`string` (UTF-8 編碼的字串)。
說明問題詳細資訊的訊息。
## DBSubnetGroupDoesNotCoverEnoughAZs (結構)
**傳回的 HTTP 狀態碼：**400。
除非只有一個可用區域，否則資料庫子網路群組中的子網路至少應覆蓋兩個可用區域。
**欄位**
+ **message** - 這是 ExceptionMessage，類型:`string` (UTF-8 編碼的字串)。
說明問題詳細資訊的訊息。
## DBSubnetGroupNotAllowedFault (結構)
**傳回的 HTTP 狀態碼：**400。
指出建立僅供讀取複本時不應指定 DBSubnetGroup，此複本與來源執行個體位於相同的區域。
**欄位**
+ **message** - 這是 ExceptionMessage，類型:`string` (UTF-8 編碼的字串)。
說明問題詳細資訊的訊息。
## DBSubnetGroupNotFoundFault (結構)
**傳回的 HTTP 狀態碼：**404。
*DBSubnetGroupName* 不代表現有的資料庫子網路群組。
**欄位**
+ **message** - 這是 ExceptionMessage，類型:`string` (UTF-8 編碼的字串)。
說明問題詳細資訊的訊息。
## DBSubnetGroupQuotaExceededFault (結構)
**傳回的 HTTP 狀態碼：**400。
請求會造成使用者超出允許的資料庫子網路群組數目。
**欄位**
+ **message** - 這是 ExceptionMessage，類型:`string` (UTF-8 編碼的字串)。
說明問題詳細資訊的訊息。
## DBSubnetQuotaExceededFault (結構)
**傳回的 HTTP 狀態碼：**400。
請求會造成使用者超出資料庫子網路允許的子網路數目。
**欄位**
+ **message** - 這是 ExceptionMessage，類型:`string` (UTF-8 編碼的字串)。
說明問題詳細資訊的訊息。
## DBUpgradeDependencyFailureFault (結構)
**傳回的 HTTP 狀態碼：**400。
因為無法修改資料庫依賴的資源，所以資料庫升級失敗。
**欄位**
+ **message** - 這是 ExceptionMessage，類型:`string` (UTF-8 編碼的字串)。
說明問題詳細資訊的訊息。
## DomainNotFoundFault (結構)
**傳回的 HTTP 狀態碼：**404。
*Domain* 不表示現有的 Active Directory 網域。
**欄位**
+ **message** - 這是 ExceptionMessage，類型:`string` (UTF-8 編碼的字串)。
說明問題詳細資訊的訊息。
## EventSubscriptionQuotaExceededFault (結構)
**傳回的 HTTP 狀態碼：**400。
您已超過可以訂閱的事件數目。
**欄位**
+ **message** - 這是 ExceptionMessage，類型:`string` (UTF-8 編碼的字串)。
說明問題詳細資訊的訊息。
## GlobalClusterAlreadyExistsFault (結構)
**傳回的 HTTP 狀態碼：**400。
`GlobalClusterIdentifier` 已存在。選擇新的全球資料庫識別符 (唯一名稱)，以建立新的全球資料庫叢集。
**欄位**
+ **message** - 這是 ExceptionMessage，類型:`string` (UTF-8 編碼的字串)。
說明問題詳細資訊的訊息。
## GlobalClusterNotFoundFault (結構)
**傳回的 HTTP 狀態碼：**404。
`GlobalClusterIdentifier` 不會參考現有的全球資料庫叢集。
**欄位**
+ **message** - 這是 ExceptionMessage，類型:`string` (UTF-8 編碼的字串)。
說明問題詳細資訊的訊息。
## GlobalClusterQuotaExceededFault (結構)
**傳回的 HTTP 狀態碼：**400。
此帳戶的全球資料庫叢集數目已達允許的上限。
**欄位**
+ **message** - 這是 ExceptionMessage，類型:`string` (UTF-8 編碼的字串)。
說明問題詳細資訊的訊息。
## InstanceQuotaExceededFault (結構)
**傳回的 HTTP 狀態碼：**400。
請求會造成使用者超出允許的資料庫執行個體數目。
**欄位**
+ **message** - 這是 ExceptionMessage，類型:`string` (UTF-8 編碼的字串)。
說明問題詳細資訊的訊息。
## InsufficientDBClusterCapacityFault (結構)
**傳回的 HTTP 狀態碼：**403。
資料庫叢集沒有足夠的容量，無法執行目前的操作。
**欄位**
+ **message** - 這是 ExceptionMessage，類型:`string` (UTF-8 編碼的字串)。
說明問題詳細資訊的訊息。
## InsufficientDBInstanceCapacityFault (結構)
**傳回的 HTTP 狀態碼：**400。
指定的資料庫執行個體類別無法提供指定的可用區域使用。
**欄位**
+ **message** - 這是 ExceptionMessage，類型:`string` (UTF-8 編碼的字串)。
說明問題詳細資訊的訊息。
## InsufficientStorageClusterCapacityFault (結構)
**傳回的 HTTP 狀態碼：**400。
目前的動作沒有足夠的儲存體可用。您可以更新您的子網路群組，使用有更多儲存體可用的不同可用區域，來解決這個錯誤。
**欄位**
+ **message** - 這是 ExceptionMessage，類型:`string` (UTF-8 編碼的字串)。
說明問題詳細資訊的訊息。
## InvalidDBClusterEndpointStateFault (結構)
**傳回的 HTTP 狀態碼：**400。
端點處於此狀態時，無法在端點上執行請求的操作。
**欄位**
+ **message** - 這是 ExceptionMessage，類型:`string` (UTF-8 編碼的字串)。
說明問題詳細資訊的訊息。
## InvalidDBClusterSnapshotStateFault (結構)
**傳回的 HTTP 狀態碼：**400。
提供的值不是有效的資料庫叢集快照狀態。
**欄位**
+ **message** - 這是 ExceptionMessage，類型:`string` (UTF-8 編碼的字串)。
說明問題詳細資訊的訊息。
## InvalidDBClusterStateFault (結構)
**傳回的 HTTP 狀態碼：**400。
資料庫叢集不為有效狀態。
**欄位**
+ **message** - 這是 ExceptionMessage，類型:`string` (UTF-8 編碼的字串)。
說明問題詳細資訊的訊息。
## InvalidDBInstanceStateFault (結構)
**傳回的 HTTP 狀態碼：**400。
指定的資料庫執行個體不為「可用」**狀態。
**欄位**
+ **message** - 這是 ExceptionMessage，類型:`string` (UTF-8 編碼的字串)。
說明問題詳細資訊的訊息。
## InvalidDBParameterGroupStateFault (結構)
**傳回的 HTTP 狀態碼：**400。
資料庫參數群組正在使用，或為無效狀態。如果您想嘗試刪除參數群組，您無法刪除此狀態的參數群組。
**欄位**
+ **message** - 這是 ExceptionMessage，類型:`string` (UTF-8 編碼的字串)。
說明問題詳細資訊的訊息。
## InvalidDBSecurityGroupStateFault (結構)
**傳回的 HTTP 狀態碼：**400。
資料庫安全群組的狀態不允許刪除。
**欄位**
+ **message** - 這是 ExceptionMessage，類型:`string` (UTF-8 編碼的字串)。
說明問題詳細資訊的訊息。
## InvalidDBSnapshotStateFault (結構)
**傳回的 HTTP 狀態碼：**400。
資料庫快照的狀態不允許刪除。
**欄位**
+ **message** - 這是 ExceptionMessage，類型:`string` (UTF-8 編碼的字串)。
說明問題詳細資訊的訊息。
## InvalidDBSubnetGroupFault (結構)
**傳回的 HTTP 狀態碼：**400。
指出 DBSubnetGroup 和現有的跨區域僅供讀取複本，雖然有相同的來源執行個體，但不屬於同一個 VPC。
**欄位**
+ **message** - 這是 ExceptionMessage，類型:`string` (UTF-8 編碼的字串)。
說明問題詳細資訊的訊息。
## InvalidDBSubnetGroupStateFault (結構)
**傳回的 HTTP 狀態碼：**400。
資料庫子網路群組因為正在使用，所以無法刪除。
**欄位**
+ **message** - 這是 ExceptionMessage，類型:`string` (UTF-8 編碼的字串)。
說明問題詳細資訊的訊息。
## InvalidDBSubnetStateFault (結構)
**傳回的 HTTP 狀態碼：**400。
資料庫子網路不為「可用」**狀態。
**欄位**
+ **message** - 這是 ExceptionMessage，類型:`string` (UTF-8 編碼的字串)。
說明問題詳細資訊的訊息。
## InvalidEventSubscriptionStateFault (結構)
**傳回的 HTTP 狀態碼：**400。
事件訂閱為無效狀態。
**欄位**
+ **message** - 這是 ExceptionMessage，類型:`string` (UTF-8 編碼的字串)。
說明問題詳細資訊的訊息。
## InvalidGlobalClusterStateFault (結構)
**傳回的 HTTP 狀態碼：**400。
全域叢集處於無效狀態，無法執行請求的作業。
**欄位**
+ **message** - 這是 ExceptionMessage，類型:`string` (UTF-8 編碼的字串)。
說明問題詳細資訊的訊息。
## InvalidOptionGroupStateFault (結構)
**傳回的 HTTP 狀態碼：**400。
選項群組不為「可用」**狀態。
**欄位**
+ **message** - 這是 ExceptionMessage，類型:`string` (UTF-8 編碼的字串)。
說明問題詳細資訊的訊息。
## InvalidRestoreFault (結構)
**傳回的 HTTP 狀態碼：**400。
無法從 vpc 備份還原到非 vpc 資料庫執行個體。
**欄位**
+ **message** - 這是 ExceptionMessage，類型:`string` (UTF-8 編碼的字串)。
說明問題詳細資訊的訊息。
## InvalidSubnet (結構)
**傳回的 HTTP 狀態碼：**400。
請求的子網路無效，或已請求的多個子網路，不全在共同的 VPC 中。
**欄位**
+ **message** - 這是 ExceptionMessage，類型:`string` (UTF-8 編碼的字串)。
說明問題詳細資訊的訊息。
## InvalidVPCNetworkStateFault (結構)
**傳回的 HTTP 狀態碼：**400。
因為使用者的變更，資料庫子網路群組在建立後不會覆蓋所有可用區域。
**欄位**
+ **message** - 這是 ExceptionMessage，類型:`string` (UTF-8 編碼的字串)。
說明問題詳細資訊的訊息。
## KMSKeyNotAccessibleFault (結構)
**傳回的 HTTP 狀態碼：**400。
存取 KMS 金鑰發生錯誤。
**欄位**
+ **message** - 這是 ExceptionMessage，類型:`string` (UTF-8 編碼的字串)。
說明問題詳細資訊的訊息。
## OptionGroupNotFoundFault (結構)
**傳回的 HTTP 狀態碼：**404。
找不到指定的選項群組。
**欄位**
+ **message** - 這是 ExceptionMessage，類型:`string` (UTF-8 編碼的字串)。
說明問題詳細資訊的訊息。
## PointInTimeRestoreNotEnabledFault (結構)
**傳回的 HTTP 狀態碼：**400。
*SourceDBInstanceIdentifier* 是指 *BackupRetentionPeriod* 等於 0 的資料庫執行個體。
**欄位**
+ **message** - 這是 ExceptionMessage，類型:`string` (UTF-8 編碼的字串)。
說明問題詳細資訊的訊息。
## ProvisionedIopsNotAvailableInAZFault (結構)
**傳回的 HTTP 狀態碼：**400。
在指定的可用區域中無法使用佈建 IOPS。
**欄位**
+ **message** - 這是 ExceptionMessage，類型:`string` (UTF-8 編碼的字串)。
說明問題詳細資訊的訊息。
## ResourceNotFoundFault (結構)
**傳回的 HTTP 狀態碼：**404。
找不到指定的資源 ID。
**欄位**
+ **message** - 這是 ExceptionMessage，類型:`string` (UTF-8 編碼的字串)。
說明問題詳細資訊的訊息。
## SNSInvalidTopicFault (結構)
**傳回的 HTTP 狀態碼：**400。
SNS 主題無效。
**欄位**
+ **message** - 這是 ExceptionMessage，類型:`string` (UTF-8 編碼的字串)。
說明問題詳細資訊的訊息。
## SNSNoAuthorizationFault (結構)
**傳回的 HTTP 狀態碼：**400。
沒有 SNS 授權。
**欄位**
+ **message** - 這是 ExceptionMessage，類型:`string` (UTF-8 編碼的字串)。
說明問題詳細資訊的訊息。
## SNSTopicArnNotFoundFault (結構)
**傳回的 HTTP 狀態碼：**404。
找不到 SNS 主題的 ARN。
**欄位**
+ **message** - 這是 ExceptionMessage，類型:`string` (UTF-8 編碼的字串)。
說明問題詳細資訊的訊息。
## SharedSnapshotQuotaExceededFault (結構)
**傳回的 HTTP 狀態碼：**400。
您已超過可共享手動資料庫快照的帳戶數量上限。
**欄位**
+ **message** - 這是 ExceptionMessage，類型:`string` (UTF-8 編碼的字串)。
說明問題詳細資訊的訊息。
## SnapshotQuotaExceededFault (結構)
**傳回的 HTTP 狀態碼：**400。
請求會造成使用者超出允許的資料庫快照數目。
**欄位**
+ **message** - 這是 ExceptionMessage，類型:`string` (UTF-8 編碼的字串)。
說明問題詳細資訊的訊息。
## SourceNotFoundFault (結構)
**傳回的 HTTP 狀態碼：**404。
找不到來源。
**欄位**
+ **message** - 這是 ExceptionMessage，類型:`string` (UTF-8 編碼的字串)。
說明問題詳細資訊的訊息。
## StorageQuotaExceededFault (結構)
**傳回的 HTTP 狀態碼：**400。
請求會造成使用者超過所有資料庫執行個體允許的可用儲存量。
**欄位**
+ **message** - 這是 ExceptionMessage，類型:`string` (UTF-8 編碼的字串)。
說明問題詳細資訊的訊息。
## StorageTypeNotSupportedFault (結構)
**傳回的 HTTP 狀態碼：**400。
指定的 *StorageType* 無法與資料庫執行個體相關聯。
**欄位**
+ **message** - 這是 ExceptionMessage，類型:`string` (UTF-8 編碼的字串)。
說明問題詳細資訊的訊息。
## SubnetAlreadyInUse (結構)
**傳回的 HTTP 狀態碼：**400。
資料庫子網路已在可用區域中使用。
**欄位**
+ **message** - 這是 ExceptionMessage，類型:`string` (UTF-8 編碼的字串)。
說明問題詳細資訊的訊息。
## SubscriptionAlreadyExistFault (結構)
**傳回的 HTTP 狀態碼：**400。
此訂閱已存在。
**欄位**
+ **message** - 這是 ExceptionMessage，類型:`string` (UTF-8 編碼的字串)。
說明問題詳細資訊的訊息。
## SubscriptionCategoryNotFoundFault (結構)
**傳回的 HTTP 狀態碼：**404。
找不到指定的訂閱類別。
**欄位**
+ **message** - 這是 ExceptionMessage，類型:`string` (UTF-8 編碼的字串)。
說明問題詳細資訊的訊息。
## SubscriptionNotFoundFault (結構)
**傳回的 HTTP 狀態碼：**404。
找不到指定的訂閱。
**欄位**
+ **message** - 這是 ExceptionMessage，類型:`string` (UTF-8 編碼的字串)。
說明問題詳細資訊的訊息。