aws-events-rule-kinesisstreams 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-kinesisstreams.

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

Language	Package
Python	`aws_solutions_constructs.aws_events_rule_kinesisstreams`
Typescript	`@aws-solutions-constructs/aws-events-rule-kinesisstreams`
Java	`software.amazon.awsconstructs.services.eventsrulekinesisstreams`

Overview

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:

Typescript

// aws-events-rule-kinesisstreams has been deprecated for CDK V2 in favor of aws-eventbridge-kinesisstreams.
// This sample uses the CDK V1 syntax
import * as cdk from '@aws-cdk/core';
import * as events from '@aws-cdk/aws-events';
import { EventsRuleToKinesisStreams, EventsRuleToKinesisStreamsProps } from "@aws-solutions-constructs/aws-events-rule-kinesisstreams";

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

new EventsRuleToKinesisStreams(this, 'test-events-rule-kinesis-streams', constructProps);

Python

# aws-events-rule-kinesisstreams has been deprecated for CDK V2 in favor of aws-eventbridge-kinesisstreams.
# This sample uses the CDK V1 syntax
from aws_solutions_constructs.aws_events_rule_kinesis_streams import EventsRuleToKinesisStreams, EventsRuleToKinesisStreamsProps
from aws_cdk import (
    aws_events as events,
    core
)

EventsRuleToKinesisStreams(self, 'test_events_rule_kinesis_streams',
                        event_rule_props=events.RuleProps(
                            schedule=events.Schedule.rate(
                                core.Duration.minutes(5)),
                        ))

Java

// aws-events-rule-kinesisstreams has been deprecated for CDK V2 in favor of aws-eventbridge-kinesisstreams.
// This sample uses the CDK V1 syntax
import software.constructs.Construct;

import software.amazon.awscdk.core.*;
import software.amazon.awscdk.services.events.*;
import software.amazon.awsconstructs.services.eventsrulekinesisstreams.*;

new EventsRuleToKinesisStreams(this, "test-events-rule-kinesis-streams",
        new EventsRuleToKinesisStreamsProps.Builder()
                .eventRuleProps(new RuleProps.Builder()
                        .schedule(Schedule.rate(Duration.minutes(5)))
                        .build())
                .build());

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

Metadata

Release files for aws-solutions-constructs.aws-events-rule-kinesis-streams 1.181.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for aws-solutions-constructs.aws-events-rule-kinesis-streams 1.181.1
File	Size	Uploaded
aws-solutions-constructs.aws-events-rule-kinesis-streams-1.181.1.tar.gz	153.7 kB	Dec 2, 2022	Details

Built distribution (wheel)

Table of built distributions (wheels) for aws-solutions-constructs.aws-events-rule-kinesis-streams 1.181.1
File	Interpreter	ABI	Platform	Reset
aws_solutions_constructs.aws_events_rule_kinesis_streams-1.181.1-py3-none-any.whl 152.5 kB Dec 2, 2022	Python 3	none	any	Details

Total release size: 306.2 kB

Release files / aws-solutions-constructs.aws-events-rule-kinesis-streams-1.181.1.tar.gz

Download URL	aws-solutions-constructs.aws-events-rule-kinesis-streams-1.181.1.tar.gz
Size	153.7 kB
Tags	Source
SHA-256 checksum How to use checksums	`a9f23c5d941f25e3fb3a087128f8b2133671c643eb5916ee374ebd425ea33d93`
BLAKE2b-256 checksum How to use checksums	`912f15190858c3e42cfef1d9b77aef57bb5c980440b7c79959fae90d32bf3d71`
Upload date	Dec 2, 2022
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.2 CPython/3.9.12`

Release files / aws_solutions_constructs.aws_events_rule_kinesis_streams-1.181.1-py3-none-any.whl

Download URL	aws_solutions_constructs.aws_events_rule_kinesis_streams-1.181.1-py3-none-any.whl
Size	152.5 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`17bfd409ef1f85867ba95688f1b2b105cf7ec8bb81463ad1af1d930260606c73`
BLAKE2b-256 checksum How to use checksums	`e843e165d4eaf6e69bb7c0b6a907741a09874074c593a01a8a589148b582f1b0`
Upload date	Dec 2, 2022
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.2 CPython/3.9.12`