

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

# Neptune サブネット API
サブネット

**アクション:**
+ [CreateDBSubnetGroup (アクション)](#CreateDBSubnetGroup)
+ [DeleteDBSubnetGroup (アクション)](#DeleteDBSubnetGroup)
+ [ModifyDBSubnetGroup (アクション)](#ModifyDBSubnetGroup)
+ [DescribeDBSubnetGroups (アクション)](#DescribeDBSubnetGroups)

**構造:**
+ [サブネット (構造)](#Subnet)
+ [DBSubnetGroup (構造)](#DBSubnetGroup)

## CreateDBSubnetGroup (アクション)
CreateDBSubnetGroup

         この API の AWS CLI 名は `create-db-subnet-group` です。

新しい DB サブネットグループを作成します。DB サブネットグループには、Amazon リージョン内の少なくとも 2 つの AZ に少なくとも 1 つのサブネットが含まれている必要があります。

**[リクエスト**]
+ **DBSubnetGroupDescription** (CLI では: `--db-subnet-group-description`) — *必須:* タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  DB サブネットグループの説明。
+ **DBSubnetGroupName** (CLI では: `--db-subnet-group-name`) — *必須:* タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  DB サブネットグループの名前。この値は小文字で保存されます。

  制約: 最大 255 文字の英字、数字、ピリオド、アンダースコア、スペース、またはハイフンのみを使用できます。デフォルト値を使用することはできません。

  例:`mySubnetgroup`
+ **SubnetIds** (CLI では: `--subnet-ids`) — *必須:* タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  DB サブネットグループの EC2 サブネット ID。
+ **Tags**  (CLI では: `--tags`) - [Tag](api-other-apis.md#Tag) オブジェクトの配列。

  新しい DB サブネットグループに割り当てられるタグ。

**レスポンス**

Amazon Neptune DB サブネットグループの詳細が含まれています。

このデータ型は、[DescribeDBSubnetGroups (アクション)](#DescribeDBSubnetGroups) アクションのレスポンス要素として使用されます。
+ **DBSubnetGroupArn** — 文字列、タイプ: `string` (UTF-8 でエンコードされた文字列)。

  DB サブネットグループの Amazon リソースネーム (ARN)。
+ **DBSubnetGroupDescription** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  DB サブネットグループの説明を入力します。
+ **DBSubnetGroupName** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  DB サブネットグループの名前。
+ **SubnetGroupStatus** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  DB サブネットグループのステータスを入力します。
+ **Subnets** – [サブネット](#Subnet) オブジェクトの配列。

   [サブネット (構造)](#Subnet) 要素のリストが含まれます。
+ **VpcId** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  DB サブネットグループの VpcId を入力します。

**エラー**
+ [DBSubnetGroupAlreadyExistsFault](api-faults.md#DBSubnetGroupAlreadyExistsFault)
+ [DBSubnetGroupQuotaExceededFault](api-faults.md#DBSubnetGroupQuotaExceededFault)
+ [DBSubnetQuotaExceededFault](api-faults.md#DBSubnetQuotaExceededFault)
+ [DBSubnetGroupDoesNotCoverEnoughAZs](api-faults.md#DBSubnetGroupDoesNotCoverEnoughAZs)
+ [InvalidSubnet](api-faults.md#InvalidSubnet)

## DeleteDBSubnetGroup (アクション)
DeleteDBSubnetGroup

         この API の AWS CLI 名は `delete-db-subnet-group` です。

DB サブネットグループを削除します。

**注記**  
指定されたデータベースサブネットグループは、どの DB インスタンスにも関連付けないでください。

**[リクエスト**]
+ **DBSubnetGroupName** (CLI では: `--db-subnet-group-name`) — *必須:* タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  削除するデータベースサブネットグループの名前。
**注記**  
デフォルトのサブネットグループを削除することはできません。

  制約:

  制約: 既存の DBSubnetGroup の名前と一致する必要があります。デフォルト値を使用することはできません。

  例:`mySubnetgroup`

**応答**
+ *応答パラメータはありません。*

**エラー**
+ [InvalidDBSubnetGroupStateFault](api-faults.md#InvalidDBSubnetGroupStateFault)
+ [InvalidDBSubnetStateFault](api-faults.md#InvalidDBSubnetStateFault)
+ [DBSubnetGroupNotFoundFault](api-faults.md#DBSubnetGroupNotFoundFault)

## ModifyDBSubnetGroup (アクション)
ModifyDBSubnetGroup

         この API の AWS CLI 名は `modify-db-subnet-group` です。

既存の DB サブネットグループを変更します。DB サブネットグループには、Amazon リージョン内の少なくとも 2 つの AZ に少なくとも 1 つのサブネットが含まれている必要があります。

**[リクエスト**]
+ **DBSubnetGroupDescription** (CLI では: `--db-subnet-group-description`) — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  DB サブネットグループの説明。
+ **DBSubnetGroupName** (CLI では: `--db-subnet-group-name`) — *必須:* タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  DB サブネットグループの名前。この値は小文字で保存されます。デフォルトのサブネットグループを変更することはできません。

  制約: 既存の DBSubnetGroup の名前と一致する必要があります。デフォルト値を使用することはできません。

  例:`mySubnetgroup`
+ **SubnetIds** (CLI では: `--subnet-ids`) — *必須:* タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  DB サブネットグループの EC2 サブネット ID。

**レスポンス**

Amazon Neptune DB サブネットグループの詳細が含まれています。

このデータ型は、[DescribeDBSubnetGroups (アクション)](#DescribeDBSubnetGroups) アクションのレスポンス要素として使用されます。
+ **DBSubnetGroupArn** — 文字列、タイプ: `string` (UTF-8 でエンコードされた文字列)。

  DB サブネットグループの Amazon リソースネーム (ARN)。
+ **DBSubnetGroupDescription** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  DB サブネットグループの説明を入力します。
+ **DBSubnetGroupName** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  DB サブネットグループの名前。
+ **SubnetGroupStatus** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  DB サブネットグループのステータスを入力します。
+ **Subnets** – [サブネット](#Subnet) オブジェクトの配列。

   [サブネット (構造)](#Subnet) 要素のリストが含まれます。
+ **VpcId** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  DB サブネットグループの VpcId を入力します。

**エラー**
+ [DBSubnetGroupNotFoundFault](api-faults.md#DBSubnetGroupNotFoundFault)
+ [DBSubnetQuotaExceededFault](api-faults.md#DBSubnetQuotaExceededFault)
+ [SubnetAlreadyInUse](api-faults.md#SubnetAlreadyInUse)
+ [DBSubnetGroupDoesNotCoverEnoughAZs](api-faults.md#DBSubnetGroupDoesNotCoverEnoughAZs)
+ [InvalidSubnet](api-faults.md#InvalidSubnet)

## DescribeDBSubnetGroups (アクション)
DescribeDBSubnetGroups

         この API の AWS CLI 名は `describe-db-subnet-groups` です。

DBSubnetGroup の説明のリストを返します。DBSubnetGroupName を指定した場合、リストには指定した DBSubnetGroup の説明のみが含まれます。

CIDR 範囲の概要については、[Wikipedia のチュートリアル](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)を参照してください。

**[リクエスト**]
+ **DBSubnetGroupName** (CLI では: `--db-subnet-group-name`) — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  詳細を返す DB サブネットグループの名前。
+ **Filters**  (CLI では: `--filters`) - [フィルター](api-datatypes.md#Filter) オブジェクトの配列。

  このパラメータは、現在サポートされていません。
+ **Marker** (CLI では: `--marker`) — タイプ: `string` (UTF-8 でエンコードされた文字列) の文字列。

   以前の DescribeDBSubnetGroups リクエストによって提供されたオプションのページ分割トークン。このパラメータを指定した場合、レスポンスには `MaxRecords` で指定された値まで、マーカーを超えるレコードのみが含まれます。
+ **MaxRecords** (CLI では: `--max-records`) — IntegerOptional、タイプ: `integer` (符号付き 32 ビット整数)。

   レスポンスに含めるレコードの最大数。指定された `MaxRecords` の値よりも多くのレコードが存在する場合、マーカーと呼ばれるページ割りトークンがレスポンスに含まれるため、残りの結果を取得できます。

  デフォルト: 100

  制約: 最小 20、最大 100。

**応答**
+ **DBSubnetGroups** – [DBSubnetGroup](#DBSubnetGroup) オブジェクトの配列。

   [DBSubnetGroup (構造)](#DBSubnetGroup) インスタンスのリスト。
+ **Marker** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

   以前のリクエストによって提供されたオプションのページ割りトークン。このパラメータを指定した場合、レスポンスには `MaxRecords` で指定された値まで、マーカーを超えるレコードのみが含まれます。

**エラー**
+ [DBSubnetGroupNotFoundFault](api-faults.md#DBSubnetGroupNotFoundFault)

## *構造:*
\$1\$1\$1\$1\$1\$1\$1\$1\$1\$1\$1\$1\$1\$1\$1\$1\$1\$1\$1\$1\$1\$1\$1\$1

## サブネット (構造)
サブネット

サブネットを指定します。

 このデータ型は、[DescribeDBSubnetGroups (アクション)](#DescribeDBSubnetGroups) アクションのレスポンス要素として使用されます。

**フィールド**
+ **SubnetAvailabilityZone** - これは [AvailabilityZone](api-datatypes.md#AvailabilityZone) オブジェクトです。

  サブネットが属する EC2 アベイラビリティーゾーンを指定します。
+ **SubnetIdentifier** — 文字列、タイプ: `string` (UTF-8 でエンコードされた文字列)。

  サブネットの識別子を指定します。
+ **SubnetStatus** — 文字列、タイプ: `string` (UTF-8 でエンコードされた文字列)。

  サブネットのステータスを指定します。

## DBSubnetGroup (構造)
DBSubnetGroup

Amazon Neptune DB サブネットグループの詳細が含まれています。

このデータ型は、[DescribeDBSubnetGroups (アクション)](#DescribeDBSubnetGroups) アクションのレスポンス要素として使用されます。

**フィールド**
+ **DBSubnetGroupArn** — 文字列、タイプ: `string` (UTF-8 でエンコードされた文字列)。

  DB サブネットグループの Amazon リソースネーム (ARN)。
+ **DBSubnetGroupDescription** — 文字列、タイプ: `string` (UTF-8 でエンコードされた文字列)。

  DB サブネットグループの説明を入力します。
+ **DBSubnetGroupName** — 文字列、タイプ: `string` (UTF-8 でエンコードされた文字列)。

  DB サブネットグループの名前。
+ **SubnetGroupStatus** — 文字列、タイプ: `string` (UTF-8 でエンコードされた文字列)。

  DB サブネットグループのステータスを入力します。
+ **Subnets** — これは [サブネット](#Subnet) オブジェクトの配列です。

   [サブネット (構造)](#Subnet) 要素のリストが含まれます。
+ **VpcId** — 文字列、タイプ: `string` (UTF-8 でエンコードされた文字列)。

  DB サブネットグループの VpcId を入力します。

`DBSubnetGroup` は、以下のレスポンス要素として使用されます。
+ [CreateDBSubnetGroup](#CreateDBSubnetGroup)
+ [ModifyDBSubnetGroup](#ModifyDBSubnetGroup)