Exciting news!Announcing our $4.6M Series Seed. Learn more
Socket
LoveBlogFAQ
Install
Log in

@aws-solutions-constructs/aws-events-rule-kinesisstreams

Package Overview
Dependencies
8
Maintainers
1
Versions
99
Issues
File Explorer

Advanced tools

@aws-solutions-constructs/aws-events-rule-kinesisstreams

CDK Constructs for deploying Amazon CloudWatch Events Rule that invokes Amazon Kinesis Data Stream

    1.146.0latest

Version published
Maintainers
1
Yearly downloads
10,169
increased by225.72%

Weekly downloads

Changelog

Source

1.146.0 (2022-03-02)

  • Upgraded all patterns to CDK v1.146.0

Readme

Source

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/
LanguagePackage
Python Logo Pythonaws_solutions_constructs.aws_events_rule_kinesisstreams
Typescript Logo Typescript@aws-solutions-constructs/aws-events-rule-kinesisstreams
Java Logo Javasoftware.amazon.awsconstructs.services.eventsrulekinesisstreams

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-streams', props);

Initializer

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

Parameters

Pattern Construct Props

NameTypeDescription
existingEventBusInterface?events.IEventBusOptional user-provided custom EventBus for construct to use. Providing both this and eventBusProps results an error.
eventBusProps?events.EventBusPropsOptional 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.
eventRulePropsevents.RulePropsUser provided eventRuleProps to override the defaults.
existingStreamObj?kinesis.StreamExisting instance of Kinesis Stream, providing both this and kinesisStreamProps will cause an error.
kinesisStreamProps?kinesis.StreamPropsOptional user-provided props to override the default props for the Kinesis stream.
createCloudWatchAlarmsbooleanWhether to create recommended CloudWatch alarms.

Pattern Properties

NameTypeDescription
eventBus?events.IEventBusReturns the instance of events.IEventBus used by the construct
eventsRuleevents.RuleReturns an instance of events.Rule created by the construct.
kinesisStreamkinesis.StreamReturns an instance of the Kinesis stream created by the pattern.
eventsRole?iam.RoleReturns 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


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

Keywords

Socket

Product

Subscribe to our newsletter

Get open source security insights delivered straight into your inbox. Be the first to learn about new features and product updates.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc