CDK Constructs for AWS API Gateway and Amazon Kinesis Data Streams integration.
Project description
aws-apigateway-kinesisstreams module
---Reference Documentation: | https://docs.aws.amazon.com/solutions/latest/constructs/ |
---|
Language | Package |
---|---|
Python | aws_solutions_constructs.aws_apigateway_kinesisstreams |
Typescript | @aws-solutions-constructs/aws-apigateway-kinesisstreams |
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:
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
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
© Copyright 2022 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
Close
Hashes for aws-solutions-constructs.aws-apigateway-kinesisstreams-1.163.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ca5c9adbf103d7abc1b99ae03d4bdda728ccbbc6494554379a695899402177cc |
|
MD5 | 850978d76fec2ad613d1938c8771ef4c |
|
BLAKE2b-256 | 10b27d6348fdb52bb75324b71c1b08ae049956ebe25ba2498993cd67183ef1c6 |
Close
Hashes for aws_solutions_constructs.aws_apigateway_kinesisstreams-1.163.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c54f60d0969735ddcc5110b645c59cee985b243861caec05f6f6ba0983e5abfa |
|
MD5 | 3b35fa086d4460b194c25a89888c224a |
|
BLAKE2b-256 | d93d7213e1fa9b8cb6be48dd67f635fc346eb40ebf57591f1c113f81f9b16160 |