aws-solutions-constructs.aws-iot-sqs 2.85.2__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.
- aws_solutions_constructs/aws_iot_sqs/__init__.py +1 -147
- aws_solutions_constructs/aws_iot_sqs/_jsii/__init__.py +2 -2
- aws_solutions_constructs/aws_iot_sqs/_jsii/aws-iot-sqs@2.85.3.jsii.tgz +0 -0
- aws_solutions_constructs_aws_iot_sqs-2.85.3.dist-info/METADATA +28 -0
- aws_solutions_constructs_aws_iot_sqs-2.85.3.dist-info/RECORD +9 -0
- aws_solutions_constructs/aws_iot_sqs/_jsii/aws-iot-sqs@2.85.2.jsii.tgz +0 -0
- aws_solutions_constructs_aws_iot_sqs-2.85.2.dist-info/METADATA +0 -174
- aws_solutions_constructs_aws_iot_sqs-2.85.2.dist-info/RECORD +0 -9
- {aws_solutions_constructs_aws_iot_sqs-2.85.2.dist-info → aws_solutions_constructs_aws_iot_sqs-2.85.3.dist-info}/LICENSE +0 -0
- {aws_solutions_constructs_aws_iot_sqs-2.85.2.dist-info → aws_solutions_constructs_aws_iot_sqs-2.85.3.dist-info}/WHEEL +0 -0
- {aws_solutions_constructs_aws_iot_sqs-2.85.2.dist-info → aws_solutions_constructs_aws_iot_sqs-2.85.3.dist-info}/top_level.txt +0 -0
|
@@ -1,151 +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_sqs`|
|
|
24
|
-
| Typescript|`@aws-solutions-constructs/aws-iot-sqs`|
|
|
25
|
-
| Java|`software.amazon.awsconstructs.services.iotsqs`|
|
|
26
|
-
|
|
27
|
-
## Overview
|
|
28
|
-
|
|
29
|
-
This AWS Solutions Construct implements an AWS IoT MQTT topic rule and an AWS SQS Queue pattern.
|
|
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 { IotToSqsProps, IotToSqs } from '@aws-solutions-constructs/aws-iot-sqs';
|
|
39
|
-
|
|
40
|
-
const constructProps: IotToSqsProps = {
|
|
41
|
-
iotTopicRuleProps: {
|
|
42
|
-
topicRulePayload: {
|
|
43
|
-
ruleDisabled: false,
|
|
44
|
-
description: "Testing the IotToSqs Pattern",
|
|
45
|
-
sql: "SELECT * FROM 'iot/sqs/#'",
|
|
46
|
-
actions: []
|
|
47
|
-
}
|
|
48
|
-
}
|
|
49
|
-
};
|
|
50
|
-
|
|
51
|
-
new IotToSqs(this, 'test-iot-sqs-integration', constructProps);
|
|
52
|
-
```
|
|
53
|
-
|
|
54
|
-
Python
|
|
55
|
-
|
|
56
|
-
```python
|
|
57
|
-
from aws_solutions_constructs.aws_iot_sqs import IotToSqs
|
|
58
|
-
from aws_cdk import (
|
|
59
|
-
aws_iot as iot,
|
|
60
|
-
Stack
|
|
61
|
-
)
|
|
62
|
-
from constructs import Construct
|
|
63
|
-
|
|
64
|
-
IotToSqs(self, 'test_iot_sqs',
|
|
65
|
-
iot_topic_rule_props=iot.CfnTopicRuleProps(
|
|
66
|
-
topic_rule_payload=iot.CfnTopicRule.TopicRulePayloadProperty(
|
|
67
|
-
rule_disabled=False,
|
|
68
|
-
description="Testing the IotToSqs Pattern",
|
|
69
|
-
sql="SELECT * FROM 'iot/sqs/#'",
|
|
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.iotsqs.*;
|
|
86
|
-
|
|
87
|
-
new IotToSqs(this, "test_iot_sqs", new IotToSqsProps.Builder()
|
|
88
|
-
.iotTopicRuleProps(new CfnTopicRuleProps.Builder()
|
|
89
|
-
.topicRulePayload(new TopicRulePayloadProperty.Builder()
|
|
90
|
-
.ruleDisabled(false)
|
|
91
|
-
.description("Testing the IotToSqs Pattern")
|
|
92
|
-
.sql("SELECT * FROM 'iot/sqs/#'")
|
|
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
|
-
|existingQueueObj?|[`sqs.Queue`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sqs.Queue.html)|Existing instance of SQS queue object, providing both this and `queueProps` will cause an error.|
|
|
105
|
-
|queueProps?|[`sqs.QueueProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sqs.QueueProps.html)|User provided props to override the default props for the SQS queue.|
|
|
106
|
-
|deadLetterQueueProps?|[`sqs.QueueProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sqs.QueueProps.html)|Optional user provided properties for the dead letter queue.|
|
|
107
|
-
|deployDeadLetterQueue?|`boolean`|Whether to deploy a secondary queue to be used as a dead letter queue. Default `true`.|
|
|
108
|
-
|maxReceiveCount?|`number`|The number of times a message can be unsuccessfully dequeued before being moved to the dead-letter queue. Required field if `deployDeadLetterQueue`=`true`.|
|
|
109
|
-
|enableEncryptionWithCustomerManagedKey?|`boolean`|If no key is provided, this flag determines whether the queue is encrypted with a new CMK or an AWS managed key. This flag is ignored if any of the following are defined: queueProps.encryptionMasterKey, encryptionKey or encryptionKeyProps.|
|
|
110
|
-
|encryptionKey?|[`kms.Key`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_kms.Key.html)|An optional, imported encryption key to encrypt the SQS Queue with.|
|
|
111
|
-
|encryptionKeyProps?|[`kms.KeyProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_kms.Key.html#construct-props)|Optional user provided properties to override the default properties for the KMS encryption key used to encrypt the SQS queue with.|
|
|
112
|
-
|
|
113
|
-
## Pattern Properties
|
|
114
|
-
|
|
115
|
-
| **Name** | **Type** | **Description** |
|
|
116
|
-
|:-------------|:----------------|-----------------|
|
|
117
|
-
|encryptionKey?|[`kms.Key`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_kms.Key.html)|Returns an instance of `kms.Key` used for the SQS queue.|
|
|
118
|
-
|iotActionsRole|[`iam.Role`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_iam.Role.html)|Returns an instance of `iam.Role` created by the construct, which allows IoT to publish messages to the SQS Queue|
|
|
119
|
-
|sqsQueue|[`sqs.Queue`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sqs.Queue.html)|Returns an instance of `sqs.Queue` created by the construct|
|
|
120
|
-
|deadLetterQueue?|[`sqs.Queue`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sqs.Queue.html)|Returns an instance of the dead-letter SQS queue created by the pattern.|
|
|
121
|
-
|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|
|
|
122
|
-
|
|
123
|
-
## Default settings
|
|
124
|
-
|
|
125
|
-
Out of the box implementation of the Construct without any override will set the following defaults:
|
|
126
|
-
|
|
127
|
-
### Amazon IoT Rule
|
|
128
|
-
|
|
129
|
-
* Configure an IoT Rule to send messages to the SQS Queue
|
|
130
|
-
|
|
131
|
-
### Amazon IAM Role
|
|
132
|
-
|
|
133
|
-
* Configure least privilege access IAM role for Amazon IoT to be able to publish messages to the SQS Queue
|
|
134
|
-
|
|
135
|
-
### Amazon SQS Queue
|
|
136
|
-
|
|
137
|
-
* Deploy a dead-letter queue for the source queue.
|
|
138
|
-
* Enable server-side encryption for the source queue using a customer-managed AWS KMS key.
|
|
139
|
-
* Enforce encryption of data in transit.
|
|
140
|
-
|
|
141
|
-
## Architecture
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
---
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
© 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-sqs/README.adoc)
|
|
149
3
|
'''
|
|
150
4
|
from pkgutil import extend_path
|
|
151
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-sqs",
|
|
37
|
-
"2.85.
|
|
37
|
+
"2.85.3",
|
|
38
38
|
__name__[0:-6],
|
|
39
|
-
"aws-iot-sqs@2.85.
|
|
39
|
+
"aws-iot-sqs@2.85.3.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-sqs
|
|
3
|
+
Version: 2.85.3
|
|
4
|
+
Summary: CDK Constructs for AWS IoT to AWS SQS integration
|
|
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-sqs/README.adoc)
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
aws_solutions_constructs/aws_iot_sqs/__init__.py,sha256=KcOuoVkW9gjUYyCxtHQh5eE8LR2lBh3yjnYDfeW2Eb4,19835
|
|
2
|
+
aws_solutions_constructs/aws_iot_sqs/py.typed,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
|
|
3
|
+
aws_solutions_constructs/aws_iot_sqs/_jsii/__init__.py,sha256=KEe1btlGjv5zk3txHxHTo6ilmrRjKjcoElhpLCvmU5w,1517
|
|
4
|
+
aws_solutions_constructs/aws_iot_sqs/_jsii/aws-iot-sqs@2.85.3.jsii.tgz,sha256=In81FeTqaF3Tgu4DhbGXjGXQzfTYhejckBYm-FGN7lc,315411
|
|
5
|
+
aws_solutions_constructs_aws_iot_sqs-2.85.3.dist-info/LICENSE,sha256=wnT4A3LZDAEpNzcPDh8VCH0i4wjvmLJ86l3A0tCINmw,10279
|
|
6
|
+
aws_solutions_constructs_aws_iot_sqs-2.85.3.dist-info/METADATA,sha256=PX200k9tQgHrhaj5QaXu0eusPNtn_hXK1w8OwVdPXjQ,1258
|
|
7
|
+
aws_solutions_constructs_aws_iot_sqs-2.85.3.dist-info/WHEEL,sha256=iAkIy5fosb7FzIOwONchHf19Qu7_1wCWyFNR5gu9nU0,91
|
|
8
|
+
aws_solutions_constructs_aws_iot_sqs-2.85.3.dist-info/top_level.txt,sha256=hi3us_KW7V1ocfOqVsNq1o3w552jCEgu_KsCckqYWsg,25
|
|
9
|
+
aws_solutions_constructs_aws_iot_sqs-2.85.3.dist-info/RECORD,,
|
|
Binary file
|
|
@@ -1,174 +0,0 @@
|
|
|
1
|
-
Metadata-Version: 2.1
|
|
2
|
-
Name: aws-solutions-constructs.aws-iot-sqs
|
|
3
|
-
Version: 2.85.2
|
|
4
|
-
Summary: CDK Constructs for AWS IoT to AWS SQS integration
|
|
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-sqs 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_sqs`|
|
|
50
|
-
| Typescript|`@aws-solutions-constructs/aws-iot-sqs`|
|
|
51
|
-
| Java|`software.amazon.awsconstructs.services.iotsqs`|
|
|
52
|
-
|
|
53
|
-
## Overview
|
|
54
|
-
|
|
55
|
-
This AWS Solutions Construct implements an AWS IoT MQTT topic rule and an AWS SQS Queue pattern.
|
|
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 { IotToSqsProps, IotToSqs } from '@aws-solutions-constructs/aws-iot-sqs';
|
|
65
|
-
|
|
66
|
-
const constructProps: IotToSqsProps = {
|
|
67
|
-
iotTopicRuleProps: {
|
|
68
|
-
topicRulePayload: {
|
|
69
|
-
ruleDisabled: false,
|
|
70
|
-
description: "Testing the IotToSqs Pattern",
|
|
71
|
-
sql: "SELECT * FROM 'iot/sqs/#'",
|
|
72
|
-
actions: []
|
|
73
|
-
}
|
|
74
|
-
}
|
|
75
|
-
};
|
|
76
|
-
|
|
77
|
-
new IotToSqs(this, 'test-iot-sqs-integration', constructProps);
|
|
78
|
-
```
|
|
79
|
-
|
|
80
|
-
Python
|
|
81
|
-
|
|
82
|
-
```python
|
|
83
|
-
from aws_solutions_constructs.aws_iot_sqs import IotToSqs
|
|
84
|
-
from aws_cdk import (
|
|
85
|
-
aws_iot as iot,
|
|
86
|
-
Stack
|
|
87
|
-
)
|
|
88
|
-
from constructs import Construct
|
|
89
|
-
|
|
90
|
-
IotToSqs(self, 'test_iot_sqs',
|
|
91
|
-
iot_topic_rule_props=iot.CfnTopicRuleProps(
|
|
92
|
-
topic_rule_payload=iot.CfnTopicRule.TopicRulePayloadProperty(
|
|
93
|
-
rule_disabled=False,
|
|
94
|
-
description="Testing the IotToSqs Pattern",
|
|
95
|
-
sql="SELECT * FROM 'iot/sqs/#'",
|
|
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.iotsqs.*;
|
|
112
|
-
|
|
113
|
-
new IotToSqs(this, "test_iot_sqs", new IotToSqsProps.Builder()
|
|
114
|
-
.iotTopicRuleProps(new CfnTopicRuleProps.Builder()
|
|
115
|
-
.topicRulePayload(new TopicRulePayloadProperty.Builder()
|
|
116
|
-
.ruleDisabled(false)
|
|
117
|
-
.description("Testing the IotToSqs Pattern")
|
|
118
|
-
.sql("SELECT * FROM 'iot/sqs/#'")
|
|
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
|
-
|existingQueueObj?|[`sqs.Queue`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sqs.Queue.html)|Existing instance of SQS queue object, providing both this and `queueProps` will cause an error.|
|
|
131
|
-
|queueProps?|[`sqs.QueueProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sqs.QueueProps.html)|User provided props to override the default props for the SQS queue.|
|
|
132
|
-
|deadLetterQueueProps?|[`sqs.QueueProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sqs.QueueProps.html)|Optional user provided properties for the dead letter queue.|
|
|
133
|
-
|deployDeadLetterQueue?|`boolean`|Whether to deploy a secondary queue to be used as a dead letter queue. Default `true`.|
|
|
134
|
-
|maxReceiveCount?|`number`|The number of times a message can be unsuccessfully dequeued before being moved to the dead-letter queue. Required field if `deployDeadLetterQueue`=`true`.|
|
|
135
|
-
|enableEncryptionWithCustomerManagedKey?|`boolean`|If no key is provided, this flag determines whether the queue is encrypted with a new CMK or an AWS managed key. This flag is ignored if any of the following are defined: queueProps.encryptionMasterKey, encryptionKey or encryptionKeyProps.|
|
|
136
|
-
|encryptionKey?|[`kms.Key`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_kms.Key.html)|An optional, imported encryption key to encrypt the SQS Queue with.|
|
|
137
|
-
|encryptionKeyProps?|[`kms.KeyProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_kms.Key.html#construct-props)|Optional user provided properties to override the default properties for the KMS encryption key used to encrypt the SQS queue with.|
|
|
138
|
-
|
|
139
|
-
## Pattern Properties
|
|
140
|
-
|
|
141
|
-
| **Name** | **Type** | **Description** |
|
|
142
|
-
|:-------------|:----------------|-----------------|
|
|
143
|
-
|encryptionKey?|[`kms.Key`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_kms.Key.html)|Returns an instance of `kms.Key` used for the SQS queue.|
|
|
144
|
-
|iotActionsRole|[`iam.Role`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_iam.Role.html)|Returns an instance of `iam.Role` created by the construct, which allows IoT to publish messages to the SQS Queue|
|
|
145
|
-
|sqsQueue|[`sqs.Queue`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sqs.Queue.html)|Returns an instance of `sqs.Queue` created by the construct|
|
|
146
|
-
|deadLetterQueue?|[`sqs.Queue`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sqs.Queue.html)|Returns an instance of the dead-letter SQS queue created by the pattern.|
|
|
147
|
-
|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|
|
|
148
|
-
|
|
149
|
-
## Default settings
|
|
150
|
-
|
|
151
|
-
Out of the box implementation of the Construct without any override will set the following defaults:
|
|
152
|
-
|
|
153
|
-
### Amazon IoT Rule
|
|
154
|
-
|
|
155
|
-
* Configure an IoT Rule to send messages to the SQS Queue
|
|
156
|
-
|
|
157
|
-
### Amazon IAM Role
|
|
158
|
-
|
|
159
|
-
* Configure least privilege access IAM role for Amazon IoT to be able to publish messages to the SQS Queue
|
|
160
|
-
|
|
161
|
-
### Amazon SQS Queue
|
|
162
|
-
|
|
163
|
-
* Deploy a dead-letter queue for the source queue.
|
|
164
|
-
* Enable server-side encryption for the source queue using a customer-managed AWS KMS key.
|
|
165
|
-
* Enforce encryption of data in transit.
|
|
166
|
-
|
|
167
|
-
## Architecture
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
---
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
© Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
|
@@ -1,9 +0,0 @@
|
|
|
1
|
-
aws_solutions_constructs/aws_iot_sqs/__init__.py,sha256=Y9G7dMVVaTLRdHcZpKYbI_hMqBE1GTZgNsePNdzmaB4,26489
|
|
2
|
-
aws_solutions_constructs/aws_iot_sqs/py.typed,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
|
|
3
|
-
aws_solutions_constructs/aws_iot_sqs/_jsii/__init__.py,sha256=LvfdO1wT0tWFbA3JH1wm3cBdbuWnQDij_m1EzQYCQuo,1517
|
|
4
|
-
aws_solutions_constructs/aws_iot_sqs/_jsii/aws-iot-sqs@2.85.2.jsii.tgz,sha256=Z2keQXqWcIfkQXzk3g4nWJitNq8nSmCBNdDkiBikfZk,316867
|
|
5
|
-
aws_solutions_constructs_aws_iot_sqs-2.85.2.dist-info/LICENSE,sha256=wnT4A3LZDAEpNzcPDh8VCH0i4wjvmLJ86l3A0tCINmw,10279
|
|
6
|
-
aws_solutions_constructs_aws_iot_sqs-2.85.2.dist-info/METADATA,sha256=Q5Kb4OFnWHx_RzypJH4qlZtT0xg93nv_-n61-dIpAvE,7912
|
|
7
|
-
aws_solutions_constructs_aws_iot_sqs-2.85.2.dist-info/WHEEL,sha256=iAkIy5fosb7FzIOwONchHf19Qu7_1wCWyFNR5gu9nU0,91
|
|
8
|
-
aws_solutions_constructs_aws_iot_sqs-2.85.2.dist-info/top_level.txt,sha256=hi3us_KW7V1ocfOqVsNq1o3w552jCEgu_KsCckqYWsg,25
|
|
9
|
-
aws_solutions_constructs_aws_iot_sqs-2.85.2.dist-info/RECORD,,
|
|
File without changes
|
|
File without changes
|