aws-apigateway-ダイナモッド

すべてのクラスは積極的に開発されており、将来のバージョンでは下位互換性がない変更または削除の対象となります。これらは対象外ですセマンティックバージョン管理モデル。つまり、これらのパッケージを使用するかもしれませんが、このパッケージの新しいバージョンにアップグレードするときにソースコードを更新する必要があるかもしれません。

注意: 正しく機能するためには、プロジェクト内の AWS ソリューション構築パッケージと AWS CDK パッケージが同じバージョンである必要があります。

言語	パッケージ
Python	aws_solutions_constructs.aws_apigateway_dynamodb
TypeScript	@aws-solutions-constructs/aws-apigateway-dynamodb
Java	software.amazon.awsconstructs.services.apigatewaydynamodb

Overview

この AWS ソリューション構築物は、Amazon DynamoDB テーブルに接続された Amazon API Gateway REST API を実装します。

TypeScript の最小限のデプロイ可能なパターン定義は次のとおりです。

import { ApiGatewayToDynamoDBProps, ApiGatewayToDynamoDB } from "@aws-solutions-constructs/aws-apigateway-dynamodb";

new ApiGatewayToDynamoDB(this, 'test-api-gateway-dynamodb-default', {});

Initializer

new ApiGatewayToDynamoDB(scope: Construct, id: string, props: ApiGatewayToDynamoDBProps);

パラメータ

• scopeConstruct

• idstring

• propsApiGatewayToDynamoDBProps

パターン構成プロパティ

名前	タイプ	説明
ダイナモテーブル	dynamodb.TableProps	DynamoDB テーブルのデフォルトの小道具をオーバーライドするオプションのユーザー提供の小道具です
ApigateWayProps？	api.RestApiProps	API Gateway のデフォルトの小道具を上書きするオプションのユーザー提供の小道具です。
作成操作の許可	boolean	DynamoDB テーブルで Create オペレーションの API Gateway メソッドをデプロイするかどうか。
リクエストテンプレートの作成	string	作成メソッドの API Gateway 要求テンプレート。AllowCreateOperation が true に設定されている場合に必要です
読み取り操作を許可	boolean	DynamoDB テーブルで API Gateway の読み取り操作メソッドをデプロイするかどうか。
更新操作の許可	boolean	DynamoDB テーブルで、更新用の API Gateway メソッドをデプロイするかどうか。
更新要求テンプレート	string	更新メソッドの API Gateway 要求テンプレート。AllowUpdateOperation が true に設定されている場合に必要
削除操作の許可	boolean	DynamoDB テーブルで、削除操作の API Gateway メソッドをデプロイするかどうか。
LogGroupProps？	logs.LogGroupProps	CloudWatch Logs ロググループのデフォルト小道具を上書きする、オプションのユーザー指定の小道具です。

パターンプロパティ

名前	タイプ	説明
apigateway	api.RestApi	パターンによって作成された API Gateway REST API のインスタンスを返します。
APIGatewayクラウドウォッチロール	iam.Role	API Gateway REST API から CloudWatch へのアクセスロギングを有効にするパターンによって作成された IAM ロールのインスタンスを返します。
APIGateWayLogGroup	logs.LogGroup	API Gateway REST API アクセスログが送信されるパターンによって作成されたロググループのインスタンスを返します。
APIGateWayRole	iam.Role	API Gateway REST API のパターンによって作成された IAM ロールのインスタンスを返します。
ダイナモテーブル	dynamodb.Table	パターンによって作成された DynamoDB テーブルのインスタンスを返します。

デフォルト設定

オーバーライドなしでこのパターンをすぐに実装すると、次のデフォルトが設定されます。

Amazon API Gateway

• エッジ最適化 API エンドポイントのデプロイ

• API Gateway での CloudWatch によるロギングを有効にする

• API Gateway の最小権限アクセス IAM ロールを設定する

• すべての API メソッドのデフォルトの authorizationType を IAM に設定する

• X-Ray トレースを有効にする

Amazon DynamoDB テーブル

• DynamoDB テーブルの請求モードをオンデマンドに設定する（リクエストごとの支払い）

• AWS マネージド KMS キーを使用した DynamoDB テーブルのサーバー側の暗号化の有効化

• DynamoDB テーブルの 'id' という名前のパーティションキーを作成します。

• CloudFormation スタックを削除するときにテーブルを保持する

• 継続的なバックアップおよびポイントインタイムリカバリを有効にします

Architecture

GitHub

このパターンのコードを表示するには、問題を作成/表示し、プル要求などを行います。
	@aws-solutions-constructions/aws-apigateway-dynamodb