Newton's Programmatic Measurements

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

    2.2.0 • Public • Published

    aws-eventbridge-kinesisstreams 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_eventbridge_kinesisstreams
    Typescript Logo Typescript @aws-solutions-constructs/aws-eventbridge-kinesisstreams
    Java Logo Java software.amazon.awsconstructs.services.eventbridgekinesisstreams

    This AWS Solutions Construct implements an Amazon EventBridge rule to send data to an Amazon Kinesis Data Stream

    Here is a minimal deployable pattern definition in Typescript:

    import * as cdk from '@aws-cdk/core';
    import {EventbridgeToKinesisStreams, EventbridgeToKinesisStreamsProps} from "@aws-solutions-constructs/aws-eventbridge-kinesisstreams";
    
    const props: EventbridgeToKinesisStreamsProps = {
        eventRuleProps: {
          schedule: events.Schedule.rate(Duration.minutes(5)),
        }
    };
    
    new EventbridgeToKinesisStreams(this, 'test-eventbridge-kinesis-streams', props);

    Initializer

    new EventbridgeToKinesisStreams(scope: Construct, id: string, props: EventbridgeToKinesisStreamsProps);
    

    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.
    existingStreamObj? kinesis.Stream Existing instance of Kinesis Stream, providing both this and kinesisStreamProps will cause an error.
    kinesisStreamProps? kinesis.StreamProps Optional user-provided props to override the default props for the Kinesis stream.
    createCloudWatchAlarms boolean Whether to create recommended CloudWatch alarms.

    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.
    kinesisStream kinesis.Stream Returns an instance of the Kinesis stream created by the pattern.
    eventsRole? iam.Role Returns an instance of the iam.Role created by the construct for events rule.
    cloudwatchAlarms? cloudwatch.Alarm[] Returns an instance of the cloudwatch.Alarm[] 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 EventBridge Rule to publish to the Kinesis Data Stream.

    Amazon Kinesis Stream

    • Enable server-side encryption for Kinesis Data Stream using AWS Managed KMS Key.

    Architecture

    Architecture Diagram


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

    Install

    npm i @aws-solutions-constructs/aws-eventbridge-kinesisstreams

    DownloadsWeekly Downloads

    609

    Version

    2.2.0

    License

    Apache-2.0

    Unpacked Size

    218 kB

    Total Files

    21

    Last publish

    Collaborators

    • aws-solutions-constructs-team