awssolutionsconstructsawsapigatewaydynamodb

README

aws-apigateway-dynamodb module

---

All classes are under active development and subject to non-backward compatible changes or removal in any future version. These are not subject to the Semantic Versioning model. This means that while you may use them, you may need to update your source code when upgrading to a newer version of this package.

---

Reference Documentation:	https://docs.aws.amazon.com/solutions/latest/constructs/

Language	Package
Python	aws_solutions_constructs.aws_apigateway_dynamodb
Typescript	@aws-solutions-constructs/aws-apigateway-dynamodb
Java	software.amazon.awsconstructs.services.apigatewaydynamodb

Overview

This AWS Solutions Construct implements an Amazon API Gateway REST API connected to Amazon DynamoDB table.

Here is a minimal deployable pattern definition in 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);

Parameters

• scope Construct
• id string
• props ApiGatewayToDynamoDBProps

Pattern Construct Props

Name	Type	Description
dynamoTableProps?	dynamodb.TableProps	Optional user provided props to override the default props for DynamoDB Table.
existingTableObj?	dynamodb.Table	Existing instance of DynamoDB table object, providing both this and dynamoTableProps will cause an error.
apiGatewayProps?	api.RestApiProps	Optional user-provided props to override the default props for the API Gateway.
allowCreateOperation?	boolean	Whether to deploy API Gateway Method for Create operation on DynamoDB table.
createRequestTemplate?	string	API Gateway Request template for Create method, required if allowCreateOperation set to true.
allowReadOperation?	boolean	Whether to deploy API Gateway Method for Read operation on DynamoDB table.
readRequestTemplate?	string	Optional API Gateway Request template for Read method, it will use the default template if allowReadOperation is true and readRequestTemplate is not provided. The default template only supports a partition key and not partition + sort keys.
allowUpdateOperation?	boolean	Whether to deploy API Gateway Method for Update operation on DynamoDB table.
updateRequestTemplate?	string	API Gateway Request template for Update method, required if allowUpdateOperation set to true.
allowDeleteOperation?	boolean	Whether to deploy API Gateway Method for Delete operation on DynamoDB table.
deleteRequestTemplate?	string	Optional API Gateway Request template for Delete method, it will use the default template if allowDeleteOperation is true and deleteRequestTemplate is not provided. The default template only supports a partition key and not partition + sort keys.
logGroupProps?	logs.LogGroupProps	User provided props to override the default props for for the CloudWatchLogs LogGroup.

Pattern Properties

Name	Type	Description
apiGateway	api.RestApi	Returns an instance of the api.RestApi created by the construct.
apiGatewayRole	iam.Role	Returns an instance of the iam.Role created by the construct for API Gateway.
dynamoTable	dynamodb.Table	Returns an instance of dynamodb.Table created by the construct.
apiGatewayCloudWatchRole?	iam.Role	Returns an instance of the iam.Role created by the construct for API Gateway for CloudWatch access.
apiGatewayLogGroup	logs.LogGroup	Returns an instance of the LogGroup created by the construct for API Gateway access logging to CloudWatch.

Default settings

Out of the box implementation of the Construct without any override will set the following defaults:

Amazon API Gateway

• Deploy an edge-optimized API endpoint
• Enable CloudWatch logging for API Gateway
• Configure least privilege access IAM role for API Gateway
• Set the default authorizationType for all API methods to IAM
• Enable X-Ray Tracing

Amazon DynamoDB Table

• Set the billing mode for DynamoDB Table to On-Demand (Pay per request)
• Enable server-side encryption for DynamoDB Table using AWS managed KMS Key
• Creates a partition key called 'id' for DynamoDB Table
• Retain the Table when deleting the CloudFormation stack
• Enable continuous backups and point-in-time recovery

Architecture

---

© Copyright 2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.

Documentation

Overview

CDK Constructs for AWS API Gateway and Amazon DynamoDB integration.

Index

• func ApiGatewayToDynamoDB_IsConstruct(x interface{}) *bool
• func NewApiGatewayToDynamoDB_Override(a ApiGatewayToDynamoDB, scope constructs.Construct, id *string, ...)
• type ApiGatewayToDynamoDB
  • func NewApiGatewayToDynamoDB(scope constructs.Construct, id *string, props *ApiGatewayToDynamoDBProps) ApiGatewayToDynamoDB
• type ApiGatewayToDynamoDBProps

Functions

func ApiGatewayToDynamoDB_IsConstruct

func ApiGatewayToDynamoDB_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func NewApiGatewayToDynamoDB_Override

func NewApiGatewayToDynamoDB_Override(a ApiGatewayToDynamoDB, scope constructs.Construct, id *string, props *ApiGatewayToDynamoDBProps)

Types

type ApiGatewayToDynamoDB

type ApiGatewayToDynamoDB interface {
	constructs.Construct
	ApiGateway() awsapigateway.RestApi
	ApiGatewayCloudWatchRole() awsiam.Role
	ApiGatewayLogGroup() awslogs.LogGroup
	ApiGatewayRole() awsiam.Role
	DynamoTable() awsdynamodb.Table
	Node() constructs.Node
	ToString() *string
}

func NewApiGatewayToDynamoDB

func NewApiGatewayToDynamoDB(scope constructs.Construct, id *string, props *ApiGatewayToDynamoDBProps) ApiGatewayToDynamoDB

type ApiGatewayToDynamoDBProps

type ApiGatewayToDynamoDBProps struct {
	// Whether to deploy API Gateway Method for Create operation on DynamoDB table.
	AllowCreateOperation *bool `json:"allowCreateOperation"`
	// Whether to deploy API Gateway Method for Delete operation on DynamoDB table.
	AllowDeleteOperation *bool `json:"allowDeleteOperation"`
	// Whether to deploy API Gateway Method for Read operation on DynamoDB table.
	AllowReadOperation *bool `json:"allowReadOperation"`
	// Whether to deploy API Gateway Method for Update operation on DynamoDB table.
	AllowUpdateOperation *bool `json:"allowUpdateOperation"`
	// Optional user-provided props to override the default props for the API Gateway.
	ApiGatewayProps *awsapigateway.RestApiProps `json:"apiGatewayProps"`
	// API Gateway Request template for Create method, required if allowCreateOperation set to true.
	CreateRequestTemplate *string `json:"createRequestTemplate"`
	// Optional API Gateway Request template for Delete method, it will use the default template if allowDeleteOperation is true and deleteRequestTemplate is not provided.
	//
	// The default template only supports a partition key and not partition + sort keys.
	DeleteRequestTemplate *string `json:"deleteRequestTemplate"`
	// Optional user provided props to override the default props.
	DynamoTableProps *awsdynamodb.TableProps `json:"dynamoTableProps"`
	// Existing instance of DynamoDB table object, providing both this and `dynamoTableProps` will cause an error.
	ExistingTableObj awsdynamodb.Table `json:"existingTableObj"`
	// User provided props to override the default props for the CloudWatchLogs LogGroup.
	LogGroupProps *awslogs.LogGroupProps `json:"logGroupProps"`
	// Optional API Gateway Request template for Read method, it will use the default template if allowReadOperation is true and readRequestTemplate is not provided.
	//
	// The default template only supports a partition key and not partition + sort keys.
	ReadRequestTemplate *string `json:"readRequestTemplate"`
	// API Gateway Request template for Update method, required if allowUpdateOperation set to true.
	UpdateRequestTemplate *string `json:"updateRequestTemplate"`
}