CopyDBClusterSnapshot - Amazon DocumentDB

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

CopyDBClusterSnapshot

複製叢集的快照。

若要從共用手動叢集快照複製叢集快照,SourceDBClusterSnapshotIdentifier必須是共用叢集快照的 Amazon 資源名稱 (ARN)。您只能在相同的 AWS 區域中複製共用資料庫叢集快照,無論是否加密。

若要在進行複製作業之後取消複製作業,請刪除叢集快照處於複製狀態TargetDBClusterSnapshotIdentifier時所識別的目標叢集快照。

請求參數

如需所有動作的一般參數資訊,請參閱《Common Parameters》。

SourceDBClusterSnapshotIdentifier

要複製之叢集快照的識別碼。此參數不區分大小寫。

約束:

  • 必須指定可用 狀態下的有效系統快照。

  • 如果來源快照與副本相 AWS 區域 同,請指定有效的快照識別碼。

  • 如果來源快照與副本 AWS 區域 不同,請指定有效的叢集快照 ARN。

範例:my-cluster-snapshot1

類型:字串

必要:是

TargetDBClusterSnapshotIdentifier

要從來源叢集快照建立之新叢集快照的識別碼。此參數不區分大小寫。

約束:

  • 必須包含 1 到 63 個字母、數字或連字號。

  • 第一個字元必須是字母。

  • 不能以連字號結尾或連續包含兩個連字號。

範例:my-cluster-snapshot2

類型:字串

必要:是

CopyTags

設定為true可將來源叢集快照中的所有標籤複製到目標叢集快照,否則false。預設值為 false

類型:布林值

必要:否

KmsKeyId

加密叢集快照的 AWS KMS 金鑰識別碼。 AWS KMS 金鑰識別碼是 Amazon 資源名稱 (ARN)、 AWS KMS 金鑰識別碼或 AWS KMS 加密 AWS KMS 金鑰的金鑰別名。

如果您從中複製加密的叢集快照 AWS 帳戶,您可以指定一個值,KmsKeyId以使用新的 AWS KMS 加密金鑰加密副本。如果未指定的值KmsKeyId,則會使用與來源叢集快照相同的 AWS KMS 金鑰來加密叢集快照的副本。

如果您複製從另一個叢集共用的加密叢集快照 AWS 帳戶,則必須指定的值KmsKeyId

若要將加密的叢集快照複製KmsKeyId到另一個 AWS 區域,請設定為要用來加密目的地區域中叢集快照副本的 AWS KMS 金鑰 ID。 AWS KMS 加密金鑰專屬於它 AWS 區域 們所建立的金鑰,您無法使用其 AWS 區域 中一個加密金鑰 AWS 區域。

如果您複製未加密的叢集快照並指定KmsKeyId參數值,則會傳回錯誤。

類型:字串

必要:否

PreSignedUrl

包含針對 CopyDBClusterSnapshot API 動作的簽章第 4 版已簽署要求的 URL,其中包 AWS 區域 含要複製的來源叢集快照集。從另一個叢集快照複製叢集快照時,您必須使用PreSignedUrl參數 AWS 區域。

如果您使用 AWS SDK 工具或 AWS CLI,您可以指定 SourceRegion (或 --source-region AWS CLI),而不是PreSignedUrl手動指定。指定SourceRegion自動產生預先簽署的 URL,此 URL 是可在來源中執行之作業的有效要求。 AWS 區域

預先簽署的 URL 必須是 CopyDBClusterSnapshot API 動作的有效要求,該動作可在包含要複製的叢集快照的來源 AWS 區域 中執行。預先簽章的 URL 請求必須包含下列參數值:

  • SourceRegion-包含要複製之快照的區域 ID。

  • SourceDBClusterSnapshotIdentifier-要複製之加密叢集快照的識別碼。此識別符必須是來源 AWS 區域的 Amazon Resource Name (ARN) 格式。例如,如果您要從 us-east-1 複製加密的叢集快照 AWS 區域,則SourceDBClusterSnapshotIdentifier看起來如下所示:。arn:aws:rds:us-east-1:12345678012:sample-cluster:sample-cluster-snapshot

  • TargetDBClusterSnapshotIdentifier-要建立之新叢集快照的識別碼。此參數不區分大小寫。

類型:字串

必要:否

標籤. N

要指派給叢集快照的標籤。

類型:Tag 物件陣列

必要:否

回應元素

服務會傳回下列元素。

DBClusterSnapshot

叢集快照的詳細資訊。

類型:DBClusterSnapshot 物件

錯誤

如需所有動作常見錯誤的資訊,請參閱常見錯誤

DBClusterSnapshotAlreadyExistsFault

您已經擁有具有指定識別碼的叢集快照。

HTTP 狀態碼:400

DBClusterSnapshotNotFoundFault

DBClusterSnapshotIdentifier不參考現有的叢集快照。

HTTP 狀態碼:404

InvalidDBClusterSnapshotStateFault

提供的值不是有效的叢集快照狀態。

HTTP 狀態碼:400

InvalidDBClusterStateFault

叢集不是有效的狀態。

HTTP 狀態碼:400

KMSKeyNotAccessibleFault

存取 AWS KMS 金鑰時發生錯誤。

HTTP 狀態碼:400

SnapshotQuotaExceeded

該請求會導致您超過允許的快照數量。

HTTP 狀態碼:400

另請參閱

如需在其中一個特定語言 AWS SDK 中使用此 API 的詳細資訊,請參閱下列內容: