2.85.2 • Published 10 months ago

@aws-solutions-constructs/aws-apigateway-kinesisstreams v2.85.2

Weekly downloads
117
License
Apache-2.0
Repository
github
Last release
10 months ago

aws-apigateway-kinesisstreams module

Stability: Stable

Reference Documentation:https://docs.aws.amazon.com/solutions/latest/constructs/
LanguagePackage
Python Logo Pythonaws_solutions_constructs.aws_apigateway_kinesisstreams
Typescript Logo Typescript@aws-solutions-constructs/aws-apigateway-kinesisstreams
Java Logo Javasoftware.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:

Typescript

import { Construct } from 'constructs';
import { Stack, StackProps } from 'aws-cdk-lib';
import { ApiGatewayToKinesisStreams, ApiGatewayToKinesisStreamsProps } from '@aws-solutions-constructs/aws-apigateway-kinesisstreams';

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

Python

from aws_solutions_constructs.aws_apigateway_kinesisstreams import ApiGatewayToKinesisStreams
from aws_cdk import Stack
from constructs import Construct

ApiGatewayToKinesisStreams(self, 'test-apigw-kinesis')

Java

import software.constructs.Construct;

import software.amazon.awscdk.Stack;
import software.amazon.awscdk.StackProps;
import software.amazon.awsconstructs.services.apigatewaykinesisstreams.*;

new ApiGatewayToKinesisStreams(this, "test-apigw-kinesis", new ApiGatewayToKinesisStreamsProps.Builder()
        .build());

Pattern Construct Props

NameTypeDescription
apiGatewayProps?api.RestApiPropsOptional user-provided props to override the default props for the API Gateway.
putRecordRequestTemplate?stringAPI Gateway request template for the PutRecord action. If not provided, a default one will be used.
createUsagePlan?booleanWhether to create a Usage Plan attached to the API. Must be true if apiGatewayProps.defaultMethodOptions.apiKeyRequired is true. @default - true (to match legacy behavior)
additionalPutRecordRequestTemplates?{ [contentType: string]: string; }Optional PutRecord Request Templates for content-types other than application/json. Use the putRecordRequestTemplate property to set the request template for the application/json content-type.
putRecordRequestModel?api.ModelOptionsAPI Gateway request model for the PutRecord action. If not provided, a default one will be created.
putRecordIntegrationResponses?api.IntegrationResponses[]Optional, custom API Gateway Integration Response for the PutRecord action.
putRecordMethodResponses?api.MethodResponses[]Optional, custom API Gateway Method Responses for the putRecord action. default: { statusCode: "200", responseParameters: { "method.response.header.Content-Type": true }},{ statusCode: "500", responseParameters: { "method.response.header.Content-Type": true } }
putRecordsRequestTemplate?stringAPI Gateway request template for the PutRecords action. If not provided, a default one will be used.
additionalPutRecordsRequestTemplates?{ [contentType: string]: string; }Optional PutRecords Request Templates for content-types other than application/json. Use the putRecordsRequestTemplate property to set the request template for the application/json content-type.
putRecordsRequestModel?api.ModelOptionsAPI Gateway request model for the PutRecords action. If not provided, a default one will be created.
putRecordsIntegrationResponses?api.IntegrationResponses[]Optional, custom API Gateway Integration Response for the PutRecords action.
putRecordsMethodResponses?api.MethodResponses[]Optional, custom API Gateway Method Responses for the putRecords action. default: { statusCode: "200", responseParameters: { "method.response.header.Content-Type": true }},{ statusCode: "500", responseParameters: { "method.response.header.Content-Type": true } }
existingStreamObj?kinesis.StreamExisting instance of Kinesis Stream, providing both this and kinesisStreamProps will cause an error.
kinesisStreamProps?kinesis.StreamPropsOptional user-provided props to override the default props for the Kinesis stream.
logGroupProps?logs.LogGroupPropsUser provided props to override the default props for for the CloudWatchLogs LogGroup.
createCloudWatchAlarmsbooleanWhether to create recommended CloudWatch alarms for Kinesis Data Stream. Default value is set to true

Pattern Properties

NameTypeDescription
apiGatewayapi.RestApiReturns an instance of the API Gateway REST API created by the pattern.
apiGatewayRoleiam.RoleReturns an instance of the iam.Role created by the construct for API Gateway.
apiGatewayCloudWatchRole?iam.RoleReturns an instance of the iam.Role created by the construct for API Gateway for CloudWatch access.
apiGatewayLogGrouplogs.LogGroupReturns an instance of the LogGroup created by the construct for API Gateway access logging to CloudWatch.
kinesisStreamkinesis.StreamReturns 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

MethodRequest PathRequest BodyStream ActionDescription
POST/record{ "data": "Hello World!", "partitionKey": "pk001" }kinesis:PutRecordWrites a single data record into the stream.
POST/records{ "records": [{ "data": "abc", "partitionKey": "pk001" }, { "data": "xyz", "partitionKey": "pk001" }] }kinesis:PutRecordsWrites 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 Amazon.com, Inc. or its affiliates. All Rights Reserved.

awscdkawscdkAWS Solutions ConstructsAmazon API GatewayAmazon Kinesis Data Streams
@aws-solutions-constructs/coreconstructs
@infinitebrahmanuniverse/nolb-_aws-so@everything-registry/sub-chunk-103
2.83.0

11 months ago

2.79.1

12 months ago

2.79.0

12 months ago

2.82.0

11 months ago

2.78.0

1 year ago

2.78.1

12 months ago

2.81.0

12 months ago

2.77.0

1 year ago

2.80.0

12 months ago

2.76.0

1 year ago

2.75.0

1 year ago

2.74.0

1 year ago

2.85.0

10 months ago

2.85.2

10 months ago

2.85.1

10 months ago

2.84.0

11 months ago

2.73.0

1 year ago

2.72.0

1 year ago

2.71.0

1 year ago

2.69.0

1 year ago

2.68.0

2 years ago

2.67.0

2 years ago

2.67.1

2 years ago

2.70.0

1 year ago

2.60.0

2 years ago

2.65.0

2 years ago

2.64.0

2 years ago

2.63.0

2 years ago

2.59.0

2 years ago

2.62.0

2 years ago

2.58.0

2 years ago

2.58.1

2 years ago

2.61.0

2 years ago

2.57.0

2 years ago

2.56.0

2 years ago

2.55.0

2 years ago

2.54.1

2 years ago

2.54.0

2 years ago

2.53.0

2 years ago

2.52.1

2 years ago

2.52.0

2 years ago

2.51.0

2 years ago

2.50.0

2 years ago

2.49.0

2 years ago

2.48.0

2 years ago

2.47.0

2 years ago

2.46.0

2 years ago

2.45.0

2 years ago

2.44.0

3 years ago

2.43.0

3 years ago

2.43.1

3 years ago

2.42.0

3 years ago

2.41.0

3 years ago

2.40.0

3 years ago

2.38.0

3 years ago

2.39.0

3 years ago

2.37.0

3 years ago

2.36.0

3 years ago

2.34.0

3 years ago

2.33.0

3 years ago

2.32.0

3 years ago

2.31.0

3 years ago

2.35.0

3 years ago

2.30.0

3 years ago

2.27.0

3 years ago

1.176.0

3 years ago

2.26.0

3 years ago

1.175.0

3 years ago

1.179.0

3 years ago

2.29.0

3 years ago

1.181.0

3 years ago

1.181.1

3 years ago

1.174.0

3 years ago

1.178.0

3 years ago

2.28.0

3 years ago

1.180.0

3 years ago

1.177.0

3 years ago

1.168.0

4 years ago

2.19.0

4 years ago

1.172.0

3 years ago

2.22.0

3 years ago

1.167.0

4 years ago

2.18.0

4 years ago

2.21.0

4 years ago

1.171.0

3 years ago

2.25.0

3 years ago

2.17.0

4 years ago

1.170.0

3 years ago

2.20.0

4 years ago

1.170.1

3 years ago

2.24.0

3 years ago

1.169.0

4 years ago

2.16.0

4 years ago

1.173.0

3 years ago

2.23.0

3 years ago

2.11.0

4 years ago

1.160.0

4 years ago

1.164.0

4 years ago

1.157.0

4 years ago

1.163.0

4 years ago

2.10.0

4 years ago

1.163.2

4 years ago

1.163.1

4 years ago

2.14.0

4 years ago

1.162.0

4 years ago

1.166.1

4 years ago

2.13.0

4 years ago

1.159.0

4 years ago

2.12.0

4 years ago

1.161.0

4 years ago

1.165.0

4 years ago

2.9.0

4 years ago

1.158.0

4 years ago

2.8.0

4 years ago

1.153.0

4 years ago

1.153.1

4 years ago

2.7.0

4 years ago

1.156.0

4 years ago

1.156.1

4 years ago

2.6.0

4 years ago

1.155.0

4 years ago

1.154.0

4 years ago

2.4.0

4 years ago

1.149.0

4 years ago

1.148.0

4 years ago

1.152.0

4 years ago

1.147.0

4 years ago

1.151.0

4 years ago

2.5.0

4 years ago

1.150.0

4 years ago

1.145.0

4 years ago

1.141.0

4 years ago

1.144.0

4 years ago

1.140.0

4 years ago

1.143.0

4 years ago

1.142.0

4 years ago

1.146.0

4 years ago

1.134.0

4 years ago

1.130.0

4 years ago

1.138.2

4 years ago

1.138.1

4 years ago

1.138.0

4 years ago

2.3.0

4 years ago

1.133.0

4 years ago

1.137.0

4 years ago

2.2.0

4 years ago

1.132.0

4 years ago

1.136.0

4 years ago

2.1.0

4 years ago

1.131.0

4 years ago

1.139.0

4 years ago

1.135.0

4 years ago

1.128.0

4 years ago

2.0.0

4 years ago

1.129.0

4 years ago

1.127.0

4 years ago

2.0.0-rc.2

4 years ago

1.126.0

4 years ago

2.0.0-rc.1

4 years ago

1.125.0

4 years ago

1.124.0

4 years ago

1.123.0

4 years ago

1.122.0

4 years ago

1.121.0

4 years ago

1.120.0

5 years ago

1.119.0

5 years ago

1.118.0

5 years ago

1.117.0

5 years ago

1.115.0

5 years ago

1.116.0

5 years ago

1.113.0

5 years ago

1.114.0

5 years ago

1.112.0

5 years ago

1.111.0

5 years ago

1.110.1

5 years ago

1.109.0

5 years ago

1.108.1

5 years ago

1.110.0

5 years ago

1.108.0

5 years ago

1.107.0

5 years ago

1.106.1

5 years ago

1.105.0

5 years ago

1.106.0

5 years ago

1.101.0

5 years ago

1.103.0

5 years ago

1.99.0

5 years ago

1.100.0

5 years ago

1.104.0

5 years ago

1.102.0

5 years ago

1.98.0

5 years ago

1.97.0

5 years ago

1.96.0

5 years ago

1.95.2

5 years ago

1.95.1

5 years ago

1.95.0

5 years ago

1.94.1

5 years ago

1.94.0

5 years ago

1.93.0

5 years ago

1.92.0

5 years ago

1.91.0

5 years ago

1.90.1

5 years ago

1.90.0

5 years ago

1.89.0

5 years ago

1.88.0

5 years ago

1.87.1

5 years ago

1.86.0

5 years ago

1.87.0

5 years ago

1.85.0

5 years ago

1.84.0

5 years ago

1.82.0

5 years ago

1.83.0

5 years ago

1.81.0

5 years ago

1.80.0

5 years ago

1.79.0

5 years ago

1.78.0

5 years ago

1.77.0

5 years ago

1.76.0

5 years ago

1.75.0

5 years ago

1.74.0

5 years ago

1.73.0

5 years ago

1.72.0

5 years ago

1.71.0

5 years ago

1.70.0

5 years ago

1.69.0

5 years ago

1.68.0

5 years ago

1.67.0

5 years ago

1.66.0

5 years ago

1.65.0

5 years ago

1.64.1

5 years ago

1.64.0

5 years ago

1.63.0

5 years ago

1.62.0

5 years ago