Package: aws-solutions-constructs.aws-eventbridge-kinesis-streams
aws-eventbridge-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 theSemantic Versioningmodel.
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/LanguagePackagePythonaws_solutions_constructs.aws_eventbridge_kinesisstreamsTypescript@aws-solutions-constructs/aws-eventbridge-kinesisstreamsJavasoftware.amazon.awsconstructs.services.eventbridgekinesisstreamsOverviewThis AWS Solutions Construct implements an Amazon EventBridge rule to send data to an Amazon Kinesis Data StreamHere is a minimal deployable pattern definition:Typescriptimport{Construct}from'constructs';import{Stack,StackProps,Duration}from'aws-cdk-lib';import{EventbridgeToKinesisStreams,EventbridgeToKinesisStreamsProps}from"@aws-solutions-constructs/aws-eventbridge-kinesisstreams";import*aseventsfrom'aws-cdk-lib/aws-events';constconstructProps:EventbridgeToKinesisStreamsProps={eventRuleProps:{schedule:events.Schedule.rate(Duration.minutes(5)),}};newEventbridgeToKinesisStreams(this,'test-eventbridge-kinesis-streams',constructProps);Pythonfromaws_solutions_constructs.aws_eventbridge_kinesis_streamsimportEventbridgeToKinesisStreams,EventbridgeToKinesisStreamsPropsfromaws_cdkimport(aws_eventsasevents,Duration,Stack)fromconstructsimportConstructEventbridgeToKinesisStreams(self,'test-eventbridge-kinesis-streams',event_rule_props=events.RuleProps(schedule=events.Schedule.rate(Duration.minutes(5)),))Javaimportsoftware.constructs.Construct;importsoftware.amazon.awscdk.Stack;importsoftware.amazon.awscdk.StackProps;importsoftware.amazon.awscdk.Duration;importsoftware.amazon.awscdk.services.events.*;importsoftware.amazon.awsconstructs.services.eventbridgekinesisstreams.*;newEventbridgeToKinesisStreams(this,"test-eventbridge-kinesis-streams",newEventbridgeToKinesisStreamsProps.Builder().eventRuleProps(newRuleProps.Builder().schedule(Schedule.rate(Duration.minutes(5))).build()).build());Pattern Construct PropsNameTypeDescriptionexistingEventBusInterface?events.IEventBusOptional user-provided custom EventBus for construct to use. Providing both this andeventBusPropsresults 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 norexistingEventBusInterfaceis provided the construct will use thedefaultEventBus. Providing both this andexistingEventBusInterfaceresults an error.eventRulePropsevents.RulePropsUser provided eventRuleProps to override the defaults.existingStreamObj?kinesis.StreamExisting instance of Kinesis Stream, providing both this andkinesisStreamPropswill 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 PropertiesNameTypeDescriptioneventBus?events.IEventBusReturns the instance of events.IEventBus used by the constructeventsRuleevents.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 settingsOut of the box implementation of the Construct without any override will set the following defaults:Amazon EventBridge RuleConfigure least privilege access IAM role for EventBridge Rule to publish to the Kinesis Data Stream.Amazon Kinesis StreamEnable server-side encryption for Kinesis Data Stream using AWS Managed KMS Key.Architecture© Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.