npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2022 – Pkg Stats / Ryan Hefner

@aws-solutions-constructs/aws-apigateway-dynamodb

v1.138.1

Published

CDK Constructs for AWS API Gateway and Amazon DynamoDB integration.

Downloads

3,117

Readme

aws-apigateway-dynamodb module


Stability: Experimental

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 Logo Python|aws_solutions_constructs.aws_apigateway_dynamodb| |Typescript Logo Typescript|@aws-solutions-constructs/aws-apigateway-dynamodb| |Java Logo 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

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

Architecture Diagram


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