2.74.0 • Published 9 months ago

@aws-solutions-constructs/aws-iot-kinesisfirehose-s3 v2.74.0

Weekly downloads
165
License
Apache-2.0
Repository
github
Last release
9 months ago

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/
LanguagePackage
Python Logo Pythonaws_solutions_constructs.aws_iot_kinesisfirehose_s3
Typescript Logo Typescript@aws-solutions-constructs/aws-iot-kinesisfirehose-s3
Java Logo Javasoftware.amazon.awsconstructs.services.iotkinesisfirehoses3

Overview

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:

Typescript

import { Construct } from 'constructs';
import { Stack, StackProps } from 'aws-cdk-lib';
import { IotToKinesisFirehoseToS3Props, IotToKinesisFirehoseToS3 } from '@aws-solutions-constructs/aws-iot-kinesisfirehose-s3';

const constructProps: 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', constructProps);

Python

from aws_solutions_constructs.aws_iot_kinesisfirehose_s3 import IotToKinesisFirehoseToS3Props, IotToKinesisFirehoseToS3
from aws_cdk import (
    aws_iot as iot,
    Stack
)
from constructs import Construct

IotToKinesisFirehoseToS3(self, 'test_iot_firehose_s3',
                        iot_topic_rule_props=iot.CfnTopicRuleProps(
                            topic_rule_payload=iot.CfnTopicRule.TopicRulePayloadProperty(
                                rule_disabled=False,
                                description="Persistent storage of connected vehicle telematics data",
                                sql="SELECT * FROM 'connectedcar/telemetry/#'",
                                actions=[]
                            )
                        ))

Java

import software.constructs.Construct;
import java.util.List;

import software.amazon.awscdk.Stack;
import software.amazon.awscdk.StackProps;
import software.amazon.awscdk.services.iot.*;
import software.amazon.awscdk.services.iot.CfnTopicRule.TopicRulePayloadProperty;
import software.amazon.awsconstructs.services.iotkinesisfirehoses3.*;

new IotToKinesisFirehoseToS3(this, "test-iot-firehose-s3", new IotToKinesisFirehoseToS3Props.Builder()
        .iotTopicRuleProps(new CfnTopicRuleProps.Builder()
                .topicRulePayload(new TopicRulePayloadProperty.Builder()
                        .ruleDisabled(false)
                        .description("Persistent storage of connected vehicle telematics data")
                        .sql("SELECT * FROM 'connectedcar/telemetry/#'")
                        .actions(List.of())
                        .build())
                .build())
        .build());

Pattern Construct Props

NameTypeDescription
iotTopicRulePropsiot.CfnTopicRulePropsUser provided CfnTopicRuleProps to override the defaults
kinesisFirehoseProps?kinesisfirehose.CfnDeliveryStreamPropsOptional user provided props to override the default props for Kinesis Firehose Delivery Stream
existingBucketObj?s3.IBucketExisting instance of S3 Bucket object, providing both this and bucketProps will cause an error.
bucketProps?s3.BucketPropsUser provided props to override the default props for the S3 Bucket. If this is provided, then also providing bucketProps is an error.
logGroupProps?logs.LogGroupPropsUser provided props to override the default props for for the CloudWatchLogs LogGroup.
loggingBucketProps?s3.BucketPropsOptional user provided props to override the default props for the S3 Logging Bucket.
logS3AccessLogs?booleanWhether to turn on Access Logging for the S3 bucket. Creates an S3 bucket with associated storage costs for the logs. Enabling Access Logging is a best practice. default - true

Pattern Properties

