aws-solutions-constructs.aws-iot-kinesisstreams 2.85.2__tar.gz → 2.85.4__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- aws_solutions_constructs_aws_iot_kinesisstreams-2.85.4/PKG-INFO +28 -0
- aws_solutions_constructs_aws_iot_kinesisstreams-2.85.4/README.md +1 -0
- {aws_solutions_constructs_aws_iot_kinesisstreams-2.85.2 → aws_solutions_constructs_aws_iot_kinesisstreams-2.85.4}/setup.py +3 -3
- {aws_solutions_constructs_aws_iot_kinesisstreams-2.85.2 → aws_solutions_constructs_aws_iot_kinesisstreams-2.85.4}/src/aws_solutions_constructs/aws_iot_kinesisstreams/__init__.py +1 -136
- {aws_solutions_constructs_aws_iot_kinesisstreams-2.85.2 → aws_solutions_constructs_aws_iot_kinesisstreams-2.85.4}/src/aws_solutions_constructs/aws_iot_kinesisstreams/_jsii/__init__.py +2 -2
- aws_solutions_constructs_aws_iot_kinesisstreams-2.85.4/src/aws_solutions_constructs/aws_iot_kinesisstreams/_jsii/aws-iot-kinesisstreams@2.85.4.jsii.tgz +0 -0
- aws_solutions_constructs_aws_iot_kinesisstreams-2.85.4/src/aws_solutions_constructs.aws_iot_kinesisstreams.egg-info/PKG-INFO +28 -0
- {aws_solutions_constructs_aws_iot_kinesisstreams-2.85.2 → aws_solutions_constructs_aws_iot_kinesisstreams-2.85.4}/src/aws_solutions_constructs.aws_iot_kinesisstreams.egg-info/SOURCES.txt +1 -1
- {aws_solutions_constructs_aws_iot_kinesisstreams-2.85.2 → aws_solutions_constructs_aws_iot_kinesisstreams-2.85.4}/src/aws_solutions_constructs.aws_iot_kinesisstreams.egg-info/requires.txt +1 -1
- aws_solutions_constructs_aws_iot_kinesisstreams-2.85.2/PKG-INFO +0 -163
- aws_solutions_constructs_aws_iot_kinesisstreams-2.85.2/README.md +0 -136
- aws_solutions_constructs_aws_iot_kinesisstreams-2.85.2/src/aws_solutions_constructs/aws_iot_kinesisstreams/_jsii/aws-iot-kinesisstreams@2.85.2.jsii.tgz +0 -0
- aws_solutions_constructs_aws_iot_kinesisstreams-2.85.2/src/aws_solutions_constructs.aws_iot_kinesisstreams.egg-info/PKG-INFO +0 -163
- {aws_solutions_constructs_aws_iot_kinesisstreams-2.85.2 → aws_solutions_constructs_aws_iot_kinesisstreams-2.85.4}/LICENSE +0 -0
- {aws_solutions_constructs_aws_iot_kinesisstreams-2.85.2 → aws_solutions_constructs_aws_iot_kinesisstreams-2.85.4}/MANIFEST.in +0 -0
- {aws_solutions_constructs_aws_iot_kinesisstreams-2.85.2 → aws_solutions_constructs_aws_iot_kinesisstreams-2.85.4}/pyproject.toml +0 -0
- {aws_solutions_constructs_aws_iot_kinesisstreams-2.85.2 → aws_solutions_constructs_aws_iot_kinesisstreams-2.85.4}/setup.cfg +0 -0
- {aws_solutions_constructs_aws_iot_kinesisstreams-2.85.2 → aws_solutions_constructs_aws_iot_kinesisstreams-2.85.4}/src/aws_solutions_constructs/aws_iot_kinesisstreams/py.typed +0 -0
- {aws_solutions_constructs_aws_iot_kinesisstreams-2.85.2 → aws_solutions_constructs_aws_iot_kinesisstreams-2.85.4}/src/aws_solutions_constructs.aws_iot_kinesisstreams.egg-info/dependency_links.txt +0 -0
- {aws_solutions_constructs_aws_iot_kinesisstreams-2.85.2 → aws_solutions_constructs_aws_iot_kinesisstreams-2.85.4}/src/aws_solutions_constructs.aws_iot_kinesisstreams.egg-info/top_level.txt +0 -0
@@ -0,0 +1,28 @@
|
|
1
|
+
Metadata-Version: 2.1
|
2
|
+
Name: aws-solutions-constructs.aws-iot-kinesisstreams
|
3
|
+
Version: 2.85.4
|
4
|
+
Summary: CDK Constructs for AWS IoT to AWS Kinesis Data Stream.
|
5
|
+
Home-page: https://github.com/awslabs/aws-solutions-constructs.git
|
6
|
+
Author: Amazon Web Services
|
7
|
+
License: Apache-2.0
|
8
|
+
Project-URL: Source, https://github.com/awslabs/aws-solutions-constructs.git
|
9
|
+
Classifier: Intended Audience :: Developers
|
10
|
+
Classifier: Operating System :: OS Independent
|
11
|
+
Classifier: Programming Language :: JavaScript
|
12
|
+
Classifier: Programming Language :: Python :: 3 :: Only
|
13
|
+
Classifier: Programming Language :: Python :: 3.9
|
14
|
+
Classifier: Programming Language :: Python :: 3.10
|
15
|
+
Classifier: Programming Language :: Python :: 3.11
|
16
|
+
Classifier: Typing :: Typed
|
17
|
+
Classifier: License :: OSI Approved
|
18
|
+
Requires-Python: ~=3.9
|
19
|
+
Description-Content-Type: text/markdown
|
20
|
+
License-File: LICENSE
|
21
|
+
Requires-Dist: aws-cdk-lib<3.0.0,>=2.193.0
|
22
|
+
Requires-Dist: aws-solutions-constructs.core==2.85.4
|
23
|
+
Requires-Dist: constructs<11.0.0,>=10.0.0
|
24
|
+
Requires-Dist: jsii<2.0.0,>=1.111.0
|
25
|
+
Requires-Dist: publication>=0.0.3
|
26
|
+
Requires-Dist: typeguard<4.3.0,>=2.13.3
|
27
|
+
|
28
|
+
Documentation for this pattern can be found [here](https://github.com/awslabs/aws-solutions-constructs/blob/main/source/patterns/%40aws-solutions-constructs/aws-iot-kinesisstreams/README.adoc)
|
@@ -0,0 +1 @@
|
|
1
|
+
Documentation for this pattern can be found [here](https://github.com/awslabs/aws-solutions-constructs/blob/main/source/patterns/%40aws-solutions-constructs/aws-iot-kinesisstreams/README.adoc)
|
@@ -5,7 +5,7 @@ kwargs = json.loads(
|
|
5
5
|
"""
|
6
6
|
{
|
7
7
|
"name": "aws-solutions-constructs.aws-iot-kinesisstreams",
|
8
|
-
"version": "2.85.
|
8
|
+
"version": "2.85.4",
|
9
9
|
"description": "CDK Constructs for AWS IoT to AWS Kinesis Data Stream.",
|
10
10
|
"license": "Apache-2.0",
|
11
11
|
"url": "https://github.com/awslabs/aws-solutions-constructs.git",
|
@@ -26,7 +26,7 @@ kwargs = json.loads(
|
|
26
26
|
],
|
27
27
|
"package_data": {
|
28
28
|
"aws_solutions_constructs.aws_iot_kinesisstreams._jsii": [
|
29
|
-
"aws-iot-kinesisstreams@2.85.
|
29
|
+
"aws-iot-kinesisstreams@2.85.4.jsii.tgz"
|
30
30
|
],
|
31
31
|
"aws_solutions_constructs.aws_iot_kinesisstreams": [
|
32
32
|
"py.typed"
|
@@ -35,7 +35,7 @@ kwargs = json.loads(
|
|
35
35
|
"python_requires": "~=3.9",
|
36
36
|
"install_requires": [
|
37
37
|
"aws-cdk-lib>=2.193.0, <3.0.0",
|
38
|
-
"aws-solutions-constructs.core==2.85.
|
38
|
+
"aws-solutions-constructs.core==2.85.4",
|
39
39
|
"constructs>=10.0.0, <11.0.0",
|
40
40
|
"jsii>=1.111.0, <2.0.0",
|
41
41
|
"publication>=0.0.3",
|
@@ -1,140 +1,5 @@
|
|
1
1
|
r'''
|
2
|
-
|
3
|
-
|
4
|
-
<!--BEGIN STABILITY BANNER-->---
|
5
|
-
|
6
|
-
|
7
|
-

|
8
|
-
|
9
|
-
> All classes are under active development and subject to non-backward compatible changes or removal in any
|
10
|
-
> future version. These are not subject to the [Semantic Versioning](https://semver.org/) model.
|
11
|
-
> 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.
|
12
|
-
|
13
|
-
---
|
14
|
-
<!--END STABILITY BANNER-->
|
15
|
-
|
16
|
-
| **Reference Documentation**:| <span style="font-weight: normal">https://docs.aws.amazon.com/solutions/latest/constructs/</span>|
|
17
|
-
|:-------------|:-------------|
|
18
|
-
|
19
|
-
<div style="height:8px"></div>
|
20
|
-
|
21
|
-
| **Language** | **Package** |
|
22
|
-
|:-------------|-----------------|
|
23
|
-
| Python|`aws_solutions_constructs.aws_iot_kinesisstreams`|
|
24
|
-
| Typescript|`@aws-solutions-constructs/aws-iot-kinesisstreams`|
|
25
|
-
| Java|`software.amazon.awsconstructs.services.iotkinesisstreams`|
|
26
|
-
|
27
|
-
## Overview
|
28
|
-
|
29
|
-
This AWS Solutions Construct implements an AWS IoT MQTT topic rule to send data to an Amazon Kinesis Data Stream.
|
30
|
-
|
31
|
-
Here is a minimal deployable pattern definition:
|
32
|
-
|
33
|
-
Typescript
|
34
|
-
|
35
|
-
```python
|
36
|
-
import { Construct } from 'constructs';
|
37
|
-
import { Stack, StackProps } from 'aws-cdk-lib';
|
38
|
-
import { IotToKinesisStreamsProps, IotToKinesisStreams } from '@aws-solutions-constructs/aws-iot-kinesisstreams';
|
39
|
-
|
40
|
-
const constructProps: IotToKinesisStreamsProps = {
|
41
|
-
iotTopicRuleProps: {
|
42
|
-
topicRulePayload: {
|
43
|
-
ruleDisabled: false,
|
44
|
-
description: "Sends data to kinesis data stream",
|
45
|
-
sql: "SELECT * FROM 'solutions/construct'",
|
46
|
-
actions: []
|
47
|
-
}
|
48
|
-
}
|
49
|
-
};
|
50
|
-
|
51
|
-
new IotToKinesisStreams(this, 'test-iot-kinesisstreams', constructProps);
|
52
|
-
```
|
53
|
-
|
54
|
-
Python
|
55
|
-
|
56
|
-
```python
|
57
|
-
from aws_solutions_constructs.aws_iot_kinesisstreams import IotToKinesisStreamsProps, IotToKinesisStreams
|
58
|
-
from aws_cdk import (
|
59
|
-
aws_iot as iot,
|
60
|
-
Stack
|
61
|
-
)
|
62
|
-
from constructs import Construct
|
63
|
-
|
64
|
-
IotToKinesisStreams(self, 'test-iot-kinesisstreams',
|
65
|
-
iot_topic_rule_props=iot.CfnTopicRuleProps(
|
66
|
-
topic_rule_payload=iot.CfnTopicRule.TopicRulePayloadProperty(
|
67
|
-
rule_disabled=False,
|
68
|
-
description="Sends data to kinesis data stream",
|
69
|
-
sql="SELECT * FROM 'solutions/construct'",
|
70
|
-
actions=[]
|
71
|
-
)
|
72
|
-
))
|
73
|
-
```
|
74
|
-
|
75
|
-
Java
|
76
|
-
|
77
|
-
```java
|
78
|
-
import software.constructs.Construct;
|
79
|
-
import java.util.List;
|
80
|
-
|
81
|
-
import software.amazon.awscdk.Stack;
|
82
|
-
import software.amazon.awscdk.StackProps;
|
83
|
-
import software.amazon.awscdk.services.iot.*;
|
84
|
-
import software.amazon.awscdk.services.iot.CfnTopicRule.TopicRulePayloadProperty;
|
85
|
-
import software.amazon.awsconstructs.services.iotkinesisstreams.*;
|
86
|
-
|
87
|
-
new IotToKinesisStreams(this, "test-iot-kinesisstreams", new IotToKinesisStreamsProps.Builder()
|
88
|
-
.iotTopicRuleProps(new CfnTopicRuleProps.Builder()
|
89
|
-
.topicRulePayload(new TopicRulePayloadProperty.Builder()
|
90
|
-
.ruleDisabled(false)
|
91
|
-
.description("Sends data to kinesis data stream")
|
92
|
-
.sql("SELECT * FROM 'solutions/construct'")
|
93
|
-
.actions(List.of())
|
94
|
-
.build())
|
95
|
-
.build())
|
96
|
-
.build());
|
97
|
-
```
|
98
|
-
|
99
|
-
## Pattern Construct Props
|
100
|
-
|
101
|
-
| **Name** | **Type** | **Description** |
|
102
|
-
|:-------------|:----------------|-----------------|
|
103
|
-
|iotTopicRuleProps|[`iot.CfnTopicRuleProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_iot.CfnTopicRuleProps.html)|User provided CfnTopicRuleProps to override the defaults|
|
104
|
-
|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.|
|
105
|
-
|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 data stream, providing both this and `existingStreamObj` will cause an error|
|
106
|
-
|createCloudWatchAlarms|`boolean`|Whether to create recommended CloudWatch alarms for Kinesis Data Stream. Default value is set to `true`|
|
107
|
-
|
108
|
-
## Pattern Properties
|
109
|
-
|
110
|
-
| **Name** | **Type** | **Description** |
|
111
|
-
|:-------------|:----------------|-----------------|
|
112
|
-
|iotTopicRule|[`iot.CfnTopicRule`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_iot.CfnTopicRule.html)|Returns an instance of iot.CfnTopicRule created by the construct|
|
113
|
-
|iotActionsRole|[`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 IoT Rule|
|
114
|
-
|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 construct.|
|
115
|
-
|cloudwatchAlarms?|[`cloudwatch.Alarm[]`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_cloudwatch.Alarm.html)|Returns an array of recommended CloudWatch Alarms created by the construct for Kinesis Data stream|
|
116
|
-
|
117
|
-
## Default settings
|
118
|
-
|
119
|
-
Out of the box implementation of the Construct without any override will set the following defaults:
|
120
|
-
|
121
|
-
### Amazon IoT Rule
|
122
|
-
|
123
|
-
* Configure least privilege access IAM role for Amazon IoT Rule
|
124
|
-
|
125
|
-
### Amazon Kinesis Data Stream
|
126
|
-
|
127
|
-
* Configure recommended CloudWatch Alarms for Amazon Kinesis Data Stream
|
128
|
-
* Configure least privilege access IAM role for Amazon Kinesis Data Stream
|
129
|
-
|
130
|
-
## Architecture
|
131
|
-
|
132
|
-

|
133
|
-
|
134
|
-
---
|
135
|
-
|
136
|
-
|
137
|
-
© Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
2
|
+
Documentation for this pattern can be found [here](https://github.com/awslabs/aws-solutions-constructs/blob/main/source/patterns/%40aws-solutions-constructs/aws-iot-kinesisstreams/README.adoc)
|
138
3
|
'''
|
139
4
|
from pkgutil import extend_path
|
140
5
|
__path__ = extend_path(__path__, __name__)
|
@@ -34,9 +34,9 @@ import constructs._jsii
|
|
34
34
|
|
35
35
|
__jsii_assembly__ = jsii.JSIIAssembly.load(
|
36
36
|
"@aws-solutions-constructs/aws-iot-kinesisstreams",
|
37
|
-
"2.85.
|
37
|
+
"2.85.4",
|
38
38
|
__name__[0:-6],
|
39
|
-
"aws-iot-kinesisstreams@2.85.
|
39
|
+
"aws-iot-kinesisstreams@2.85.4.jsii.tgz",
|
40
40
|
)
|
41
41
|
|
42
42
|
__all__ = [
|
Binary file
|
@@ -0,0 +1,28 @@
|
|
1
|
+
Metadata-Version: 2.1
|
2
|
+
Name: aws-solutions-constructs.aws-iot-kinesisstreams
|
3
|
+
Version: 2.85.4
|
4
|
+
Summary: CDK Constructs for AWS IoT to AWS Kinesis Data Stream.
|
5
|
+
Home-page: https://github.com/awslabs/aws-solutions-constructs.git
|
6
|
+
Author: Amazon Web Services
|
7
|
+
License: Apache-2.0
|
8
|
+
Project-URL: Source, https://github.com/awslabs/aws-solutions-constructs.git
|
9
|
+
Classifier: Intended Audience :: Developers
|
10
|
+
Classifier: Operating System :: OS Independent
|
11
|
+
Classifier: Programming Language :: JavaScript
|
12
|
+
Classifier: Programming Language :: Python :: 3 :: Only
|
13
|
+
Classifier: Programming Language :: Python :: 3.9
|
14
|
+
Classifier: Programming Language :: Python :: 3.10
|
15
|
+
Classifier: Programming Language :: Python :: 3.11
|
16
|
+
Classifier: Typing :: Typed
|
17
|
+
Classifier: License :: OSI Approved
|
18
|
+
Requires-Python: ~=3.9
|
19
|
+
Description-Content-Type: text/markdown
|
20
|
+
License-File: LICENSE
|
21
|
+
Requires-Dist: aws-cdk-lib<3.0.0,>=2.193.0
|
22
|
+
Requires-Dist: aws-solutions-constructs.core==2.85.4
|
23
|
+
Requires-Dist: constructs<11.0.0,>=10.0.0
|
24
|
+
Requires-Dist: jsii<2.0.0,>=1.111.0
|
25
|
+
Requires-Dist: publication>=0.0.3
|
26
|
+
Requires-Dist: typeguard<4.3.0,>=2.13.3
|
27
|
+
|
28
|
+
Documentation for this pattern can be found [here](https://github.com/awslabs/aws-solutions-constructs/blob/main/source/patterns/%40aws-solutions-constructs/aws-iot-kinesisstreams/README.adoc)
|
@@ -11,4 +11,4 @@ src/aws_solutions_constructs.aws_iot_kinesisstreams.egg-info/top_level.txt
|
|
11
11
|
src/aws_solutions_constructs/aws_iot_kinesisstreams/__init__.py
|
12
12
|
src/aws_solutions_constructs/aws_iot_kinesisstreams/py.typed
|
13
13
|
src/aws_solutions_constructs/aws_iot_kinesisstreams/_jsii/__init__.py
|
14
|
-
src/aws_solutions_constructs/aws_iot_kinesisstreams/_jsii/aws-iot-kinesisstreams@2.85.
|
14
|
+
src/aws_solutions_constructs/aws_iot_kinesisstreams/_jsii/aws-iot-kinesisstreams@2.85.4.jsii.tgz
|
@@ -1,163 +0,0 @@
|
|
1
|
-
Metadata-Version: 2.1
|
2
|
-
Name: aws-solutions-constructs.aws-iot-kinesisstreams
|
3
|
-
Version: 2.85.2
|
4
|
-
Summary: CDK Constructs for AWS IoT to AWS Kinesis Data Stream.
|
5
|
-
Home-page: https://github.com/awslabs/aws-solutions-constructs.git
|
6
|
-
Author: Amazon Web Services
|
7
|
-
License: Apache-2.0
|
8
|
-
Project-URL: Source, https://github.com/awslabs/aws-solutions-constructs.git
|
9
|
-
Classifier: Intended Audience :: Developers
|
10
|
-
Classifier: Operating System :: OS Independent
|
11
|
-
Classifier: Programming Language :: JavaScript
|
12
|
-
Classifier: Programming Language :: Python :: 3 :: Only
|
13
|
-
Classifier: Programming Language :: Python :: 3.9
|
14
|
-
Classifier: Programming Language :: Python :: 3.10
|
15
|
-
Classifier: Programming Language :: Python :: 3.11
|
16
|
-
Classifier: Typing :: Typed
|
17
|
-
Classifier: License :: OSI Approved
|
18
|
-
Requires-Python: ~=3.9
|
19
|
-
Description-Content-Type: text/markdown
|
20
|
-
License-File: LICENSE
|
21
|
-
Requires-Dist: aws-cdk-lib<3.0.0,>=2.193.0
|
22
|
-
Requires-Dist: aws-solutions-constructs.core==2.85.2
|
23
|
-
Requires-Dist: constructs<11.0.0,>=10.0.0
|
24
|
-
Requires-Dist: jsii<2.0.0,>=1.111.0
|
25
|
-
Requires-Dist: publication>=0.0.3
|
26
|
-
Requires-Dist: typeguard<4.3.0,>=2.13.3
|
27
|
-
|
28
|
-
# aws-iot-kinesisstreams module
|
29
|
-
|
30
|
-
<!--BEGIN STABILITY BANNER-->---
|
31
|
-
|
32
|
-
|
33
|
-

|
34
|
-
|
35
|
-
> All classes are under active development and subject to non-backward compatible changes or removal in any
|
36
|
-
> future version. These are not subject to the [Semantic Versioning](https://semver.org/) model.
|
37
|
-
> 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.
|
38
|
-
|
39
|
-
---
|
40
|
-
<!--END STABILITY BANNER-->
|
41
|
-
|
42
|
-
| **Reference Documentation**:| <span style="font-weight: normal">https://docs.aws.amazon.com/solutions/latest/constructs/</span>|
|
43
|
-
|:-------------|:-------------|
|
44
|
-
|
45
|
-
<div style="height:8px"></div>
|
46
|
-
|
47
|
-
| **Language** | **Package** |
|
48
|
-
|:-------------|-----------------|
|
49
|
-
| Python|`aws_solutions_constructs.aws_iot_kinesisstreams`|
|
50
|
-
| Typescript|`@aws-solutions-constructs/aws-iot-kinesisstreams`|
|
51
|
-
| Java|`software.amazon.awsconstructs.services.iotkinesisstreams`|
|
52
|
-
|
53
|
-
## Overview
|
54
|
-
|
55
|
-
This AWS Solutions Construct implements an AWS IoT MQTT topic rule to send data to an Amazon Kinesis Data Stream.
|
56
|
-
|
57
|
-
Here is a minimal deployable pattern definition:
|
58
|
-
|
59
|
-
Typescript
|
60
|
-
|
61
|
-
```python
|
62
|
-
import { Construct } from 'constructs';
|
63
|
-
import { Stack, StackProps } from 'aws-cdk-lib';
|
64
|
-
import { IotToKinesisStreamsProps, IotToKinesisStreams } from '@aws-solutions-constructs/aws-iot-kinesisstreams';
|
65
|
-
|
66
|
-
const constructProps: IotToKinesisStreamsProps = {
|
67
|
-
iotTopicRuleProps: {
|
68
|
-
topicRulePayload: {
|
69
|
-
ruleDisabled: false,
|
70
|
-
description: "Sends data to kinesis data stream",
|
71
|
-
sql: "SELECT * FROM 'solutions/construct'",
|
72
|
-
actions: []
|
73
|
-
}
|
74
|
-
}
|
75
|
-
};
|
76
|
-
|
77
|
-
new IotToKinesisStreams(this, 'test-iot-kinesisstreams', constructProps);
|
78
|
-
```
|
79
|
-
|
80
|
-
Python
|
81
|
-
|
82
|
-
```python
|
83
|
-
from aws_solutions_constructs.aws_iot_kinesisstreams import IotToKinesisStreamsProps, IotToKinesisStreams
|
84
|
-
from aws_cdk import (
|
85
|
-
aws_iot as iot,
|
86
|
-
Stack
|
87
|
-
)
|
88
|
-
from constructs import Construct
|
89
|
-
|
90
|
-
IotToKinesisStreams(self, 'test-iot-kinesisstreams',
|
91
|
-
iot_topic_rule_props=iot.CfnTopicRuleProps(
|
92
|
-
topic_rule_payload=iot.CfnTopicRule.TopicRulePayloadProperty(
|
93
|
-
rule_disabled=False,
|
94
|
-
description="Sends data to kinesis data stream",
|
95
|
-
sql="SELECT * FROM 'solutions/construct'",
|
96
|
-
actions=[]
|
97
|
-
)
|
98
|
-
))
|
99
|
-
```
|
100
|
-
|
101
|
-
Java
|
102
|
-
|
103
|
-
```java
|
104
|
-
import software.constructs.Construct;
|
105
|
-
import java.util.List;
|
106
|
-
|
107
|
-
import software.amazon.awscdk.Stack;
|
108
|
-
import software.amazon.awscdk.StackProps;
|
109
|
-
import software.amazon.awscdk.services.iot.*;
|
110
|
-
import software.amazon.awscdk.services.iot.CfnTopicRule.TopicRulePayloadProperty;
|
111
|
-
import software.amazon.awsconstructs.services.iotkinesisstreams.*;
|
112
|
-
|
113
|
-
new IotToKinesisStreams(this, "test-iot-kinesisstreams", new IotToKinesisStreamsProps.Builder()
|
114
|
-
.iotTopicRuleProps(new CfnTopicRuleProps.Builder()
|
115
|
-
.topicRulePayload(new TopicRulePayloadProperty.Builder()
|
116
|
-
.ruleDisabled(false)
|
117
|
-
.description("Sends data to kinesis data stream")
|
118
|
-
.sql("SELECT * FROM 'solutions/construct'")
|
119
|
-
.actions(List.of())
|
120
|
-
.build())
|
121
|
-
.build())
|
122
|
-
.build());
|
123
|
-
```
|
124
|
-
|
125
|
-
## Pattern Construct Props
|
126
|
-
|
127
|
-
| **Name** | **Type** | **Description** |
|
128
|
-
|:-------------|:----------------|-----------------|
|
129
|
-
|iotTopicRuleProps|[`iot.CfnTopicRuleProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_iot.CfnTopicRuleProps.html)|User provided CfnTopicRuleProps to override the defaults|
|
130
|
-
|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.|
|
131
|
-
|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 data stream, providing both this and `existingStreamObj` will cause an error|
|
132
|
-
|createCloudWatchAlarms|`boolean`|Whether to create recommended CloudWatch alarms for Kinesis Data Stream. Default value is set to `true`|
|
133
|
-
|
134
|
-
## Pattern Properties
|
135
|
-
|
136
|
-
| **Name** | **Type** | **Description** |
|
137
|
-
|:-------------|:----------------|-----------------|
|
138
|
-
|iotTopicRule|[`iot.CfnTopicRule`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_iot.CfnTopicRule.html)|Returns an instance of iot.CfnTopicRule created by the construct|
|
139
|
-
|iotActionsRole|[`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 IoT Rule|
|
140
|
-
|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 construct.|
|
141
|
-
|cloudwatchAlarms?|[`cloudwatch.Alarm[]`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_cloudwatch.Alarm.html)|Returns an array of recommended CloudWatch Alarms created by the construct for Kinesis Data stream|
|
142
|
-
|
143
|
-
## Default settings
|
144
|
-
|
145
|
-
Out of the box implementation of the Construct without any override will set the following defaults:
|
146
|
-
|
147
|
-
### Amazon IoT Rule
|
148
|
-
|
149
|
-
* Configure least privilege access IAM role for Amazon IoT Rule
|
150
|
-
|
151
|
-
### Amazon Kinesis Data Stream
|
152
|
-
|
153
|
-
* Configure recommended CloudWatch Alarms for Amazon Kinesis Data Stream
|
154
|
-
* Configure least privilege access IAM role for Amazon Kinesis Data Stream
|
155
|
-
|
156
|
-
## Architecture
|
157
|
-
|
158
|
-

|
159
|
-
|
160
|
-
---
|
161
|
-
|
162
|
-
|
163
|
-
© Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
@@ -1,136 +0,0 @@
|
|
1
|
-
# aws-iot-kinesisstreams module
|
2
|
-
|
3
|
-
<!--BEGIN STABILITY BANNER-->---
|
4
|
-
|
5
|
-
|
6
|
-

|
7
|
-
|
8
|
-
> All classes are under active development and subject to non-backward compatible changes or removal in any
|
9
|
-
> future version. These are not subject to the [Semantic Versioning](https://semver.org/) model.
|
10
|
-
> 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.
|
11
|
-
|
12
|
-
---
|
13
|
-
<!--END STABILITY BANNER-->
|
14
|
-
|
15
|
-
| **Reference Documentation**:| <span style="font-weight: normal">https://docs.aws.amazon.com/solutions/latest/constructs/</span>|
|
16
|
-
|:-------------|:-------------|
|
17
|
-
|
18
|
-
<div style="height:8px"></div>
|
19
|
-
|
20
|
-
| **Language** | **Package** |
|
21
|
-
|:-------------|-----------------|
|
22
|
-
| Python|`aws_solutions_constructs.aws_iot_kinesisstreams`|
|
23
|
-
| Typescript|`@aws-solutions-constructs/aws-iot-kinesisstreams`|
|
24
|
-
| Java|`software.amazon.awsconstructs.services.iotkinesisstreams`|
|
25
|
-
|
26
|
-
## Overview
|
27
|
-
|
28
|
-
This AWS Solutions Construct implements an AWS IoT MQTT topic rule to send data to an Amazon Kinesis Data Stream.
|
29
|
-
|
30
|
-
Here is a minimal deployable pattern definition:
|
31
|
-
|
32
|
-
Typescript
|
33
|
-
|
34
|
-
```python
|
35
|
-
import { Construct } from 'constructs';
|
36
|
-
import { Stack, StackProps } from 'aws-cdk-lib';
|
37
|
-
import { IotToKinesisStreamsProps, IotToKinesisStreams } from '@aws-solutions-constructs/aws-iot-kinesisstreams';
|
38
|
-
|
39
|
-
const constructProps: IotToKinesisStreamsProps = {
|
40
|
-
iotTopicRuleProps: {
|
41
|
-
topicRulePayload: {
|
42
|
-
ruleDisabled: false,
|
43
|
-
description: "Sends data to kinesis data stream",
|
44
|
-
sql: "SELECT * FROM 'solutions/construct'",
|
45
|
-
actions: []
|
46
|
-
}
|
47
|
-
}
|
48
|
-
};
|
49
|
-
|
50
|
-
new IotToKinesisStreams(this, 'test-iot-kinesisstreams', constructProps);
|
51
|
-
```
|
52
|
-
|
53
|
-
Python
|
54
|
-
|
55
|
-
```python
|
56
|
-
from aws_solutions_constructs.aws_iot_kinesisstreams import IotToKinesisStreamsProps, IotToKinesisStreams
|
57
|
-
from aws_cdk import (
|
58
|
-
aws_iot as iot,
|
59
|
-
Stack
|
60
|
-
)
|
61
|
-
from constructs import Construct
|
62
|
-
|
63
|
-
IotToKinesisStreams(self, 'test-iot-kinesisstreams',
|
64
|
-
iot_topic_rule_props=iot.CfnTopicRuleProps(
|
65
|
-
topic_rule_payload=iot.CfnTopicRule.TopicRulePayloadProperty(
|
66
|
-
rule_disabled=False,
|
67
|
-
description="Sends data to kinesis data stream",
|
68
|
-
sql="SELECT * FROM 'solutions/construct'",
|
69
|
-
actions=[]
|
70
|
-
)
|
71
|
-
))
|
72
|
-
```
|
73
|
-
|
74
|
-
Java
|
75
|
-
|
76
|
-
```java
|
77
|
-
import software.constructs.Construct;
|
78
|
-
import java.util.List;
|
79
|
-
|
80
|
-
import software.amazon.awscdk.Stack;
|
81
|
-
import software.amazon.awscdk.StackProps;
|
82
|
-
import software.amazon.awscdk.services.iot.*;
|
83
|
-
import software.amazon.awscdk.services.iot.CfnTopicRule.TopicRulePayloadProperty;
|
84
|
-
import software.amazon.awsconstructs.services.iotkinesisstreams.*;
|
85
|
-
|
86
|
-
new IotToKinesisStreams(this, "test-iot-kinesisstreams", new IotToKinesisStreamsProps.Builder()
|
87
|
-
.iotTopicRuleProps(new CfnTopicRuleProps.Builder()
|
88
|
-
.topicRulePayload(new TopicRulePayloadProperty.Builder()
|
89
|
-
.ruleDisabled(false)
|
90
|
-
.description("Sends data to kinesis data stream")
|
91
|
-
.sql("SELECT * FROM 'solutions/construct'")
|
92
|
-
.actions(List.of())
|
93
|
-
.build())
|
94
|
-
.build())
|
95
|
-
.build());
|
96
|
-
```
|
97
|
-
|
98
|
-
## Pattern Construct Props
|
99
|
-
|
100
|
-
| **Name** | **Type** | **Description** |
|
101
|
-
|:-------------|:----------------|-----------------|
|
102
|
-
|iotTopicRuleProps|[`iot.CfnTopicRuleProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_iot.CfnTopicRuleProps.html)|User provided CfnTopicRuleProps to override the defaults|
|
103
|
-
|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.|
|
104
|
-
|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 data stream, providing both this and `existingStreamObj` will cause an error|
|
105
|
-
|createCloudWatchAlarms|`boolean`|Whether to create recommended CloudWatch alarms for Kinesis Data Stream. Default value is set to `true`|
|
106
|
-
|
107
|
-
## Pattern Properties
|
108
|
-
|
109
|
-
| **Name** | **Type** | **Description** |
|
110
|
-
|:-------------|:----------------|-----------------|
|
111
|
-
|iotTopicRule|[`iot.CfnTopicRule`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_iot.CfnTopicRule.html)|Returns an instance of iot.CfnTopicRule created by the construct|
|
112
|
-
|iotActionsRole|[`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 IoT Rule|
|
113
|
-
|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 construct.|
|
114
|
-
|cloudwatchAlarms?|[`cloudwatch.Alarm[]`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_cloudwatch.Alarm.html)|Returns an array of recommended CloudWatch Alarms created by the construct for Kinesis Data stream|
|
115
|
-
|
116
|
-
## Default settings
|
117
|
-
|
118
|
-
Out of the box implementation of the Construct without any override will set the following defaults:
|
119
|
-
|
120
|
-
### Amazon IoT Rule
|
121
|
-
|
122
|
-
* Configure least privilege access IAM role for Amazon IoT Rule
|
123
|
-
|
124
|
-
### Amazon Kinesis Data Stream
|
125
|
-
|
126
|
-
* Configure recommended CloudWatch Alarms for Amazon Kinesis Data Stream
|
127
|
-
* Configure least privilege access IAM role for Amazon Kinesis Data Stream
|
128
|
-
|
129
|
-
## Architecture
|
130
|
-
|
131
|
-

|
132
|
-
|
133
|
-
---
|
134
|
-
|
135
|
-
|
136
|
-
© Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
Binary file
|
@@ -1,163 +0,0 @@
|
|
1
|
-
Metadata-Version: 2.1
|
2
|
-
Name: aws-solutions-constructs.aws-iot-kinesisstreams
|
3
|
-
Version: 2.85.2
|
4
|
-
Summary: CDK Constructs for AWS IoT to AWS Kinesis Data Stream.
|
5
|
-
Home-page: https://github.com/awslabs/aws-solutions-constructs.git
|
6
|
-
Author: Amazon Web Services
|
7
|
-
License: Apache-2.0
|
8
|
-
Project-URL: Source, https://github.com/awslabs/aws-solutions-constructs.git
|
9
|
-
Classifier: Intended Audience :: Developers
|
10
|
-
Classifier: Operating System :: OS Independent
|
11
|
-
Classifier: Programming Language :: JavaScript
|
12
|
-
Classifier: Programming Language :: Python :: 3 :: Only
|
13
|
-
Classifier: Programming Language :: Python :: 3.9
|
14
|
-
Classifier: Programming Language :: Python :: 3.10
|
15
|
-
Classifier: Programming Language :: Python :: 3.11
|
16
|
-
Classifier: Typing :: Typed
|
17
|
-
Classifier: License :: OSI Approved
|
18
|
-
Requires-Python: ~=3.9
|
19
|
-
Description-Content-Type: text/markdown
|
20
|
-
License-File: LICENSE
|
21
|
-
Requires-Dist: aws-cdk-lib<3.0.0,>=2.193.0
|
22
|
-
Requires-Dist: aws-solutions-constructs.core==2.85.2
|
23
|
-
Requires-Dist: constructs<11.0.0,>=10.0.0
|
24
|
-
Requires-Dist: jsii<2.0.0,>=1.111.0
|
25
|
-
Requires-Dist: publication>=0.0.3
|
26
|
-
Requires-Dist: typeguard<4.3.0,>=2.13.3
|
27
|
-
|
28
|
-
# aws-iot-kinesisstreams module
|
29
|
-
|
30
|
-
<!--BEGIN STABILITY BANNER-->---
|
31
|
-
|
32
|
-
|
33
|
-

|
34
|
-
|
35
|
-
> All classes are under active development and subject to non-backward compatible changes or removal in any
|
36
|
-
> future version. These are not subject to the [Semantic Versioning](https://semver.org/) model.
|
37
|
-
> 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.
|
38
|
-
|
39
|
-
---
|
40
|
-
<!--END STABILITY BANNER-->
|
41
|
-
|
42
|
-
| **Reference Documentation**:| <span style="font-weight: normal">https://docs.aws.amazon.com/solutions/latest/constructs/</span>|
|
43
|
-
|:-------------|:-------------|
|
44
|
-
|
45
|
-
<div style="height:8px"></div>
|
46
|
-
|
47
|
-
| **Language** | **Package** |
|
48
|
-
|:-------------|-----------------|
|
49
|
-
| Python|`aws_solutions_constructs.aws_iot_kinesisstreams`|
|
50
|
-
| Typescript|`@aws-solutions-constructs/aws-iot-kinesisstreams`|
|
51
|
-
| Java|`software.amazon.awsconstructs.services.iotkinesisstreams`|
|
52
|
-
|
53
|
-
## Overview
|
54
|
-
|
55
|
-
This AWS Solutions Construct implements an AWS IoT MQTT topic rule to send data to an Amazon Kinesis Data Stream.
|
56
|
-
|
57
|
-
Here is a minimal deployable pattern definition:
|
58
|
-
|
59
|
-
Typescript
|
60
|
-
|
61
|
-
```python
|
62
|
-
import { Construct } from 'constructs';
|
63
|
-
import { Stack, StackProps } from 'aws-cdk-lib';
|
64
|
-
import { IotToKinesisStreamsProps, IotToKinesisStreams } from '@aws-solutions-constructs/aws-iot-kinesisstreams';
|
65
|
-
|
66
|
-
const constructProps: IotToKinesisStreamsProps = {
|
67
|
-
iotTopicRuleProps: {
|
68
|
-
topicRulePayload: {
|
69
|
-
ruleDisabled: false,
|
70
|
-
description: "Sends data to kinesis data stream",
|
71
|
-
sql: "SELECT * FROM 'solutions/construct'",
|
72
|
-
actions: []
|
73
|
-
}
|
74
|
-
}
|
75
|
-
};
|
76
|
-
|
77
|
-
new IotToKinesisStreams(this, 'test-iot-kinesisstreams', constructProps);
|
78
|
-
```
|
79
|
-
|
80
|
-
Python
|
81
|
-
|
82
|
-
```python
|
83
|
-
from aws_solutions_constructs.aws_iot_kinesisstreams import IotToKinesisStreamsProps, IotToKinesisStreams
|
84
|
-
from aws_cdk import (
|
85
|
-
aws_iot as iot,
|
86
|
-
Stack
|
87
|
-
)
|
88
|
-
from constructs import Construct
|
89
|
-
|
90
|
-
IotToKinesisStreams(self, 'test-iot-kinesisstreams',
|
91
|
-
iot_topic_rule_props=iot.CfnTopicRuleProps(
|
92
|
-
topic_rule_payload=iot.CfnTopicRule.TopicRulePayloadProperty(
|
93
|
-
rule_disabled=False,
|
94
|
-
description="Sends data to kinesis data stream",
|
95
|
-
sql="SELECT * FROM 'solutions/construct'",
|
96
|
-
actions=[]
|
97
|
-
)
|
98
|
-
))
|
99
|
-
```
|
100
|
-
|
101
|
-
Java
|
102
|
-
|
103
|
-
```java
|
104
|
-
import software.constructs.Construct;
|
105
|
-
import java.util.List;
|
106
|
-
|
107
|
-
import software.amazon.awscdk.Stack;
|
108
|
-
import software.amazon.awscdk.StackProps;
|
109
|
-
import software.amazon.awscdk.services.iot.*;
|
110
|
-
import software.amazon.awscdk.services.iot.CfnTopicRule.TopicRulePayloadProperty;
|
111
|
-
import software.amazon.awsconstructs.services.iotkinesisstreams.*;
|
112
|
-
|
113
|
-
new IotToKinesisStreams(this, "test-iot-kinesisstreams", new IotToKinesisStreamsProps.Builder()
|
114
|
-
.iotTopicRuleProps(new CfnTopicRuleProps.Builder()
|
115
|
-
.topicRulePayload(new TopicRulePayloadProperty.Builder()
|
116
|
-
.ruleDisabled(false)
|
117
|
-
.description("Sends data to kinesis data stream")
|
118
|
-
.sql("SELECT * FROM 'solutions/construct'")
|
119
|
-
.actions(List.of())
|
120
|
-
.build())
|
121
|
-
.build())
|
122
|
-
.build());
|
123
|
-
```
|
124
|
-
|
125
|
-
## Pattern Construct Props
|
126
|
-
|
127
|
-
| **Name** | **Type** | **Description** |
|
128
|
-
|:-------------|:----------------|-----------------|
|
129
|
-
|iotTopicRuleProps|[`iot.CfnTopicRuleProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_iot.CfnTopicRuleProps.html)|User provided CfnTopicRuleProps to override the defaults|
|
130
|
-
|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.|
|
131
|
-
|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 data stream, providing both this and `existingStreamObj` will cause an error|
|
132
|
-
|createCloudWatchAlarms|`boolean`|Whether to create recommended CloudWatch alarms for Kinesis Data Stream. Default value is set to `true`|
|
133
|
-
|
134
|
-
## Pattern Properties
|
135
|
-
|
136
|
-
| **Name** | **Type** | **Description** |
|
137
|
-
|:-------------|:----------------|-----------------|
|
138
|
-
|iotTopicRule|[`iot.CfnTopicRule`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_iot.CfnTopicRule.html)|Returns an instance of iot.CfnTopicRule created by the construct|
|
139
|
-
|iotActionsRole|[`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 IoT Rule|
|
140
|
-
|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 construct.|
|
141
|
-
|cloudwatchAlarms?|[`cloudwatch.Alarm[]`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_cloudwatch.Alarm.html)|Returns an array of recommended CloudWatch Alarms created by the construct for Kinesis Data stream|
|
142
|
-
|
143
|
-
## Default settings
|
144
|
-
|
145
|
-
Out of the box implementation of the Construct without any override will set the following defaults:
|
146
|
-
|
147
|
-
### Amazon IoT Rule
|
148
|
-
|
149
|
-
* Configure least privilege access IAM role for Amazon IoT Rule
|
150
|
-
|
151
|
-
### Amazon Kinesis Data Stream
|
152
|
-
|
153
|
-
* Configure recommended CloudWatch Alarms for Amazon Kinesis Data Stream
|
154
|
-
* Configure least privilege access IAM role for Amazon Kinesis Data Stream
|
155
|
-
|
156
|
-
## Architecture
|
157
|
-
|
158
|
-

|
159
|
-
|
160
|
-
---
|
161
|
-
|
162
|
-
|
163
|
-
© Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|