翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
# Neptune パラメータ API
**アクション:**
+ [CopyDBParameterGroup (アクション)](#CopyDBParameterGroup)
+ [CopyDBClusterParameterGroup (アクション)](#CopyDBClusterParameterGroup)
+ [CreateDBParameterGroup (アクション)](#CreateDBParameterGroup)
+ [CreateDBClusterParameterGroup (アクション)](#CreateDBClusterParameterGroup)
+ [DeleteDBParameterGroup (アクション)](#DeleteDBParameterGroup)
+ [DeleteDBClusterParameterGroup (アクション)](#DeleteDBClusterParameterGroup)
+ [ModifyDBParameterGroup (アクション)](#ModifyDBParameterGroup)
+ [ModifyDBClusterParameterGroup (アクション)](#ModifyDBClusterParameterGroup)
+ [ResetDBParameterGroup (アクション)](#ResetDBParameterGroup)
+ [ResetDBClusterParameterGroup (アクション)](#ResetDBClusterParameterGroup)
+ [DescribeDBParameters (アクション)](#DescribeDBParameters)
+ [DescribeDBParameterGroups (アクション)](#DescribeDBParameterGroups)
+ [DescribeDBClusterParameters (アクション)](#DescribeDBClusterParameters)
+ [DescribeDBClusterParameterGroups (アクション)](#DescribeDBClusterParameterGroups)
+ [DescribeEngineDefaultParameters (アクション)](#DescribeEngineDefaultParameters)
+ [DescribeEngineDefaultClusterParameters (アクション)](#DescribeEngineDefaultClusterParameters)
**構造:**
+ [パラメータ (構造)](#Parameter)
+ [DBParameterGroup (構造)](#DBParameterGroup)
+ [DBClusterParameterGroup (構造)](#DBClusterParameterGroup)
+ [DBParameterGroupStatus (構造)](#DBParameterGroupStatus)
## CopyDBParameterGroup (アクション)
この API の AWS CLI 名は `copy-db-parameter-group` です。
指定された DB パラメータグループをコピーします。
**[リクエスト**]
+ **SourceDBParameterGroupIdentifier** (CLI では: `--source-db-parameter-group-identifier`) — *必須:* タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。
DB パラメータグループの識別子または ARN。ARN 作成の詳細については、「[Amazon リソースネーム (ARN) の構築](https://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html#tagging.ARN.Constructing)」を参照してください。
制約:
+ 有効な DB パラメータグループを指定する必要があります。
+ DB パラメータグループの識別子を指定する必要があります。例: `my-db-param-group`、または有効な ARN。
+ **Tags** (CLI では: `--tags`) - [Tag](api-other-apis.md#Tag) オブジェクトの配列。
タグは、コピーされた DB パラメータグループに割り当てられます。
+ **TargetDBParameterGroupDescription** (CLI では: `--target-db-parameter-group-description`) — *必須:* タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。
コピーされた DB パラメータグループの説明。
+ **TargetDBParameterGroupIdentifier** (CLI では: `--target-db-parameter-group-identifier`) — *必須:* タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。
コピーされた DB パラメータグループの識別子。
制約:
+ null、空、または空白にすることはできません。
+ 1 ～ 255 の文字、数字またはハイフンを使用する必要があります。
+ 1 字目は英字である必要があります。
+ ハイフンを、文字列の最後に使用したり、2 つ続けて使用したりすることはできません。
例:`my-db-parameter-group`
**レスポンス**
Amazon Neptune DB パラメータグループの詳細が含まれています。
このデータ型は、[DescribeDBParameterGroups (アクション)](#DescribeDBParameterGroups) アクションのレスポンス要素として使用されます。
+ **DBParameterGroupArn** — 文字列、タイプ: `string` (UTF-8 でエンコードされた文字列)。
DB パラメータグループの Amazon リソースネーム (ARN)。
+ **DBParameterGroupFamily** — 文字列、タイプ: `string` (UTF-8 でエンコードされた文字列)。
この DB クラスターパラメータグループと互換性がある DB パラメータグループファミリーの名前を指定します。
+ **DBParameterGroupName** — 文字列、タイプ: `string` (UTF-8 でエンコードされた文字列)。
DB パラメータグループの名前を入力します。
+ **Description** — 文字列、タイプ: `string` (UTF-8 でエンコードされた文字列)。
この DB パラメータグループに対するユーザー定義の説明を指定します。
**エラー**
+ [DBParameterGroupNotFoundFault](api-faults.md#DBParameterGroupNotFoundFault)
+ [DBParameterGroupAlreadyExistsFault](api-faults.md#DBParameterGroupAlreadyExistsFault)
+ [DBParameterGroupQuotaExceededFault](api-faults.md#DBParameterGroupQuotaExceededFault)
## CopyDBClusterParameterGroup (アクション)
この API の AWS CLI 名は `copy-db-cluster-parameter-group` です。
指定された DB クラスターパラメータグループをコピーします。
**[リクエスト**]
+ **SourceDBClusterParameterGroupIdentifier** (CLI では: `--source-db-cluster-parameter-group-identifier`) — *必須:* タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。
識別子またはソース DB クラスターのパラメータグループの Amazon リソースネーム (ARN)。ARN 作成の詳細については、「[Amazon リソースネーム (ARN) の構築](https://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html#tagging.ARN.Constructing)」を参照してください。
制約:
+ 有効な DB クラスターグループを指定する必要があります。
+ ソース DB クラスターパラメータグループがコピーと同じ Amazon リージョンにある場合は、有効な DB パラメータグループ識別子を指定します。例: `my-db-cluster-param-group` または有効な ARN。
+ ソース DB パラメータグループがコピーとは異なる Amazon リージョンにある場合は、有効な DB クラスターパラメータグループ ARN を指定します。例: `arn:aws:rds:us-east-1:123456789012:cluster-pg:custom-cluster-group1`。
+ **Tags** (CLI では: `--tags`) - [Tag](api-other-apis.md#Tag) オブジェクトの配列。
コピーされた DB クラスターパラメータグループに割り当てられるタグ。
+ **TargetDBClusterParameterGroupDescription** (CLI では: `--target-db-cluster-parameter-group-description`) — *必須:* タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。
コピーされた DB クラスターパラメータグループの説明。
+ **TargetDBClusterParameterGroupIdentifier** (CLI では: `--target-db-cluster-parameter-group-identifier`) — *必須:* タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。
コピーされた DB クラスターパラメータグループの識別子。
制約:
+ null、空、または空白にすることはできません。
+ 1 ～ 255 の文字、数字またはハイフンを使用する必要があります。
+ 1 字目は英字である必要があります。
+ ハイフンを、文字列の最後に使用したり、2 つ続けて使用したりすることはできません
例:`my-cluster-param-group1`
**レスポンス**
Amazon Neptune DB クラスターパラメータグループの詳細が含まれています。
このデータ型は、[DescribeDBClusterParameterGroups (アクション)](#DescribeDBClusterParameterGroups) アクションのレスポンス要素として使用されます。
+ **DBClusterParameterGroupArn** — 文字列、タイプ: `string` (UTF-8 でエンコードされた文字列)。
DB クラスターパラメータグループの Amazon リソースネーム (ARN)。
+ **DBClusterParameterGroupName** — 文字列、タイプ: `string` (UTF-8 でエンコードされた文字列)。
DB クラスターパラメータグループの名前を指定します。
+ **DBParameterGroupFamily** — 文字列、タイプ: `string` (UTF-8 でエンコードされた文字列)。
この DB クラスターパラメータグループと互換性がある DB クラスターパラメータグループファミリーの名前を指定します。
+ **Description** — 文字列、タイプ: `string` (UTF-8 でエンコードされた文字列)。
この DB クラスターパラメータグループに対するユーザー定義の説明を指定します。
**エラー**
+ [DBParameterGroupNotFoundFault](api-faults.md#DBParameterGroupNotFoundFault)
+ [DBParameterGroupQuotaExceededFault](api-faults.md#DBParameterGroupQuotaExceededFault)
+ [DBParameterGroupAlreadyExistsFault](api-faults.md#DBParameterGroupAlreadyExistsFault)
## CreateDBParameterGroup (アクション)
この API の AWS CLI 名は `create-db-parameter-group` です。
DB パラメータグループを作成します。
DB パラメータグループは、最初は DB インスタンスで使用されるデータベースエンジンのデフォルトパラメータで作成されます。パラメータのいずれかにカスタム値を指定するには、*ModifyDBParameterGroup* を使用して作成した後でグループを変更する必要があります。DB パラメータグループを作成したら、*ModifyDBInstance* を使用して DB インスタンスに関連付ける必要があります。新しい DB パラメータグループを実行中の DB インスタンスに関連付ける場合、フェイルオーバーせずに新しい DB パラメータグループと関連付け済みの設定を有効にするには、DB インスタンスを再起動する必要があります。
**重要**
DB パラメータグループの作成後、その DB パラメータグループをデフォルトのパラメータグループとして使用する最初の DB インスタンスが作成されるまで、5 分以上かかります。その間に、Amazon Neptune によってインスタンスの作成アクションが完了し、そのパラメータグループが新しい DB インスタンスのデフォルトとして使用されるようになります。この点は、DB インスタンスのデフォルトデータベースの作成時に必須になるパラメータ (デフォルトデータベースの文字セットを定義する `character_set_database` パラメータなど) に特に重要です。Amazon Neptune コンソールの [*Parameter Groups*] オプション、または *DescribeDBParameters* コマンドを使用して、DB パラメータグループが作成または変更されたことを確認できます。
**[リクエスト**]
+ **DBParameterGroupFamily** (CLI では: `--db-parameter-group-family`) — *必須:* タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。
DB パラメータグループファミリーの名前。DB パラメータグループは、1 つだけの DB パラメータグループファミリーに関連付けることが可能で、その DB パラメータグループファミリーと互換性のあるデータベースエンジンおよびエンジンバージョンを実行している DB インスタンスにのみ適用できます。
+ **DBParameterGroupName** (CLI では: `--db-parameter-group-name`) — *必須:* タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。
DB パラメータグループの名前。
制約:
+ 1 ～ 255 の英字、数字、ハイフンである必要があります。
+ 1 字目は英字である必要があります。
+ ハイフンを、文字列の最後に使用したり、2 つ続けて使用したりすることはできません
**注記**
この値は小文字で保存されます。
+ **Description** (CLI では: `--description`) — *必須:* タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。
DB パラメータグループの説明。
+ **Tags** (CLI では: `--tags`) - [Tag](api-other-apis.md#Tag) オブジェクトの配列。
タグは、新しい DB パラメータグループに割り当てられます。
**レスポンス**
Amazon Neptune DB パラメータグループの詳細が含まれています。
このデータ型は、[DescribeDBParameterGroups (アクション)](#DescribeDBParameterGroups) アクションのレスポンス要素として使用されます。
+ **DBParameterGroupArn** — 文字列、タイプ: `string` (UTF-8 でエンコードされた文字列)。
DB パラメータグループの Amazon リソースネーム (ARN)。
+ **DBParameterGroupFamily** — 文字列、タイプ: `string` (UTF-8 でエンコードされた文字列)。
この DB クラスターパラメータグループと互換性がある DB パラメータグループファミリーの名前を指定します。
+ **DBParameterGroupName** — 文字列、タイプ: `string` (UTF-8 でエンコードされた文字列)。
DB パラメータグループの名前を入力します。
+ **Description** — 文字列、タイプ: `string` (UTF-8 でエンコードされた文字列)。
この DB パラメータグループに対するユーザー定義の説明を指定します。
**エラー**
+ [DBParameterGroupQuotaExceededFault](api-faults.md#DBParameterGroupQuotaExceededFault)
+ [DBParameterGroupAlreadyExistsFault](api-faults.md#DBParameterGroupAlreadyExistsFault)
## CreateDBClusterParameterGroup (アクション)
この API の AWS CLI 名は `create-db-cluster-parameter-group` です。
新しい DB クラスターのパラメータグループを作成します。
DB クラスターパラメータグループのパラメータは、DB クラスター内のすべてのインスタンスに適用されます。
DB クラスターパラメータグループは、最初は DB クラスターのインスタンスで使用されるデータベースエンジンのデフォルトパラメータで作成されます。パラメータのいずれかにカスタム値を指定するには、[ModifyDBClusterParameterGroup (アクション)](#ModifyDBClusterParameterGroup) を使用して作成後にグループを変更する必要があります。DB クラスターパラメータグループを作成したら、[ModifyDBCluster (アクション)](api-clusters.md#ModifyDBCluster) を使用して使用する DB クラスターに関連付ける必要があります。新しい DB クラスターパラメータグループを実行中の DB クラスターに関連付ける場合、フェイルオーバーせずに新しい DB パラメータグループと関連付け済みの設定を有効にするには、DB クラスターの DB インスタンスを再起動する必要があります。
**重要**
DB クラスターパラメータグループの作成後、デフォルトのパラメータグループとしてその DB クラスターパラメータグループを使用する最初の DB クラスターが作成されるまで、5 分以上かかります。その間に、Amazon Neptune によってインスタンスの作成アクションが完了し、その DB クラスターパラメータグループが新しい DB クラスターのデフォルトとして使用されるようになります。この点は、DB クラスターのデフォルトデータベースの作成時に必須になるパラメータ (デフォルトデータベースの文字セットを定義する `character_set_database` パラメータなど) に特に重要です。*Amazon Neptune コンソール*の [[Parameter Groups](https://console.aws.amazon.com/rds/)] オプション、または [DescribeDBClusterParameters (アクション)](#DescribeDBClusterParameters) コマンドを使用して、DB クラスターパラメータグループが作成または変更されたことを確認できます。
**[リクエスト**]
+ **DBClusterParameterGroupName** (CLI では: `--db-cluster-parameter-group-name`) — *必須:* タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。
DB クラスターパラメータグループの名前。
制約:
+ 既存の DBClusterParameterGroup の名前と一致する必要があります。
**注記**
この値は小文字で保存されます。
+ **DBParameterGroupFamily** (CLI では: `--db-parameter-group-family`) — *必須:* タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。
DB クラスターパラメータグループファミリーの名前。DB クラスターパラメータグループは、1 つだけの DB クラスターパラメータグループファミリーに関連付けることが可能で、その DB クラスターパラメータグループファミリーと互換性のあるデータベースエンジンおよびエンジンバージョンを実行している DB クラスターにのみ適用できます。
+ **Description** (CLI では: `--description`) — *必須:* タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。
DB クラスターパラメータグループの説明。
+ **Tags** (CLI では: `--tags`) - [Tag](api-other-apis.md#Tag) オブジェクトの配列。
新しい DB クラスターパラメータグループに割り当てられるタグ。
**レスポンス**
Amazon Neptune DB クラスターパラメータグループの詳細が含まれています。
このデータ型は、[DescribeDBClusterParameterGroups (アクション)](#DescribeDBClusterParameterGroups) アクションのレスポンス要素として使用されます。
+ **DBClusterParameterGroupArn** — 文字列、タイプ: `string` (UTF-8 でエンコードされた文字列)。
DB クラスターパラメータグループの Amazon リソースネーム (ARN)。
+ **DBClusterParameterGroupName** — 文字列、タイプ: `string` (UTF-8 でエンコードされた文字列)。
DB クラスターパラメータグループの名前を指定します。
+ **DBParameterGroupFamily** — 文字列、タイプ: `string` (UTF-8 でエンコードされた文字列)。
この DB クラスターパラメータグループと互換性がある DB クラスターパラメータグループファミリーの名前を指定します。
+ **Description** — 文字列、タイプ: `string` (UTF-8 でエンコードされた文字列)。
この DB クラスターパラメータグループに対するユーザー定義の説明を指定します。
**エラー**
+ [DBParameterGroupQuotaExceededFault](api-faults.md#DBParameterGroupQuotaExceededFault)
+ [DBParameterGroupAlreadyExistsFault](api-faults.md#DBParameterGroupAlreadyExistsFault)
## DeleteDBParameterGroup (アクション)
この API の AWS CLI 名は `delete-db-parameter-group` です。
指定された DBParameterGroup を削除します。削除する DBParameterGroup は、どの DB インスタンスにも関連付けることができません。
**[リクエスト**]
+ **DBParameterGroupName** (CLI では: `--db-parameter-group-name`) — *必須:* タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。
DB パラメータグループの名前。
制約:
+ 既存の DB パラメータグループの名前にする必要があります。
+ デフォルトの DB パラメータグループを削除することはできません。
+ DB インスタンスに関連付けることはできません。
**応答**
+ *応答パラメータはありません。*
**エラー**
+ [InvalidDBParameterGroupStateFault](api-faults.md#InvalidDBParameterGroupStateFault)
+ [DBParameterGroupNotFoundFault](api-faults.md#DBParameterGroupNotFoundFault)
## DeleteDBClusterParameterGroup (アクション)
この API の AWS CLI 名は `delete-db-cluster-parameter-group` です。
指定された DB クラスターパラメータグループを削除します。削除する DB クラスターパラメータグループは、どの DB クラスターにも関連付けることができません。
**[リクエスト**]
+ **DBClusterParameterGroupName** (CLI では: `--db-cluster-parameter-group-name`) — *必須:* タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。
DB クラスターパラメータグループの名前。
制約:
+ 既存の DB クラスターパラメータグループの名前にする必要があります。
+ デフォルトの DB クラスターパラメータグループを削除することはできません。
+ DB クラスターに関連付けることはできません。
**応答**
+ *応答パラメータはありません。*
**エラー**
+ [InvalidDBParameterGroupStateFault](api-faults.md#InvalidDBParameterGroupStateFault)
+ [DBParameterGroupNotFoundFault](api-faults.md#DBParameterGroupNotFoundFault)
## ModifyDBParameterGroup (アクション)
この API の AWS CLI 名は `modify-db-parameter-group` です。
DB パラメータグループのパラメータを変更します。複数のパラメータを変更するには、以下のリストを送信します: `ParameterName`、`ParameterValue`、`ApplyMethod`。最大 20 個のパラメータを単一のリクエストで修正できます。
**注記**
動的パラメータの変更は直ちに適用されます。静的パラメータの変更の場合、変更を有効にするには、パラメータグループに関連付けられている DB インスタンスにフェイルオーバーせずに再起動する必要があります。
**重要**
DB パラメータグループの変更後、デフォルトのパラメータグループとしてその DB パラメータグループを使用する最初の DB インスタンスが作成されるまで、5 分以上かかります。その間に、Amazon Neptune によってインスタンスの変更アクションが完了し、そのパラメータグループが新しい DB インスタンスのデフォルトとして使用されるようになります。この点は、DB インスタンスのデフォルトデータベースの作成時に必須になるパラメータ (デフォルトデータベースの文字セットを定義する `character_set_database` パラメータなど) に特に重要です。Amazon Neptune コンソールの [*Parameter Groups*] オプション、または *DescribeDBParameters* コマンドを使用して、DB パラメータグループが作成または変更されたことを確認できます。
**[リクエスト**]
+ **DBParameterGroupName** (CLI では: `--db-parameter-group-name`) — *必須:* タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。
DB パラメータグループの名前。
制約:
+ 指定した場合、既存の DBParameterGroup の名前と一致する必要があります。
+ **Parameters** (CLI では: `--parameters`) - *必須:* [パラメータ](#Parameter) オブジェクトの配列。
パラメータ名、値、およびパラメータ更新用の apply メソッドの配列。少なくとも 1 つのパラメータ名、値、および適用方法を指定する必要があります。後続の引数はオプションです。最大 20 個のパラメータを単一のリクエストで修正できます。
有効な値 (適用方法): `immediate | pending-reboot`
**注記**
即時値は動的パラメータでのみ使用できます。pending-reboot 値は動的パラメータと静的パラメータの両方に使用でき、変更はフェイルオーバーなしで DB インスタンスを再起動すると適用されます。
**レスポンス**
+ **DBParameterGroupName** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。
DB パラメータグループの名前を入力します。
**エラー**
+ [DBParameterGroupNotFoundFault](api-faults.md#DBParameterGroupNotFoundFault)
+ [InvalidDBParameterGroupStateFault](api-faults.md#InvalidDBParameterGroupStateFault)
## ModifyDBClusterParameterGroup (アクション)
この API の AWS CLI 名は `modify-db-cluster-parameter-group` です。
DB クラスターパラメータグループのパラメータを変更します。複数のパラメータを変更するには、以下のリストを送信します: `ParameterName`、`ParameterValue`、`ApplyMethod`。最大 20 個のパラメータを単一のリクエストで修正できます。
**注記**
動的パラメータの変更は直ちに適用されます。静的パラメータの変更の場合、変更を有効にするには、パラメータグループに関連付けられている DB クラスターにフェイルオーバーせずに再起動する必要があります。
**重要**
DB クラスターパラメータグループの作成後、デフォルトのパラメータグループとしてその DB クラスターパラメータグループを使用する最初の DB クラスターが作成されるまで、5 分以上かかります。その間に、Amazon Neptune によってインスタンスの作成アクションが完了し、そのパラメータグループが新しい DB クラスターのデフォルトとして使用されるようになります。この点は、DB クラスターのデフォルトデータベースの作成時に必須になるパラメータ (デフォルトデータベースの文字セットを定義する `character_set_database` パラメータなど) に特に重要です。Amazon Neptune コンソールの [*Parameter Groups*] オプション、または [DescribeDBClusterParameters (アクション)](#DescribeDBClusterParameters) コマンドを使用して、DB クラスターパラメータグループが作成または変更されたことを確認できます。
**[リクエスト**]
+ **DBClusterParameterGroupName** (CLI では: `--db-cluster-parameter-group-name`) — *必須:* タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。
変更する DB クラスターパラメータグループの名前。
+ **Parameters** (CLI では: `--parameters`) - *必須:* [パラメータ](#Parameter) オブジェクトの配列。
変更する DB クラスターパラメータグループ内のパラメータのリスト。
**レスポンス**
+ **DBClusterParameterGroupName** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。
DB クラスターパラメータグループの名前。
制約:
+ 1 ～ 255 文字の英字または数字でなければなりません。
+ 1 字目は英字である必要があります。
+ ハイフンを、文字列の最後に使用したり、2 つ続けて使用したりすることはできません
**注記**
この値は小文字で保存されます。
**エラー**
+ [DBParameterGroupNotFoundFault](api-faults.md#DBParameterGroupNotFoundFault)
+ [InvalidDBParameterGroupStateFault](api-faults.md#InvalidDBParameterGroupStateFault)
## ResetDBParameterGroup (アクション)
この API の AWS CLI 名は `reset-db-parameter-group` です。
DB パラメータグループのパラメータをエンジン/システムのデフォルト値に変更します。特定のパラメータをリセットするには、`ParameterName` と `ApplyMethod` のリストを指定します。DB パラメータグループ全体をリセットするには、`DBParameterGroup` 名と `ResetAllParameters` パラメータを指定します。グループ全体をリセットすると、動的パラメータが即座に更新され、静的パラメータが `pending-reboot` に設定されて、次回の DB インスタンスの再起動や `RebootDBInstance` リクエストで有効になります。
**[リクエスト**]
+ **DBParameterGroupName** (CLI では: `--db-parameter-group-name`) — *必須:* タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。
DB パラメータグループの名前。
制約:
+ 既存の DBParameterGroup の名前と一致する必要があります。
+ **Parameters** (CLI では: `--parameters`) - [パラメータ](#Parameter) オブジェクトの配列。
DB パラメータグループ全体をリセットするには、`DBParameterGroup` 名と `ResetAllParameters` パラメータを指定します。特定のパラメータをリセットするには、`ParameterName` と `ApplyMethod` のリストを指定します。最大 20 個のパラメータを単一のリクエストで修正できます。
有効な値 (適用方法): `pending-reboot`
+ **ResetAllParameters** (CLI では: `--reset-all-parameters`) — ブール値、タイプ: `boolean` (ブール値 (真または偽))。
DB パラメータグループ内のすべてのパラメータをデフォルト値にリセットする (`true`) かしないか (`false`) を指定します。
デフォルト: `true`
**レスポンス**
+ **DBParameterGroupName** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。
DB パラメータグループの名前を入力します。
**エラー**
+ [InvalidDBParameterGroupStateFault](api-faults.md#InvalidDBParameterGroupStateFault)
+ [DBParameterGroupNotFoundFault](api-faults.md#DBParameterGroupNotFoundFault)
## ResetDBClusterParameterGroup (アクション)
この API の AWS CLI 名は `reset-db-cluster-parameter-group` です。
DB クラスターパラメータグループのパラメータをデフォルト値に変更します。特定のパラメータをリセットするには、`ParameterName` と `ApplyMethod` のリストを送信します。DB クラスターパラメータグループ全体をリセットするには、`DBClusterParameterGroupName` 名と `ResetAllParameters` パラメータを指定します。
グループ全体をリセットすると、動的パラメータが即座に更新され、静的パラメータが `pending-reboot` に設定されて、次回の DB インスタンスの再起動や [RebootDBInstance (アクション)](api-instances.md#RebootDBInstance) リクエストで有効になります。更新された静的パラメータを適用する DB クラスター内のすべての DB インスタンスに対して、[RebootDBInstance (アクション)](api-instances.md#RebootDBInstance) を呼び出す必要があります。
**[リクエスト**]
+ **DBClusterParameterGroupName** (CLI では: `--db-cluster-parameter-group-name`) — *必須:* タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。
リセットする DB クラスターパラメータグループの名前。
+ **Parameters** (CLI では: `--parameters`) - [パラメータ](#Parameter) オブジェクトの配列。
デフォルト値にリセットする DB クラスターパラメータグループ内のパラメータ名のリスト。`ResetAllParameters` パラメータが `true` に設定されている場合は、このパラメータを設定することはできません。
+ **ResetAllParameters** (CLI では: `--reset-all-parameters`) — ブール値、タイプ: `boolean` (ブール値 (真または偽))。
DB クラスターパラメータグループ内のすべてのパラメータをデフォルト値にリセットするには `true` に設定し、それ以外の場合は `false` に設定します。`Parameters` パラメータに指定されたパラメータ名のリストがある場合、このパラメータは使用できません。
**レスポンス**
+ **DBClusterParameterGroupName** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。
DB クラスターパラメータグループの名前。
制約:
+ 1 ～ 255 文字の英字または数字でなければなりません。
+ 1 字目は英字である必要があります。
+ ハイフンを、文字列の最後に使用したり、2 つ続けて使用したりすることはできません
**注記**
この値は小文字で保存されます。
**エラー**
+ [InvalidDBParameterGroupStateFault](api-faults.md#InvalidDBParameterGroupStateFault)
+ [DBParameterGroupNotFoundFault](api-faults.md#DBParameterGroupNotFoundFault)
## DescribeDBParameters (アクション)
この API の AWS CLI 名は `describe-db-parameters` です。
特定の DB パラメータグループの詳細なパラメータリストを返します。
**[リクエスト**]
+ **DBParameterGroupName** (CLI では: `--db-parameter-group-name`) — *必須:* タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。
詳細を返す特定の DB パラメータグループの名前。
制約:
+ 指定した場合、既存の DBParameterGroup の名前と一致する必要があります。
+ **Filters** (CLI では: `--filters`) - [フィルター](api-datatypes.md#Filter) オブジェクトの配列。
このパラメータは、現在サポートされていません。
+ **Marker** (CLI では: `--marker`) — タイプ: `string` (UTF-8 でエンコードされた文字列) の文字列。
以前の `DescribeDBParameters` リクエストによって提供されたオプションのページ割りトークン。このパラメータを指定した場合、レスポンスには `MaxRecords` で指定された値まで、マーカーを超えるレコードのみが含まれます。
+ **MaxRecords** (CLI では: `--max-records`) — IntegerOptional、タイプ: `integer` (符号付き 32 ビット整数)。
レスポンスに含めるレコードの最大数。指定された `MaxRecords` の値よりも多くのレコードが存在する場合、マーカーと呼ばれるページ割りトークンがレスポンスに含まれるため、残りの結果を取得できます。
デフォルト: 100
制約: 最小 20、最大 100。
+ **Source** (CLI では: `--source`) — タイプ: `string` (UTF-8 でエンコードされた文字列) の文字列。
返すパラメータのタイプ。
デフォルト: 返されるすべてのパラメータタイプ
有効な値：`user | system | engine-default`
**レスポンス**
+ **Marker** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。
以前のリクエストによって提供されたオプションのページ割りトークン。このパラメータを指定した場合、レスポンスには `MaxRecords` で指定された値まで、マーカーを超えるレコードのみが含まれます。
+ **Parameters** – [パラメータ](#Parameter) オブジェクトの配列。
[パラメータ (構造)](#Parameter) 値のリスト。
**エラー**
+ [DBParameterGroupNotFoundFault](api-faults.md#DBParameterGroupNotFoundFault)
## DescribeDBParameterGroups (アクション)
この API の AWS CLI 名は `describe-db-parameter-groups` です。
`DBParameterGroup` の説明のリストを返します。`DBParameterGroupName` を指定した場合、リストには指定した DB パラメータグループの説明のみが含まれます。
**[リクエスト**]
+ **DBParameterGroupName** (CLI では: `--db-parameter-group-name`) — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。
詳細を返す特定の DB パラメータグループの名前。
制約:
+ 指定した場合、既存の DBClusterParameterGroup の名前と一致する必要があります。
+ **Filters** (CLI では: `--filters`) - [フィルター](api-datatypes.md#Filter) オブジェクトの配列。
このパラメータは、現在サポートされていません。
+ **Marker** (CLI では: `--marker`) — タイプ: `string` (UTF-8 でエンコードされた文字列) の文字列。
以前の `DescribeDBParameterGroups` リクエストによって提供されたオプションのページ割りトークン。このパラメータを指定した場合、レスポンスには `MaxRecords` で指定された値まで、マーカーを超えるレコードのみが含まれます。
+ **MaxRecords** (CLI では: `--max-records`) — IntegerOptional、タイプ: `integer` (符号付き 32 ビット整数)。
レスポンスに含めるレコードの最大数。指定された `MaxRecords` の値よりも多くのレコードが存在する場合、マーカーと呼ばれるページ割りトークンがレスポンスに含まれるため、残りの結果を取得できます。
デフォルト: 100
制約: 最小 20、最大 100。
**応答**
+ **DBParameterGroups** – [DBParameterGroup](#DBParameterGroup) オブジェクトの配列。
[DBParameterGroup (構造)](#DBParameterGroup) インスタンスのリスト。
+ **Marker** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。
以前のリクエストによって提供されたオプションのページ割りトークン。このパラメータを指定した場合、レスポンスには `MaxRecords` で指定された値まで、マーカーを超えるレコードのみが含まれます。
**エラー**
+ [DBParameterGroupNotFoundFault](api-faults.md#DBParameterGroupNotFoundFault)
## DescribeDBClusterParameters (アクション)
この API の AWS CLI 名は `describe-db-cluster-parameters` です。
特定の DB クラスターパラメータグループの詳細なパラメータリストを返します。
**[リクエスト**]
+ **DBClusterParameterGroupName** (CLI では: `--db-cluster-parameter-group-name`) — *必須:* タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。
パラメータの詳細を返す特定の DB クラスターパラメータグループの名前。
制約:
+ 指定した場合、既存の DBClusterParameterGroup の名前と一致する必要があります。
+ **Filters** (CLI では: `--filters`) - [フィルター](api-datatypes.md#Filter) オブジェクトの配列。
このパラメータは、現在サポートされていません。
+ **Marker** (CLI では: `--marker`) — タイプ: `string` (UTF-8 でエンコードされた文字列) の文字列。
以前の `DescribeDBClusterParameters` リクエストによって提供されたオプションのページ割りトークン。このパラメータを指定した場合、レスポンスには `MaxRecords` で指定された値まで、マーカーを超えるレコードのみが含まれます。
+ **MaxRecords** (CLI では: `--max-records`) — IntegerOptional、タイプ: `integer` (符号付き 32 ビット整数)。
レスポンスに含めるレコードの最大数。指定された `MaxRecords` の値よりも多くのレコードが存在する場合、マーカーと呼ばれるページ割りトークンがレスポンスに含まれるため、残りの結果を取得できます。
デフォルト: 100
制約: 最小 20、最大 100。
+ **Source** (CLI では: `--source`) — タイプ: `string` (UTF-8 でエンコードされた文字列) の文字列。
特定のソースのパラメータのみを返すことを示す値。パラメータのソースは `engine`、`service`、または `customer` のいずれかとすることができます。
**レスポンス**
+ **Marker** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。
以前の DescribeDBClusterParameters リクエストによって提供されたオプションのページ分割トークン。このパラメータを指定した場合、レスポンスには `MaxRecords` で指定された値まで、マーカーを超えるレコードのみが含まれます。
+ **Parameters** – [パラメータ](#Parameter) オブジェクトの配列。
DB クラスターパラメータグループのパラメータのリストを入力します。
**エラー**
+ [DBParameterGroupNotFoundFault](api-faults.md#DBParameterGroupNotFoundFault)
## DescribeDBClusterParameterGroups (アクション)
この API の AWS CLI 名は `describe-db-cluster-parameter-groups` です。
`DBClusterParameterGroup` の説明のリストを返します。`DBClusterParameterGroupName` パラメータを指定した場合、リストには指定した DB クラスターパラメータグループの説明のみが含まれます。
**[リクエスト**]
+ **DBClusterParameterGroupName** (CLI では: `--db-cluster-parameter-group-name`) — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。
詳細を返す特定の DB クラスターパラメータグループの名前。
制約:
+ 指定した場合、既存の DBClusterParameterGroup の名前と一致する必要があります。
+ **Filters** (CLI では: `--filters`) - [フィルター](api-datatypes.md#Filter) オブジェクトの配列。
このパラメータは、現在サポートされていません。
+ **Marker** (CLI では: `--marker`) — タイプ: `string` (UTF-8 でエンコードされた文字列) の文字列。
以前の `DescribeDBClusterParameterGroups` リクエストによって提供されたオプションのページ割りトークン。このパラメータを指定した場合、レスポンスには `MaxRecords` で指定された値まで、マーカーを超えるレコードのみが含まれます。
+ **MaxRecords** (CLI では: `--max-records`) — IntegerOptional、タイプ: `integer` (符号付き 32 ビット整数)。
レスポンスに含めるレコードの最大数。指定された `MaxRecords` の値よりも多くのレコードが存在する場合、マーカーと呼ばれるページ割りトークンがレスポンスに含まれるため、残りの結果を取得できます。
デフォルト: 100
制約: 最小 20、最大 100。
**応答**
+ **DBClusterParameterGroups** – [DBClusterParameterGroup](#DBClusterParameterGroup) オブジェクトの配列。
DB クラスターパラメータグループのリスト。
+ **Marker** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。
以前の `DescribeDBClusterParameterGroups` リクエストによって提供されたオプションのページ割りトークン。このパラメータを指定した場合、レスポンスには `MaxRecords` で指定された値まで、マーカーを超えるレコードのみが含まれます。
**エラー**
+ [DBParameterGroupNotFoundFault](api-faults.md#DBParameterGroupNotFoundFault)
## DescribeEngineDefaultParameters (アクション)
この API の AWS CLI 名は `describe-engine-default-parameters` です。
指定されたデータベースエンジンのデフォルトのエンジンおよびシステムパラメータ情報を返します。
**[リクエスト**]
+ **DBParameterGroupFamily** (CLI では: `--db-parameter-group-family`) — *必須:* タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。
DB パラメータグループファミリーの名前。
+ **Filters** (CLI では: `--filters`) - [フィルター](api-datatypes.md#Filter) オブジェクトの配列。
現在サポートされていません。
+ **Marker** (CLI では: `--marker`) — タイプ: `string` (UTF-8 でエンコードされた文字列) の文字列。
以前の `DescribeEngineDefaultParameters` リクエストによって提供されたオプションのページ割りトークン。このパラメータを指定した場合、レスポンスには `MaxRecords` で指定された値まで、マーカーを超えるレコードのみが含まれます。
+ **MaxRecords** (CLI では: `--max-records`) — IntegerOptional、タイプ: `integer` (符号付き 32 ビット整数)。
レスポンスに含めるレコードの最大数。指定された `MaxRecords` の値よりも多くのレコードが存在する場合、マーカーと呼ばれるページ割りトークンがレスポンスに含まれるため、残りの結果を取得できます。
デフォルト: 100
制約: 最小 20、最大 100。
**レスポンス**
[DescribeEngineDefaultParameters (アクション)](#DescribeEngineDefaultParameters) アクションの呼び出しが成功した結果が含まれています。
+ **DBParameterGroupFamily** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。
エンジンのデフォルトパラメータが適用される DB パラメータグループファミリーの名前を指定します。
+ **Marker** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。
以前の EngineDefaults リクエストによって提供されたオプションのページ分割トークン。このパラメータを指定した場合、レスポンスには `MaxRecords` で指定された値まで、マーカーを超えるレコードのみが含まれます。
+ **Parameters** – [パラメータ](#Parameter) オブジェクトの配列。
エンジンのデフォルトパラメータのリストが含まれます。
## DescribeEngineDefaultClusterParameters (アクション)
この API の AWS CLI 名は `describe-engine-default-cluster-parameters` です。
クラスターのデータベースエンジンのデフォルトのエンジンおよびシステムパラメータ情報を返します。
**[リクエスト**]
+ **DBParameterGroupFamily** (CLI では: `--db-parameter-group-family`) — *必須:* タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。
エンジンパラメータ情報を返す DB クラスターパラメータグループファミリーの名前。
+ **Filters** (CLI では: `--filters`) - [フィルター](api-datatypes.md#Filter) オブジェクトの配列。
このパラメータは、現在サポートされていません。
+ **Marker** (CLI では: `--marker`) — タイプ: `string` (UTF-8 でエンコードされた文字列) の文字列。
以前の `DescribeEngineDefaultClusterParameters` リクエストによって提供されたオプションのページ割りトークン。このパラメータを指定した場合、レスポンスには `MaxRecords` で指定された値まで、マーカーを超えるレコードのみが含まれます。
+ **MaxRecords** (CLI では: `--max-records`) — IntegerOptional、タイプ: `integer` (符号付き 32 ビット整数)。
レスポンスに含めるレコードの最大数。指定された `MaxRecords` の値よりも多くのレコードが存在する場合、マーカーと呼ばれるページ割りトークンがレスポンスに含まれるため、残りの結果を取得できます。
デフォルト: 100
制約: 最小 20、最大 100。
**レスポンス**
[DescribeEngineDefaultParameters (アクション)](#DescribeEngineDefaultParameters) アクションの呼び出しが成功した結果が含まれています。
+ **DBParameterGroupFamily** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。
エンジンのデフォルトパラメータが適用される DB パラメータグループファミリーの名前を指定します。
+ **Marker** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。
以前の EngineDefaults リクエストによって提供されたオプションのページ分割トークン。このパラメータを指定した場合、レスポンスには `MaxRecords` で指定された値まで、マーカーを超えるレコードのみが含まれます。
+ **Parameters** – [パラメータ](#Parameter) オブジェクトの配列。
エンジンのデフォルトパラメータのリストが含まれます。
## *構造:*
## パラメータ (構造)
パラメータを指定します。
**フィールド**
+ **AllowedValues** — 文字列、タイプ: `string` (UTF-8 でエンコードされた文字列)。
パラメータの有効な値の範囲を指定します。
+ **ApplyMethod** — ApplyMethod、タイプ: `string` (UTF-8 でエンコードされた文字列)。
パラメータの更新を適用するタイミングを指定します。
+ **ApplyType** — 文字列、タイプ: `string` (UTF-8 でエンコードされた文字列)。
エンジン固有のパラメータタイプを指定します。
+ **DataType** — 文字列、タイプ: `string` (UTF-8 でエンコードされた文字列)。
パラメータの有効なデータ型を指定します。
+ **Description** — 文字列、タイプ: `string` (UTF-8 でエンコードされた文字列)。
パラメータの説明を入力します。
+ **IsModifiable** — ブール値、タイプ: `boolean` (ブール値 (真または偽))。
パラメータを変更できるか (`true`) 、できない (`false`) かを示します。いくつかのパラメータには、それらの変更を妨げるセキュリティ上または運用上の影響があります。
+ **MinimumEngineVersion** — 文字列、タイプ: `string` (UTF-8 でエンコードされた文字列)。
パラメータを適用できる最も古いエンジンバージョン。
+ **ParameterName** — 文字列、タイプ: `string` (UTF-8 でエンコードされた文字列)。
パラメータの名前を指定します。
+ **ParameterValue** — 文字列、タイプ: `string` (UTF-8 でエンコードされた文字列)。
パラメータの値を指定します。
+ **Source** — 文字列、タイプ: `string` (UTF-8 でエンコードされた文字列)。
パラメータ値のソースを示します。
## DBParameterGroup (構造)
Amazon Neptune DB パラメータグループの詳細が含まれています。
このデータ型は、[DescribeDBParameterGroups (アクション)](#DescribeDBParameterGroups) アクションのレスポンス要素として使用されます。
**フィールド**
+ **DBParameterGroupArn** — 文字列、タイプ: `string` (UTF-8 でエンコードされた文字列)。
DB パラメータグループの Amazon リソースネーム (ARN)。
+ **DBParameterGroupFamily** — 文字列、タイプ: `string` (UTF-8 でエンコードされた文字列)。
この DB クラスターパラメータグループと互換性がある DB パラメータグループファミリーの名前を指定します。
+ **DBParameterGroupName** — 文字列、タイプ: `string` (UTF-8 でエンコードされた文字列)。
DB パラメータグループの名前を入力します。
+ **Description** — 文字列、タイプ: `string` (UTF-8 でエンコードされた文字列)。
この DB パラメータグループに対するユーザー定義の説明を指定します。
`DBParameterGroup` は、以下のレスポンス要素として使用されます。
+ [CopyDBParameterGroup](#CopyDBParameterGroup)
+ [CreateDBParameterGroup](#CreateDBParameterGroup)
## DBClusterParameterGroup (構造)
Amazon Neptune DB クラスターパラメータグループの詳細が含まれています。
このデータ型は、[DescribeDBClusterParameterGroups (アクション)](#DescribeDBClusterParameterGroups) アクションのレスポンス要素として使用されます。
**フィールド**
+ **DBClusterParameterGroupArn** — 文字列、タイプ: `string` (UTF-8 でエンコードされた文字列)。
DB クラスターパラメータグループの Amazon リソースネーム (ARN)。
+ **DBClusterParameterGroupName** — 文字列、タイプ: `string` (UTF-8 でエンコードされた文字列)。
DB クラスターパラメータグループの名前を指定します。
+ **DBParameterGroupFamily** — 文字列、タイプ: `string` (UTF-8 でエンコードされた文字列)。
この DB クラスターパラメータグループと互換性がある DB クラスターパラメータグループファミリーの名前を指定します。
+ **Description** — 文字列、タイプ: `string` (UTF-8 でエンコードされた文字列)。
この DB クラスターパラメータグループに対するユーザー定義の説明を指定します。
`DBClusterParameterGroup` は、以下のレスポンス要素として使用されます。
+ [CopyDBClusterParameterGroup](#CopyDBClusterParameterGroup)
+ [CreateDBClusterParameterGroup](#CreateDBClusterParameterGroup)
## DBParameterGroupStatus (構造)
DB パラメータグループのステータス。
このデータ型は、以下のアクションのレスポンス要素として使用されます。
+ [CreateDBInstance (アクション)](api-instances.md#CreateDBInstance)
+ [DeleteDBInstance (アクション)](api-instances.md#DeleteDBInstance)
+ [ModifyDBInstance (アクション)](api-instances.md#ModifyDBInstance)
+ [RebootDBInstance (アクション)](api-instances.md#RebootDBInstance)
**フィールド**
+ **DBParameterGroupName** — 文字列、タイプ: `string` (UTF-8 でエンコードされた文字列)。
DP パラメータグループの名前。
+ **ParameterApplyStatus** — 文字列、タイプ: `string` (UTF-8 でエンコードされた文字列)。
パラメータ更新のステータス。