NameTypeDescription
kinesisFirehosekinesisfirehose.CfnDeliveryStreamReturns an instance of kinesisfirehose.CfnDeliveryStream created by the construct
s3Bucket?s3.BucketReturns an instance of s3.Bucket created by the construct
s3LoggingBucket?s3.BucketReturns an instance of s3.Bucket created by the construct as the logging bucket for the primary bucket.
iotTopicRuleiot.CfnTopicRuleReturns an instance of iot.CfnTopicRule created by the construct
iotActionsRoleiam.RoleReturns an instance of the iam.Role created by the construct for IoT Rule
kinesisFirehoseRoleiam.RoleReturns an instance of the iam.Role created by the construct for Kinesis Data Firehose delivery stream
kinesisFirehoseLogGrouplogs.LogGroupReturns an instance of the LogGroup created by the construct for Kinesis Data Firehose delivery stream
s3BucketInterfaces3.IBucketReturns an instance of s3.IBucket created by the construct

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 Amazon.com, Inc. or its affiliates. All Rights Reserved.

2.74.0

9 months ago

2.73.0

9 months ago

2.72.0

9 months ago

2.71.0

10 months ago

2.69.0

10 months ago

2.68.0

11 months ago

2.67.0

11 months ago

2.67.1

11 months ago

2.70.0

10 months ago

2.60.0

1 year ago

2.65.0

11 months ago

2.64.0

12 months ago

2.63.0

12 months ago

2.59.0

1 year ago

2.62.0

12 months ago

2.58.0

1 year ago

2.58.1

1 year ago

2.61.0

1 year ago

2.57.0

1 year ago

2.56.0

1 year ago

2.55.0

1 year ago

2.54.1

1 year ago

2.54.0

1 year ago

2.53.0

1 year ago

2.52.1

1 year ago

2.52.0

1 year ago

2.51.0

1 year ago

2.50.0

1 year ago

2.49.0

1 year ago

2.48.0

2 years ago

2.47.0

2 years ago

2.46.0

2 years ago

2.45.0

2 years ago

2.44.0

2 years ago

2.43.0

2 years ago

2.43.1

2 years ago

2.42.0

2 years ago

2.41.0

2 years ago

2.40.0

2 years ago

2.39.0

2 years ago

2.38.0

2 years ago

2.37.0

2 years ago

2.34.0

2 years ago

2.33.0

2 years ago

2.32.0

2 years ago

2.31.0

2 years ago

2.36.0

2 years ago

2.35.0

2 years ago

2.30.0

3 years ago

2.27.0

3 years ago

1.176.0

3 years ago

2.26.0

3 years ago

1.175.0

3 years ago

1.179.0

3 years ago

2.29.0

3 years ago

1.181.0

3 years ago

1.181.1

3 years ago

1.174.0

3 years ago

1.178.0

3 years ago

2.28.0

3 years ago

1.180.0

3 years ago

1.177.0

3 years ago

1.168.0

3 years ago

2.19.0

3 years ago

1.172.0

3 years ago

2.22.0

3 years ago

1.167.0

3 years ago

2.18.0

3 years ago

2.21.0

3 years ago

1.171.0

3 years ago

2.25.0

3 years ago

2.17.0

3 years ago

1.170.0

3 years ago

2.20.0

3 years ago

1.170.1

3 years ago

2.24.0

3 years ago

1.169.0

3 years ago

2.16.0

3 years ago

1.173.0

3 years ago

2.23.0

3 years ago

2.11.0

3 years ago

1.160.0

3 years ago

1.164.0

3 years ago

1.157.0

3 years ago

1.163.0

3 years ago

2.10.0

3 years ago

1.163.2

3 years ago

1.163.1

3 years ago

2.14.0

3 years ago

1.162.0

3 years ago

1.166.1

3 years ago

2.13.0

3 years ago

1.159.0

3 years ago

2.12.0

3 years ago

1.161.0

3 years ago

1.165.0

3 years ago

2.9.0

3 years ago

1.158.0

3 years ago

2.8.0

3 years ago

1.153.0

3 years ago

1.153.1

3 years ago

2.7.0

3 years ago

1.156.0

3 years ago

1.156.1

3 years ago

2.6.0

3 years ago

1.155.0

3 years ago

