CopyDBClusterSnapshot - Amazon DocumentDB

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

CopyDBClusterSnapshot

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

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

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

リクエストパラメータ

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

SourceDBClusterSnapshotIdentifier

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

制約:

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

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

  • クラスタースナップショットのコピー元とコピー先が異なる AWS リージョン にある場合、またはクラスタースナップショットが別の AWS アカウントによって所有されている場合は、有効なスナップショットの ARN を指定します。

例:my-cluster-snapshot1

タイプ: 文字列

必須: はい

TargetDBClusterSnapshotIdentifier

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

制約:

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

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

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

例:my-cluster-snapshot2

タイプ: 文字列

必須: はい

CopyTags

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

型: ブール値

必須: いいえ

KmsKeyId

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

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

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

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

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

タイプ: 文字列

必須: いいえ

PreSignedUrl

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

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

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

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

  • SourceDBClusterSnapshotIdentifier - コピーする暗号化されたクラスタースナップショットの識別子。この識別子は、ソース AWS リージョン の Amazon リソースネーム (ARN) 形式であることが必要です。例えば、us-east-1 AWS リージョン から暗号化されたクラスタスナップショットをコピーする場合、SourceDBClusterSnapshotIdentifierarn: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 SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。