@aws-solutions-constructs/aws-apigateway-kinesisstreams

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

Usage no npm install needed!

<script type="module">
  import awsSolutionsConstructsAwsApigatewayKinesisstreams from 'https://cdn.skypack.dev/@aws-solutions-constructs/aws-apigateway-kinesisstreams';
</script>

README

aws-apigateway-kinesisstreams module

Stability: Stable

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, providing both this and kinesisStreamProps will cause an error.
kinesisStreamProps? kinesis.StreamProps Optional user-provided props to override the default props for the Kinesis stream.
logGroupProps? logs.LogGroupProps User provided props to override the default props for for the CloudWatchLogs LogGroup.
createCloudWatchAlarms boolean Whether to create recommended CloudWatch alarms for Kinesis Data Stream. Default value is set to true

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.
cloudwatchAlarms? cloudwatch.Alarm[] Returns an array of recommended CloudWatch Alarms created by the construct for Kinesis Data stream

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 2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.