本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
Neptune 快照 API
動作:
結構:
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 物件的陣列。要指派給資料庫叢集快照的標籤。
回應
包含 Amazon Neptune 資料庫叢集快照的詳細資訊
此資料類型在 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。
錯誤
DeleteDBClusterSnapshot (動作)
此 API 的 AWS CLI 名稱是:delete-db-cluster-snapshot
。
刪除資料庫叢集快照。如果正在複製快照,即會終止複製操作。
注意
資料庫叢集快照必須為 available
狀態才能刪除。
請求
-
DBClusterSnapshotIdentifier (在 CLI 中:
--db-cluster-snapshot-identifier
) – 必要:字串,類型為:string
(UTF-8 編碼的字串)。要刪除之資料庫叢集快照的識別符。
限制條件:必須是
available
狀態的現有資料庫叢集快照名稱。
回應
包含 Amazon Neptune 資料庫叢集快照的詳細資訊
此資料類型在 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。
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 物件的陣列。要指派給新資料庫叢集快照副本的標籤。
-
TargetDBClusterSnapshotIdentifier (在 CLI 中:
--target-db-cluster-snapshot-identifier
) – 必要:字串,類型為:string
(UTF-8 編碼的字串)。要從來源資料庫叢集快照建立之新資料庫叢集快照的識別符。此參數不區分大小寫。
約束:
-
必須包含 1 到 63 個字母、數字或連字號。
-
第一個字元必須是字母。
-
不能以連字號結尾或連續包含兩個連字號。
範例:
my-cluster-snapshot2
-
回應
包含 Amazon Neptune 資料庫叢集快照的詳細資訊
此資料類型在 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。
錯誤
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 (動作) 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 (動作) API 動作的結果。
手動資料庫叢集快照屬性是用於授權其他 Amazon 帳戶以複製或還原手動資料庫叢集快照。如需詳細資訊,請參閱 ModifyDBClusterSnapshotAttribute (動作) API 動作。
-
DBClusterSnapshotAttributes – 一個 DBClusterSnapshotAttribute 物件陣列。
手動資料庫叢集快照的屬性和值清單。
-
DBClusterSnapshotIdentifier – 字串,類型為:
string
(UTF-8 編碼的字串)。屬性套用目標之手動資料庫叢集快照的識別符。
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 物件。包含 Neptune Serverless 資料庫叢集的擴展組態。
如需詳細資訊,請參閱《Amazon Neptune 使用者指南》中的使用 Amazon Neptune Serverless。
-
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 物件的陣列。要指派給已還原資料庫叢集的標籤。
-
VpcSecurityGroupIds (在 CLI 中:
--vpc-security-group-ids
) – 字串,類型為:string
(UTF-8 編碼的字串)。新資料庫叢集將歸屬之 VPC 安全群組清單。
回應
包含 Amazon Neptune 資料庫叢集的詳細資訊。
此資料類型會在 DescribeDBClusters (動作) 動作中用作回應元素。
-
AllocatedStorage – IntegerOptional,類型為:
integer
(帶正負號的 32 位元整數)。AllocatedStorage
一律會傳回 1,因為 Neptune 資料庫叢集儲存體大小並非固定,而是會視需要自動調整。 -
AssociatedRoles – 一個 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 物件陣列。
提供組成資料庫叢集的執行個體清單。
-
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。 -
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 物件。
此資料類型會在
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 物件。
顯示 Neptune Serverless 資料庫叢集的擴展組態。
如需詳細資訊,請參閱《Amazon Neptune 使用者指南》中的使用 Amazon Neptune Serverless。
-
Status – 字串,類型為:
string
(UTF-8 編碼的字串)。指定此資料庫叢集的目前狀態。
-
StorageEncrypted – 布林值,類型為:
boolean
(布林值 (true 或 false))。指定是否要加密資料庫叢集。
-
StorageType – 字串,類型為:
string
(UTF-8 編碼的字串)。資料庫叢集使用的儲存類型。
有效值:
-
standard
– (預設值) 針對具有中至低 I/O 使用量的應用程式提供具成本效益的資料庫儲存體。 -
iopt1
– 啟用 I/O 優化儲存,旨在符合 I/O 密集型圖形工作負載的需求,而這些工作負載則需要可預測的定價、低 I/O 延遲和一致的 I/O 輸送量。僅引擎版本 1.3.0.0 開始提供 Neptune I/O 優化儲存。
-
-
VpcSecurityGroups – 一個 VpcSecurityGroupMembership 物件陣列。
提供資料庫叢集歸屬的 VPC 安全群組清單。
錯誤
RestoreDBClusterToPointInTime (動作)
此 API 的 AWS CLI 名稱是:restore-db-cluster-to-point-in-time
。
將資料庫叢集還原到任意時間點。使用者可以還原到 LatestRestorableTime
之前的任意時間點,最多 BackupRetentionPeriod
天。目標資料庫叢集使用與原始資料庫叢集有相同組態之來源資料庫叢集建立,但新的資料庫叢集使用預設資料庫安全群組建立時除外。
注意
這個動作只會還原資料庫叢集,不會還原該資料庫叢集的資料庫執行個體。您必須呼叫 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 物件。包含 Neptune Serverless 資料庫叢集的擴展組態。
如需詳細資訊,請參閱《Amazon Neptune 使用者指南》中的使用 Amazon Neptune Serverless。
-
SourceDBClusterIdentifier (在 CLI 中:
--source-db-cluster-identifier
) – 必要:字串,類型為:string
(UTF-8 編碼的字串)。還原來源之來源資料庫叢集的識別符。
約束:
-
必須符合現有 DBCluster 的識別碼。
-
-
StorageType (在 CLI 中:
--storage-type
) – 字串,類型為:string
(UTF-8 編碼的字串)。指定要和資料庫叢集建立關聯的儲存類型。
有效值:
standard
、iopt1
預設:
standard
-
Tags (在 CLI 中:
--tags
) – 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 (動作) 動作中用作回應元素。
-
AllocatedStorage – IntegerOptional,類型為:
integer
(帶正負號的 32 位元整數)。AllocatedStorage
一律會傳回 1,因為 Neptune 資料庫叢集儲存體大小並非固定,而是會視需要自動調整。 -
AssociatedRoles – 一個 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 物件陣列。
提供組成資料庫叢集的執行個體清單。
-
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。 -
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 物件。
此資料類型會在
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 物件。
顯示 Neptune Serverless 資料庫叢集的擴展組態。
如需詳細資訊,請參閱《Amazon Neptune 使用者指南》中的使用 Amazon Neptune Serverless。
-
Status – 字串,類型為:
string
(UTF-8 編碼的字串)。指定此資料庫叢集的目前狀態。
-
StorageEncrypted – 布林值,類型為:
boolean
(布林值 (true 或 false))。指定是否要加密資料庫叢集。
-
StorageType – 字串,類型為:
string
(UTF-8 編碼的字串)。資料庫叢集使用的儲存類型。
有效值:
-
standard
– (預設值) 針對具有中至低 I/O 使用量的應用程式提供具成本效益的資料庫儲存體。 -
iopt1
– 啟用 I/O 優化儲存,旨在符合 I/O 密集型圖形工作負載的需求,而這些工作負載則需要可預測的定價、低 I/O 延遲和一致的 I/O 輸送量。僅引擎版本 1.3.0.0 開始提供 Neptune I/O 優化儲存。
-
-
VpcSecurityGroups – 一個 VpcSecurityGroupMembership 物件陣列。
提供資料庫叢集歸屬的 VPC 安全群組清單。
錯誤
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
) – 篩選條件 物件的陣列。目前不支援此參數。
-
IncludePublic (在 CLI 中:
--include-public
) – 布林值,類型為:boolean
(布林值 (true 或 false))。True 則包含可由任何 Amazon 帳戶複製或還原的公有手動資料庫叢集快照,否則為 false。預設值為
false
。預設值為 false。您可以使用 ModifyDBClusterSnapshotAttribute (動作) API 動作,以公有狀態共享手動的資料庫叢集快照。
-
IncludeShared (在 CLI 中:
--include-shared
) – 布林值,類型為:boolean
(布林值 (true 或 false))。True 則包含來自其他 Amazon 帳戶的共用手動資料庫叢集快照,且此 Amazon 帳戶具有複製或還原的許可,否則為 false。預設值為
false
。您可以使用 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 物件陣列。
為使用者提供資料庫叢集快照的清單。
-
Marker – 字串,類型為:
string
(UTF-8 編碼的字串)。前一個 DescribeDBClusterSnapshots (動作) 請求提供的選用分頁字符。若指定此參數,則回應只會包含超過標記的記錄,直到
MaxRecords
指定的值為止。
DescribeDBClusterSnapshotAttributes (動作)
此 API 的 AWS CLI 名稱是:describe-db-cluster-snapshot-attributes
。
傳回手動資料庫叢集快照之資料庫叢集快照屬性名稱和值的清單。
與其他 Amazon 帳戶共用快照時,DescribeDBClusterSnapshotAttributes
會傳回 restore
屬性和 Amazon 帳戶的 ID 清單,此 Amazon 帳戶有權複製或還原手動資料庫叢集快照。如果 all
包含在 restore
屬性的值清單中,則手動資料庫叢集快照為公有,且所有 Amazon 帳戶都可以複製或還原它。
若要新增或移除 Amazon 帳戶複製或還原手動資料庫叢集快照的許可,或使手動資料庫叢集快照成為公有或私有的,請使用 ModifyDBClusterSnapshotAttribute (動作) API 動作。
請求
-
DBClusterSnapshotIdentifier (在 CLI 中:
--db-cluster-snapshot-identifier
) – 必要:字串,類型為:string
(UTF-8 編碼的字串)。要描述屬性之資料庫叢集快照的識別符。
回應
包含成功呼叫 DescribeDBClusterSnapshotAttributes (動作) API 動作的結果。
手動資料庫叢集快照屬性是用於授權其他 Amazon 帳戶以複製或還原手動資料庫叢集快照。如需詳細資訊,請參閱 ModifyDBClusterSnapshotAttribute (動作) API 動作。
-
DBClusterSnapshotAttributes – 一個 DBClusterSnapshotAttribute 物件陣列。
手動資料庫叢集快照的屬性和值清單。
-
DBClusterSnapshotIdentifier – 字串,類型為:
string
(UTF-8 編碼的字串)。屬性套用目標之手動資料庫叢集快照的識別符。
結構:
DBClusterSnapshot (結構)
包含 Amazon Neptune 資料庫叢集快照的詳細資訊
此資料類型在 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
會用來做為以下項目的回應元素:
DBClusterSnapshotAttribute (結構)
包含手動資料庫叢集快照屬性的名稱和值。
手動資料庫叢集快照屬性是用於授權其他 Amazon 帳戶以還原手動資料庫叢集快照。如需詳細資訊,請參閱 ModifyDBClusterSnapshotAttribute (動作) API 動作。
欄位
-
AttributeName - 這是字串,類型為:
string
(UTF-8 編碼的字串)。手動資料庫叢集快照屬性的名稱。
名為
restore
的屬性是指具有複製或還原手動資料庫叢集快照許可的 Amazon 帳戶清單。如需詳細資訊,請參閱 ModifyDBClusterSnapshotAttribute (動作) API 動作。 -
AttributeValues - 這是字串,類型為:
string
(UTF-8 編碼的字串)。手動資料庫叢集快照屬性的值。
如果
AttributeName
欄位設為restore
,則此元素會傳回 Amazon 帳戶 ID 的清單,這些帳戶有權複製或還原手動資料庫叢集快照。如果清單中有all
值,則手動資料庫叢集快照為公有,且可供任何 Amazon 帳戶複製或還原。
DBClusterSnapshotAttributesResult (結構)
包含成功呼叫 DescribeDBClusterSnapshotAttributes (動作) API 動作的結果。
手動資料庫叢集快照屬性是用於授權其他 Amazon 帳戶以複製或還原手動資料庫叢集快照。如需詳細資訊,請參閱 ModifyDBClusterSnapshotAttribute (動作) API 動作。
欄位
-
DBClusterSnapshotAttributes - 這是 DBClusterSnapshotAttribute 物件的陣列。
手動資料庫叢集快照的屬性和值清單。
-
DBClusterSnapshotIdentifier - 這是字串,類型為:
string
(UTF-8 編碼的字串)。屬性套用目標之手動資料庫叢集快照的識別符。
DBClusterSnapshotAttributesResult
會用來做為以下項目的回應元素: