cdk-tweet-queue 2.0.590 → 2.0.591

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.
Files changed (4) hide show
  1. package/.jsii +2 -2
  2. package/API.md +732 -31
  3. package/lib/tweet-queue.js +1 -1
  4. package/package.json +5 -5
package/.jsii CHANGED
@@ -4031,6 +4031,6 @@
4031
4031
  "symbolId": "lib/tweet-queue:TweetQueueProps"
4032
4032
  }
4033
4033
  },
4034
- "version": "2.0.590",
4035
- "fingerprint": "OA4924U/sjvmNM9NK6MQoUEVHv/EpCibRZomCMk2Su8="
4034
+ "version": "2.0.591",
4035
+ "fingerprint": "zT4trGCXrjtSJRVxamA2ziszpzB2vWSPYAMujOJvNGY="
4036
4036
  }
package/API.md CHANGED
@@ -1,62 +1,763 @@
1
- # API Reference
1
+ # API Reference <a name="API Reference" id="api-reference"></a>
2
2
 
3
- **Classes**
3
+ ## Constructs <a name="Constructs" id="Constructs"></a>
4
4
 
5
- Name|Description
6
- ----|-----------
7
- [TweetQueue](#cdk-tweet-queue-tweetqueue)|*No description*
5
+ ### TweetQueue <a name="TweetQueue" id="cdk-tweet-queue.TweetQueue"></a>
8
6
 
7
+ #### Initializers <a name="Initializers" id="cdk-tweet-queue.TweetQueue.Initializer"></a>
9
8
 
10
- **Structs**
9
+ ```typescript
10
+ import { TweetQueue } from 'cdk-tweet-queue'
11
11
 
12
- Name|Description
13
- ----|-----------
14
- [TweetQueueProps](#cdk-tweet-queue-tweetqueueprops)|*No description*
12
+ new TweetQueue(parent: Construct, id: string, props: TweetQueueProps)
13
+ ```
15
14
 
15
+ | **Name** | **Type** | **Description** |
16
+ | --- | --- | --- |
17
+ | <code><a href="#cdk-tweet-queue.TweetQueue.Initializer.parameter.parent">parent</a></code> | <code>constructs.Construct</code> | *No description.* |
18
+ | <code><a href="#cdk-tweet-queue.TweetQueue.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
19
+ | <code><a href="#cdk-tweet-queue.TweetQueue.Initializer.parameter.props">props</a></code> | <code><a href="#cdk-tweet-queue.TweetQueueProps">TweetQueueProps</a></code> | *No description.* |
16
20
 
21
+ ---
17
22
 
18
- ## class TweetQueue <a id="cdk-tweet-queue-tweetqueue"></a>
23
+ ##### `parent`<sup>Required</sup> <a name="parent" id="cdk-tweet-queue.TweetQueue.Initializer.parameter.parent"></a>
19
24
 
25
+ - *Type:* constructs.Construct
20
26
 
27
+ ---
21
28
 
22
- __Implements__: [IConstruct](#constructs-iconstruct), [IDependable](#constructs-idependable), [IResource](#aws-cdk-lib-iresource), [IDependable](#constructs-idependable), [IConstruct](#constructs-iconstruct), [aws_sqs.IQueue](#aws-cdk-lib-aws-sqs-iqueue), [IDependable](#constructs-idependable), [IConstruct](#constructs-iconstruct), [IResource](#aws-cdk-lib-iresource)
23
- __Extends__: [aws_sqs.Queue](#aws-cdk-lib-aws-sqs-queue)
29
+ ##### `id`<sup>Required</sup> <a name="id" id="cdk-tweet-queue.TweetQueue.Initializer.parameter.id"></a>
24
30
 
25
- ### Initializer
31
+ - *Type:* string
26
32
 
33
+ ---
27
34
 
35
+ ##### `props`<sup>Required</sup> <a name="props" id="cdk-tweet-queue.TweetQueue.Initializer.parameter.props"></a>
28
36
 
37
+ - *Type:* <a href="#cdk-tweet-queue.TweetQueueProps">TweetQueueProps</a>
29
38
 
30
- ```ts
31
- new TweetQueue(parent: Construct, id: string, props: TweetQueueProps)
39
+ ---
40
+
41
+ #### Methods <a name="Methods" id="Methods"></a>
42
+
43
+ | **Name** | **Description** |
44
+ | --- | --- |
45
+ | <code><a href="#cdk-tweet-queue.TweetQueue.toString">toString</a></code> | Returns a string representation of this construct. |
46
+ | <code><a href="#cdk-tweet-queue.TweetQueue.applyRemovalPolicy">applyRemovalPolicy</a></code> | Apply the given removal policy to this resource. |
47
+ | <code><a href="#cdk-tweet-queue.TweetQueue.addToResourcePolicy">addToResourcePolicy</a></code> | Adds a statement to the IAM resource policy associated with this queue. |
48
+ | <code><a href="#cdk-tweet-queue.TweetQueue.grant">grant</a></code> | Grant the actions defined in queueActions to the identity Principal given on this SQS queue resource. |
49
+ | <code><a href="#cdk-tweet-queue.TweetQueue.grantConsumeMessages">grantConsumeMessages</a></code> | Grant permissions to consume messages from a queue. |
50
+ | <code><a href="#cdk-tweet-queue.TweetQueue.grantPurge">grantPurge</a></code> | Grant an IAM principal permissions to purge all messages from the queue. |
51
+ | <code><a href="#cdk-tweet-queue.TweetQueue.grantSendMessages">grantSendMessages</a></code> | Grant access to send messages to a queue to the given identity. |
52
+ | <code><a href="#cdk-tweet-queue.TweetQueue.metric">metric</a></code> | Return the given named metric for this Queue. |
53
+ | <code><a href="#cdk-tweet-queue.TweetQueue.metricApproximateAgeOfOldestMessage">metricApproximateAgeOfOldestMessage</a></code> | The approximate age of the oldest non-deleted message in the queue. |
54
+ | <code><a href="#cdk-tweet-queue.TweetQueue.metricApproximateNumberOfMessagesDelayed">metricApproximateNumberOfMessagesDelayed</a></code> | The number of messages in the queue that are delayed and not available for reading immediately. |
55
+ | <code><a href="#cdk-tweet-queue.TweetQueue.metricApproximateNumberOfMessagesNotVisible">metricApproximateNumberOfMessagesNotVisible</a></code> | The number of messages that are in flight. |
56
+ | <code><a href="#cdk-tweet-queue.TweetQueue.metricApproximateNumberOfMessagesVisible">metricApproximateNumberOfMessagesVisible</a></code> | The number of messages available for retrieval from the queue. |
57
+ | <code><a href="#cdk-tweet-queue.TweetQueue.metricNumberOfEmptyReceives">metricNumberOfEmptyReceives</a></code> | The number of ReceiveMessage API calls that did not return a message. |
58
+ | <code><a href="#cdk-tweet-queue.TweetQueue.metricNumberOfMessagesDeleted">metricNumberOfMessagesDeleted</a></code> | The number of messages deleted from the queue. |
59
+ | <code><a href="#cdk-tweet-queue.TweetQueue.metricNumberOfMessagesReceived">metricNumberOfMessagesReceived</a></code> | The number of messages returned by calls to the ReceiveMessage action. |
60
+ | <code><a href="#cdk-tweet-queue.TweetQueue.metricNumberOfMessagesSent">metricNumberOfMessagesSent</a></code> | The number of messages added to a queue. |
61
+ | <code><a href="#cdk-tweet-queue.TweetQueue.metricSentMessageSize">metricSentMessageSize</a></code> | The size of messages added to a queue. |
62
+
63
+ ---
64
+
65
+ ##### `toString` <a name="toString" id="cdk-tweet-queue.TweetQueue.toString"></a>
66
+
67
+ ```typescript
68
+ public toString(): string
69
+ ```
70
+
71
+ Returns a string representation of this construct.
72
+
73
+ ##### `applyRemovalPolicy` <a name="applyRemovalPolicy" id="cdk-tweet-queue.TweetQueue.applyRemovalPolicy"></a>
74
+
75
+ ```typescript
76
+ public applyRemovalPolicy(policy: RemovalPolicy): void
77
+ ```
78
+
79
+ Apply the given removal policy to this resource.
80
+
81
+ The Removal Policy controls what happens to this resource when it stops
82
+ being managed by CloudFormation, either because you've removed it from the
83
+ CDK application or because you've made a change that requires the resource
84
+ to be replaced.
85
+
86
+ The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
87
+ account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
88
+
89
+ ###### `policy`<sup>Required</sup> <a name="policy" id="cdk-tweet-queue.TweetQueue.applyRemovalPolicy.parameter.policy"></a>
90
+
91
+ - *Type:* aws-cdk-lib.RemovalPolicy
92
+
93
+ ---
94
+
95
+ ##### `addToResourcePolicy` <a name="addToResourcePolicy" id="cdk-tweet-queue.TweetQueue.addToResourcePolicy"></a>
96
+
97
+ ```typescript
98
+ public addToResourcePolicy(statement: PolicyStatement): AddToResourcePolicyResult
99
+ ```
100
+
101
+ Adds a statement to the IAM resource policy associated with this queue.
102
+
103
+ If this queue was created in this stack (`new Queue`), a queue policy
104
+ will be automatically created upon the first call to `addToPolicy`. If
105
+ the queue is imported (`Queue.import`), then this is a no-op.
106
+
107
+ ###### `statement`<sup>Required</sup> <a name="statement" id="cdk-tweet-queue.TweetQueue.addToResourcePolicy.parameter.statement"></a>
108
+
109
+ - *Type:* aws-cdk-lib.aws_iam.PolicyStatement
110
+
111
+ ---
112
+
113
+ ##### `grant` <a name="grant" id="cdk-tweet-queue.TweetQueue.grant"></a>
114
+
115
+ ```typescript
116
+ public grant(grantee: IGrantable, actions: string): Grant
117
+ ```
118
+
119
+ Grant the actions defined in queueActions to the identity Principal given on this SQS queue resource.
120
+
121
+ ###### `grantee`<sup>Required</sup> <a name="grantee" id="cdk-tweet-queue.TweetQueue.grant.parameter.grantee"></a>
122
+
123
+ - *Type:* aws-cdk-lib.aws_iam.IGrantable
124
+
125
+ Principal to grant right to.
126
+
127
+ ---
128
+
129
+ ###### `actions`<sup>Required</sup> <a name="actions" id="cdk-tweet-queue.TweetQueue.grant.parameter.actions"></a>
130
+
131
+ - *Type:* string
132
+
133
+ The actions to grant.
134
+
135
+ ---
136
+
137
+ ##### `grantConsumeMessages` <a name="grantConsumeMessages" id="cdk-tweet-queue.TweetQueue.grantConsumeMessages"></a>
138
+
139
+ ```typescript
140
+ public grantConsumeMessages(grantee: IGrantable): Grant
141
+ ```
142
+
143
+ Grant permissions to consume messages from a queue.
144
+
145
+ This will grant the following permissions:
146
+
147
+ - sqs:ChangeMessageVisibility
148
+ - sqs:DeleteMessage
149
+ - sqs:ReceiveMessage
150
+ - sqs:GetQueueAttributes
151
+ - sqs:GetQueueUrl
152
+
153
+ If encryption is used, permission to use the key to decrypt the contents of the queue will also be granted to the same principal.
154
+
155
+ This will grant the following KMS permissions:
156
+
157
+ - kms:Decrypt
158
+
159
+ ###### `grantee`<sup>Required</sup> <a name="grantee" id="cdk-tweet-queue.TweetQueue.grantConsumeMessages.parameter.grantee"></a>
160
+
161
+ - *Type:* aws-cdk-lib.aws_iam.IGrantable
162
+
163
+ Principal to grant consume rights to.
164
+
165
+ ---
166
+
167
+ ##### `grantPurge` <a name="grantPurge" id="cdk-tweet-queue.TweetQueue.grantPurge"></a>
168
+
169
+ ```typescript
170
+ public grantPurge(grantee: IGrantable): Grant
171
+ ```
172
+
173
+ Grant an IAM principal permissions to purge all messages from the queue.
174
+
175
+ This will grant the following permissions:
176
+
177
+ - sqs:PurgeQueue
178
+ - sqs:GetQueueAttributes
179
+ - sqs:GetQueueUrl
180
+
181
+ ###### `grantee`<sup>Required</sup> <a name="grantee" id="cdk-tweet-queue.TweetQueue.grantPurge.parameter.grantee"></a>
182
+
183
+ - *Type:* aws-cdk-lib.aws_iam.IGrantable
184
+
185
+ Principal to grant send rights to.
186
+
187
+ ---
188
+
189
+ ##### `grantSendMessages` <a name="grantSendMessages" id="cdk-tweet-queue.TweetQueue.grantSendMessages"></a>
190
+
191
+ ```typescript
192
+ public grantSendMessages(grantee: IGrantable): Grant
193
+ ```
194
+
195
+ Grant access to send messages to a queue to the given identity.
196
+
197
+ This will grant the following permissions:
198
+
199
+ - sqs:SendMessage
200
+ - sqs:GetQueueAttributes
201
+ - sqs:GetQueueUrl
202
+
203
+ If encryption is used, permission to use the key to encrypt/decrypt the contents of the queue will also be granted to the same principal.
204
+
205
+ This will grant the following KMS permissions:
206
+
207
+ - kms:Decrypt
208
+ - kms:Encrypt
209
+ - kms:ReEncrypt*
210
+ - kms:GenerateDataKey*
211
+
212
+ ###### `grantee`<sup>Required</sup> <a name="grantee" id="cdk-tweet-queue.TweetQueue.grantSendMessages.parameter.grantee"></a>
213
+
214
+ - *Type:* aws-cdk-lib.aws_iam.IGrantable
215
+
216
+ Principal to grant send rights to.
217
+
218
+ ---
219
+
220
+ ##### `metric` <a name="metric" id="cdk-tweet-queue.TweetQueue.metric"></a>
221
+
222
+ ```typescript
223
+ public metric(metricName: string, props?: MetricOptions): Metric
224
+ ```
225
+
226
+ Return the given named metric for this Queue.
227
+
228
+ ###### `metricName`<sup>Required</sup> <a name="metricName" id="cdk-tweet-queue.TweetQueue.metric.parameter.metricName"></a>
229
+
230
+ - *Type:* string
231
+
232
+ ---
233
+
234
+ ###### `props`<sup>Optional</sup> <a name="props" id="cdk-tweet-queue.TweetQueue.metric.parameter.props"></a>
235
+
236
+ - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
237
+
238
+ ---
239
+
240
+ ##### `metricApproximateAgeOfOldestMessage` <a name="metricApproximateAgeOfOldestMessage" id="cdk-tweet-queue.TweetQueue.metricApproximateAgeOfOldestMessage"></a>
241
+
242
+ ```typescript
243
+ public metricApproximateAgeOfOldestMessage(props?: MetricOptions): Metric
244
+ ```
245
+
246
+ The approximate age of the oldest non-deleted message in the queue.
247
+
248
+ Maximum over 5 minutes
249
+
250
+ ###### `props`<sup>Optional</sup> <a name="props" id="cdk-tweet-queue.TweetQueue.metricApproximateAgeOfOldestMessage.parameter.props"></a>
251
+
252
+ - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
253
+
254
+ ---
255
+
256
+ ##### `metricApproximateNumberOfMessagesDelayed` <a name="metricApproximateNumberOfMessagesDelayed" id="cdk-tweet-queue.TweetQueue.metricApproximateNumberOfMessagesDelayed"></a>
257
+
258
+ ```typescript
259
+ public metricApproximateNumberOfMessagesDelayed(props?: MetricOptions): Metric
260
+ ```
261
+
262
+ The number of messages in the queue that are delayed and not available for reading immediately.
263
+
264
+ Maximum over 5 minutes
265
+
266
+ ###### `props`<sup>Optional</sup> <a name="props" id="cdk-tweet-queue.TweetQueue.metricApproximateNumberOfMessagesDelayed.parameter.props"></a>
267
+
268
+ - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
269
+
270
+ ---
271
+
272
+ ##### `metricApproximateNumberOfMessagesNotVisible` <a name="metricApproximateNumberOfMessagesNotVisible" id="cdk-tweet-queue.TweetQueue.metricApproximateNumberOfMessagesNotVisible"></a>
273
+
274
+ ```typescript
275
+ public metricApproximateNumberOfMessagesNotVisible(props?: MetricOptions): Metric
276
+ ```
277
+
278
+ The number of messages that are in flight.
279
+
280
+ Maximum over 5 minutes
281
+
282
+ ###### `props`<sup>Optional</sup> <a name="props" id="cdk-tweet-queue.TweetQueue.metricApproximateNumberOfMessagesNotVisible.parameter.props"></a>
283
+
284
+ - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
285
+
286
+ ---
287
+
288
+ ##### `metricApproximateNumberOfMessagesVisible` <a name="metricApproximateNumberOfMessagesVisible" id="cdk-tweet-queue.TweetQueue.metricApproximateNumberOfMessagesVisible"></a>
289
+
290
+ ```typescript
291
+ public metricApproximateNumberOfMessagesVisible(props?: MetricOptions): Metric
292
+ ```
293
+
294
+ The number of messages available for retrieval from the queue.
295
+
296
+ Maximum over 5 minutes
297
+
298
+ ###### `props`<sup>Optional</sup> <a name="props" id="cdk-tweet-queue.TweetQueue.metricApproximateNumberOfMessagesVisible.parameter.props"></a>
299
+
300
+ - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
301
+
302
+ ---
303
+
304
+ ##### `metricNumberOfEmptyReceives` <a name="metricNumberOfEmptyReceives" id="cdk-tweet-queue.TweetQueue.metricNumberOfEmptyReceives"></a>
305
+
306
+ ```typescript
307
+ public metricNumberOfEmptyReceives(props?: MetricOptions): Metric
308
+ ```
309
+
310
+ The number of ReceiveMessage API calls that did not return a message.
311
+
312
+ Sum over 5 minutes
313
+
314
+ ###### `props`<sup>Optional</sup> <a name="props" id="cdk-tweet-queue.TweetQueue.metricNumberOfEmptyReceives.parameter.props"></a>
315
+
316
+ - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
317
+
318
+ ---
319
+
320
+ ##### `metricNumberOfMessagesDeleted` <a name="metricNumberOfMessagesDeleted" id="cdk-tweet-queue.TweetQueue.metricNumberOfMessagesDeleted"></a>
321
+
322
+ ```typescript
323
+ public metricNumberOfMessagesDeleted(props?: MetricOptions): Metric
324
+ ```
325
+
326
+ The number of messages deleted from the queue.
327
+
328
+ Sum over 5 minutes
329
+
330
+ ###### `props`<sup>Optional</sup> <a name="props" id="cdk-tweet-queue.TweetQueue.metricNumberOfMessagesDeleted.parameter.props"></a>
331
+
332
+ - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
333
+
334
+ ---
335
+
336
+ ##### `metricNumberOfMessagesReceived` <a name="metricNumberOfMessagesReceived" id="cdk-tweet-queue.TweetQueue.metricNumberOfMessagesReceived"></a>
337
+
338
+ ```typescript
339
+ public metricNumberOfMessagesReceived(props?: MetricOptions): Metric
340
+ ```
341
+
342
+ The number of messages returned by calls to the ReceiveMessage action.
343
+
344
+ Sum over 5 minutes
345
+
346
+ ###### `props`<sup>Optional</sup> <a name="props" id="cdk-tweet-queue.TweetQueue.metricNumberOfMessagesReceived.parameter.props"></a>
347
+
348
+ - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
349
+
350
+ ---
351
+
352
+ ##### `metricNumberOfMessagesSent` <a name="metricNumberOfMessagesSent" id="cdk-tweet-queue.TweetQueue.metricNumberOfMessagesSent"></a>
353
+
354
+ ```typescript
355
+ public metricNumberOfMessagesSent(props?: MetricOptions): Metric
356
+ ```
357
+
358
+ The number of messages added to a queue.
359
+
360
+ Sum over 5 minutes
361
+
362
+ ###### `props`<sup>Optional</sup> <a name="props" id="cdk-tweet-queue.TweetQueue.metricNumberOfMessagesSent.parameter.props"></a>
363
+
364
+ - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
365
+
366
+ ---
367
+
368
+ ##### `metricSentMessageSize` <a name="metricSentMessageSize" id="cdk-tweet-queue.TweetQueue.metricSentMessageSize"></a>
369
+
370
+ ```typescript
371
+ public metricSentMessageSize(props?: MetricOptions): Metric
372
+ ```
373
+
374
+ The size of messages added to a queue.
375
+
376
+ Average over 5 minutes
377
+
378
+ ###### `props`<sup>Optional</sup> <a name="props" id="cdk-tweet-queue.TweetQueue.metricSentMessageSize.parameter.props"></a>
379
+
380
+ - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
381
+
382
+ ---
383
+
384
+ #### Static Functions <a name="Static Functions" id="Static Functions"></a>
385
+
386
+ | **Name** | **Description** |
387
+ | --- | --- |
388
+ | <code><a href="#cdk-tweet-queue.TweetQueue.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
389
+ | <code><a href="#cdk-tweet-queue.TweetQueue.isOwnedResource">isOwnedResource</a></code> | Returns true if the construct was created by CDK, and false otherwise. |
390
+ | <code><a href="#cdk-tweet-queue.TweetQueue.isResource">isResource</a></code> | Check whether the given construct is a Resource. |
391
+ | <code><a href="#cdk-tweet-queue.TweetQueue.fromQueueArn">fromQueueArn</a></code> | Import an existing SQS queue provided an ARN. |
392
+ | <code><a href="#cdk-tweet-queue.TweetQueue.fromQueueAttributes">fromQueueAttributes</a></code> | Import an existing queue. |
393
+
394
+ ---
395
+
396
+ ##### `isConstruct` <a name="isConstruct" id="cdk-tweet-queue.TweetQueue.isConstruct"></a>
397
+
398
+ ```typescript
399
+ import { TweetQueue } from 'cdk-tweet-queue'
400
+
401
+ TweetQueue.isConstruct(x: any)
402
+ ```
403
+
404
+ Checks if `x` is a construct.
405
+
406
+ Use this method instead of `instanceof` to properly detect `Construct`
407
+ instances, even when the construct library is symlinked.
408
+
409
+ Explanation: in JavaScript, multiple copies of the `constructs` library on
410
+ disk are seen as independent, completely different libraries. As a
411
+ consequence, the class `Construct` in each copy of the `constructs` library
412
+ is seen as a different class, and an instance of one class will not test as
413
+ `instanceof` the other class. `npm install` will not create installations
414
+ like this, but users may manually symlink construct libraries together or
415
+ use a monorepo tool: in those cases, multiple copies of the `constructs`
416
+ library can be accidentally installed, and `instanceof` will behave
417
+ unpredictably. It is safest to avoid using `instanceof`, and using
418
+ this type-testing method instead.
419
+
420
+ ###### `x`<sup>Required</sup> <a name="x" id="cdk-tweet-queue.TweetQueue.isConstruct.parameter.x"></a>
421
+
422
+ - *Type:* any
423
+
424
+ Any object.
425
+
426
+ ---
427
+
428
+ ##### `isOwnedResource` <a name="isOwnedResource" id="cdk-tweet-queue.TweetQueue.isOwnedResource"></a>
429
+
430
+ ```typescript
431
+ import { TweetQueue } from 'cdk-tweet-queue'
432
+
433
+ TweetQueue.isOwnedResource(construct: IConstruct)
434
+ ```
435
+
436
+ Returns true if the construct was created by CDK, and false otherwise.
437
+
438
+ ###### `construct`<sup>Required</sup> <a name="construct" id="cdk-tweet-queue.TweetQueue.isOwnedResource.parameter.construct"></a>
439
+
440
+ - *Type:* constructs.IConstruct
441
+
442
+ ---
443
+
444
+ ##### `isResource` <a name="isResource" id="cdk-tweet-queue.TweetQueue.isResource"></a>
445
+
446
+ ```typescript
447
+ import { TweetQueue } from 'cdk-tweet-queue'
448
+
449
+ TweetQueue.isResource(construct: IConstruct)
450
+ ```
451
+
452
+ Check whether the given construct is a Resource.
453
+
454
+ ###### `construct`<sup>Required</sup> <a name="construct" id="cdk-tweet-queue.TweetQueue.isResource.parameter.construct"></a>
455
+
456
+ - *Type:* constructs.IConstruct
457
+
458
+ ---
459
+
460
+ ##### `fromQueueArn` <a name="fromQueueArn" id="cdk-tweet-queue.TweetQueue.fromQueueArn"></a>
461
+
462
+ ```typescript
463
+ import { TweetQueue } from 'cdk-tweet-queue'
464
+
465
+ TweetQueue.fromQueueArn(scope: Construct, id: string, queueArn: string)
32
466
  ```
33
467
 
34
- * **parent** (<code>[Construct](#constructs-construct)</code>) *No description*
35
- * **id** (<code>string</code>) *No description*
36
- * **props** (<code>[TweetQueueProps](#cdk-tweet-queue-tweetqueueprops)</code>) *No description*
37
- * **query** (<code>string</code>) The twitter query string to stream.
38
- * **secretArn** (<code>string</code>) The SecretsManager secret that contains Twitter authentication credentials from https://apps.twitter.com/ with the following attributes (exact names): - consumer_key - consumer_secret - access_token_key - access_token_secret.
39
- * **intervalMin** (<code>number</code>) Polling interval in minutes. __*Default*__: 1min
40
- * **retentionPeriodSec** (<code>number</code>) Number of seconds for messages to wait in the queue for processing. __*Default*__: 60 seconds
41
- * **visibilityTimeoutSec** (<code>number</code>) Number of seconds for messages to be invisible while they are processed. __*Default*__: 60 seconds
468
+ Import an existing SQS queue provided an ARN.
469
+
470
+ ###### `scope`<sup>Required</sup> <a name="scope" id="cdk-tweet-queue.TweetQueue.fromQueueArn.parameter.scope"></a>
471
+
472
+ - *Type:* constructs.Construct
473
+
474
+ The parent creating construct.
475
+
476
+ ---
477
+
478
+ ###### `id`<sup>Required</sup> <a name="id" id="cdk-tweet-queue.TweetQueue.fromQueueArn.parameter.id"></a>
479
+
480
+ - *Type:* string
481
+
482
+ The construct's name.
42
483
 
484
+ ---
43
485
 
486
+ ###### `queueArn`<sup>Required</sup> <a name="queueArn" id="cdk-tweet-queue.TweetQueue.fromQueueArn.parameter.queueArn"></a>
44
487
 
488
+ - *Type:* string
45
489
 
46
- ## struct TweetQueueProps <a id="cdk-tweet-queue-tweetqueueprops"></a>
490
+ queue ARN (i.e. arn:aws:sqs:us-east-2:444455556666:queue1).
47
491
 
492
+ ---
493
+
494
+ ##### `fromQueueAttributes` <a name="fromQueueAttributes" id="cdk-tweet-queue.TweetQueue.fromQueueAttributes"></a>
495
+
496
+ ```typescript
497
+ import { TweetQueue } from 'cdk-tweet-queue'
498
+
499
+ TweetQueue.fromQueueAttributes(scope: Construct, id: string, attrs: QueueAttributes)
500
+ ```
501
+
502
+ Import an existing queue.
503
+
504
+ ###### `scope`<sup>Required</sup> <a name="scope" id="cdk-tweet-queue.TweetQueue.fromQueueAttributes.parameter.scope"></a>
505
+
506
+ - *Type:* constructs.Construct
507
+
508
+ ---
509
+
510
+ ###### `id`<sup>Required</sup> <a name="id" id="cdk-tweet-queue.TweetQueue.fromQueueAttributes.parameter.id"></a>
511
+
512
+ - *Type:* string
513
+
514
+ ---
515
+
516
+ ###### `attrs`<sup>Required</sup> <a name="attrs" id="cdk-tweet-queue.TweetQueue.fromQueueAttributes.parameter.attrs"></a>
517
+
518
+ - *Type:* aws-cdk-lib.aws_sqs.QueueAttributes
519
+
520
+ ---
521
+
522
+ #### Properties <a name="Properties" id="Properties"></a>
523
+
524
+ | **Name** | **Type** | **Description** |
525
+ | --- | --- | --- |
526
+ | <code><a href="#cdk-tweet-queue.TweetQueue.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
527
+ | <code><a href="#cdk-tweet-queue.TweetQueue.property.env">env</a></code> | <code>aws-cdk-lib.ResourceEnvironment</code> | The environment this resource belongs to. |
528
+ | <code><a href="#cdk-tweet-queue.TweetQueue.property.stack">stack</a></code> | <code>aws-cdk-lib.Stack</code> | The stack in which this resource is defined. |
529
+ | <code><a href="#cdk-tweet-queue.TweetQueue.property.fifo">fifo</a></code> | <code>boolean</code> | Whether this queue is an Amazon SQS FIFO queue. |
530
+ | <code><a href="#cdk-tweet-queue.TweetQueue.property.queueArn">queueArn</a></code> | <code>string</code> | The ARN of this queue. |
531
+ | <code><a href="#cdk-tweet-queue.TweetQueue.property.queueName">queueName</a></code> | <code>string</code> | The name of this queue. |
532
+ | <code><a href="#cdk-tweet-queue.TweetQueue.property.queueUrl">queueUrl</a></code> | <code>string</code> | The URL of this queue. |
533
+ | <code><a href="#cdk-tweet-queue.TweetQueue.property.encryptionMasterKey">encryptionMasterKey</a></code> | <code>aws-cdk-lib.aws_kms.IKey</code> | If this queue is encrypted, this is the KMS key. |
534
+ | <code><a href="#cdk-tweet-queue.TweetQueue.property.encryptionType">encryptionType</a></code> | <code>aws-cdk-lib.aws_sqs.QueueEncryption</code> | Whether the contents of the queue are encrypted, and by what type of key. |
535
+ | <code><a href="#cdk-tweet-queue.TweetQueue.property.deadLetterQueue">deadLetterQueue</a></code> | <code>aws-cdk-lib.aws_sqs.DeadLetterQueue</code> | If this queue is configured with a dead-letter queue, this is the dead-letter queue settings. |
536
+
537
+ ---
538
+
539
+ ##### `node`<sup>Required</sup> <a name="node" id="cdk-tweet-queue.TweetQueue.property.node"></a>
540
+
541
+ ```typescript
542
+ public readonly node: Node;
543
+ ```
544
+
545
+ - *Type:* constructs.Node
546
+
547
+ The tree node.
548
+
549
+ ---
550
+
551
+ ##### `env`<sup>Required</sup> <a name="env" id="cdk-tweet-queue.TweetQueue.property.env"></a>
552
+
553
+ ```typescript
554
+ public readonly env: ResourceEnvironment;
555
+ ```
556
+
557
+ - *Type:* aws-cdk-lib.ResourceEnvironment
558
+
559
+ The environment this resource belongs to.
560
+
561
+ For resources that are created and managed by the CDK
562
+ (generally, those created by creating new class instances like Role, Bucket, etc.),
563
+ this is always the same as the environment of the stack they belong to;
564
+ however, for imported resources
565
+ (those obtained from static methods like fromRoleArn, fromBucketName, etc.),
566
+ that might be different than the stack they were imported into.
567
+
568
+ ---
569
+
570
+ ##### `stack`<sup>Required</sup> <a name="stack" id="cdk-tweet-queue.TweetQueue.property.stack"></a>
571
+
572
+ ```typescript
573
+ public readonly stack: Stack;
574
+ ```
575
+
576
+ - *Type:* aws-cdk-lib.Stack
577
+
578
+ The stack in which this resource is defined.
579
+
580
+ ---
581
+
582
+ ##### `fifo`<sup>Required</sup> <a name="fifo" id="cdk-tweet-queue.TweetQueue.property.fifo"></a>
583
+
584
+ ```typescript
585
+ public readonly fifo: boolean;
586
+ ```
48
587
 
588
+ - *Type:* boolean
589
+
590
+ Whether this queue is an Amazon SQS FIFO queue.
591
+
592
+ If false, this is a standard queue.
593
+
594
+ ---
595
+
596
+ ##### `queueArn`<sup>Required</sup> <a name="queueArn" id="cdk-tweet-queue.TweetQueue.property.queueArn"></a>
597
+
598
+ ```typescript
599
+ public readonly queueArn: string;
600
+ ```
601
+
602
+ - *Type:* string
603
+
604
+ The ARN of this queue.
605
+
606
+ ---
607
+
608
+ ##### `queueName`<sup>Required</sup> <a name="queueName" id="cdk-tweet-queue.TweetQueue.property.queueName"></a>
609
+
610
+ ```typescript
611
+ public readonly queueName: string;
612
+ ```
613
+
614
+ - *Type:* string
615
+
616
+ The name of this queue.
617
+
618
+ ---
619
+
620
+ ##### `queueUrl`<sup>Required</sup> <a name="queueUrl" id="cdk-tweet-queue.TweetQueue.property.queueUrl"></a>
621
+
622
+ ```typescript
623
+ public readonly queueUrl: string;
624
+ ```
625
+
626
+ - *Type:* string
627
+
628
+ The URL of this queue.
629
+
630
+ ---
631
+
632
+ ##### `encryptionMasterKey`<sup>Optional</sup> <a name="encryptionMasterKey" id="cdk-tweet-queue.TweetQueue.property.encryptionMasterKey"></a>
633
+
634
+ ```typescript
635
+ public readonly encryptionMasterKey: IKey;
636
+ ```
637
+
638
+ - *Type:* aws-cdk-lib.aws_kms.IKey
639
+
640
+ If this queue is encrypted, this is the KMS key.
641
+
642
+ ---
643
+
644
+ ##### `encryptionType`<sup>Optional</sup> <a name="encryptionType" id="cdk-tweet-queue.TweetQueue.property.encryptionType"></a>
645
+
646
+ ```typescript
647
+ public readonly encryptionType: QueueEncryption;
648
+ ```
649
+
650
+ - *Type:* aws-cdk-lib.aws_sqs.QueueEncryption
651
+
652
+ Whether the contents of the queue are encrypted, and by what type of key.
653
+
654
+ ---
655
+
656
+ ##### `deadLetterQueue`<sup>Optional</sup> <a name="deadLetterQueue" id="cdk-tweet-queue.TweetQueue.property.deadLetterQueue"></a>
657
+
658
+ ```typescript
659
+ public readonly deadLetterQueue: DeadLetterQueue;
660
+ ```
661
+
662
+ - *Type:* aws-cdk-lib.aws_sqs.DeadLetterQueue
663
+
664
+ If this queue is configured with a dead-letter queue, this is the dead-letter queue settings.
665
+
666
+ ---
667
+
668
+
669
+ ## Structs <a name="Structs" id="Structs"></a>
670
+
671
+ ### TweetQueueProps <a name="TweetQueueProps" id="cdk-tweet-queue.TweetQueueProps"></a>
672
+
673
+ #### Initializer <a name="Initializer" id="cdk-tweet-queue.TweetQueueProps.Initializer"></a>
674
+
675
+ ```typescript
676
+ import { TweetQueueProps } from 'cdk-tweet-queue'
677
+
678
+ const tweetQueueProps: TweetQueueProps = { ... }
679
+ ```
680
+
681
+ #### Properties <a name="Properties" id="Properties"></a>
682
+
683
+ | **Name** | **Type** | **Description** |
684
+ | --- | --- | --- |
685
+ | <code><a href="#cdk-tweet-queue.TweetQueueProps.property.query">query</a></code> | <code>string</code> | The twitter query string to stream. |
686
+ | <code><a href="#cdk-tweet-queue.TweetQueueProps.property.secretArn">secretArn</a></code> | <code>string</code> | The SecretsManager secret that contains Twitter authentication credentials from https://apps.twitter.com/ with the following attributes (exact names): - consumer_key - consumer_secret - access_token_key - access_token_secret. |
687
+ | <code><a href="#cdk-tweet-queue.TweetQueueProps.property.intervalMin">intervalMin</a></code> | <code>number</code> | Polling interval in minutes. |
688
+ | <code><a href="#cdk-tweet-queue.TweetQueueProps.property.retentionPeriodSec">retentionPeriodSec</a></code> | <code>number</code> | Number of seconds for messages to wait in the queue for processing. |
689
+ | <code><a href="#cdk-tweet-queue.TweetQueueProps.property.visibilityTimeoutSec">visibilityTimeoutSec</a></code> | <code>number</code> | Number of seconds for messages to be invisible while they are processed. |
690
+
691
+ ---
692
+
693
+ ##### `query`<sup>Required</sup> <a name="query" id="cdk-tweet-queue.TweetQueueProps.property.query"></a>
694
+
695
+ ```typescript
696
+ public readonly query: string;
697
+ ```
698
+
699
+ - *Type:* string
700
+
701
+ The twitter query string to stream.
702
+
703
+ ---
704
+
705
+ ##### `secretArn`<sup>Required</sup> <a name="secretArn" id="cdk-tweet-queue.TweetQueueProps.property.secretArn"></a>
706
+
707
+ ```typescript
708
+ public readonly secretArn: string;
709
+ ```
710
+
711
+ - *Type:* string
712
+
713
+ The SecretsManager secret that contains Twitter authentication credentials from https://apps.twitter.com/ with the following attributes (exact names): - consumer_key - consumer_secret - access_token_key - access_token_secret.
714
+
715
+ ---
716
+
717
+ ##### `intervalMin`<sup>Optional</sup> <a name="intervalMin" id="cdk-tweet-queue.TweetQueueProps.property.intervalMin"></a>
718
+
719
+ ```typescript
720
+ public readonly intervalMin: number;
721
+ ```
722
+
723
+ - *Type:* number
724
+ - *Default:* 1min
725
+
726
+ Polling interval in minutes.
727
+
728
+ Set to 0 to disable polling.
729
+
730
+ ---
731
+
732
+ ##### `retentionPeriodSec`<sup>Optional</sup> <a name="retentionPeriodSec" id="cdk-tweet-queue.TweetQueueProps.property.retentionPeriodSec"></a>
733
+
734
+ ```typescript
735
+ public readonly retentionPeriodSec: number;
736
+ ```
737
+
738
+ - *Type:* number
739
+ - *Default:* 60 seconds
740
+
741
+ Number of seconds for messages to wait in the queue for processing.
742
+
743
+ After this time, messages will be removed from the queue.
744
+
745
+ ---
746
+
747
+ ##### `visibilityTimeoutSec`<sup>Optional</sup> <a name="visibilityTimeoutSec" id="cdk-tweet-queue.TweetQueueProps.property.visibilityTimeoutSec"></a>
748
+
749
+ ```typescript
750
+ public readonly visibilityTimeoutSec: number;
751
+ ```
49
752
 
753
+ - *Type:* number
754
+ - *Default:* 60 seconds
50
755
 
756
+ Number of seconds for messages to be invisible while they are processed.
51
757
 
758
+ Based on the amount of time it would require to process a single message.
52
759
 
53
- Name | Type | Description
54
- -----|------|-------------
55
- **query** | <code>string</code> | The twitter query string to stream.
56
- **secretArn** | <code>string</code> | The SecretsManager secret that contains Twitter authentication credentials from https://apps.twitter.com/ with the following attributes (exact names): - consumer_key - consumer_secret - access_token_key - access_token_secret.
57
- **intervalMin**? | <code>number</code> | Polling interval in minutes.<br/>__*Default*__: 1min
58
- **retentionPeriodSec**? | <code>number</code> | Number of seconds for messages to wait in the queue for processing.<br/>__*Default*__: 60 seconds
59
- **visibilityTimeoutSec**? | <code>number</code> | Number of seconds for messages to be invisible while they are processed.<br/>__*Default*__: 60 seconds
760
+ ---
60
761
 
61
762
 
62
763
 
package/lib/tweet-queue.js CHANGED
@@ -52,5 +52,5 @@ class TweetQueue extends sqs.Queue {
52
52
  }
53
53
  exports.TweetQueue = TweetQueue;
54
54
  _a = JSII_RTTI_SYMBOL_1;
55
- TweetQueue[_a] = { fqn: "cdk-tweet-queue.TweetQueue", version: "2.0.590" };
55
+ TweetQueue[_a] = { fqn: "cdk-tweet-queue.TweetQueue", version: "2.0.591" };
56
56
  //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHdlZXQtcXVldWUuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyJ0d2VldC1xdWV1ZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7OztBQUFBLDZCQUE2QjtBQUM3Qiw2Q0FBdUM7QUFDdkMscURBQXFEO0FBQ3JELGlEQUFpRDtBQUNqRCwwREFBMEQ7QUFDMUQsMkNBQTJDO0FBQzNDLHdEQUF3RDtBQUN4RCwyQ0FBMkM7QUF5QzNDLE1BQWEsVUFBVyxTQUFRLEdBQUcsQ0FBQyxLQUFLO0lBQ3ZDLFlBQVksTUFBaUIsRUFBRSxFQUFVLEVBQUUsS0FBc0I7UUFDL0QsS0FBSyxDQUFDLE1BQU0sRUFBRSxFQUFFLEVBQUU7WUFDaEIsZUFBZSxFQUFFLEtBQUssQ0FBQyxrQkFBa0IsS0FBSyxTQUFTLENBQUMsQ0FBQyxDQUFDLHNCQUFRLENBQUMsT0FBTyxDQUFDLEVBQUUsQ0FBQyxDQUFDLENBQUMsQ0FBQyxzQkFBUSxDQUFDLE9BQU8sQ0FBQyxLQUFLLENBQUMsa0JBQWtCLENBQUM7WUFDM0gsaUJBQWlCLEVBQUUsS0FBSyxDQUFDLG9CQUFvQixLQUFLLFNBQVMsQ0FBQyxDQUFDLENBQUMsc0JBQVEsQ0FBQyxPQUFPLENBQUMsRUFBRSxDQUFDLENBQUMsQ0FBQyxDQUFDLHNCQUFRLENBQUMsT0FBTyxDQUFDLEtBQUssQ0FBQyxvQkFBb0IsQ0FBQztTQUNsSSxDQUFDLENBQUM7UUFFSCxNQUFNLE9BQU8sR0FBRyxJQUFJLENBQUM7UUFDckIsTUFBTSxLQUFLLEdBQUcsSUFBSSxRQUFRLENBQUMsS0FBSyxDQUFDLElBQUksRUFBRSxpQkFBaUIsRUFBRTtZQUN4RCxZQUFZLEVBQUUsRUFBRSxJQUFJLEVBQUUsT0FBTyxFQUFFLElBQUksRUFBRSxRQUFRLENBQUMsYUFBYSxDQUFDLE1BQU0sRUFBRTtTQUNyRSxDQUFDLENBQUM7UUFFSCxNQUFNLEVBQUUsR0FBRyxJQUFJLE1BQU0sQ0FBQyxjQUFjLENBQUMsSUFBSSxFQUFFLFFBQVEsRUFBRTtZQUNuRCxLQUFLLEVBQUUsSUFBSSxDQUFDLElBQUksQ0FBQyxTQUFTLEVBQUUsUUFBUSxFQUFFLFVBQVUsQ0FBQztZQUNqRCxPQUFPLEVBQUUsc0JBQVEsQ0FBQyxPQUFPLENBQUMsRUFBRSxDQUFDO1lBQzdCLFdBQVcsRUFBRTtnQkFDWCxrQkFBa0IsRUFBRSxLQUFLLENBQUMsU0FBUztnQkFDbkMsYUFBYSxFQUFFLEtBQUssQ0FBQyxLQUFLO2dCQUMxQixTQUFTLEVBQUUsSUFBSSxDQUFDLFFBQVE7Z0JBQ3hCLHFCQUFxQixFQUFFLEtBQUssQ0FBQyxTQUFTO2dCQUN0Qyx5QkFBeUIsRUFBRSxPQUFPO2FBQ25DO1NBQ0YsQ0FBQyxDQUFDO1FBRUgsRUFBRSxDQUFDLGVBQWUsQ0FBQyxJQUFJLEdBQUcsQ0FBQyxlQUFlLENBQUM7WUFDekMsU0FBUyxFQUFFLENBQUMsS0FBSyxDQUFDLFNBQVMsQ0FBQztZQUM1QixPQUFPLEVBQUUsQ0FBQywrQkFBK0IsQ0FBQztTQUMzQyxDQUFDLENBQUMsQ0FBQztRQUVKLEVBQUUsQ0FBQyxlQUFlLENBQUMsSUFBSSxHQUFHLENBQUMsZUFBZSxDQUFDO1lBQ3pDLFNBQVMsRUFBRSxDQUFDLElBQUksQ0FBQyxRQUFRLENBQUM7WUFDMUIsT0FBTyxFQUFFLENBQUMsaUJBQWlCLEVBQUUsc0JBQXNCLENBQUM7U0FDckQsQ0FBQyxDQUFDLENBQUM7UUFFSixLQUFLLENBQUMsa0JBQWtCLENBQUMsRUFBRSxDQUFDLENBQUM7UUFFN0IsTUFBTSxRQUFRLEdBQUcsS0FBSyxDQUFDLFdBQVcsS0FBSyxTQUFTLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUMsS0FBSyxDQUFDLFdBQVcsQ0FBQztRQUN6RSxJQUFJLFFBQVEsR0FBRyxDQUFDLEVBQUU7WUFDaEIsTUFBTSxLQUFLLEdBQUcsSUFBSSxNQUFNLENBQUMsSUFBSSxDQUFDLElBQUksRUFBRSxjQUFjLEVBQUU7Z0JBQ2xELFFBQVEsRUFBRSxNQUFNLENBQUMsUUFBUSxDQUFDLElBQUksQ0FBQyxzQkFBUSxDQUFDLE9BQU8sQ0FBQyxRQUFRLENBQUMsQ0FBQzthQUMzRCxDQUFDLENBQUM7WUFFSCxLQUFLLENBQUMsU0FBUyxDQUFDLElBQUksT0FBTyxDQUFDLGNBQWMsQ0FBQyxFQUFFLENBQUMsQ0FBQyxDQUFDO1NBQ2pEO0lBQ0gsQ0FBQzs7QUE1Q0gsZ0NBNkNDIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0ICogYXMgcGF0aCBmcm9tICdwYXRoJztcbmltcG9ydCB7IER1cmF0aW9uIH0gZnJvbSAnYXdzLWNkay1saWInO1xuaW1wb3J0ICogYXMgZHluYW1vZGIgZnJvbSAnYXdzLWNkay1saWIvYXdzLWR5bmFtb2RiJztcbmltcG9ydCAqIGFzIGV2ZW50cyBmcm9tICdhd3MtY2RrLWxpYi9hd3MtZXZlbnRzJztcbmltcG9ydCAqIGFzIHRhcmdldHMgZnJvbSAnYXdzLWNkay1saWIvYXdzLWV2ZW50cy10YXJnZXRzJztcbmltcG9ydCAqIGFzIGlhbSBmcm9tICdhd3MtY2RrLWxpYi9hd3MtaWFtJztcbmltcG9ydCAqIGFzIGxhbWJkYSBmcm9tICdhd3MtY2RrLWxpYi9hd3MtbGFtYmRhLW5vZGVqcyc7XG5pbXBvcnQgKiBhcyBzcXMgZnJvbSAnYXdzLWNkay1saWIvYXdzLXNxcyc7XG5pbXBvcnQgeyBDb25zdHJ1Y3QgfSBmcm9tICdjb25zdHJ1Y3RzJztcblxuZXhwb3J0IGludGVyZmFjZSBUd2VldFF1ZXVlUHJvcHMge1xuICAvKipcbiAgICogVGhlIFNlY3JldHNNYW5hZ2VyIHNlY3JldCB0aGF0IGNvbnRhaW5zIFR3aXR0ZXIgYXV0aGVudGljYXRpb24gY3JlZGVudGlhbHNcbiAgICogZnJvbSBodHRwczovL2FwcHMudHdpdHRlci5jb20vIHdpdGggdGhlIGZvbGxvd2luZyBhdHRyaWJ1dGVzIChleGFjdCBuYW1lcyk6XG4gICAqICAtIGNvbnN1bWVyX2tleVxuICAgKiAgLSBjb25zdW1lcl9zZWNyZXRcbiAgICogIC0gYWNjZXNzX3Rva2VuX2tleVxuICAgKiAgLSBhY2Nlc3NfdG9rZW5fc2VjcmV0XG4gICAqL1xuICByZWFkb25seSBzZWNyZXRBcm46IHN0cmluZztcblxuICAvKipcbiAgICogVGhlIHR3aXR0ZXIgcXVlcnkgc3RyaW5nIHRvIHN0cmVhbS5cbiAgICovXG4gIHJlYWRvbmx5IHF1ZXJ5OiBzdHJpbmc7XG5cbiAgLyoqXG4gICAqIFBvbGxpbmcgaW50ZXJ2YWwgaW4gbWludXRlcy5cbiAgICogU2V0IHRvIDAgdG8gZGlzYWJsZSBwb2xsaW5nLlxuICAgKiBAZGVmYXVsdCAxbWluXG4gICAqL1xuICByZWFkb25seSBpbnRlcnZhbE1pbj86IG51bWJlcjtcblxuICAvKipcbiAgICogTnVtYmVyIG9mIHNlY29uZHMgZm9yIG1lc3NhZ2VzIHRvIHdhaXQgaW4gdGhlIHF1ZXVlIGZvciBwcm9jZXNzaW5nLlxuICAgKiBBZnRlciB0aGlzIHRpbWUsIG1lc3NhZ2VzIHdpbGwgYmUgcmVtb3ZlZCBmcm9tIHRoZSBxdWV1ZS5cbiAgICogQGRlZmF1bHQgNjAgc2Vjb25kc1xuICAgKi9cbiAgcmVhZG9ubHkgcmV0ZW50aW9uUGVyaW9kU2VjPzogbnVtYmVyO1xuXG4gIC8qKlxuICAgKiBOdW1iZXIgb2Ygc2Vjb25kcyBmb3IgbWVzc2FnZXMgdG8gYmUgaW52aXNpYmxlIHdoaWxlIHRoZXkgYXJlIHByb2Nlc3NlZC5cbiAgICogQmFzZWQgb24gdGhlIGFtb3VudCBvZiB0aW1lIGl0IHdvdWxkIHJlcXVpcmUgdG8gcHJvY2VzcyBhIHNpbmdsZSBtZXNzYWdlLlxuICAgKiBAZGVmYXVsdCA2MCBzZWNvbmRzXG4gICAqL1xuICByZWFkb25seSB2aXNpYmlsaXR5VGltZW91dFNlYz86IG51bWJlcjtcbn1cblxuZXhwb3J0IGNsYXNzIFR3ZWV0UXVldWUgZXh0ZW5kcyBzcXMuUXVldWUge1xuICBjb25zdHJ1Y3RvcihwYXJlbnQ6IENvbnN0cnVjdCwgaWQ6IHN0cmluZywgcHJvcHM6IFR3ZWV0UXVldWVQcm9wcykge1xuICAgIHN1cGVyKHBhcmVudCwgaWQsIHtcbiAgICAgIHJldGVudGlvblBlcmlvZDogcHJvcHMucmV0ZW50aW9uUGVyaW9kU2VjID09PSB1bmRlZmluZWQgPyBEdXJhdGlvbi5zZWNvbmRzKDYwKSA6IER1cmF0aW9uLnNlY29uZHMocHJvcHMucmV0ZW50aW9uUGVyaW9kU2VjKSxcbiAgICAgIHZpc2liaWxpdHlUaW1lb3V0OiBwcm9wcy52aXNpYmlsaXR5VGltZW91dFNlYyA9PT0gdW5kZWZpbmVkID8gRHVyYXRpb24uc2Vjb25kcyg2MCkgOiBEdXJhdGlvbi5zZWNvbmRzKHByb3BzLnZpc2liaWxpdHlUaW1lb3V0U2VjKSxcbiAgICB9KTtcblxuICAgIGNvbnN0IGtleU5hbWUgPSAnaWQnO1xuICAgIGNvbnN0IHRhYmxlID0gbmV3IGR5bmFtb2RiLlRhYmxlKHRoaXMsICdDaGVja3BvaW50VGFibGUnLCB7XG4gICAgICBwYXJ0aXRpb25LZXk6IHsgbmFtZToga2V5TmFtZSwgdHlwZTogZHluYW1vZGIuQXR0cmlidXRlVHlwZS5TVFJJTkcgfSxcbiAgICB9KTtcblxuICAgIGNvbnN0IGZuID0gbmV3IGxhbWJkYS5Ob2RlanNGdW5jdGlvbih0aGlzLCAnUG9sbGVyJywge1xuICAgICAgZW50cnk6IHBhdGguam9pbihfX2Rpcm5hbWUsICdwb2xsZXInLCAnaW5kZXgudHMnKSxcbiAgICAgIHRpbWVvdXQ6IER1cmF0aW9uLm1pbnV0ZXMoMTUpLFxuICAgICAgZW52aXJvbm1lbnQ6IHtcbiAgICAgICAgQ1JFREVOVElBTFNfU0VDUkVUOiBwcm9wcy5zZWNyZXRBcm4sXG4gICAgICAgIFRXSVRURVJfUVVFUlk6IHByb3BzLnF1ZXJ5LFxuICAgICAgICBRVUVVRV9VUkw6IHRoaXMucXVldWVVcmwsXG4gICAgICAgIENIRUNLUE9JTlRfVEFCTEVfTkFNRTogdGFibGUudGFibGVOYW1lLFxuICAgICAgICBDSEVDS1BPSU5UX1RBQkxFX0tFWV9OQU1FOiBrZXlOYW1lLFxuICAgICAgfSxcbiAgICB9KTtcblxuICAgIGZuLmFkZFRvUm9sZVBvbGljeShuZXcgaWFtLlBvbGljeVN0YXRlbWVudCh7XG4gICAgICByZXNvdXJjZXM6IFtwcm9wcy5zZWNyZXRBcm5dLFxuICAgICAgYWN0aW9uczogWydzZWNyZXRzbWFuYWdlcjpHZXRTZWNyZXRWYWx1ZSddLFxuICAgIH0pKTtcblxuICAgIGZuLmFkZFRvUm9sZVBvbGljeShuZXcgaWFtLlBvbGljeVN0YXRlbWVudCh7XG4gICAgICByZXNvdXJjZXM6IFt0aGlzLnF1ZXVlQXJuXSxcbiAgICAgIGFjdGlvbnM6IFsnc3FzOlNlbmRNZXNzYWdlJywgJ3NxczpTZW5kTWVzc2FnZUJhdGNoJ10sXG4gICAgfSkpO1xuXG4gICAgdGFibGUuZ3JhbnRSZWFkV3JpdGVEYXRhKGZuKTtcblxuICAgIGNvbnN0IGludGVydmFsID0gcHJvcHMuaW50ZXJ2YWxNaW4gPT09IHVuZGVmaW5lZCA/IDEgOiBwcm9wcy5pbnRlcnZhbE1pbjtcbiAgICBpZiAoaW50ZXJ2YWwgPiAwKSB7XG4gICAgICBjb25zdCB0aW1lciA9IG5ldyBldmVudHMuUnVsZSh0aGlzLCAnUG9sbGluZ1RpbWVyJywge1xuICAgICAgICBzY2hlZHVsZTogZXZlbnRzLlNjaGVkdWxlLnJhdGUoRHVyYXRpb24ubWludXRlcyhpbnRlcnZhbCkpLFxuICAgICAgfSk7XG5cbiAgICAgIHRpbWVyLmFkZFRhcmdldChuZXcgdGFyZ2V0cy5MYW1iZGFGdW5jdGlvbihmbikpO1xuICAgIH1cbiAgfVxufVxuXG4iXX0=
package/package.json CHANGED
@@ -48,7 +48,8 @@
48
48
  "@typescript-eslint/parser": "^7",
49
49
  "aws-cdk": "^2.20.0",
50
50
  "aws-cdk-lib": "^2.154.1",
51
- "aws-sdk": "^2.1682.0",
51
+ "aws-sdk": "^2.1683.0",
52
+ "commit-and-tag-version": "^12",
52
53
  "constructs": "^10.3.0",
53
54
  "esbuild": "^0.23.1",
54
55
  "eslint": "^8",
@@ -58,11 +59,10 @@
58
59
  "jest-junit": "^15",
59
60
  "jsii": "1.x",
60
61
  "jsii-diff": "^1.102.0",
61
- "jsii-docgen": "^1.8.110",
62
+ "jsii-docgen": "^10.5.0",
62
63
  "jsii-pacmak": "^1.102.0",
63
64
  "jsii-rosetta": "1.x",
64
- "projen": "^0.86.0",
65
- "standard-version": "^9",
65
+ "projen": "^0.86.4",
66
66
  "ts-node": "^10.9.2",
67
67
  "twitter": "^1.7.1",
68
68
  "typescript": "^5.5.4"
@@ -90,7 +90,7 @@
90
90
  "publishConfig": {
91
91
  "access": "public"
92
92
  },
93
- "version": "2.0.590",
93
+ "version": "2.0.591",
94
94
  "jest": {
95
95
  "coverageProvider": "v8",
96
96
  "testMatch": [