aws-solutions-constructs.aws-iot-kinesisstreams 2.85.1__py3-none-any.whl → 2.85.3__py3-none-any.whl

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.
@@ -1,140 +1,5 @@
1
1
  r'''
2
- # aws-iot-kinesisstreams module
3
-
4
- <!--BEGIN STABILITY BANNER-->---
5
-
6
-
7
- ![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge)
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 Logo](https://docs.aws.amazon.com/cdk/api/latest/img/python32.png) Python|`aws_solutions_constructs.aws_iot_kinesisstreams`|
24
- |![Typescript Logo](https://docs.aws.amazon.com/cdk/api/latest/img/typescript32.png) Typescript|`@aws-solutions-constructs/aws-iot-kinesisstreams`|
25
- |![Java Logo](https://docs.aws.amazon.com/cdk/api/latest/img/java32.png) 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
- ![Architecture Diagram](architecture.png)
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.1",
37
+ "2.85.3",
38
38
  __name__[0:-6],
39
- "aws-iot-kinesisstreams@2.85.1.jsii.tgz",
39
+ "aws-iot-kinesisstreams@2.85.3.jsii.tgz",
40
40
  )
41
41
 
42
42
  __all__ = [
@@ -0,0 +1,28 @@
1
+ Metadata-Version: 2.1
2
+ Name: aws-solutions-constructs.aws-iot-kinesisstreams
3
+ Version: 2.85.3
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.3
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,9 @@
1
+ aws_solutions_constructs/aws_iot_kinesisstreams/__init__.py,sha256=Rl3t6wfkJyC-opNklT9lNlE6F-TTLMd6Io5QuO8SdaE,10857
2
+ aws_solutions_constructs/aws_iot_kinesisstreams/py.typed,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
3
+ aws_solutions_constructs/aws_iot_kinesisstreams/_jsii/__init__.py,sha256=qk3rJJaOGkkBfU2ZdbmdlrXog_-cSSIarRvk4ByEnMs,1539
4
+ aws_solutions_constructs/aws_iot_kinesisstreams/_jsii/aws-iot-kinesisstreams@2.85.3.jsii.tgz,sha256=TrtZLP5uDVHBSnI6HHHnfGv91dYDzLPt_ngs3CNTOao,55319
5
+ aws_solutions_constructs_aws_iot_kinesisstreams-2.85.3.dist-info/LICENSE,sha256=wnT4A3LZDAEpNzcPDh8VCH0i4wjvmLJ86l3A0tCINmw,10279
6
+ aws_solutions_constructs_aws_iot_kinesisstreams-2.85.3.dist-info/METADATA,sha256=gCIQZFpee1Awtd-lPr3eftn5ZpflBDHTLoM2OK9jB94,1285
7
+ aws_solutions_constructs_aws_iot_kinesisstreams-2.85.3.dist-info/WHEEL,sha256=iAkIy5fosb7FzIOwONchHf19Qu7_1wCWyFNR5gu9nU0,91
8
+ aws_solutions_constructs_aws_iot_kinesisstreams-2.85.3.dist-info/top_level.txt,sha256=hi3us_KW7V1ocfOqVsNq1o3w552jCEgu_KsCckqYWsg,25
9
+ aws_solutions_constructs_aws_iot_kinesisstreams-2.85.3.dist-info/RECORD,,
@@ -1,163 +0,0 @@
1
- Metadata-Version: 2.1
2
- Name: aws-solutions-constructs.aws-iot-kinesisstreams
3
- Version: 2.85.1
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.1
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
- ![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge)
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 Logo](https://docs.aws.amazon.com/cdk/api/latest/img/python32.png) Python|`aws_solutions_constructs.aws_iot_kinesisstreams`|
50
- |![Typescript Logo](https://docs.aws.amazon.com/cdk/api/latest/img/typescript32.png) Typescript|`@aws-solutions-constructs/aws-iot-kinesisstreams`|
51
- |![Java Logo](https://docs.aws.amazon.com/cdk/api/latest/img/java32.png) 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
- ![Architecture Diagram](architecture.png)
159
-
160
- ---
161
-
162
-
163
- © Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
@@ -1,9 +0,0 @@
1
- aws_solutions_constructs/aws_iot_kinesisstreams/__init__.py,sha256=wbXhrz1Qi979SF3xe4eWB4sKluuF6s6Z3R3HhbSsrvU,16660
2
- aws_solutions_constructs/aws_iot_kinesisstreams/py.typed,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
3
- aws_solutions_constructs/aws_iot_kinesisstreams/_jsii/__init__.py,sha256=MIIpC1Vza1i-qGUYxgP_mBu7IbhyWvB3PuUcA-JBS-w,1539
4
- aws_solutions_constructs/aws_iot_kinesisstreams/_jsii/aws-iot-kinesisstreams@2.85.1.jsii.tgz,sha256=Mstjd1jv2lBD6PZAWElUmA6l61Jr1ORpZDzl9IzNwjI,56683
5
- aws_solutions_constructs_aws_iot_kinesisstreams-2.85.1.dist-info/LICENSE,sha256=wnT4A3LZDAEpNzcPDh8VCH0i4wjvmLJ86l3A0tCINmw,10279
6
- aws_solutions_constructs_aws_iot_kinesisstreams-2.85.1.dist-info/METADATA,sha256=RSR9Ad5wECHgCHNOFtsscre4Au0ehH1AP9ucCEH5qBE,7088
7
- aws_solutions_constructs_aws_iot_kinesisstreams-2.85.1.dist-info/WHEEL,sha256=iAkIy5fosb7FzIOwONchHf19Qu7_1wCWyFNR5gu9nU0,91
8
- aws_solutions_constructs_aws_iot_kinesisstreams-2.85.1.dist-info/top_level.txt,sha256=hi3us_KW7V1ocfOqVsNq1o3w552jCEgu_KsCckqYWsg,25
9
- aws_solutions_constructs_aws_iot_kinesisstreams-2.85.1.dist-info/RECORD,,