CDK Constructs for deploying Amazon CloudWatch Events Rule that invokes Amazon Kinesis Data Stream
Project description
aws-events-rule-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 the Semantic Versioning model. 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/ |
---|
Language | Package |
---|---|
Python | aws_solutions_constructs.aws_events_rule_kinesisstream |
Typescript | @aws-solutions-constructs/aws-events-rule-kinesisstreams |
Java | software.amazon.awsconstructs.services.eventsrulekinesisstream |
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:
# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
import aws_cdk.core as cdk
from aws_solutions_constructs.aws_events_rule_kinesis_streams import EventsRuleToKinesisStreams, EventsRuleToKinesisStreamsProps
props = EventsRuleToKinesisStreamsProps(
event_rule_props=RuleProps(
schedule=events.Schedule.rate(Duration.minutes(5))
)
)
EventsRuleToKinesisStreams(self, "test-events-rule-kinesis-stream", props)
Initializer
new EventsRuleToKinesisStreams(scope: Construct, id: string, props: EventsRuleToKinesisStreamsProps);
Parameters
- scope
Construct
- id
string
- props
EventsRuleToKinesisStreamsProps
Pattern Construct Props
Name | Type | Description |
---|---|---|
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 |
---|---|---|
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. |
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
© Copyright 2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for aws-solutions-constructs.aws-events-rule-kinesis-streams-1.106.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | fb415f67dc383cad499d914bb53db74044e1826f07dd8daf6d2116510447b9f9 |
|
MD5 | 19bc2efc5bbe8a49620fe6d76c40b30f |
|
BLAKE2b-256 | 34a9c160479487191ff515f85f2b52f93fb41b21682fefcdea4cf91203eeb775 |
Hashes for aws_solutions_constructs.aws_events_rule_kinesis_streams-1.106.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f64397802cd16130ef68e69ae64fd86d172c8b3ef876e78b64757de504c18fc2 |
|
MD5 | c43385374d32dc8da6b703bfd5008227 |
|
BLAKE2b-256 | 029dd0578d406ad7533098b079ec328d4341225415c72e52e443b385d66c9e7b |