Skip to main content

CDK Constructs for AWS API Gateway and Amazon Kinesis Data Streams integration.

Project description

aws-apigateway-kinesisstreams 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_kinesisstreams
Typescript Logo Typescript @aws-solutions-constructs/aws-apigateway-kinesisstreams
Java Logo Java software.amazon.awsconstructs.services.apigatewaykinesisstreams

Overview

This AWS Solutions Construct implements an Amazon API Gateway connected to an Amazon Kinesis Data Stream pattern.

Here is a minimal deployable pattern definition in Typescript:

import { ApiGatewayToKinesisStreams, ApiGatewayToKinesisStreamsProps } from '@aws-solutions-constructs/aws-apigateway-kinesisstreams';

new ApiGatewayToKinesisStreams(this, 'test-apigw-kinesis', {});

Initializer

new ApiGatewayToKinesisStreams(scope: Construct, id: string, props: ApiGatewayToKinesisStreamsProps);

Parameters

Pattern Construct Props

Name Type Description
apiGatewayProps? api.RestApiProps Optional user-provided props to override the default props for the API Gateway.
putRecordRequestTemplate? string API Gateway request template for the PutRecord action. If not provided, a default one will be used.
putRecordRequestModel? api.ModelOptions API Gateway request model for the PutRecord action. If not provided, a default one will be created.
putRecordsRequestTemplate? string API Gateway request template for the PutRecords action. If not provided, a default one will be used.
putRecordsRequestModel? api.ModelOptions API Gateway request model for the PutRecords action. If not provided, a default one will be created.
existingStreamObj? kinesis.Stream Existing instance of Kinesis Stream, if this is set then kinesisStreamProps is ignored.
kinesisStreamProps? kinesis.StreamProps Optional user-provided props to override the default props for the Kinesis stream.

Pattern Properties

Name Type Description
apiGateway api.RestApi Returns an instance of the API Gateway REST API created by the pattern.
apiGatewayRole iam.Role Returns an instance of the iam.Role created by the construct for API Gateway.
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.
kinesisStream kinesis.Stream Returns an instance of the Kinesis stream created or used by the pattern.

Sample API Usage

Method Request Path Request Body Stream Action Description
POST /record { "data": "Hello World!", "partitionKey": "pk001" } kinesis:PutRecord Writes a single data record into the stream.
POST /records { "records": [{ "data": "abc", "partitionKey": "pk001" }, { "data": "xyz", "partitionKey": "pk001" }] } kinesis:PutRecords Writes multiple data records into the stream in a single call.

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
  • Validate request body before passing data to Kinesis

Amazon Kinesis Data Stream

  • Configure least privilege access IAM role for Kinesis Stream
  • Enable server-side encryption for Kinesis Stream using AWS Managed KMS Key

Architecture

Architecture Diagram


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

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Built Distribution

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page