Naughty Platypus Memorabilia

    @aws-solutions-constructs/aws-iot-kinesisfirehose-s3
    TypeScript icon, indicating that this package has built-in type declarations

    1.123.0 • Public • Published

    aws-iot-kinesisfirehose-s3 module


    Stability: Experimental

    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.


    Reference Documentation: https://docs.aws.amazon.com/solutions/latest/constructs/
    Language Package
    Python Logo Python aws_solutions_constructs.aws_iot_kinesisfirehose_s3
    Typescript Logo Typescript @aws-solutions-constructs/aws-iot-kinesisfirehose-s3
    Java Logo Java software.amazon.awsconstructs.services.iotkinesisfirehoses3

    This AWS Solutions Construct implements an AWS IoT MQTT topic rule to send data to an Amazon Kinesis Data Firehose delivery stream connected to an Amazon S3 bucket.

    Here is a minimal deployable pattern definition in Typescript:

    const { IotToKinesisFirehoseToS3Props, IotToKinesisFirehoseToS3 } from '@aws-solutions-constructs/aws-iot-kinesisfirehose-s3';
    
    const props: IotToKinesisFirehoseToS3Props = {
        iotTopicRuleProps: {
            topicRulePayload: {
                ruleDisabled: false,
                description: "Persistent storage of connected vehicle telematics data",
                sql: "SELECT * FROM 'connectedcar/telemetry/#'",
                actions: []
            }
        }
    };
    
    new IotToKinesisFirehoseToS3(this, 'test-iot-firehose-s3', props);

    Initializer

    new IotToKinesisFirehoseToS3(scope: Construct, id: string, props: IotToKinesisFirehoseToS3Props);
    

    Parameters

    Pattern Construct Props

    Name Type Description
    iotTopicRuleProps iot.CfnTopicRuleProps User provided CfnTopicRuleProps to override the defaults
    kinesisFirehoseProps? kinesisfirehose.CfnDeliveryStreamProps Optional user provided props to override the default props for Kinesis Firehose Delivery Stream
    existingBucketObj? s3.IBucket Existing instance of S3 Bucket object, providing both this and bucketProps will cause an error.
    bucketProps? s3.BucketProps User provided props to override the default props for the S3 Bucket. If this is provided, then also providing bucketProps is an error.
    logGroupProps? logs.LogGroupProps User provided props to override the default props for for the CloudWatchLogs LogGroup.

    Pattern Properties

    Name Type Description
    kinesisFirehose kinesisfirehose.CfnDeliveryStream Returns an instance of kinesisfirehose.CfnDeliveryStream created by the construct
    s3Bucket? s3.Bucket Returns an instance of s3.Bucket created by the construct
    s3LoggingBucket? s3.Bucket Returns an instance of s3.Bucket created by the construct as the logging bucket for the primary bucket.
    iotTopicRule iot.CfnTopicRule Returns an instance of iot.CfnTopicRule created by the construct
    iotActionsRole iam.Role Returns an instance of the iam.Role created by the construct for IoT Rule
    kinesisFirehoseRole iam.Role Returns an instance of the iam.Role created by the construct for Kinesis Data Firehose delivery stream
    kinesisFirehoseLogGroup logs.LogGroup Returns an instance of the LogGroup created by the construct for Kinesis Data Firehose delivery stream

    Default settings

    Out of the box implementation of the Construct without any override will set the following defaults:

    Amazon IoT Rule

    • Configure least privilege access IAM role for Amazon IoT

    Amazon Kinesis Firehose

    • Enable CloudWatch logging for Kinesis Firehose
    • Configure least privilege access IAM role for Amazon Kinesis Firehose

    Amazon S3 Bucket

    • Configure Access logging for S3 Bucket
    • Enable server-side encryption for S3 Bucket using AWS managed KMS Key
    • Enforce encryption of data in transit
    • Turn on the versioning for S3 Bucket
    • Don't allow public access for S3 Bucket
    • Retain the S3 Bucket when deleting the CloudFormation stack
    • Applies Lifecycle rule to move noncurrent object versions to Glacier storage after 90 days

    Architecture

    Architecture Diagram


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

    Install

    npm i @aws-solutions-constructs/aws-iot-kinesisfirehose-s3

    DownloadsWeekly Downloads

    223

    Version

    1.123.0

    License

    Apache-2.0

    Unpacked Size

    249 kB

    Total Files

    12

    Last publish

    Collaborators

    • aws-solutions-constructs-team