1.154.0

3 years ago

2.4.0

3 years ago

1.149.0

3 years ago

1.148.0

3 years ago

1.152.0

3 years ago

1.147.0

3 years ago

1.151.0

3 years ago

2.5.0

3 years ago

1.150.0

3 years ago

1.145.0

3 years ago

1.141.0

3 years ago

1.144.0

3 years ago

1.140.0

3 years ago

1.143.0

3 years ago

1.142.0

3 years ago

1.146.0

3 years ago

1.134.0

4 years ago

1.130.0

4 years ago

1.138.2

3 years ago

1.138.1

3 years ago

1.138.0

3 years ago

2.3.0

3 years ago

1.133.0

4 years ago

1.137.0

4 years ago

2.2.0

3 years ago

1.132.0

4 years ago

1.136.0

4 years ago

2.1.0

4 years ago

1.131.0

4 years ago

1.139.0

3 years ago

1.135.0

4 years ago

2.0.0

4 years ago

1.129.0

4 years ago

1.128.0

4 years ago

1.127.0

4 years ago

2.0.0-rc.2

4 years ago

1.126.0

4 years ago

2.0.0-rc.1

4 years ago

1.125.0

4 years ago

1.124.0

4 years ago

1.123.0

4 years ago

1.122.0

4 years ago

1.121.0

4 years ago

1.120.0

4 years ago

1.119.0

4 years ago

1.118.0

4 years ago

1.117.0

4 years ago

1.115.0

4 years ago

1.116.0

4 years ago

1.113.0

4 years ago

1.114.0

4 years ago

1.112.0

4 years ago

1.111.0

4 years ago

1.110.1

4 years ago

1.109.0

4 years ago

1.108.1

4 years ago

1.110.0

4 years ago

1.108.0

4 years ago

1.107.0

4 years ago

1.106.1

4 years ago

1.105.0

4 years ago

1.106.0

4 years ago

1.101.0

4 years ago

1.103.0

4 years ago

1.99.0

4 years ago

1.100.0

4 years ago

1.104.0

4 years ago

1.102.0

4 years ago

1.98.0

4 years ago

1.97.0

4 years ago

1.96.0

4 years ago

1.94.1

4 years ago

1.95.2

4 years ago

1.95.1

4 years ago

1.95.0

4 years ago

1.94.0

4 years ago

1.92.0

4 years ago

1.93.0

4 years ago

1.91.0

4 years ago

1.90.1

4 years ago

1.90.0

4 years ago

1.89.0

4 years ago

1.88.0

4 years ago

1.87.1

4 years ago

1.86.0

4 years ago

1.87.0

4 years ago

1.85.0

4 years ago

1.84.0

4 years ago

1.82.0

4 years ago

1.83.0

4 years ago

1.81.0

4 years ago

1.80.0

5 years ago

1.79.0

5 years ago

1.78.0

5 years ago

1.77.0

5 years ago

1.76.0

5 years ago

1.75.0

5 years ago

1.74.0

5 years ago

1.73.0

5 years ago

1.72.0

5 years ago

1.71.0

5 years ago

1.70.0

5 years ago

1.69.0

5 years ago

1.68.0

5 years ago

1.67.0

5 years ago

1.66.0

5 years ago

1.65.0

5 years ago

1.64.1

5 years ago

1.64.0

5 years ago

1.63.0

5 years ago

1.62.0

5 years ago

1.61.1

5 years ago

1.61.0

5 years ago

1.60.0

5 years ago

1.59.0

5 years ago

1.58.0

5 years ago

1.57.0

5 years ago

1.56.0

5 years ago

1.55.0

5 years ago

1.54.0

5 years ago

1.53.0

5 years ago

1.52.0

5 years ago

1.51.0

5 years ago

1.50.0

5 years ago

1.49.0

5 years ago

1.48.0

5 years ago

1.47.0

5 years ago

1.46.0

5 years ago