RestoreDBClusterFromSnapshot - Amazon DocumentDB

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

RestoreDBClusterFromSnapshot

スナップショットまたはクラスタースナップショットから新しいクラスターを作成します。

スナップショットを指定した場合、ターゲットクラスターは、デフォルト設定とデフォルトセキュリティグループを使用してソース DB スナップショットから作成されます。

クラスタースナップショットを指定した場合、新しいクラスターが既定のセキュリティグループを使用して作成される場合以外は、ターゲットクラスターは元のソース DB クラスターと同じ構成でソースクラスターの復元ポイントから作成されます。

リクエストパラメータ

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

DBClusterIdentifier

スナップショットまたはクラスタースナップショットから作成するクラスター名。このパラメータでは大文字と小文字は区別されません。

制約:

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

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

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

例: my-snapshot-id

型: 文字列

必須: はい

Engine

新しいクラスターに使用するデータベースエンジン。

デフォルト: ソースオブジェクトと同じ。

制約: ソースのエンジンに対応する必要があります。

型: 文字列

必須: はい

SnapshotIdentifier

復元元のスナップショットまたはクラスタースナップショットの識別子。

クラスタースナップショットを指定するには、名前または Amazon リソースネーム (ARN) のいずれかを使用できます。ただし、スナップショットを指定するには ARN のみを使用できます。

制約:

  • 既存のスナップショットの識別子と一致する必要があります。

型: 文字列

必須: はい

AvailabilityZonesAvailabilityZone。N

DB クラスターのインスタンスを作成できる Amazon EC2 アベイラビリティーゾーンのリストを提供します。

タイプ:文字列の配列

必須: いいえ

DBClusterParameterGroupName

このクラスターに関連付ける DB クラスターパラメータグループの名前。

タイプ: 文字列。      必須: いいえ

この引数を省略すると、指定したDBクラスターのデフォルトのパラメータグループが使用されます。指定した場合、既存の DB クラスターのパラメータグループの名前と一致する必要があります。1 ~ 255 の文字、数字またはハイフンを使用する必要があります。名前は文字で開始し、ハイフン以外で終了する必要があります。ハイフンを 2 つ続けて使用することはできません。

タイプ: 文字列

必須: いいえ

DBSubnetGroupName

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

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

例: mySubnetgroup

タイプ: 文字列

必須: いいえ

DeletionProtection

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

タイプ: ブール

必須: いいえ

EnableCloudwatchLogsExports.member.N

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

タイプ:文字列の配列

必須: いいえ

EngineVersion

新しいクラスターに使用するデータベースエンジンのバージョン。

タイプ: 文字列

必須: いいえ

KmsKeyId

DB スナップショットまたはクラスタースナップショットから暗号化されたクラスターを復元するときに使用する AWS KMS キー識別子。

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

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

  • SnapshotIdentifier のスナップショットまたはクラスタースナップショットが暗号化されている場合、スナップショットまたはクラスタースナップショットを暗号化に使用された AWS KMSキーで復元されたクラスターが暗号化されます。

  • SnapshotIdentifier のスナップショットまたはクラスタースナップショットが暗号化されていない場合、復元されたクラスターは暗号化されません。

タイプ: 文字列

必須: いいえ

Port

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

制約: 115065535 の値である必要があります。

デフォルト : 元のクラスターと同じポート。

タイプ: 整数

必須: いいえ

StorageType

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

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

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

デフォルト値は standard です

タイプ: 文字列

必須: いいえ

Tags.Tag.N

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

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

必須: いいえ

VpcSecurityGroupIds.VpcSecurityGroupId.N

クラスターに関連付けられる仮想プライベートクラウド (VPC) セキュリティグループのリスト。

タイプ:文字列の配列

必須: いいえ

レスポンス要素

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

DBCluster

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

型: DBCluster オブジェクト

エラー

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

DBClusterAlreadyExistsFault

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

HTTP ステータスコード:400

DBClusterQuotaExceededFault

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

HTTP ステータスコード: 403

DBClusterSnapshotNotFoundFault

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

HTTP ステータスコード: 404

DBSnapshotNotFound

DBSnapshotIdentifier は既存のスナップショットを参照していません。

HTTP ステータスコード: 404

DBSubnetGroupNotFoundFault

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

HTTP ステータスコード: 404

DBSubnetGroupNotFoundFault

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

HTTP ステータスコード: 404

InsufficientDBClusterCapacityFault

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

HTTP ステータスコード: 403

InsufficientStorageClusterCapacity

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

HTTP ステータスコード:400

InvalidDBClusterSnapshotStateFault

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

HTTP ステータスコード:400

InvalidDBSnapshotState

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

HTTP ステータスコード:400

InvalidRestoreFault

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

HTTP ステータスコード:400

InvalidSubnet

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

HTTP ステータスコード:400

InvalidVPCNetworkStateFault

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

HTTP ステータスコード:400

KMSKeyNotAccessibleFault

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

HTTP ステータスコード:400

StorageQuotaExceeded

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

HTTP ステータスコード:400

StorageQuotaExceeded

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

HTTP ステータスコード:400

その他の参照資料

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