# aws-eventbridge-kinesisstreams module
<!--BEGIN STABILITY BANNER-->---
> 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](https://semver.org/) 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.
---
<!--END STABILITY BANNER-->
| **Reference Documentation**:| <span style="font-weight: normal">https://docs.aws.amazon.com/solutions/latest/constructs/</span>|
|:-------------|:-------------|
<div style="height:8px"></div>
| **Language** | **Package** |
|:-------------|-----------------|
| Python|`aws_solutions_constructs.aws_eventbridge_kinesisstreams`|
| Typescript|`@aws-solutions-constructs/aws-eventbridge-kinesisstreams`|
| 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:
Typescript
```python
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
```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
```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`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_events.IEventBus.html)| Optional user-provided custom EventBus for construct to use. Providing both this and `eventBusProps` results an error.|
|eventBusProps?|[`events.EventBusProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_events.EventBusProps.html)|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` results an error.|
|eventRuleProps|[`events.RuleProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_events.RuleProps.html)|User provided eventRuleProps to override the defaults. |
|existingStreamObj?|[`kinesis.Stream`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_kinesis.Stream.html)|Existing instance of Kinesis Stream, providing both this and `kinesisStreamProps` will cause an error.|
|kinesisStreamProps?|[`kinesis.StreamProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_kinesis.StreamProps.html)|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`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_events.IEventBus.html)|Returns the instance of events.IEventBus used by the construct|
|eventsRule|[`events.Rule`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_events.Rule.html)|Returns an instance of events.Rule created by the construct.|
|kinesisStream|[`kinesis.Stream`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_kinesis.Stream.html)|Returns an instance of the Kinesis stream created by the pattern.|
|eventsRole?|[`iam.Role`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_iam.Role.html)|Returns an instance of the iam.Role created by the construct for events rule.|
|cloudwatchAlarms?|[`cloudwatch.Alarm[]`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_cloudwatch.Alarm.html)|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
---
© Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
Raw data
{
"_id": null,
"home_page": "https://github.com/awslabs/aws-solutions-constructs.git",
"name": "aws-solutions-constructs.aws-eventbridge-kinesis-streams",
"maintainer": null,
"docs_url": null,
"requires_python": "~=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Amazon Web Services",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/91/2d/26034775f35cb81ff34a32dc2ab1ef1a534920bece98ea6e24d4b6b54a18/aws_solutions_constructs_aws_eventbridge_kinesis_streams-2.74.0.tar.gz",
"platform": null,
"description": "# aws-eventbridge-kinesisstreams module\n\n<!--BEGIN STABILITY BANNER-->---\n\n\n\n\n> All classes are under active development and subject to non-backward compatible changes or removal in any\n> future version. These are not subject to the [Semantic Versioning](https://semver.org/) model.\n> 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.\n\n---\n<!--END STABILITY BANNER-->\n\n| **Reference Documentation**:| <span style=\"font-weight: normal\">https://docs.aws.amazon.com/solutions/latest/constructs/</span>|\n|:-------------|:-------------|\n\n<div style=\"height:8px\"></div>\n\n| **Language** | **Package** |\n|:-------------|-----------------|\n| Python|`aws_solutions_constructs.aws_eventbridge_kinesisstreams`|\n| Typescript|`@aws-solutions-constructs/aws-eventbridge-kinesisstreams`|\n| Java|`software.amazon.awsconstructs.services.eventbridgekinesisstreams`|\n\n## Overview\n\nThis AWS Solutions Construct implements an Amazon EventBridge rule to send data to an Amazon Kinesis Data Stream\n\nHere is a minimal deployable pattern definition:\n\nTypescript\n\n```python\nimport { Construct } from 'constructs';\nimport { Stack, StackProps, Duration } from 'aws-cdk-lib';\nimport { EventbridgeToKinesisStreams, EventbridgeToKinesisStreamsProps } from \"@aws-solutions-constructs/aws-eventbridge-kinesisstreams\";\nimport * as events from 'aws-cdk-lib/aws-events';\n\nconst constructProps: EventbridgeToKinesisStreamsProps = {\n eventRuleProps: {\n schedule: events.Schedule.rate(Duration.minutes(5)),\n }\n};\n\nnew EventbridgeToKinesisStreams(this, 'test-eventbridge-kinesis-streams', constructProps);\n```\n\nPython\n\n```Python\nfrom aws_solutions_constructs.aws_eventbridge_kinesis_streams import EventbridgeToKinesisStreams, EventbridgeToKinesisStreamsProps\nfrom aws_cdk import (\n aws_events as events,\n Duration,\n Stack\n)\nfrom constructs import Construct\n\nEventbridgeToKinesisStreams(self, 'test-eventbridge-kinesis-streams',\n event_rule_props=events.RuleProps(\n schedule=events.Schedule.rate(Duration.minutes(5)),\n ))\n```\n\nJava\n\n```java\nimport software.constructs.Construct;\n\nimport software.amazon.awscdk.Stack;\nimport software.amazon.awscdk.StackProps;\nimport software.amazon.awscdk.Duration;\nimport software.amazon.awscdk.services.events.*;\nimport software.amazon.awsconstructs.services.eventbridgekinesisstreams.*;\n\nnew EventbridgeToKinesisStreams(this, \"test-eventbridge-kinesis-streams\",\n new EventbridgeToKinesisStreamsProps.Builder()\n .eventRuleProps(new RuleProps.Builder()\n .schedule(Schedule.rate(Duration.minutes(5)))\n .build())\n .build());\n```\n\n## Pattern Construct Props\n\n| **Name** | **Type** | **Description** |\n|:-------------|:----------------|-----------------|\n|existingEventBusInterface?|[`events.IEventBus`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_events.IEventBus.html)| Optional user-provided custom EventBus for construct to use. Providing both this and `eventBusProps` results an error.|\n|eventBusProps?|[`events.EventBusProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_events.EventBusProps.html)|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` results an error.|\n|eventRuleProps|[`events.RuleProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_events.RuleProps.html)|User provided eventRuleProps to override the defaults. |\n|existingStreamObj?|[`kinesis.Stream`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_kinesis.Stream.html)|Existing instance of Kinesis Stream, providing both this and `kinesisStreamProps` will cause an error.|\n|kinesisStreamProps?|[`kinesis.StreamProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_kinesis.StreamProps.html)|Optional user-provided props to override the default props for the Kinesis stream. |\n|createCloudWatchAlarms|`boolean`|Whether to create recommended CloudWatch alarms. |\n\n## Pattern Properties\n\n| **Name** | **Type** | **Description** |\n|:-------------|:----------------|-----------------|\n|eventBus?|[`events.IEventBus`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_events.IEventBus.html)|Returns the instance of events.IEventBus used by the construct|\n|eventsRule|[`events.Rule`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_events.Rule.html)|Returns an instance of events.Rule created by the construct.|\n|kinesisStream|[`kinesis.Stream`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_kinesis.Stream.html)|Returns an instance of the Kinesis stream created by the pattern.|\n|eventsRole?|[`iam.Role`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_iam.Role.html)|Returns an instance of the iam.Role created by the construct for events rule.|\n|cloudwatchAlarms?|[`cloudwatch.Alarm[]`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_cloudwatch.Alarm.html)|Returns an instance of the cloudwatch.Alarm[] created by the construct.|\n\n## Default settings\n\nOut of the box implementation of the Construct without any override will set the following defaults:\n\n### Amazon EventBridge Rule\n\n* Configure least privilege access IAM role for EventBridge Rule to publish to the Kinesis Data Stream.\n\n### Amazon Kinesis Stream\n\n* Enable server-side encryption for Kinesis Data Stream using AWS Managed KMS Key.\n\n## Architecture\n\n\n\n---\n\n\n\u00a9 Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "CDK Constructs for deploying Amazon CloudWatch Events Rule that invokes Amazon Kinesis Data Stream",
"version": "2.74.0",
"project_urls": {
"Homepage": "https://github.com/awslabs/aws-solutions-constructs.git",
"Source": "https://github.com/awslabs/aws-solutions-constructs.git"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2d79fccdfbdfdef86edbd5a42206313cb39dc0f79cb50c7d1aa2efd1616662cf",
"md5": "643d5570ab481312f9eb3d8d7c4287b3",
"sha256": "234497a10555e64e05f4a9c1dda191b7026b0adf5aac53e1ad3fdb2e232d3714"
},
"downloads": -1,
"filename": "aws_solutions_constructs.aws_eventbridge_kinesis_streams-2.74.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "643d5570ab481312f9eb3d8d7c4287b3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "~=3.8",
"size": 85616,
"upload_time": "2024-10-22T18:07:33",
"upload_time_iso_8601": "2024-10-22T18:07:33.843821Z",
"url": "https://files.pythonhosted.org/packages/2d/79/fccdfbdfdef86edbd5a42206313cb39dc0f79cb50c7d1aa2efd1616662cf/aws_solutions_constructs.aws_eventbridge_kinesis_streams-2.74.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "912d26034775f35cb81ff34a32dc2ab1ef1a534920bece98ea6e24d4b6b54a18",
"md5": "b391c7bf4bbda02d9cfccec9d77839c1",
"sha256": "11e6b0033497297166876456a96358f020d9db8a069b1fa90e5eef4f9d8fc7cb"
},
"downloads": -1,
"filename": "aws_solutions_constructs_aws_eventbridge_kinesis_streams-2.74.0.tar.gz",
"has_sig": false,
"md5_digest": "b391c7bf4bbda02d9cfccec9d77839c1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "~=3.8",
"size": 86721,
"upload_time": "2024-10-22T18:09:20",
"upload_time_iso_8601": "2024-10-22T18:09:20.752929Z",
"url": "https://files.pythonhosted.org/packages/91/2d/26034775f35cb81ff34a32dc2ab1ef1a534920bece98ea6e24d4b6b54a18/aws_solutions_constructs_aws_eventbridge_kinesis_streams-2.74.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-22 18:09:20",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "awslabs",
"github_project": "aws-solutions-constructs",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "aws-solutions-constructs.aws-eventbridge-kinesis-streams"
}
JSON
