

# Amazon RDS Data API の有効化
<a name="data-api.enabling"></a>

Amazon RDS Data API (Data API) を使用するには、Aurora DB クラスター用に有効にする必要があります。Data API の有効化は、DB クラスターの作成時または変更時に行うことができます。

**注記**  
 Data API がクラスターで使用できるかどうかは、Aurora のバージョン、データベースエンジン、AWS リージョンによって異なります。古い Aurora バージョンでは、Data API は Aurora Serverless v1 クラスターでのみ動作します。新しい Aurora バージョンの場合、Data API は、プロビジョニングされたインスタンスと Aurora Serverless v2 インスタンスの両方を使用するクラスターで動作します。クラスターが Data API を使用できるかどうかを確認するには、「[RDS Data API でサポートされているリージョンと Aurora DB エンジン](Concepts.Aurora_Fea_Regions_DB-eng.Feature.Data_API.md)」を参照してください。

**Topics**
+ [データベースの作成時の RDS Data API の有効化](#data-api.enabling.creating)
+ [既存のデータベースでの RDS Data API の有効化](#data-api.enabling.modifying)

## データベースの作成時の RDS Data API の有効化
<a name="data-api.enabling.creating"></a>

RDS Data API (Data API) をサポートするデータベースを作成するときに、この機能を有効にできます。次の手順では、AWS マネジメントコンソール、AWS CLI または RDS API を使用するときにこれを行う方法について説明します。

### コンソール
<a name="data-api.enabling.creating.console"></a>

DB クラスターの作成時に Data API を有効にするには、次のスクリーンショットのように、**[データベースの作成]** ページの **[接続]** セクションで **[RDS Data API を有効にする]** チェックボックスをオンにします。

![\[[データベースの作成] ページの [接続] セクションで、[RDS Data API を有効にする] チェックボックスをオンにします。\]](http://docs.aws.amazon.com/ja_jp/AmazonRDS/latest/AuroraUserGuide/images/data-api-enable-on-create.png)


RDS Data API を使用できる Aurora DB クラスターの作成方法については、以下を参照してください。
+ Aurora Serverless v2 およびプロビジョニングされたクラスターの場合 – [Amazon Aurora DB クラスターの作成](Aurora.CreateInstance.md)
+ Aurora Serverless v1 – [Aurora Serverless v1 DB クラスターの作成](aurora-serverless.create.md) の場合

### AWS CLI
<a name="data-api.enabling.creating.cli"></a>

Aurora DB クラスターの作成中に Data API を有効にするには、`--enable-http-endpoint` オプションを指定して [create-db-cluster](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-cluster.html) AWS CLI コマンドを実行します。

次の例では、Data API を有効にして Aurora PostgreSQL DB クラスターを作成します。

Linux、macOS、Unix の場合:

```
aws rds create-db-cluster \
    --db-cluster-identifier my_pg_cluster \
    --engine aurora-postgresql \
    --enable-http-endpoint
```

Windows の場合:

```
aws rds create-db-cluster ^
    --db-cluster-identifier my_pg_cluster ^
    --engine aurora-postgresql ^
    --enable-http-endpoint
```

### RDS API
<a name="data-api.enabling.creating.api"></a>

Aurora DB クラスターの作成中に Data API を有効にするには、`EnableHttpEndpoint` パラメータの値を `true` に設定して [CreateDBCluster](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBCluster.html) オペレーションを使用します。

## 既存のデータベースでの RDS Data API の有効化
<a name="data-api.enabling.modifying"></a>

RDS Data API (Data API) をサポートする DB クラスターを変更して、この機能を有効または無効にできます。

**Topics**
+ [Data API (Aurora Serverless v2 および プロビジョンド) の有効化または無効化](#data-api.enabling.modifying.all)
+ [Data API の有効化または無効化 (Aurora Serverless v1 のみ)](#data-api.enabling.modifying.sv1)

### Data API (Aurora Serverless v2 および プロビジョンド) の有効化または無効化
<a name="data-api.enabling.modifying.all"></a>

Aurora Serverless v2 およびプロビジョニングされたデータベースで Data API を有効または無効にするには、次の手順を使用します。Aurora Serverless v1 データベースで Data API を有効または無効にするには、「[Data API の有効化または無効化 (Aurora Serverless v1 のみ)](#data-api.enabling.modifying.sv1)」の手順を使用します。

#### コンソール
<a name="data-api.enabling.modifying.all.console"></a>

Data API を有効または無効にするには、この機能をサポートする DB クラスターの RDS コンソールを使用します。これを行うには、Data API を有効または無効にするデータベースのクラスター詳細ページを開き、**[接続とセキュリティ]** タブで **[RDS Data API]** セクションに移動します。このセクションでは、Data API のステータスを表示し、それを有効または無効にできます。

次のスクリーンショットは、**[RDS Data API]** が有効になっていないことを示しています。

![\[DB クラスターの詳細ページの [接続とセキュリティ] タブの [RDS Data API] セクション。Data API のステータスは無効と表示され、[RDS Data API を有効にする] ボタンが表示されます。\]](http://docs.aws.amazon.com/ja_jp/AmazonRDS/latest/AuroraUserGuide/images/data-api-enable-from-details.png)


#### AWS CLI
<a name="data-api.enabling.modifying.all.cli"></a>

既存のデータベースで Data API を有効または無効にするには、[enable-http-endpoint](https://docs.aws.amazon.com/cli/latest/reference/rds/enable-http-endpoint.html) または [disable-http-endpoint](https://docs.aws.amazon.com/cli/latest/reference/rds/disable-http-endpoint.html) AWS CLI コマンドを実行し、DB クラスターの ARN を指定します。

次の例では、Data API を有効にします。

Linux、macOS、Unix の場合:

```
aws rds enable-http-endpoint \
    --resource-arn cluster_arn
```

Windows の場合:

```
aws rds enable-http-endpoint ^
    --resource-arn cluster_arn
```

#### RDS API
<a name="data-api.enabling.modifying.all.api"></a>

既存のデータベースで Data API を有効または無効にするには、[EnableHttpEndpoint](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_EnableHttpEndpoint.html) オペレーションと [DisableHttpEndpoint](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DisableHttpEndpoint.html) オペレーションを使用します。

### Data API の有効化または無効化 (Aurora Serverless v1 のみ)
<a name="data-api.enabling.modifying.sv1"></a>

Aurora Serverless v1 データベースで Data API を有効または無効にするには、次の手順を使用します。Aurora Serverless v2 およびプロビジョニングされたデータベースで Data API を有効または無効にするには、「[Data API (Aurora Serverless v2 および プロビジョンド) の有効化または無効化](#data-api.enabling.modifying.all)」の手順を使用します。

#### コンソール
<a name="data-api.enabling.modifying.sv1.console"></a>

Aurora Serverless v1 DB クラスターの変更時には、RDS コンソールの **[接続]** セクションで Data API を有効にします。

次のスクリーンショットは、Aurora DB クラスターを変更時に有効になった **[Data API]** を示しています。

![\[DB クラスターの変更ページの [接続] セクションで、[Data API] チェックボックスが選択されています。\]](http://docs.aws.amazon.com/ja_jp/AmazonRDS/latest/AuroraUserGuide/images/data-api-modify-serverlessv1.png)


Aurora Serverless v1 DB クラスターを変更する手順については、「[Aurora Serverless v1 DB クラスターの変更](aurora-serverless.modifying.md)」を参照してください。

#### AWS CLI
<a name="data-api.enabling.modifying.sv1.cli"></a>

Data API を有効または無効にするには、必要に応じて `--enable-http-endpoint`または `--no-enable-http-endpoint` を使用して [modify-db-cluster](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-cluster.html) AWS CLI コマンドを実行します。

次の例では、`sample-cluster` で Data API を有効にします。

Linux、macOS、Unix の場合:

```
aws rds modify-db-cluster \
    --db-cluster-identifier sample-cluster \
    --enable-http-endpoint
```

Windows の場合:

```
aws rds modify-db-cluster ^
    --db-cluster-identifier sample-cluster ^
    --enable-http-endpoint
```

#### RDS API
<a name="data-api.enabling.modifying.sv1.api"></a>

Data API を有効にするには、[ModifyDBCluster](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBCluster.html) オペレーションを使用し、必要に応じて `EnableHttpEndpoint` の値を `true` または `false` に設定します。