翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
RestoreDBClusterToPointInTime
クラスターを任意の時点に復元します。ユーザーは LatestRestorableTime より前の任意の時点に最大 BackupRetentionPeriod 日間復元できます。ターゲットクラスターは、新しいクラスターがデフォルトのセキュリティグループで作成されない場合、元のクラスターと同じ構成で作成されます。
リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「共通パラメータ」を参照してください。
- DBClusterIdentifier
-
作成する新しいクラスターの名前。
制約:
-
1 ～ 63 の文字、数字またはハイフンを使用する必要があります。
-
最初の文字は文字にする必要があります。
-
ハイフンで終わることも、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 KMS 暗号化キーを所有 AWS アカウント する と同じ を持つクラスターを復元する場合は、 AWS KMS 暗号化 AWS KMS キーの ARN の代わりにキーエイリアスを使用できます。
新しいクラスターに復元し、ソースクラスターの暗号化に使用される AWS KMS キーとは異なる AWS KMS キーを使用して新しいクラスターを暗号化できます。新しい DB クラスターは、
KmsKeyIdパラメータで識別される AWS KMS キーで暗号化されます。KmsKeyIdパラメータの値を指定しない場合は、以下のようになります。-
クラスターが暗号化されている場合、復元されたクラスターは、ソースクラスターの暗号化に使用された AWS KMS キーを使用して暗号化されます。
-
クラスターが暗号化されていない場合、復元されたクラスターは暗号化されません。
DBClusterIdentifierが暗号化されていないクラスターを参照している場合、復元リクエストは拒否されます。タイプ: 文字列
必須: いいえ
-
- NetworkType
-
クラスターのネットワークタイプ。
ネットワークタイプは、クラスターに
DBSubnetGroup指定された によって決まります。は、IPv4 プロトコル、または IPv4 と IPv6 プロトコル () のみをサポートDBSubnetGroupできますDUAL。詳細については、「Amazon DocumentDB デベロッパーガイド」の「VPC 内の DocumentDB クラスター」を参照してください。 Amazon 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 SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
