aws-events-rule-kinesisstreams 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_events_rule_kinesisstream`
Typescript	`@aws-solutions-constructs/aws-events-rule-kinesisstreams`
Java	`software.amazon.awsconstructs.services.eventsrulekinesisstream`

This AWS Solutions Construct implements an Amazon CloudWatch Events 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 {EventsRuleToKinesisStreams, EventsRuleToKinesisStreamsProps} from "@aws-solutions-constructs/aws-events-rule-kinesisstreams";

const props: EventsRuleToKinesisStreamsProps = {
    eventRuleProps: {
      schedule: events.Schedule.rate(Duration.minutes(5)),
    }
};

new EventsRuleToKinesisStreams(this, 'test-events-rule-kinesis-stream', props);

Initializer

new EventsRuleToKinesisStreams(scope: Construct, id: string, props: EventsRuleToKinesisStreamsProps);

Parameters

scope Construct
id string
props EventsRuleToKinesisStreamsProps

Pattern Construct Props

Name	Type	Description
eventRuleProps	`events.RuleProps`	User provided eventRuleProps to override the defaults.
existingStreamObj?	`kinesis.Stream`	Existing instance of Kinesis Stream, if this is set then kinesisStreamProps is ignored.
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
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.

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 Data Stream.

Amazon Kinesis Stream

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

Architecture

Architecture Diagram