awssolutionsconstructsawsiotkinesisfirehoses3

README

aws-iot-kinesisfirehose-s3 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.

---

Reference Documentation:	https://docs.aws.amazon.com/solutions/latest/constructs/

Language	Package
Python	aws_solutions_constructs.aws_iot_kinesisfirehose_s3
Typescript	@aws-solutions-constructs/aws-iot-kinesisfirehose-s3
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

• scope Construct
• id string
• props IotToKinesisFirehoseToS3Props

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.
loggingBucketProps?	s3.BucketProps	Optional user provided props to override the default props for the S3 Logging Bucket.
logS3AccessLogs?	boolean	Whether 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

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
s3BucketInterface	s3.IBucket	Returns 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

---

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

Documentation

Overview

CDK Constructs for AWS IoT to AWS Kinesis Firehose to AWS S3 integration.

Index

• func IotToKinesisFirehoseToS3_IsConstruct(x interface{}) *bool
• func NewIotToKinesisFirehoseToS3_Override(i IotToKinesisFirehoseToS3, scope constructs.Construct, id *string, ...)
• type IotToKinesisFirehoseToS3
  • func NewIotToKinesisFirehoseToS3(scope constructs.Construct, id *string, props *IotToKinesisFirehoseToS3Props) IotToKinesisFirehoseToS3
• type IotToKinesisFirehoseToS3Props

Functions

func IotToKinesisFirehoseToS3_IsConstruct

func IotToKinesisFirehoseToS3_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func NewIotToKinesisFirehoseToS3_Override

func NewIotToKinesisFirehoseToS3_Override(i IotToKinesisFirehoseToS3, scope constructs.Construct, id *string, props *IotToKinesisFirehoseToS3Props)

Types

type IotToKinesisFirehoseToS3

type IotToKinesisFirehoseToS3 interface {
	constructs.Construct
	IotActionsRole() awsiam.Role
	IotTopicRule() awsiot.CfnTopicRule
	KinesisFirehose() awskinesisfirehose.CfnDeliveryStream
	KinesisFirehoseLogGroup() awslogs.LogGroup
	KinesisFirehoseRole() awsiam.Role
	Node() constructs.Node
	S3Bucket() awss3.Bucket
	S3BucketInterface() awss3.IBucket
	S3LoggingBucket() awss3.Bucket
	ToString() *string
}

func NewIotToKinesisFirehoseToS3

func NewIotToKinesisFirehoseToS3(scope constructs.Construct, id *string, props *IotToKinesisFirehoseToS3Props) IotToKinesisFirehoseToS3

type IotToKinesisFirehoseToS3Props

type IotToKinesisFirehoseToS3Props struct {
	// User provided CfnTopicRuleProps to override the defaults.
	IotTopicRuleProps *awsiot.CfnTopicRuleProps `json:"iotTopicRuleProps"`
	// User provided props to override the default props for the S3 Bucket.
	BucketProps *awss3.BucketProps `json:"bucketProps"`
	// Existing instance of S3 Bucket object, providing both this and `bucketProps` will cause an error.
	ExistingBucketObj awss3.IBucket `json:"existingBucketObj"`
	// Optional user provided props to override the default props.
	KinesisFirehoseProps interface{} `json:"kinesisFirehoseProps"`
	// Optional user provided props to override the default props for the S3 Logging Bucket.
	LoggingBucketProps *awss3.BucketProps `json:"loggingBucketProps"`
	// User provided props to override the default props for the CloudWatchLogs LogGroup.
	LogGroupProps *awslogs.LogGroupProps `json:"logGroupProps"`
	// Whether to turn on Access Logs for the S3 bucket with the associated storage costs.
	//
	// Enabling Access Logging is a best practice.
	LogS3AccessLogs *bool `json:"logS3AccessLogs"`
}