Numerous Pancakes Munched

    @aws-solutions-konstruk/aws-apigateway-dynamodb
    TypeScript icon, indicating that this package has built-in type declarations

    0.8.1 • Public • Published

    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.

    Keywords

    none

    Install

    npm i @aws-solutions-konstruk/aws-apigateway-dynamodb

    DownloadsWeekly Downloads

    4

    Version

    0.8.1

    License

    Apache-2.0

    Unpacked Size

    221 kB

    Total Files

    16

    Last publish

    Collaborators

    • aws-solutions-konstruk-support