aws-eventbridge-kinesisstreams - AWS Solutions Constructs
OverviewPattern Construct PropsPattern PropertiesDefault settingsArchitectureGithub

aws-eventbridge-kinesisstreams

Stability:Experimental
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

Overview

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:

Example
Typescript
import { Construct } from 'constructs';
import { Stack, StackProps, Duration } from 'aws-cdk-lib';
import { EventbridgeToKinesisStreams, EventbridgeToKinesisStreamsProps } from "@aws-solutions-constructs/aws-eventbridge-kinesisstreams";
import * as events from 'aws-cdk-lib/aws-events';

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

new EventbridgeToKinesisStreams(this, 'test-eventbridge-kinesis-streams', constructProps);
Python
from aws_solutions_constructs.aws_eventbridge_kinesis_streams import EventbridgeToKinesisStreams, EventbridgeToKinesisStreamsProps
from aws_cdk import (
    aws_events as events,
    Duration,
    Stack
)
from constructs import Construct

EventbridgeToKinesisStreams(self, 'test-eventbridge-kinesis-streams',
    event_rule_props=events.RuleProps(
        schedule=events.Schedule.rate(Duration.minutes(5)),
    ))
Java
import software.constructs.Construct;

import software.amazon.awscdk.Stack;
import software.amazon.awscdk.StackProps;
import software.amazon.awscdk.Duration;
import software.amazon.awscdk.services.events.*;
import software.amazon.awsconstructs.services.eventbridgekinesisstreams.*;

new EventbridgeToKinesisStreams(this, "test-eventbridge-kinesis-streams",
        new EventbridgeToKinesisStreamsProps.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 this construct to use. Providing both this and eventBusProps causes 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 causes 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

Diagram showing the EventBridge rule, Kinesis data stream and IAM role created by the construct

Github

Go to the Github repo for this pattern to view the code, read/create issues and pull requests and more.