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 🙏

© 2021 – Pkg Stats / Ryan Hefner

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

v1.126.0

Published

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

Downloads

1,825

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.