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.157.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a906a4ad202b80eae15ea1ac6806e44cd45c0d03f88fbb627ce43a0424518e6b |
|
MD5 | 881a4f31d8dc225f285cfa406b5aaeb2 |
|
BLAKE2b-256 | e57c7f969aeac39701833186bc321686660d5d888d51d7197ef8dbca87e0c81d |
Close
Hashes for aws_solutions_constructs.aws_apigateway_kinesisstreams-1.157.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8a74381583ea1fcb6d37ffa2aa1aea4b9544238674bd5abd495dfebc13ff69b5 |
|
MD5 | 7b387778d62165a40bbf57d5794e22eb |
|
BLAKE2b-256 | 0d72e8cead7a9fe77566b5d8764c06308088e2f60f5bd44bb1e0557ed62812ae |