Skip to main content

CDK constructs for defining an interaction between an Amazon Kinesis Data Firehose delivery stream and (1) an Amazon S3 bucket, and (2) an Amazon Kinesis Data Analytics application.

Project description

aws-kinesisfirehose-s3-and-kinesisanalytics module

---

Stability: Experimental

This is a developer preview (public beta) module.

All classes are under active development and subject to non-backward compatible changes or removal in any future version. These are not subject to the Semantic Versioning model. This means that while you may use them, you may need to update your source code when upgrading to a newer version of this package.


API Reference: http://docs.awssolutionsbuilder.com/aws-solutions-konstruk/latest/api/aws-kinesisfirehose-s3-and-kinesisanalytics/
Language Package
Python Logo{: style="height:16px;width:16px"} Python aws_solutions_konstruk.aws_kinesisfirehose_s3_and_kinesisanalytics
Typescript Logo{: style="height:16px;width:16px"} Typescript @aws-solutions-konstruk/aws-kinesisfirehose-s3-and-kinesisanalytics

This AWS Solutions Konstruk implements an Amazon Kinesis Firehose delivery stream connected to:

  1. An Amazon S3 bucket, and
  2. An Amazon Kinesis Analytics application.

Here is a minimal deployable pattern definition:

const { KinesisFirehoseToAnalyticsAndS3 } = require('@aws-solutions-konstruk/aws-kinesisfirehose-s3-and-kinesisanalytics');

new KinesisFirehoseToAnalyticsAndS3(stack, 'FirehoseToS3AndAnalyticsPattern', {
    kinesisAnalyticsProps: {
        inputs: [{
            inputSchema: {
                recordColumns: [{
                    name: 'ticker_symbol',
                    sqlType: 'VARCHAR(4)',
                    mapping: '$.ticker_symbol'
                }, {
                    name: 'sector',
                    sqlType: 'VARCHAR(16)',
                    mapping: '$.sector'
                }, {
                    name: 'change',
                    sqlType: 'REAL',
                    mapping: '$.change'
                }, {
                    name: 'price',
                    sqlType: 'REAL',
                    mapping: '$.price'
                }],
                recordFormat: {
                    recordFormatType: 'JSON'
                },
                recordEncoding: 'UTF-8'
            },
            namePrefix: 'SOURCE_SQL_STREAM'
        }]
    }
});

Initializer

new KinesisFirehoseToAnalyticsAndS3(scope: Construct, id: string, props: KinesisFirehoseToAnalyticsAndS3Props);

Parameters

Pattern Construct Props

Name Type Description
kinesisFirehoseProps? kinesisFirehose.CfnDeliveryStreamProps Optional user-provided props to override the default props for the Kinesis Firehose delivery stream.
kinesisAnalyticsProps? kinesisAnalytics.CfnApplicationProps Optional user-provided props to override the default props for the Kinesis Analytics application.
deployBucket? boolean Whether to create a S3 Bucket or use an existing S3 Bucket
existingBucketObj? s3.Bucket Existing instance of S3 Bucket object
bucketProps? s3.BucketProps Optional user provided props to override the default props for S3 Bucket

Pattern Properties

Name Type Description
kinesisAnalytics() kinesisAnalytics.CfnApplication Returns an instance of the Kinesis Analytics application created by the pattern.
kinesisFirehose() kinesisFirehose.CfnDeliveryStream Returns an instance of the Kinesis Firehose delivery stream created by the pattern.
bucket() s3.Bucket Returns an instance of the S3 bucket created by the pattern.

Architecture

Architecture Diagram


© Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.

Project details


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

File details

Details for the file aws-solutions-konstruk.aws-kinesis-firehose-s3-kinesis-analytics-0.8.1.tar.gz.

File metadata

File hashes

Hashes for aws-solutions-konstruk.aws-kinesis-firehose-s3-kinesis-analytics-0.8.1.tar.gz
Algorithm Hash digest
SHA256 8c7d520514872459c05191fcabb873ec3f3cd196d478cf990fe00a91bb8a7e6f
MD5 acf0e99ec348951ec8ed765d4785c2e0
BLAKE2b-256 dd179f9b6c6e99cc95f42a3ad90023b3d7a60e37ff48ac4d3c0303b18c17931f

See more details on using hashes here.

File details

Details for the file aws_solutions_konstruk.aws_kinesis_firehose_s3_kinesis_analytics-0.8.1-py3-none-any.whl.

File metadata

File hashes

Hashes for aws_solutions_konstruk.aws_kinesis_firehose_s3_kinesis_analytics-0.8.1-py3-none-any.whl
Algorithm Hash digest
SHA256 7da83a11da4f4b53769dba44d43e7ec77997c22d787778d86c793b86001964af
MD5 9374f82ca37a927cfb087fd48491df4f
BLAKE2b-256 b33a9814a6391dd46bf281e4a4e93009953c76c8dabb9d8ef4225e6f4633e53d

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page