Exciting news!Announcing our $4.6M Series Seed. Learn more
Socket
LoveBlogFAQ
Install
Log in

@aws-solutions-constructs/aws-events-rule-kinesisfirehose-s3

Package Overview
Dependencies
9
Maintainers
1
Versions
99
Issues
File Explorer

Advanced tools

@aws-solutions-constructs/aws-events-rule-kinesisfirehose-s3

CDK Constructs for Amazon CloudWatch Events Rule to Amazon Kinesis Firehose to Amazon S3 integration.

    1.146.0latest

Version published
Maintainers
1
Yearly downloads
10,803
increased by182.88%

Weekly downloads

Changelog

Source

1.146.0 (2022-03-02)

  • Upgraded all patterns to CDK v1.146.0

Readme

Source

aws-events-rule-kinesisfirehose-s3 module


Stability: Deprecated

Some of our early constructs don’t meet the naming standards that evolved for the library. We are releasing completely feature compatible versions with corrected names. The underlying implementation code is the same regardless of whether you deploy the construct using the old or new name. We will support both names for all 1.x releases, but in 2.x we will only publish the correctly named constructs. This construct is being replaced by the functionally identical aws-eventbridge-kinesisfirehose-s3.


Reference Documentation:https://docs.aws.amazon.com/solutions/latest/constructs/
LanguagePackage
Python Logo Pythonaws_solutions_constructs.aws_events_rule_kinesisfirehose_s3
Typescript Logo Typescript@aws-solutions-constructs/aws-events-rule-kinesisfirehose-s3
Java Logo Javasoftware.amazon.awsconstructs.services.eventsrulekinesisfirehoses3

This AWS Solutions Construct implements an Amazon CloudWatch Events 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:

import * as cdk from '@aws-cdk/core'; import { EventsRuleToKinesisFirehoseToS3, EventsRuleToKinesisFirehoseToS3Props } from '@aws-solutions-constructs/aws-events-rule-kinesisfirehose-s3'; const eventsRuleToKinesisFirehoseToS3Props: EventsRuleToKinesisFirehoseToS3Props = { eventRuleProps: { schedule: events.Schedule.rate(cdk.Duration.minutes(5)) } }; new EventsRuleToKinesisFirehoseToS3(this, 'test-events-rule-firehose-s3', eventsRuleToKinesisFirehoseToS3Props);

Initializer

new EventsRuleToKinesisFirehoseToS3(scope: Construct, id: string, props: EventsRuleToKinesisFirehoseToS3Props);

Parameters

Pattern Construct Props

NameTypeDescription
existingEventBusInterface?events.IEventBusOptional user-provided custom EventBus for construct to use. Providing both this and eventBusProps results an error.
eventBusProps?events.EventBusPropsOptional user-provided properties to override the default properties when creating a custom EventBus. Setting this value to {} will create a custom EventBus using all default properties. If neither this nor existingEventBusInterface is provided the construct will use the default EventBus. Providing both this and existingEventBusInterface results an error.
eventRulePropsevents.RulePropsUser provided eventRuleProps 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. If this is provided, then also providing bucketProps is an error.
bucketProps?s3.BucketPropsUser provided props to override the default props for the S3 Bucket.
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
eventBus?events.IEventBusReturns the instance of events.IEventBus used by the construct
eventsRuleevents.RuleReturns an instance of events.Rule created by the construct.
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.
eventsRoleiam.RoleReturns an instance of the iam.Role created by the construct for Events 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 CloudWatch Events Rule

  • Configure least privilege access IAM role for Events Rule to publish to the Kinesis Firehose Delivery Stream.

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
  • 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.

Keywords

Socket

Product

Subscribe to our newsletter

Get open source security insights delivered straight into your inbox. Be the first to learn about new features and product updates.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc