Skip to main content

aws-apigateway-dynamodb module

---

Stability: Experimental

This is a developer preview (public beta) 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.


API Reference: http://docs.awssolutionsbuilder.com/aws-solutions-konstruk/latest/api/aws-apigateway-dynamodb/
Language Package
Python Logo{: style="height:16px;width:16px"} Python aws_solutions_konstruk.aws_apigateway_dynamodb
Typescript Logo{: style="height:16px;width:16px"} Typescript @aws-solutions-konstruk/aws-apigateway-dynamodb

Overview

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

Here is a minimal deployable pattern definition:

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

const props: ApiGatewayToDynamoDBProps = {};

new ApiGatewayToDynamoDB(stack, 'test-api-gateway-dynamodb-default', props);

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
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 DB 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 DB table.
allowUpdateOperation boolean Whether to deploy API Gateway Method for Update operation on Dynamodb DB 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 DB table.

Pattern Properties

Name Type Description
restApi() api.RestApi Returns an instance of the api.RestApi created by the construct.
dynamoTable() dynamodb.Table Returns an instance of dynamodb.Table created by the construct.

Architecture

Architecture Diagram


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

Metadata

Release files for aws-solutions-konstruk.aws-apigateway-dynamodb 0.8.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for aws-solutions-konstruk.aws-apigateway-dynamodb 0.8.1
File Size Uploaded
aws-solutions-konstruk.aws-apigateway-dynamodb-0.8.1.tar.gz 101.3 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for aws-solutions-konstruk.aws-apigateway-dynamodb 0.8.1
File Interpreter ABI Platform
aws_solutions_konstruk.aws_apigateway_dynamodb-0.8.1-py3-none-any.whl Python 3 none any Details

Total release size: 201.3 kB

Release files / aws-solutions-konstruk.aws-apigateway-dynamodb-0.8.1.tar.gz

Download URL aws-solutions-konstruk.aws-apigateway-dynamodb-0.8.1.tar.gz
Size 101.3 kB
Tags Source
SHA-256 checksum
How to use checksums
d8be5787aa93c556b989b541fcbf318ccaf0b876c7cf46b6eaf7ed259f5bd475
BLAKE2b-256 checksum
How to use checksums
67998bd6deffaedca5cd68332387e213ccab860db8bb4c2064bacea0ce097da4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.7.6

Release files / aws_solutions_konstruk.aws_apigateway_dynamodb-0.8.1-py3-none-any.whl

Download URL aws_solutions_konstruk.aws_apigateway_dynamodb-0.8.1-py3-none-any.whl
Size 100.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
16a89d525bca19d72b6aa1fa9321d6a63fea54e624b18c246c06bba531c2d644
BLAKE2b-256 checksum
How to use checksums
ba925120e6438c0a81cc7f63f7fbcf598f1e1d1bbb62f522bb3d60a1afc20445
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.7.6

Release history Release notifications | RSS feed

This release

0.8.1 This release

2 release files

0.8.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page