RestoreDBClusterToPointInTime

クラスターを任意の時点に復元します。ユーザーは LatestRestorableTime より前の任意の時点に最大 BackupRetentionPeriod 日間復元できます。ターゲットクラスターは、新しいクラスターがデフォルトのセキュリティグループで作成されない場合、元のクラスターと同じ構成で作成されます。

リクエストパラメータ

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

DBClusterIdentifier

作成する新しいクラスターの名前。

制約:

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

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

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

タイプ: 文字列

必須: はい

SourceDBClusterIdentifier

復元されるソースクラスターの識別子。

制約:

• 既存の DBCluster の識別子と一致する必要があります。

タイプ: 文字列

必須: はい

DBSubnetGroupName

新しいクラスターに使用するサブネットグループ名。

制約: 指定した場合、既存の DBSubnetGroup の名前と一致する必要があります。

例:mySubnetgroup

タイプ: 文字列

必須: いいえ

DeletionProtection

このクラスターを削除できるかどうかを指定します。DeletionProtection を有効にすると、クラスターが変更され DeletionProtection が無効にならない限り、クラスターを削除することができません。DeletionProtection はクラスターが誤って削除されるのを防ぎます。

型: ブール値

必須: いいえ

EnableCloudwatchLogsExports.member.N

Amazon CloudWatch Logs にエクスポートするために有効にする必要があるログタイプのリスト。

型: 文字列の配列

必須: いいえ

KmsKeyId

暗号化されたクラスターから暗号化されたクラスターを復元するときに使用する AWS KMS キー識別子。

AWS KMS キー識別子は、AWS KMS 暗号化キーの Amazon リソースネーム (ARN) です。新しいクラスターを暗号化するための AWS アカウント 暗号化キーを所有する同じ AWS KMS を使用してクラスターを復元する場合、AWS KMS 暗号化キーの ARN の代わりに AWS KMS キーエイリアスを使用できます。

新しいクラスターに復元し、ソースクラスターの暗号化に使用した AWS KMS キーとは異なる AWS KMS キーで新しいクラスターを暗号化できます。新しい DB クラスターは、AWS KMS パラメータで識別される KmsKeyId キーで暗号化されます。

KmsKeyId パラメータの値を指定しない場合は、以下のようになります。

• クラスターが暗号化されている場合、復元されたクラスターはソースクラスターの暗号化に使用された AWS KMS キーで暗号化されます。

• クラスターが暗号化されていない場合、復元されたクラスターは暗号化されません。

DBClusterIdentifier が暗号化されていないクラスターを参照している場合、復元リクエストは拒否されます。

タイプ: 文字列

必須: いいえ

NetworkType

クラスターのネットワークタイプです。

ネットワークタイプは、クラスターに指定された DBSubnetGroup によって決まります。DBSubnetGroup は IPv4 プロトコルのみ、または IPv4 プロトコルと IPv6 プロトコル (DUAL) をサポートできます。

詳細については、「Amazon DocumentDB デベロッパーガイド」の「VPC の DocumentDB クラスター」を参照してください。

有効な値: IPV4 | DUAL

タイプ: 文字列

必須: いいえ

Port

クラスターが接続を受け入れるポート番号。

制約:1150 ～ 65535 の値である必要があります。

デフォルト : エンジンのデフォルトポート。

タイプ: 整数

必須: いいえ

RestoreToTime

クラスターを復元する日時。

有効な値: 協定世界時 (UTC) 形式の時刻でなければなりません。

制約:

• インスタンスの復元可能な最新時刻より前である必要があります。

• UseLatestRestorableTime パラメータを指定しない場合は、指定する必要があります。

• UseLatestRestorableTime パラメータが true である場合は、指定することはできません。

• RestoreType パラメータが copy-on-write である場合は、指定することはできません。

例:2015-03-07T23:45:00Z

型: タイムスタンプ

必須: いいえ

RestoreType

実行する復元のタイプ。次のいずれかの値を指定できます。

• full-copy - 新しい DB クラスターは、ソース DB クラスターのフルコピーとして復元されます。

• copy-on-write - 新しい DB クラスターは、ソース DB クラスターのクローンとして復元されます。

制約 : ソース DB クラスターのエンジンバージョンが 1.11 より前である場合、copy-on-write を指定できません。

