Negligent Parachute Maintainers

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

    2.2.0 • Public • Published

    aws-eventbridge-kinesisfirehose-s3 module


    Stability: Stable


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

    This AWS Solutions Construct implements an Amazon EventBridge 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 { EventbridgeToKinesisFirehoseToS3, EventbridgeToKinesisFirehoseToS3Props } from '@aws-solutions-constructs/aws-eventbridge-kinesisfirehose-s3';
    
    const EventbridgeToKinesisFirehoseToS3Props: EventbridgeToKinesisFirehoseToS3Props = {
      eventRuleProps: {
      schedule: events.Schedule.rate(cdk.Duration.minutes(5))
      }
    };
    
    new EventbridgeToKinesisFirehoseToS3(this, 'test-eventbridge-firehose-s3', EventbridgeToKinesisFirehoseToS3Props);

    Initializer

    new EventbridgeToKinesisFirehoseToS3(scope: Construct, id: string, props: EventbridgeToKinesisFirehoseToS3Props);
    

    Parameters

    Pattern Construct Props

    Name Type Description
    existingEventBusInterface? events.IEventBus Optional user-provided custom EventBus for construct to use. Providing both this and eventBusProps results an error.
    eventBusProps? events.EventBusProps Optional 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.
    eventRuleProps events.RuleProps User provided eventRuleProps 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. If this is provided, then also providing bucketProps is an error.
    bucketProps? s3.BucketProps User provided props to override the default props for the S3 Bucket.
    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
    eventBus? events.IEventBus Returns the instance of events.IEventBus used by the construct
    eventsRule events.Rule Returns an instance of events.Rule created by the construct.
    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.
    eventsRole iam.Role Returns an instance of the iam.Role created by the construct for Events 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 EventBridge Rule

    • Configure least privilege access IAM role for Amazon EventBridge 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.

    Install

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

    DownloadsWeekly Downloads

    491

    Version

    2.2.0

    License

    Apache-2.0

    Unpacked Size

    309 kB

    Total Files

    21

    Last publish

    Collaborators

    • aws-solutions-constructs-team