Package: aws-solutions-constructs.aws-events-rule-kinesis-streams
aws-events-rule-kinesisstreams module---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/LanguagePackagePythonaws_solutions_constructs.aws_events_rule_kinesisstreamsTypescript@aws-solutions-constructs/aws-events-rule-kinesisstreamsJavasoftware.amazon.awsconstructs.services.eventsrulekinesisstreamsOverviewThis 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-kinesisstreamshasbeendeprecatedforCDKV2infavorofaws-eventbridge-kinesisstreams.//ThissampleusestheCDKV1syntaximport*ascdkfrom'@aws-cdk/core';import*aseventsfrom'@aws-cdk/aws-events';import{EventsRuleToKinesisStreams,EventsRuleToKinesisStreamsProps}from"@aws-solutions-constructs/aws-events-rule-kinesisstreams";constconstructProps:EventsRuleToKinesisStreamsProps={eventRuleProps:{schedule:events.Schedule.rate(cdk.Duration.minutes(5)),}};newEventsRuleToKinesisStreams(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 syntaxfromaws_solutions_constructs.aws_events_rule_kinesis_streamsimportEventsRuleToKinesisStreams,EventsRuleToKinesisStreamsPropsfromaws_cdkimport(aws_eventsasevents,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 syntaximportsoftware.constructs.Construct;importsoftware.amazon.awscdk.core.*;importsoftware.amazon.awscdk.services.events.*;importsoftware.amazon.awsconstructs.services.eventsrulekinesisstreams.*;newEventsRuleToKinesisStreams(this,"test-events-rule-kinesis-streams",newEventsRuleToKinesisStreamsProps.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 CloudWatch Events RuleConfigure least privilege access IAM role for Events 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 2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.