RestoreType 値を指定しない場合、新しい DB クラスターは、ソース DB クラスターのフルコピーとして復元されます。

タイプ: 文字列

必須: いいえ

ServerlessV2ScalingConfiguration

Amazon DocumentDB Serverless クラスターのスケーリング構成が含まれています。

型: ServerlessV2ScalingConfiguration オブジェクト

必須: いいえ

StorageType

DB クラスターに関連付けるストレージタイプ。

Amazon DocumentDB クラスターのストレージタイプの詳細については、「Amazon DocumentDB 開発者ガイド」の「クラスターストレージ設定」を参照してください。

ストレージタイプの有効な値 - standard | iopt1

デフォルト値は standard です

タイプ: 文字列

必須: いいえ

Tags.Tag.N

復元されたクラスターに割り当てられるタグ。

型: Tag オブジェクトの配列

必須: いいえ

UseLatestRestorableTime

true に設定する場合はクラスターを最新の復元可能なバックアップ時間に復元し、それ以外の場合は false に設定される値。

デフォルト: false

制約: RestoreToTime パラメータを指定した場合は、指定することはできません。

型: ブール値

必須: いいえ

VpcSecurityGroupIds.VpcSecurityGroupId.N

新しいクラスターが属する VPC セキュリティグループのリスト。

型: 文字列の配列

必須: いいえ

レスポンス要素

以下の要素がサービスによって返されます。

DBCluster

クラスターに関する詳細情報。

型: DBCluster オブジェクト

エラー

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

DBClusterAlreadyExistsFault

指定された識別子を持つクラスターをすでに持っています。

HTTP ステータスコード: 400

DBClusterNotFoundFault

DBClusterIdentifier は既存のクラスターを参照していません。

HTTP ステータスコード: 404

DBClusterQuotaExceededFault

クラスターの最大許容クォータに達したため、クラスターを作成できません。

HTTP ステータスコード: 403

DBClusterSnapshotNotFoundFault

DBClusterSnapshotIdentifier は既存のクラスタースナップショットを参照していません。

HTTP ステータスコード: 404

DBSubnetGroupNotFoundFault

DBSubnetGroupName は既存のサブネットグループを参照していません。

HTTP ステータスコード: 404

InsufficientDBClusterCapacityFault

クラスターには現在の操作に十分な容量がありません。

HTTP ステータスコード: 403

InsufficientStorageClusterCapacity

現在のアクションに使用可能なストレージが不十分です。使用できるストレージがより多い別のアベイラビリティーゾーンを使用するようにサブネットグループを更新することで、このエラーを解決できる場合があります。

HTTP ステータスコード: 400

InvalidDBClusterSnapshotStateFault

指定された値は有効なクラスタースナップショット状態ではありません。

HTTP ステータスコード: 400

InvalidDBClusterStateFault

クラスターは有効な状態ではありません。

HTTP ステータスコード: 400

InvalidDBSnapshotState

スナップショットの状態では削除できません。

HTTP ステータスコード: 400

InvalidRestoreFault

仮想プライベートクラウド （VPC） のバックアップから VPC以外の DB インスタンスには復元できません。

HTTP ステータスコード: 400

InvalidSubnet

要求されたサブネットが無効であるか、共通の仮想プライベートクラウド （VPC） 内に存在しない複数のサブネットが要求されました。

HTTP ステータスコード: 400

InvalidVPCNetworkStateFault

サブネットグループは、作成後に変更されたため、すべてのアベイラビリティーゾーンがカバーされません。

HTTP ステータスコード: 400

KMSKeyNotAccessibleFault

AWS KMS キーへのアクセス時にエラーが発生しました。

HTTP ステータスコード: 400

NetworkTypeNotSupported

ネットワークタイプは、DBSubnetGroup または DB エンジンのバージョンではサポートされていません。

HTTP ステータスコード: 400

StorageQuotaExceeded

リクエストにより、すべてのインスタンスで使用可能な許容ストレージ容量を超過します。

HTTP ステータスコード: 400

以下の資料も参照してください。

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

• AWS Command Line Interface V2

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go V2

• AWS SDK for Java V2

• AWS SDK for JavaScript V3

• AWS SDK for Kotlin

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3