View a markdown version of this page

Amazon RDS Data API の有効化 - Amazon Aurora
データベースの作成時の RDS Data API の有効化既存のデータベースで RDS Data API を有効化または無効化

Amazon RDS Data API の有効化

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

注記

Data API がクラスターで使用できるかどうかは、Aurora のバージョン、データベースエンジン、AWS リージョンによって異なります。Aurora の場合、Data API は、プロビジョニングされたインスタンスと Aurora Serverless v2 インスタンスの両方を使用するクラスターで動作します。クラスターが Data API を使用できるかどうかを確認するには、「RDS Data API でサポートされているリージョンと Aurora DB エンジン」を参照してください。

データベースの作成時の RDS Data API の有効化

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

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

[データベースの作成] ページの [接続] セクションで、[RDS Data API を有効にする] チェックボックスをオンにします。

RDS Data API を使用できる Aurora DB クラスターの作成方法については、以下を参照してください。

Aurora DB クラスターの作成中に Data API を有効にするには、--enable-http-endpoint オプションを指定して create-db-cluster 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

Aurora DB クラスターの作成中に Data API を有効にするには、EnableHttpEndpoint パラメータの値を true に設定して CreateDBCluster オペレーションを使用します。

既存のデータベースで RDS Data API を有効化または無効化

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

Data API (Aurora Serverless v2 および プロビジョンド) の有効化または無効化

Aurora Serverless v2 およびプロビジョニングされたデータベースで Data API を有効または無効にするには、次の手順を使用します。

Data API を有効または無効にするには、この機能をサポートする DB クラスターの RDS コンソールを使用します。これを行うには、Data API を有効または無効にするデータベースのクラスターの詳細ページを開き、[アクション] ドロップダウンメニューから [RDS Data API の有効化] または [RDS Data API の無効化] を選択します。これにより、クラスターの RDS Data API を有効または無効にできます。

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

DB クラスターの詳細ページの [接続とセキュリティ] タブの [RDS Data API] セクション。Data API のステータスは無効と表示され、[RDS Data API を有効にする] ボタンが表示されます。

既存のデータベースで Data API を有効または無効にするには、enable-http-endpoint または disable-http-endpoint 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

既存のデータベースで Data API を有効または無効にするには、EnableHttpEndpoint オペレーションと DisableHttpEndpoint オペレーションを使用します。