ResetDBClusterParameterGroup - Amazon DocumentDB

ResetDBClusterParameterGroup

クラスターパラメータグループのパラメータをデフォルト値に変更します。特定のパラメータをリセットするには、ParameterNameApplyMethod のリストを送信します。クラスターパラメータグループ全体をリセットするには、DBClusterParameterGroupNameResetAllParameters パラメータを指定します。

グループ全体をリセットすると、動的パラメータは直ちに更新され、静的パラメータは pending-reboot に設定され、次回のDB インスタンス再起動時に有効になります。

リクエストパラメータ

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

DBClusterParameterGroupName

リセットするクラスターパラメータグループの名前。

型: 文字列

必須: はい

Parameters.Parameter.N

デフォルト値にリセットするクラスターパラメータグループ内のパラメータ名のリスト。ResetAllParameters パラメータが true に設定されている場合は、このパラメータを設定することはできません。

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

必須:いいえ

ResetAllParameters

true に設定する場合はクラスターパラメータグループ内のすべてのパラメータがデフォルト値にリセットされ、それ以外の場合は false に設定される値。Parameters パラメータに指定されたパラメータ名のリストがある場合、このパラメータは使用できません。

型: ブール値

必須:いいえ

レスポンス要素

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

DBClusterParameterGroupName

クラスターパラメータグループの名前。

制約:

  • 1 ~ 255 の英数字である必要があります。

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

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

注記

この値は小文字で保存されます。

型: 文字列

エラー

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

DBParameterGroupNotFound

DBParameterGroupName は既存のパラメータグループを参照していません。

HTTP ステータスコード: 404

InvalidDBParameterGroupState

パラメータグループが使用中であるか、無効な状態です。パラメータグループを削除しようとする場合、パラメータグループがこの状態のときは削除できません。

HTTP ステータスコード:400

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

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