CopyDBClusterSnapshot - Amazon DocumentDB
リクエストパラメータレスポンス要素エラーその他の参照資料

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

CopyDBClusterSnapshot

クラスターのスナップショットをコピーします。

手動の共有クラスタースナップショットからクラスタースナップショットをコピーするには、SourceDBClusterSnapshotIdentifier が共有クラスタースナップショットの Amazon リソースネーム (ARN) でなければなりません 共有 DB クラスタースナップショットは、暗号化されているかどうかにかかわらず、同じ AWS リージョン内でコピーのみ行えます。

コピー操作の進行後にキャンセルするには、クラスタースナップショットが [copying] ステータスの間に TargetDBClusterSnapshotIdentifier で識別されるターゲットクラスタースナップショットを削除します。

リクエストパラメータ

すべてのアクションに共通のパラメータの詳細については、「共通パラメータ」を参照してください。

SourceDBClusterSnapshotIdentifier

コピーするクラスタースナップショットの識別子。このパラメータは大文字と小文字が区別されません。

制約:

  • [available (使用可能)] 状態の有効なシステムスナップショットを指定する必要があります。

  • ソーススナップショットがコピー AWS リージョン と同じ にある場合は、有効なスナップショット識別子を指定します。

  • ソーススナップショットがコピー AWS リージョン とは異なる にある場合は、有効なクラスタースナップショット ARN を指定します。

例: my-cluster-snapshot1

型: 文字列

必須: はい

TargetDBClusterSnapshotIdentifier

ソースクラスタースナップショットから作成する新しいクラスタースナップショットの識別子。このパラメータは大文字と小文字が区別されません。

制約:

  • 1 ～ 63 の文字、数字またはハイフンを使用する必要があります。

  • 1 字目は文字である必要があります。

  • ハイフンを、文字列の最後に使用したり、2 つ続けて使用したりすることはできません。

例: my-cluster-snapshot2

型: 文字列

必須: はい

CopyTags

ソースクラスタースナップショットからターゲットクラスタースナップショットにすべてのタグをコピーする場合は true に、それ以外の場合は false に設定します。デフォルトは false です。

型: ブール値

必須: いいえ

KmsKeyId

暗号化されたクラスタースナップショットの AWS KMS キー ID。キー ID AWS KMS は、 AWS KMS 暗号化 AWS KMS キーの Amazon リソースネーム (ARN)、 AWS KMS キー識別子、またはキーエイリアスです。

から暗号化されたクラスタースナップショットをコピーする場合 AWS アカウント、 の値を指定KmsKeyIdして、新しい暗号化キーでコピーを AWS KMS 暗号化できます。の値を指定しない場合KmsKeyId、クラスタースナップショットのコピーはソースクラスタースナップショットと同じ AWS KMS キーで暗号化されます。

別の から共有されている暗号化されたクラスタースナップショットをコピーする場合は AWS アカウント、 の値を指定する必要がありますKmsKeyId。

暗号化されたクラスタースナップショットを別の にコピーするには AWS リージョン、 を送信先リージョンのクラスタースナップショットのコピーを暗号化するために使用する AWS KMS キー ID KmsKeyIdに設定します。 AWS KMS 暗号化キーは、 AWS リージョン それらが作成された に固有であり、別の AWS リージョン の暗号化キーを使用することはできません AWS リージョン。

暗号化されていないクラスタースナップショットをコピーして KmsKeyId パラメータに値を指定すると、エラーが返されます。

タイプ: 文字列

必須: いいえ

PreSignedUrl

コピー元のクラスタースナップショットを含む の API アクションの署名バージョン 4 で署名 AWS リージョン されたリクエストCopyDBClusterSnapshotを含む URL。クラスタースナップショットを別の AWS リージョンからコピーする場合は、PreSignedUrl パラメータを使用する必要があります。

AWS SDK ツールまたは を使用している場合は AWS CLI、 PreSignedUrl を手動で指定する代わりに SourceRegion ( --source-regionの場合は AWS CLI) を指定できます。SourceRegion を指定すると、ソース AWS リージョンで実行できる操作の有効なリクエストである署名付き URL が自動生成されます。

署名付き URL は、コピーするクラスタースナップショット AWS リージョン を含むソースで実行できる CopyDBClusterSnapshot API アクションの有効なリクエストである必要があります。署名付き URL リクエストでは、以下のパラメータ値を指定する必要があります。

  • SourceRegion - コピーするスナップショットを含むリージョンの ID。

  • SourceDBClusterSnapshotIdentifier - コピーする暗号化されたクラスタースナップショットの識別子。この識別子は、ソース AWS リージョンの Amazon リソースネーム (ARN) 形式であることが必要です。例えば、us-east-1 AWS リージョンから暗号化されたクラスタスナップショットをコピーする場合、SourceDBClusterSnapshotIdentifier は arn:aws:rds:us-east-1:12345678012:sample-cluster:sample-cluster-snapshot のようになります。

  • TargetDBClusterSnapshotIdentifier - 作成する新しい暗号化されたクラスタースナップショットの識別子。このパラメータでは大文字と小文字は区別されません。

タイプ: 文字列

必須: いいえ

Tags.Tag.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 SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。