kds-proxy

Create a REST API as an Amazon Kinesis proxy in API Gateway

This is an Amazon Kinesis proxy project using API Gateway for CDK development with Python.

The cdk.json file tells the CDK Toolkit how to execute your app.

This project is set up like a standard Python project. The initialization process also creates a virtualenv within this project, stored under the .venv directory. To create the virtualenv it assumes that there is a python3 (or python for Windows) executable in your path with access to the venv package. If for any reason the automatic creation of the virtualenv fails, you can create the virtualenv manually.

To manually create a virtualenv on MacOS and Linux:

$ python3 -m venv .venv

After the init process completes and the virtualenv is created, you can use the following step to activate your virtualenv.

$ source .venv/bin/activate

If you are a Windows platform, you would activate the virtualenv like this:

% .venv\Scripts\activate.bat

Once the virtualenv is activated, you can install the required dependencies.

(.venv) $ pip install -r requirements.txt

At this point you can now synthesize the CloudFormation template for this code.

(.venv) $ cdk synth --all \
              -c vpc_name=default \
              --parameters SourceKinesisStreams='your-kinesis-stream-name'

Use cdk deploy command to create the stack shown above.

(.venv) $ cdk deploy --require-aproval never --all \
              -c vpc_name=default \
              --parameters SourceKinesisStreams='your-kinesis-stream-name'

To add additional dependencies, for example other CDK libraries, just add them to your setup.py file and rerun the pip install -r requirements.txt command.

Examples

• GET /streams method to invoke ListStreams in Kinesis

  $ curl -X GET https://your-api-gateway-id.execute-api.us-east-1.amazonaws.com/v1/streams
  

  The response is:

  {
    "HasMoreStreams": false,
    "StreamNames": [
      "PUT-Firehose-aEhWz"
    ],
    "StreamSummaries": [
      {
        "StreamARN": "arn:aws:kinesis:us-east-1:123456789012:stream/PUT-Firehose-aEhWz",
        "StreamCreationTimestamp": 1661612556,
        "StreamModeDetails": {
          "StreamMode": "ON_DEMAND"
        },
        "StreamName": "PUT-Firehose-aEhWz",
        "StreamStatus": "ACTIVE"
      }
    ]
  }
  

• GET /streams/{stream-name} method to invoke DescribeStream in Kinesis

  $ curl -X GET https://your-api-gateway-id.execute-api.us-east-1.amazonaws.com/v1/streams/PUT-Firehose-aEhWz
  

  The response is:

  {
    "StreamDescription": {
      "EncryptionType": "KMS",
      "EnhancedMonitoring": [
        {
          "ShardLevelMetrics": []
        }
      ],
      "HasMoreShards": false,
      "KeyId": "alias/aws/kinesis",
      "RetentionPeriodHours": 24,
      "Shards": [
        {
          "HashKeyRange": {
            "EndingHashKey": "340282366920938463463374607431768211455",
            "StartingHashKey": "0"
          },
          "SequenceNumberRange": {
            "StartingSequenceNumber": "49632740478318570836537313591685157894516301790768529410"
          },
          "ShardId": "shardId-000000000000"
        }
      ],
      "StreamARN": "arn:aws:kinesis:us-east-1:123456789012:stream/PUT-Firehose-aEhWz",
      "StreamCreationTimestamp": 1661612556,
      "StreamModeDetails": {
        "StreamMode": "ON_DEMAND"
      },
      "StreamName": "PUT-Firehose-aEhWz",
      "StreamStatus": "ACTIVE"
    }
  }
  

• PUT /streams/{stream-name}/record method to invoke PutRecord in Kinesis

  $ curl -X PUT https://your-api-gateway-id.execute-api.us-east-1.amazonaws.com/v1/streams/PUT-Firehose-aEhWz/record \
         -H 'Content-Type: application/json' \
         -d '{ "Data": "some data", "PartitionKey": "some key" }'
  

  The response is:

  {
    "EncryptionType": "KMS",
    "SequenceNumber": "49632757272385358984391127998703515973414866647712268290",
    "ShardId": "shardId-000000000000"
  }
  

• PUT /streams/{stream-name}/records method to invoke PutRecords in Kinesis

  $ curl -X PUT https://your-api-gateway-id.execute-api.us-east-1.amazonaws.com/v1/streams/PUT-Firehose-aEhWz/records \
         -H 'Content-Type: application/json' \
         -d '{"records":[{"data":"some data","partition-key":"some key"},{"data":"some other data","partition-key":"some key"}]}'
  

  The response is:

  {
    "EncryptionType": "KMS",
    "FailedRecordCount": 0,
    "Records": [
      {
        "SequenceNumber": "49632757272385358984391128069035193381135165118304223234",
        "ShardId": "shardId-000000000000"
      },
      {
        "SequenceNumber": "49632757272385358984391128069037611232774394376653635586",
        "ShardId": "shardId-000000000000"
      }
    ]
  }
  

Clean Up

Delete the CloudFormation stack by running the below command.

(.venv) $ cdk destroy --force --all

Useful commands

• cdk ls list all stacks in the app
• cdk synth emits the synthesized CloudFormation template
• cdk deploy deploy this stack to your default AWS account/region
• cdk diff compare deployed stack with current state
• cdk docs open CDK documentation

Enjoy!

References

• Tutorial: Create a REST API as an Amazon Kinesis proxy in API Gateway
• Streaming Data Solution for Amazon Kinesis
  
• Serverless Patterns Collection
• aws-samples/serverless-patterns
• Building fine-grained authorization using Amazon Cognito, API Gateway, and IAM
• Curl Cookbook

Trouble Shooting

  { "message": "Missing Authentication Token" }
  

• How do I troubleshoot API Gateway REST API endpoint 403 "Missing Authentication Token" errors?
• API Gateway permissions model for invoking an API