UNPKG

135 kBPlain TextView Raw
1{
2 "author": {
3 "name": "Amazon Web Services",
4 "organization": true,
5 "roles": [
6 "author"
7 ],
8 "url": "https://aws.amazon.com"
9 },
10 "dependencies": {
11 "@aws-cdk/aws-cloudwatch": "1.202.0",
12 "@aws-cdk/aws-iam": "1.202.0",
13 "@aws-cdk/aws-kms": "1.202.0",
14 "@aws-cdk/core": "1.202.0",
15 "constructs": "^3.3.69"
16 },
17 "dependencyClosure": {
18 "@aws-cdk/aws-cloudwatch": {
19 "targets": {
20 "dotnet": {
21 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
22 "namespace": "Amazon.CDK.AWS.CloudWatch",
23 "packageId": "Amazon.CDK.AWS.CloudWatch"
24 },
25 "java": {
26 "maven": {
27 "artifactId": "cloudwatch",
28 "groupId": "software.amazon.awscdk"
29 },
30 "package": "software.amazon.awscdk.services.cloudwatch"
31 },
32 "js": {
33 "npm": "@aws-cdk/aws-cloudwatch"
34 },
35 "python": {
36 "classifiers": [
37 "Framework :: AWS CDK",
38 "Framework :: AWS CDK :: 1"
39 ],
40 "distName": "aws-cdk.aws-cloudwatch",
41 "module": "aws_cdk.aws_cloudwatch"
42 }
43 }
44 },
45 "@aws-cdk/aws-iam": {
46 "targets": {
47 "dotnet": {
48 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
49 "namespace": "Amazon.CDK.AWS.IAM",
50 "packageId": "Amazon.CDK.AWS.IAM"
51 },
52 "java": {
53 "maven": {
54 "artifactId": "iam",
55 "groupId": "software.amazon.awscdk"
56 },
57 "package": "software.amazon.awscdk.services.iam"
58 },
59 "js": {
60 "npm": "@aws-cdk/aws-iam"
61 },
62 "python": {
63 "classifiers": [
64 "Framework :: AWS CDK",
65 "Framework :: AWS CDK :: 1"
66 ],
67 "distName": "aws-cdk.aws-iam",
68 "module": "aws_cdk.aws_iam"
69 }
70 }
71 },
72 "@aws-cdk/aws-kms": {
73 "targets": {
74 "dotnet": {
75 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
76 "namespace": "Amazon.CDK.AWS.KMS",
77 "packageId": "Amazon.CDK.AWS.KMS"
78 },
79 "java": {
80 "maven": {
81 "artifactId": "kms",
82 "groupId": "software.amazon.awscdk"
83 },
84 "package": "software.amazon.awscdk.services.kms"
85 },
86 "js": {
87 "npm": "@aws-cdk/aws-kms"
88 },
89 "python": {
90 "classifiers": [
91 "Framework :: AWS CDK",
92 "Framework :: AWS CDK :: 1"
93 ],
94 "distName": "aws-cdk.aws-kms",
95 "module": "aws_cdk.aws_kms"
96 }
97 }
98 },
99 "@aws-cdk/cloud-assembly-schema": {
100 "targets": {
101 "dotnet": {
102 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
103 "namespace": "Amazon.CDK.CloudAssembly.Schema",
104 "packageId": "Amazon.CDK.CloudAssembly.Schema"
105 },
106 "java": {
107 "maven": {
108 "artifactId": "cdk-cloud-assembly-schema",
109 "groupId": "software.amazon.awscdk"
110 },
111 "package": "software.amazon.awscdk.cloudassembly.schema"
112 },
113 "js": {
114 "npm": "@aws-cdk/cloud-assembly-schema"
115 },
116 "python": {
117 "classifiers": [
118 "Framework :: AWS CDK",
119 "Framework :: AWS CDK :: 1"
120 ],
121 "distName": "aws-cdk.cloud-assembly-schema",
122 "module": "aws_cdk.cloud_assembly_schema"
123 }
124 }
125 },
126 "@aws-cdk/core": {
127 "targets": {
128 "dotnet": {
129 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
130 "namespace": "Amazon.CDK",
131 "packageId": "Amazon.CDK"
132 },
133 "java": {
134 "maven": {
135 "artifactId": "core",
136 "groupId": "software.amazon.awscdk"
137 },
138 "package": "software.amazon.awscdk.core"
139 },
140 "js": {
141 "npm": "@aws-cdk/core"
142 },
143 "python": {
144 "classifiers": [
145 "Framework :: AWS CDK",
146 "Framework :: AWS CDK :: 1"
147 ],
148 "distName": "aws-cdk.core",
149 "module": "aws_cdk.core"
150 }
151 }
152 },
153 "@aws-cdk/cx-api": {
154 "targets": {
155 "dotnet": {
156 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
157 "namespace": "Amazon.CDK.CXAPI",
158 "packageId": "Amazon.CDK.CXAPI"
159 },
160 "java": {
161 "maven": {
162 "artifactId": "cdk-cx-api",
163 "groupId": "software.amazon.awscdk"
164 },
165 "package": "software.amazon.awscdk.cxapi"
166 },
167 "js": {
168 "npm": "@aws-cdk/cx-api"
169 },
170 "python": {
171 "classifiers": [
172 "Framework :: AWS CDK",
173 "Framework :: AWS CDK :: 1"
174 ],
175 "distName": "aws-cdk.cx-api",
176 "module": "aws_cdk.cx_api"
177 }
178 }
179 },
180 "@aws-cdk/region-info": {
181 "targets": {
182 "dotnet": {
183 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
184 "namespace": "Amazon.CDK.RegionInfo",
185 "packageId": "Amazon.CDK.RegionInfo"
186 },
187 "java": {
188 "maven": {
189 "artifactId": "cdk-region-info",
190 "groupId": "software.amazon.awscdk"
191 },
192 "package": "software.amazon.awscdk.regioninfo"
193 },
194 "js": {
195 "npm": "@aws-cdk/region-info"
196 },
197 "python": {
198 "classifiers": [
199 "Framework :: AWS CDK",
200 "Framework :: AWS CDK :: 1"
201 ],
202 "distName": "aws-cdk.region-info",
203 "module": "aws_cdk.region_info"
204 }
205 }
206 },
207 "constructs": {
208 "targets": {
209 "dotnet": {
210 "namespace": "Constructs",
211 "packageId": "Constructs"
212 },
213 "go": {
214 "moduleName": "github.com/aws/constructs-go"
215 },
216 "java": {
217 "maven": {
218 "artifactId": "constructs",
219 "groupId": "software.constructs"
220 },
221 "package": "software.constructs"
222 },
223 "js": {
224 "npm": "constructs"
225 },
226 "python": {
227 "distName": "constructs",
228 "module": "constructs"
229 }
230 }
231 }
232 },
233 "description": "The CDK Construct Library for AWS::SQS",
234 "docs": {
235 "stability": "stable"
236 },
237 "homepage": "https://github.com/aws/aws-cdk",
238 "jsiiVersion": "1.74.0 (build 6d08790)",
239 "keywords": [
240 "aws",
241 "cdk",
242 "constructs",
243 "sqs"
244 ],
245 "license": "Apache-2.0",
246 "metadata": {
247 "jsii": {
248 "compiledWithDeprecationWarnings": true,
249 "pacmak": {
250 "hasDefaultInterfaces": true
251 },
252 "rosetta": {
253 "strict": true
254 }
255 }
256 },
257 "name": "@aws-cdk/aws-sqs",
258 "readme": {
259 "markdown": "# Amazon Simple Queue Service Construct Library\n<!--BEGIN STABILITY BANNER-->\n\n---\n\n![cfn-resources: Stable](https://img.shields.io/badge/cfn--resources-stable-success.svg?style=for-the-badge)\n\n![cdk-constructs: Stable](https://img.shields.io/badge/cdk--constructs-stable-success.svg?style=for-the-badge)\n\n---\n\n<!--END STABILITY BANNER-->\n\nAmazon Simple Queue Service (SQS) is a fully managed message queuing service that\nenables you to decouple and scale microservices, distributed systems, and serverless\napplications. SQS eliminates the complexity and overhead associated with managing and\noperating message oriented middleware, and empowers developers to focus on differentiating work.\nUsing SQS, you can send, store, and receive messages between software components at any volume,\nwithout losing messages or requiring other services to be available.\n\n## Installation\n\nImport to your project:\n\n```ts nofixture\nimport * as sqs from '@aws-cdk/aws-sqs';\n```\n\n## Basic usage\n\n\nHere's how to add a basic queue to your application:\n\n```ts\nnew sqs.Queue(this, 'Queue');\n```\n\n## Encryption\n\nIf you want to encrypt the queue contents, set the `encryption` property. You can have\nthe messages encrypted with a key that SQS manages for you, or a key that you\ncan manage yourself.\n\n```ts\n// Use managed key\nnew sqs.Queue(this, 'Queue', {\n encryption: sqs.QueueEncryption.KMS_MANAGED,\n});\n\n// Use custom key\nconst myKey = new kms.Key(this, 'Key');\n\nnew sqs.Queue(this, 'Queue', {\n encryption: sqs.QueueEncryption.KMS,\n encryptionMasterKey: myKey,\n});\n```\n\n## First-In-First-Out (FIFO) queues\n\nFIFO queues give guarantees on the order in which messages are dequeued, and have additional\nfeatures in order to help guarantee exactly-once processing. For more information, see\nthe SQS manual. Note that FIFO queues are not available in all AWS regions.\n\nA queue can be made a FIFO queue by either setting `fifo: true`, giving it a name which ends\nin `\".fifo\"`, or by enabling a FIFO specific feature such as: content-based deduplication,\ndeduplication scope or fifo throughput limit.\n"
260 },
261 "repository": {
262 "directory": "packages/@aws-cdk/aws-sqs",
263 "type": "git",
264 "url": "https://github.com/aws/aws-cdk.git"
265 },
266 "schema": "jsii/0.10.0",
267 "targets": {
268 "dotnet": {
269 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
270 "namespace": "Amazon.CDK.AWS.SQS",
271 "packageId": "Amazon.CDK.AWS.SQS"
272 },
273 "java": {
274 "maven": {
275 "artifactId": "sqs",
276 "groupId": "software.amazon.awscdk"
277 },
278 "package": "software.amazon.awscdk.services.sqs"
279 },
280 "js": {
281 "npm": "@aws-cdk/aws-sqs"
282 },
283 "python": {
284 "classifiers": [
285 "Framework :: AWS CDK",
286 "Framework :: AWS CDK :: 1"
287 ],
288 "distName": "aws-cdk.aws-sqs",
289 "module": "aws_cdk.aws_sqs"
290 }
291 },
292 "types": {
293 "@aws-cdk/aws-sqs.CfnQueue": {
294 "assembly": "@aws-cdk/aws-sqs",
295 "base": "@aws-cdk/core.CfnResource",
296 "docs": {
297 "custom": {
298 "cloudformationResource": "AWS::SQS::Queue",
299 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html",
300 "exampleMetadata": "fixture=_generated"
301 },
302 "remarks": "The `AWS::SQS::Queue` resource creates an Amazon SQS standard or FIFO queue.\n\nKeep the following caveats in mind:\n\n- If you don't specify the `FifoQueue` property, Amazon SQS creates a standard queue.\n\n> You can't change the queue type after you create it and you can't convert an existing standard queue into a FIFO queue. You must either create a new FIFO queue for your application or delete your existing standard queue and recreate it as a FIFO queue. For more information, see [Moving from a standard queue to a FIFO queue](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-moving.html) in the *Amazon SQS Developer Guide* .\n- If you don't provide a value for a property, the queue is created with the default value for the property.\n- If you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.\n- To successfully create a new queue, you must provide a queue name that adheres to the [limits related to queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/limits-queues.html) and is unique within the scope of your queues.\n\nFor more information about creating FIFO (first-in-first-out) queues, see [Creating an Amazon SQS queue ( AWS CloudFormation )](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/screate-queue-cloudformation.html) in the *Amazon SQS Developer Guide* .",
303 "stability": "external",
304 "summary": "A CloudFormation `AWS::SQS::Queue`.",
305 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as sqs from '@aws-cdk/aws-sqs';\n\ndeclare const redriveAllowPolicy: any;\ndeclare const redrivePolicy: any;\nconst cfnQueue = new sqs.CfnQueue(this, 'MyCfnQueue', /* all optional props */ {\n contentBasedDeduplication: false,\n deduplicationScope: 'deduplicationScope',\n delaySeconds: 123,\n fifoQueue: false,\n fifoThroughputLimit: 'fifoThroughputLimit',\n kmsDataKeyReusePeriodSeconds: 123,\n kmsMasterKeyId: 'kmsMasterKeyId',\n maximumMessageSize: 123,\n messageRetentionPeriod: 123,\n queueName: 'queueName',\n receiveMessageWaitTimeSeconds: 123,\n redriveAllowPolicy: redriveAllowPolicy,\n redrivePolicy: redrivePolicy,\n sqsManagedSseEnabled: false,\n tags: [{\n key: 'key',\n value: 'value',\n }],\n visibilityTimeout: 123,\n});"
306 },
307 "fqn": "@aws-cdk/aws-sqs.CfnQueue",
308 "initializer": {
309 "docs": {
310 "stability": "external",
311 "summary": "Create a new `AWS::SQS::Queue`."
312 },
313 "locationInModule": {
314 "filename": "lib/sqs.generated.ts",
315 "line": 489
316 },
317 "parameters": [
318 {
319 "docs": {
320 "summary": "- scope in which this resource is defined."
321 },
322 "name": "scope",
323 "type": {
324 "fqn": "@aws-cdk/core.Construct"
325 }
326 },
327 {
328 "docs": {
329 "summary": "- scoped id of the resource."
330 },
331 "name": "id",
332 "type": {
333 "primitive": "string"
334 }
335 },
336 {
337 "docs": {
338 "summary": "- resource properties."
339 },
340 "name": "props",
341 "optional": true,
342 "type": {
343 "fqn": "@aws-cdk/aws-sqs.CfnQueueProps"
344 }
345 }
346 ]
347 },
348 "interfaces": [
349 "@aws-cdk/core.IInspectable"
350 ],
351 "kind": "class",
352 "locationInModule": {
353 "filename": "lib/sqs.generated.ts",
354 "line": 286
355 },
356 "methods": [
357 {
358 "docs": {
359 "stability": "external",
360 "summary": "Examines the CloudFormation resource and discloses attributes."
361 },
362 "locationInModule": {
363 "filename": "lib/sqs.generated.ts",
364 "line": 524
365 },
366 "name": "inspect",
367 "overrides": "@aws-cdk/core.IInspectable",
368 "parameters": [
369 {
370 "docs": {
371 "summary": "- tree inspector to collect and process attributes."
372 },
373 "name": "inspector",
374 "type": {
375 "fqn": "@aws-cdk/core.TreeInspector"
376 }
377 }
378 ]
379 },
380 {
381 "docs": {
382 "stability": "external"
383 },
384 "locationInModule": {
385 "filename": "lib/sqs.generated.ts",
386 "line": 550
387 },
388 "name": "renderProperties",
389 "overrides": "@aws-cdk/core.CfnResource",
390 "parameters": [
391 {
392 "name": "props",
393 "type": {
394 "collection": {
395 "elementtype": {
396 "primitive": "any"
397 },
398 "kind": "map"
399 }
400 }
401 }
402 ],
403 "protected": true,
404 "returns": {
405 "type": {
406 "collection": {
407 "elementtype": {
408 "primitive": "any"
409 },
410 "kind": "map"
411 }
412 }
413 }
414 }
415 ],
416 "name": "CfnQueue",
417 "properties": [
418 {
419 "const": true,
420 "docs": {
421 "stability": "external",
422 "summary": "The CloudFormation resource type name for this resource class."
423 },
424 "immutable": true,
425 "locationInModule": {
426 "filename": "lib/sqs.generated.ts",
427 "line": 290
428 },
429 "name": "CFN_RESOURCE_TYPE_NAME",
430 "static": true,
431 "type": {
432 "primitive": "string"
433 }
434 },
435 {
436 "docs": {
437 "custom": {
438 "cloudformationAttribute": "Arn"
439 },
440 "remarks": "For example: `arn:aws:sqs:us-east-2:123456789012:mystack-myqueue-15PG5C2FC1CW8` .",
441 "stability": "external",
442 "summary": "Returns the Amazon Resource Name (ARN) of the queue."
443 },
444 "immutable": true,
445 "locationInModule": {
446 "filename": "lib/sqs.generated.ts",
447 "line": 315
448 },
449 "name": "attrArn",
450 "type": {
451 "primitive": "string"
452 }
453 },
454 {
455 "docs": {
456 "custom": {
457 "cloudformationAttribute": "QueueName"
458 },
459 "remarks": "For example: `mystack-myqueue-1VF9BKQH5BJVI` .",
460 "stability": "external",
461 "summary": "Returns the queue name."
462 },
463 "immutable": true,
464 "locationInModule": {
465 "filename": "lib/sqs.generated.ts",
466 "line": 321
467 },
468 "name": "attrQueueName",
469 "type": {
470 "primitive": "string"
471 }
472 },
473 {
474 "docs": {
475 "custom": {
476 "cloudformationAttribute": "QueueUrl"
477 },
478 "stability": "external",
479 "summary": "Returns the URLs of the queues from the policy."
480 },
481 "immutable": true,
482 "locationInModule": {
483 "filename": "lib/sqs.generated.ts",
484 "line": 327
485 },
486 "name": "attrQueueUrl",
487 "type": {
488 "primitive": "string"
489 }
490 },
491 {
492 "docs": {
493 "stability": "external"
494 },
495 "immutable": true,
496 "locationInModule": {
497 "filename": "lib/sqs.generated.ts",
498 "line": 529
499 },
500 "name": "cfnProperties",
501 "overrides": "@aws-cdk/core.CfnResource",
502 "protected": true,
503 "type": {
504 "collection": {
505 "elementtype": {
506 "primitive": "any"
507 },
508 "kind": "map"
509 }
510 }
511 },
512 {
513 "docs": {
514 "custom": {
515 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-tags"
516 },
517 "remarks": "For more information, see [Resource tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) in the *AWS CloudFormation User Guide* .",
518 "stability": "external",
519 "summary": "The tags that you attach to this queue."
520 },
521 "immutable": true,
522 "locationInModule": {
523 "filename": "lib/sqs.generated.ts",
524 "line": 469
525 },
526 "name": "tags",
527 "type": {
528 "fqn": "@aws-cdk/core.TagManager"
529 }
530 },
531 {
532 "docs": {
533 "custom": {
534 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-redriveallowpolicy"
535 },
536 "remarks": "The parameters are as follows:\n\n- `redrivePermission` : The permission type that defines which source queues can specify the current queue as the dead-letter queue. Valid values are:\n\n- `allowAll` : (Default) Any source queues in this AWS account in the same Region can specify this queue as the dead-letter queue.\n- `denyAll` : No source queues can specify this queue as the dead-letter queue.\n- `byQueue` : Only queues specified by the `sourceQueueArns` parameter can specify this queue as the dead-letter queue.\n- `sourceQueueArns` : The Amazon Resource Names (ARN)s of the source queues that can specify this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the `redrivePermission` parameter is set to `byQueue` . You can specify up to 10 source queue ARNs. To allow more than 10 source queues to specify dead-letter queues, set the `redrivePermission` parameter to `allowAll` .",
537 "stability": "external",
538 "summary": "The string that includes the parameters for the permissions for the dead-letter queue redrive permission and which source queues can specify dead-letter queues as a JSON object."
539 },
540 "locationInModule": {
541 "filename": "lib/sqs.generated.ts",
542 "line": 433
543 },
544 "name": "redriveAllowPolicy",
545 "type": {
546 "primitive": "any"
547 }
548 },
549 {
550 "docs": {
551 "custom": {
552 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-redrivepolicy"
553 },
554 "remarks": "The parameters are as follows:\n\n- `deadLetterTargetArn` : The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of `maxReceiveCount` is exceeded.\n- `maxReceiveCount` : The number of times a message is delivered to the source queue before being moved to the dead-letter queue. When the `ReceiveCount` for a message exceeds the `maxReceiveCount` for a queue, Amazon SQS moves the message to the dead-letter-queue.\n\n> The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue.\n\n*JSON*\n\n`{ \"deadLetterTargetArn\" : *String* , \"maxReceiveCount\" : *Integer* }`\n\n*YAML*\n\n`deadLetterTargetArn : *String*`\n\n`maxReceiveCount : *Integer*`",
555 "stability": "external",
556 "summary": "The string that includes the parameters for the dead-letter queue functionality of the source queue as a JSON object."
557 },
558 "locationInModule": {
559 "filename": "lib/sqs.generated.ts",
560 "line": 455
561 },
562 "name": "redrivePolicy",
563 "type": {
564 "primitive": "any"
565 }
566 },
567 {
568 "docs": {
569 "custom": {
570 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-contentbaseddeduplication"
571 },
572 "remarks": "During the deduplication interval, Amazon SQS treats messages that are sent with identical content as duplicates and delivers only one copy of the message. For more information, see the `ContentBasedDeduplication` attribute for the `[CreateQueue](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_CreateQueue.html)` action in the *Amazon SQS API Reference* .",
573 "stability": "external",
574 "summary": "For first-in-first-out (FIFO) queues, specifies whether to enable content-based deduplication."
575 },
576 "locationInModule": {
577 "filename": "lib/sqs.generated.ts",
578 "line": 334
579 },
580 "name": "contentBasedDeduplication",
581 "optional": true,
582 "type": {
583 "union": {
584 "types": [
585 {
586 "primitive": "boolean"
587 },
588 {
589 "fqn": "@aws-cdk/core.IResolvable"
590 }
591 ]
592 }
593 }
594 },
595 {
596 "docs": {
597 "custom": {
598 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-deduplicationscope"
599 },
600 "remarks": "Valid values are `messageGroup` and `queue` .\n\nTo enable high throughput for a FIFO queue, set this attribute to `messageGroup` *and* set the `FifoThroughputLimit` attribute to `perMessageGroupId` . If you set these attributes to anything other than these values, normal throughput is in effect and deduplication occurs as specified. For more information, see [High throughput for FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html) and [Quotas related to messages](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html) in the *Amazon SQS Developer Guide* .",
601 "stability": "external",
602 "summary": "For high throughput for FIFO queues, specifies whether message deduplication occurs at the message group or queue level."
603 },
604 "locationInModule": {
605 "filename": "lib/sqs.generated.ts",
606 "line": 343
607 },
608 "name": "deduplicationScope",
609 "optional": true,
610 "type": {
611 "primitive": "string"
612 }
613 },
614 {
615 "docs": {
616 "custom": {
617 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-delayseconds"
618 },
619 "remarks": "You can specify an integer value of `0` to `900` (15 minutes). The default value is `0` .",
620 "stability": "external",
621 "summary": "The time in seconds for which the delivery of all messages in the queue is delayed."
622 },
623 "locationInModule": {
624 "filename": "lib/sqs.generated.ts",
625 "line": 350
626 },
627 "name": "delaySeconds",
628 "optional": true,
629 "type": {
630 "primitive": "number"
631 }
632 },
633 {
634 "docs": {
635 "custom": {
636 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-fifoqueue"
637 },
638 "remarks": "If you don't specify this property, Amazon SQS creates a standard queue. For more information, see [FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html) in the *Amazon SQS Developer Guide* .",
639 "stability": "external",
640 "summary": "If set to true, creates a FIFO queue."
641 },
642 "locationInModule": {
643 "filename": "lib/sqs.generated.ts",
644 "line": 357
645 },
646 "name": "fifoQueue",
647 "optional": true,
648 "type": {
649 "union": {
650 "types": [
651 {
652 "primitive": "boolean"
653 },
654 {
655 "fqn": "@aws-cdk/core.IResolvable"
656 }
657 ]
658 }
659 }
660 },
661 {
662 "docs": {
663 "custom": {
664 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-fifothroughputlimit"
665 },
666 "remarks": "Valid values are `perQueue` and `perMessageGroupId` .\n\nTo enable high throughput for a FIFO queue, set this attribute to `perMessageGroupId` *and* set the `DeduplicationScope` attribute to `messageGroup` . If you set these attributes to anything other than these values, normal throughput is in effect and deduplication occurs as specified. For more information, see [High throughput for FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html) and [Quotas related to messages](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html) in the *Amazon SQS Developer Guide* .",
667 "stability": "external",
668 "summary": "For high throughput for FIFO queues, specifies whether the FIFO queue throughput quota applies to the entire queue or per message group."
669 },
670 "locationInModule": {
671 "filename": "lib/sqs.generated.ts",
672 "line": 366
673 },
674 "name": "fifoThroughputLimit",
675 "optional": true,
676 "type": {
677 "primitive": "string"
678 }
679 },
680 {
681 "docs": {
682 "custom": {
683 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-kmsdatakeyreuseperiodseconds"
684 },
685 "remarks": "The value must be an integer between 60 (1 minute) and 86,400 (24 hours). The default is 300 (5 minutes).\n\n> A shorter time period provides better security, but results in more calls to AWS KMS , which might incur charges after Free Tier. For more information, see [Encryption at rest](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work) in the *Amazon SQS Developer Guide* .",
686 "stability": "external",
687 "summary": "The length of time in seconds for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again."
688 },
689 "locationInModule": {
690 "filename": "lib/sqs.generated.ts",
691 "line": 375
692 },
693 "name": "kmsDataKeyReusePeriodSeconds",
694 "optional": true,
695 "type": {
696 "primitive": "number"
697 }
698 },
699 {
700 "docs": {
701 "custom": {
702 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-kmsmasterkeyid"
703 },
704 "remarks": "To use the AWS managed KMS for Amazon SQS , specify a (default) alias ARN, alias name (e.g. `alias/aws/sqs` ), key ARN, or key ID. For more information, see the following:\n\n- [Encryption at rest](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html) in the *Amazon SQS Developer Guide*\n- [CreateQueue](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_CreateQueue.html) in the *Amazon SQS API Reference*\n- [Request Parameters](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters) in the *AWS Key Management Service API Reference*\n- The Key Management Service (KMS) section of the [AWS Key Management Service Best Practices](https://docs.aws.amazon.com/https://d0.awsstatic.com/whitepapers/aws-kms-best-practices.pdf) whitepaper",
705 "stability": "external",
706 "summary": "The ID of an AWS Key Management Service (KMS) for Amazon SQS , or a custom KMS."
707 },
708 "locationInModule": {
709 "filename": "lib/sqs.generated.ts",
710 "line": 387
711 },
712 "name": "kmsMasterKeyId",
713 "optional": true,
714 "type": {
715 "primitive": "string"
716 }
717 },
718 {
719 "docs": {
720 "custom": {
721 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-maximummessagesize"
722 },
723 "remarks": "You can specify an integer value from `1,024` bytes (1 KiB) to `262,144` bytes (256 KiB). The default value is `262,144` (256 KiB).",
724 "stability": "external",
725 "summary": "The limit of how many bytes that a message can contain before Amazon SQS rejects it."
726 },
727 "locationInModule": {
728 "filename": "lib/sqs.generated.ts",
729 "line": 394
730 },
731 "name": "maximumMessageSize",
732 "optional": true,
733 "type": {
734 "primitive": "number"
735 }
736 },
737 {
738 "docs": {
739 "custom": {
740 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-messageretentionperiod"
741 },
742 "remarks": "You can specify an integer value from `60` seconds (1 minute) to `1,209,600` seconds (14 days). The default value is `345,600` seconds (4 days).",
743 "stability": "external",
744 "summary": "The number of seconds that Amazon SQS retains a message."
745 },
746 "locationInModule": {
747 "filename": "lib/sqs.generated.ts",
748 "line": 401
749 },
750 "name": "messageRetentionPeriod",
751 "optional": true,
752 "type": {
753 "primitive": "number"
754 }
755 },
756 {
757 "docs": {
758 "custom": {
759 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-queuename"
760 },
761 "remarks": "To create a FIFO queue, the name of your FIFO queue must end with the `.fifo` suffix. For more information, see [FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html) in the *Amazon SQS Developer Guide* .\n\nIf you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the queue name. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html) in the *AWS CloudFormation User Guide* .\n\n> If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.",
762 "stability": "external",
763 "summary": "A name for the queue."
764 },
765 "locationInModule": {
766 "filename": "lib/sqs.generated.ts",
767 "line": 412
768 },
769 "name": "queueName",
770 "optional": true,
771 "type": {
772 "primitive": "string"
773 }
774 },
775 {
776 "docs": {
777 "custom": {
778 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-receivemessagewaittimeseconds"
779 },
780 "remarks": "You can specify an integer from 1 to 20. Short polling is used as the default or when you specify 0 for this property. For more information, see [Consuming messages using long polling](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-short-and-long-polling.html#sqs-long-polling) in the *Amazon SQS Developer Guide* .",
781 "stability": "external",
782 "summary": "Specifies the duration, in seconds, that the ReceiveMessage action call waits until a message is in the queue in order to include it in the response, rather than returning an empty response if a message isn't yet available."
783 },
784 "locationInModule": {
785 "filename": "lib/sqs.generated.ts",
786 "line": 419
787 },
788 "name": "receiveMessageWaitTimeSeconds",
789 "optional": true,
790 "type": {
791 "primitive": "number"
792 }
793 },
794 {
795 "docs": {
796 "custom": {
797 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-sqsmanagedsseenabled"
798 },
799 "remarks": "Only one server-side encryption option is supported per queue (for example, [SSE-KMS](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html) or [SSE-SQS](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html) ).",
800 "stability": "external",
801 "summary": "Enables server-side queue encryption using SQS owned encryption keys."
802 },
803 "locationInModule": {
804 "filename": "lib/sqs.generated.ts",
805 "line": 462
806 },
807 "name": "sqsManagedSseEnabled",
808 "optional": true,
809 "type": {
810 "union": {
811 "types": [
812 {
813 "primitive": "boolean"
814 },
815 {
816 "fqn": "@aws-cdk/core.IResolvable"
817 }
818 ]
819 }
820 }
821 },
822 {
823 "docs": {
824 "custom": {
825 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-visibilitytimeout"
826 },
827 "remarks": "This blocks other components from receiving the same message and gives the initial component time to process and delete the message from the queue.\n\nValues must be from 0 to 43,200 seconds (12 hours). If you don't specify a value, AWS CloudFormation uses the default value of 30 seconds.\n\nFor more information about Amazon SQS queue visibility timeouts, see [Visibility timeout](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html) in the *Amazon SQS Developer Guide* .",
828 "stability": "external",
829 "summary": "The length of time during which a message will be unavailable after a message is delivered from the queue."
830 },
831 "locationInModule": {
832 "filename": "lib/sqs.generated.ts",
833 "line": 480
834 },
835 "name": "visibilityTimeout",
836 "optional": true,
837 "type": {
838 "primitive": "number"
839 }
840 }
841 ],
842 "symbolId": "lib/sqs.generated:CfnQueue"
843 },
844 "@aws-cdk/aws-sqs.CfnQueuePolicy": {
845 "assembly": "@aws-cdk/aws-sqs",
846 "base": "@aws-cdk/core.CfnResource",
847 "docs": {
848 "custom": {
849 "cloudformationResource": "AWS::SQS::QueuePolicy",
850 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-policy.html",
851 "exampleMetadata": "fixture=_generated"
852 },
853 "remarks": "The `AWS::SQS::QueuePolicy` type applies a policy to Amazon SQS queues. For an example snippet, see [Declaring an Amazon SQS policy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-iam.html#scenario-sqs-policy) in the *AWS CloudFormation User Guide* .",
854 "stability": "external",
855 "summary": "A CloudFormation `AWS::SQS::QueuePolicy`.",
856 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as sqs from '@aws-cdk/aws-sqs';\n\ndeclare const policyDocument: any;\nconst cfnQueuePolicy = new sqs.CfnQueuePolicy(this, 'MyCfnQueuePolicy', {\n policyDocument: policyDocument,\n queues: ['queues'],\n});"
857 },
858 "fqn": "@aws-cdk/aws-sqs.CfnQueuePolicy",
859 "initializer": {
860 "docs": {
861 "stability": "external",
862 "summary": "Create a new `AWS::SQS::QueuePolicy`."
863 },
864 "locationInModule": {
865 "filename": "lib/sqs.generated.ts",
866 "line": 686
867 },
868 "parameters": [
869 {
870 "docs": {
871 "summary": "- scope in which this resource is defined."
872 },
873 "name": "scope",
874 "type": {
875 "fqn": "@aws-cdk/core.Construct"
876 }
877 },
878 {
879 "docs": {
880 "summary": "- scoped id of the resource."
881 },
882 "name": "id",
883 "type": {
884 "primitive": "string"
885 }
886 },
887 {
888 "docs": {
889 "summary": "- resource properties."
890 },
891 "name": "props",
892 "type": {
893 "fqn": "@aws-cdk/aws-sqs.CfnQueuePolicyProps"
894 }
895 }
896 ]
897 },
898 "interfaces": [
899 "@aws-cdk/core.IInspectable"
900 ],
901 "kind": "class",
902 "locationInModule": {
903 "filename": "lib/sqs.generated.ts",
904 "line": 640
905 },
906 "methods": [
907 {
908 "docs": {
909 "stability": "external",
910 "summary": "Examines the CloudFormation resource and discloses attributes."
911 },
912 "locationInModule": {
913 "filename": "lib/sqs.generated.ts",
914 "line": 701
915 },
916 "name": "inspect",
917 "overrides": "@aws-cdk/core.IInspectable",
918 "parameters": [
919 {
920 "docs": {
921 "summary": "- tree inspector to collect and process attributes."
922 },
923 "name": "inspector",
924 "type": {
925 "fqn": "@aws-cdk/core.TreeInspector"
926 }
927 }
928 ]
929 },
930 {
931 "docs": {
932 "stability": "external"
933 },
934 "locationInModule": {
935 "filename": "lib/sqs.generated.ts",
936 "line": 713
937 },
938 "name": "renderProperties",
939 "overrides": "@aws-cdk/core.CfnResource",
940 "parameters": [
941 {
942 "name": "props",
943 "type": {
944 "collection": {
945 "elementtype": {
946 "primitive": "any"
947 },
948 "kind": "map"
949 }
950 }
951 }
952 ],
953 "protected": true,
954 "returns": {
955 "type": {
956 "collection": {
957 "elementtype": {
958 "primitive": "any"
959 },
960 "kind": "map"
961 }
962 }
963 }
964 }
965 ],
966 "name": "CfnQueuePolicy",
967 "properties": [
968 {
969 "const": true,
970 "docs": {
971 "stability": "external",
972 "summary": "The CloudFormation resource type name for this resource class."
973 },
974 "immutable": true,
975 "locationInModule": {
976 "filename": "lib/sqs.generated.ts",
977 "line": 644
978 },
979 "name": "CFN_RESOURCE_TYPE_NAME",
980 "static": true,
981 "type": {
982 "primitive": "string"
983 }
984 },
985 {
986 "docs": {
987 "stability": "external"
988 },
989 "immutable": true,
990 "locationInModule": {
991 "filename": "lib/sqs.generated.ts",
992 "line": 706
993 },
994 "name": "cfnProperties",
995 "overrides": "@aws-cdk/core.CfnResource",
996 "protected": true,
997 "type": {
998 "collection": {
999 "elementtype": {
1000 "primitive": "any"
1001 },
1002 "kind": "map"
1003 }
1004 }
1005 },
1006 {
1007 "docs": {
1008 "custom": {
1009 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-policy.html#cfn-sqs-queuepolicy-policydoc"
1010 },
1011 "remarks": "For more information about Amazon SQS policies, see [Using custom policies with the Amazon SQS access policy language](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-creating-custom-policies.html) in the *Amazon SQS Developer Guide* .",
1012 "stability": "external",
1013 "summary": "A policy document that contains the permissions for the specified Amazon SQS queues."
1014 },
1015 "locationInModule": {
1016 "filename": "lib/sqs.generated.ts",
1017 "line": 670
1018 },
1019 "name": "policyDocument",
1020 "type": {
1021 "primitive": "any"
1022 }
1023 },
1024 {
1025 "docs": {
1026 "custom": {
1027 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-policy.html#cfn-sqs-queuepolicy-queues"
1028 },
1029 "remarks": "You can use the `[Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html)` function to specify an `[AWS::SQS::Queue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-queues.html)` resource.",
1030 "stability": "external",
1031 "summary": "The URLs of the queues to which you want to add the policy."
1032 },
1033 "locationInModule": {
1034 "filename": "lib/sqs.generated.ts",
1035 "line": 677
1036 },
1037 "name": "queues",
1038 "type": {
1039 "collection": {
1040 "elementtype": {
1041 "primitive": "string"
1042 },
1043 "kind": "array"
1044 }
1045 }
1046 }
1047 ],
1048 "symbolId": "lib/sqs.generated:CfnQueuePolicy"
1049 },
1050 "@aws-cdk/aws-sqs.CfnQueuePolicyProps": {
1051 "assembly": "@aws-cdk/aws-sqs",
1052 "datatype": true,
1053 "docs": {
1054 "custom": {
1055 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-policy.html",
1056 "exampleMetadata": "fixture=_generated"
1057 },
1058 "stability": "external",
1059 "summary": "Properties for defining a `CfnQueuePolicy`.",
1060 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as sqs from '@aws-cdk/aws-sqs';\n\ndeclare const policyDocument: any;\nconst cfnQueuePolicyProps: sqs.CfnQueuePolicyProps = {\n policyDocument: policyDocument,\n queues: ['queues'],\n};"
1061 },
1062 "fqn": "@aws-cdk/aws-sqs.CfnQueuePolicyProps",
1063 "kind": "interface",
1064 "locationInModule": {
1065 "filename": "lib/sqs.generated.ts",
1066 "line": 563
1067 },
1068 "name": "CfnQueuePolicyProps",
1069 "properties": [
1070 {
1071 "abstract": true,
1072 "docs": {
1073 "custom": {
1074 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-policy.html#cfn-sqs-queuepolicy-policydoc"
1075 },
1076 "remarks": "For more information about Amazon SQS policies, see [Using custom policies with the Amazon SQS access policy language](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-creating-custom-policies.html) in the *Amazon SQS Developer Guide* .",
1077 "stability": "external",
1078 "summary": "A policy document that contains the permissions for the specified Amazon SQS queues."
1079 },
1080 "immutable": true,
1081 "locationInModule": {
1082 "filename": "lib/sqs.generated.ts",
1083 "line": 570
1084 },
1085 "name": "policyDocument",
1086 "type": {
1087 "primitive": "any"
1088 }
1089 },
1090 {
1091 "abstract": true,
1092 "docs": {
1093 "custom": {
1094 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-policy.html#cfn-sqs-queuepolicy-queues"
1095 },
1096 "remarks": "You can use the `[Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html)` function to specify an `[AWS::SQS::Queue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-queues.html)` resource.",
1097 "stability": "external",
1098 "summary": "The URLs of the queues to which you want to add the policy."
1099 },
1100 "immutable": true,
1101 "locationInModule": {
1102 "filename": "lib/sqs.generated.ts",
1103 "line": 577
1104 },
1105 "name": "queues",
1106 "type": {
1107 "collection": {
1108 "elementtype": {
1109 "primitive": "string"
1110 },
1111 "kind": "array"
1112 }
1113 }
1114 }
1115 ],
1116 "symbolId": "lib/sqs.generated:CfnQueuePolicyProps"
1117 },
1118 "@aws-cdk/aws-sqs.CfnQueueProps": {
1119 "assembly": "@aws-cdk/aws-sqs",
1120 "datatype": true,
1121 "docs": {
1122 "custom": {
1123 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html",
1124 "exampleMetadata": "fixture=_generated"
1125 },
1126 "stability": "external",
1127 "summary": "Properties for defining a `CfnQueue`.",
1128 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as sqs from '@aws-cdk/aws-sqs';\n\ndeclare const redriveAllowPolicy: any;\ndeclare const redrivePolicy: any;\nconst cfnQueueProps: sqs.CfnQueueProps = {\n contentBasedDeduplication: false,\n deduplicationScope: 'deduplicationScope',\n delaySeconds: 123,\n fifoQueue: false,\n fifoThroughputLimit: 'fifoThroughputLimit',\n kmsDataKeyReusePeriodSeconds: 123,\n kmsMasterKeyId: 'kmsMasterKeyId',\n maximumMessageSize: 123,\n messageRetentionPeriod: 123,\n queueName: 'queueName',\n receiveMessageWaitTimeSeconds: 123,\n redriveAllowPolicy: redriveAllowPolicy,\n redrivePolicy: redrivePolicy,\n sqsManagedSseEnabled: false,\n tags: [{\n key: 'key',\n value: 'value',\n }],\n visibilityTimeout: 123,\n};"
1129 },
1130 "fqn": "@aws-cdk/aws-sqs.CfnQueueProps",
1131 "kind": "interface",
1132 "locationInModule": {
1133 "filename": "lib/sqs.generated.ts",
1134 "line": 19
1135 },
1136 "name": "CfnQueueProps",
1137 "properties": [
1138 {
1139 "abstract": true,
1140 "docs": {
1141 "custom": {
1142 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-contentbaseddeduplication"
1143 },
1144 "remarks": "During the deduplication interval, Amazon SQS treats messages that are sent with identical content as duplicates and delivers only one copy of the message. For more information, see the `ContentBasedDeduplication` attribute for the `[CreateQueue](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_CreateQueue.html)` action in the *Amazon SQS API Reference* .",
1145 "stability": "external",
1146 "summary": "For first-in-first-out (FIFO) queues, specifies whether to enable content-based deduplication."
1147 },
1148 "immutable": true,
1149 "locationInModule": {
1150 "filename": "lib/sqs.generated.ts",
1151 "line": 26
1152 },
1153 "name": "contentBasedDeduplication",
1154 "optional": true,
1155 "type": {
1156 "union": {
1157 "types": [
1158 {
1159 "primitive": "boolean"
1160 },
1161 {
1162 "fqn": "@aws-cdk/core.IResolvable"
1163 }
1164 ]
1165 }
1166 }
1167 },
1168 {
1169 "abstract": true,
1170 "docs": {
1171 "custom": {
1172 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-deduplicationscope"
1173 },
1174 "remarks": "Valid values are `messageGroup` and `queue` .\n\nTo enable high throughput for a FIFO queue, set this attribute to `messageGroup` *and* set the `FifoThroughputLimit` attribute to `perMessageGroupId` . If you set these attributes to anything other than these values, normal throughput is in effect and deduplication occurs as specified. For more information, see [High throughput for FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html) and [Quotas related to messages](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html) in the *Amazon SQS Developer Guide* .",
1175 "stability": "external",
1176 "summary": "For high throughput for FIFO queues, specifies whether message deduplication occurs at the message group or queue level."
1177 },
1178 "immutable": true,
1179 "locationInModule": {
1180 "filename": "lib/sqs.generated.ts",
1181 "line": 35
1182 },
1183 "name": "deduplicationScope",
1184 "optional": true,
1185 "type": {
1186 "primitive": "string"
1187 }
1188 },
1189 {
1190 "abstract": true,
1191 "docs": {
1192 "custom": {
1193 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-delayseconds"
1194 },
1195 "remarks": "You can specify an integer value of `0` to `900` (15 minutes). The default value is `0` .",
1196 "stability": "external",
1197 "summary": "The time in seconds for which the delivery of all messages in the queue is delayed."
1198 },
1199 "immutable": true,
1200 "locationInModule": {
1201 "filename": "lib/sqs.generated.ts",
1202 "line": 42
1203 },
1204 "name": "delaySeconds",
1205 "optional": true,
1206 "type": {
1207 "primitive": "number"
1208 }
1209 },
1210 {
1211 "abstract": true,
1212 "docs": {
1213 "custom": {
1214 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-fifoqueue"
1215 },
1216 "remarks": "If you don't specify this property, Amazon SQS creates a standard queue. For more information, see [FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html) in the *Amazon SQS Developer Guide* .",
1217 "stability": "external",
1218 "summary": "If set to true, creates a FIFO queue."
1219 },
1220 "immutable": true,
1221 "locationInModule": {
1222 "filename": "lib/sqs.generated.ts",
1223 "line": 49
1224 },
1225 "name": "fifoQueue",
1226 "optional": true,
1227 "type": {
1228 "union": {
1229 "types": [
1230 {
1231 "primitive": "boolean"
1232 },
1233 {
1234 "fqn": "@aws-cdk/core.IResolvable"
1235 }
1236 ]
1237 }
1238 }
1239 },
1240 {
1241 "abstract": true,
1242 "docs": {
1243 "custom": {
1244 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-fifothroughputlimit"
1245 },
1246 "remarks": "Valid values are `perQueue` and `perMessageGroupId` .\n\nTo enable high throughput for a FIFO queue, set this attribute to `perMessageGroupId` *and* set the `DeduplicationScope` attribute to `messageGroup` . If you set these attributes to anything other than these values, normal throughput is in effect and deduplication occurs as specified. For more information, see [High throughput for FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html) and [Quotas related to messages](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html) in the *Amazon SQS Developer Guide* .",
1247 "stability": "external",
1248 "summary": "For high throughput for FIFO queues, specifies whether the FIFO queue throughput quota applies to the entire queue or per message group."
1249 },
1250 "immutable": true,
1251 "locationInModule": {
1252 "filename": "lib/sqs.generated.ts",
1253 "line": 58
1254 },
1255 "name": "fifoThroughputLimit",
1256 "optional": true,
1257 "type": {
1258 "primitive": "string"
1259 }
1260 },
1261 {
1262 "abstract": true,
1263 "docs": {
1264 "custom": {
1265 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-kmsdatakeyreuseperiodseconds"
1266 },
1267 "remarks": "The value must be an integer between 60 (1 minute) and 86,400 (24 hours). The default is 300 (5 minutes).\n\n> A shorter time period provides better security, but results in more calls to AWS KMS , which might incur charges after Free Tier. For more information, see [Encryption at rest](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work) in the *Amazon SQS Developer Guide* .",
1268 "stability": "external",
1269 "summary": "The length of time in seconds for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again."
1270 },
1271 "immutable": true,
1272 "locationInModule": {
1273 "filename": "lib/sqs.generated.ts",
1274 "line": 67
1275 },
1276 "name": "kmsDataKeyReusePeriodSeconds",
1277 "optional": true,
1278 "type": {
1279 "primitive": "number"
1280 }
1281 },
1282 {
1283 "abstract": true,
1284 "docs": {
1285 "custom": {
1286 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-kmsmasterkeyid"
1287 },
1288 "remarks": "To use the AWS managed KMS for Amazon SQS , specify a (default) alias ARN, alias name (e.g. `alias/aws/sqs` ), key ARN, or key ID. For more information, see the following:\n\n- [Encryption at rest](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html) in the *Amazon SQS Developer Guide*\n- [CreateQueue](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_CreateQueue.html) in the *Amazon SQS API Reference*\n- [Request Parameters](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters) in the *AWS Key Management Service API Reference*\n- The Key Management Service (KMS) section of the [AWS Key Management Service Best Practices](https://docs.aws.amazon.com/https://d0.awsstatic.com/whitepapers/aws-kms-best-practices.pdf) whitepaper",
1289 "stability": "external",
1290 "summary": "The ID of an AWS Key Management Service (KMS) for Amazon SQS , or a custom KMS."
1291 },
1292 "immutable": true,
1293 "locationInModule": {
1294 "filename": "lib/sqs.generated.ts",
1295 "line": 79
1296 },
1297 "name": "kmsMasterKeyId",
1298 "optional": true,
1299 "type": {
1300 "primitive": "string"
1301 }
1302 },
1303 {
1304 "abstract": true,
1305 "docs": {
1306 "custom": {
1307 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-maximummessagesize"
1308 },
1309 "remarks": "You can specify an integer value from `1,024` bytes (1 KiB) to `262,144` bytes (256 KiB). The default value is `262,144` (256 KiB).",
1310 "stability": "external",
1311 "summary": "The limit of how many bytes that a message can contain before Amazon SQS rejects it."
1312 },
1313 "immutable": true,
1314 "locationInModule": {
1315 "filename": "lib/sqs.generated.ts",
1316 "line": 86
1317 },
1318 "name": "maximumMessageSize",
1319 "optional": true,
1320 "type": {
1321 "primitive": "number"
1322 }
1323 },
1324 {
1325 "abstract": true,
1326 "docs": {
1327 "custom": {
1328 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-messageretentionperiod"
1329 },
1330 "remarks": "You can specify an integer value from `60` seconds (1 minute) to `1,209,600` seconds (14 days). The default value is `345,600` seconds (4 days).",
1331 "stability": "external",
1332 "summary": "The number of seconds that Amazon SQS retains a message."
1333 },
1334 "immutable": true,
1335 "locationInModule": {
1336 "filename": "lib/sqs.generated.ts",
1337 "line": 93
1338 },
1339 "name": "messageRetentionPeriod",
1340 "optional": true,
1341 "type": {
1342 "primitive": "number"
1343 }
1344 },
1345 {
1346 "abstract": true,
1347 "docs": {
1348 "custom": {
1349 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-queuename"
1350 },
1351 "remarks": "To create a FIFO queue, the name of your FIFO queue must end with the `.fifo` suffix. For more information, see [FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html) in the *Amazon SQS Developer Guide* .\n\nIf you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the queue name. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html) in the *AWS CloudFormation User Guide* .\n\n> If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.",
1352 "stability": "external",
1353 "summary": "A name for the queue."
1354 },
1355 "immutable": true,
1356 "locationInModule": {
1357 "filename": "lib/sqs.generated.ts",
1358 "line": 104
1359 },
1360 "name": "queueName",
1361 "optional": true,
1362 "type": {
1363 "primitive": "string"
1364 }
1365 },
1366 {
1367 "abstract": true,
1368 "docs": {
1369 "custom": {
1370 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-receivemessagewaittimeseconds"
1371 },
1372 "remarks": "You can specify an integer from 1 to 20. Short polling is used as the default or when you specify 0 for this property. For more information, see [Consuming messages using long polling](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-short-and-long-polling.html#sqs-long-polling) in the *Amazon SQS Developer Guide* .",
1373 "stability": "external",
1374 "summary": "Specifies the duration, in seconds, that the ReceiveMessage action call waits until a message is in the queue in order to include it in the response, rather than returning an empty response if a message isn't yet available."
1375 },
1376 "immutable": true,
1377 "locationInModule": {
1378 "filename": "lib/sqs.generated.ts",
1379 "line": 111
1380 },
1381 "name": "receiveMessageWaitTimeSeconds",
1382 "optional": true,
1383 "type": {
1384 "primitive": "number"
1385 }
1386 },
1387 {
1388 "abstract": true,
1389 "docs": {
1390 "custom": {
1391 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-redriveallowpolicy"
1392 },
1393 "remarks": "The parameters are as follows:\n\n- `redrivePermission` : The permission type that defines which source queues can specify the current queue as the dead-letter queue. Valid values are:\n\n- `allowAll` : (Default) Any source queues in this AWS account in the same Region can specify this queue as the dead-letter queue.\n- `denyAll` : No source queues can specify this queue as the dead-letter queue.\n- `byQueue` : Only queues specified by the `sourceQueueArns` parameter can specify this queue as the dead-letter queue.\n- `sourceQueueArns` : The Amazon Resource Names (ARN)s of the source queues that can specify this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the `redrivePermission` parameter is set to `byQueue` . You can specify up to 10 source queue ARNs. To allow more than 10 source queues to specify dead-letter queues, set the `redrivePermission` parameter to `allowAll` .",
1394 "stability": "external",
1395 "summary": "The string that includes the parameters for the permissions for the dead-letter queue redrive permission and which source queues can specify dead-letter queues as a JSON object."
1396 },
1397 "immutable": true,
1398 "locationInModule": {
1399 "filename": "lib/sqs.generated.ts",
1400 "line": 125
1401 },
1402 "name": "redriveAllowPolicy",
1403 "optional": true,
1404 "type": {
1405 "primitive": "any"
1406 }
1407 },
1408 {
1409 "abstract": true,
1410 "docs": {
1411 "custom": {
1412 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-redrivepolicy"
1413 },
1414 "remarks": "The parameters are as follows:\n\n- `deadLetterTargetArn` : The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of `maxReceiveCount` is exceeded.\n- `maxReceiveCount` : The number of times a message is delivered to the source queue before being moved to the dead-letter queue. When the `ReceiveCount` for a message exceeds the `maxReceiveCount` for a queue, Amazon SQS moves the message to the dead-letter-queue.\n\n> The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue.\n\n*JSON*\n\n`{ \"deadLetterTargetArn\" : *String* , \"maxReceiveCount\" : *Integer* }`\n\n*YAML*\n\n`deadLetterTargetArn : *String*`\n\n`maxReceiveCount : *Integer*`",
1415 "stability": "external",
1416 "summary": "The string that includes the parameters for the dead-letter queue functionality of the source queue as a JSON object."
1417 },
1418 "immutable": true,
1419 "locationInModule": {
1420 "filename": "lib/sqs.generated.ts",
1421 "line": 147
1422 },
1423 "name": "redrivePolicy",
1424 "optional": true,
1425 "type": {
1426 "primitive": "any"
1427 }
1428 },
1429 {
1430 "abstract": true,
1431 "docs": {
1432 "custom": {
1433 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-sqsmanagedsseenabled"
1434 },
1435 "remarks": "Only one server-side encryption option is supported per queue (for example, [SSE-KMS](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html) or [SSE-SQS](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html) ).",
1436 "stability": "external",
1437 "summary": "Enables server-side queue encryption using SQS owned encryption keys."
1438 },
1439 "immutable": true,
1440 "locationInModule": {
1441 "filename": "lib/sqs.generated.ts",
1442 "line": 154
1443 },
1444 "name": "sqsManagedSseEnabled",
1445 "optional": true,
1446 "type": {
1447 "union": {
1448 "types": [
1449 {
1450 "primitive": "boolean"
1451 },
1452 {
1453 "fqn": "@aws-cdk/core.IResolvable"
1454 }
1455 ]
1456 }
1457 }
1458 },
1459 {
1460 "abstract": true,
1461 "docs": {
1462 "custom": {
1463 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-tags"
1464 },
1465 "remarks": "For more information, see [Resource tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) in the *AWS CloudFormation User Guide* .",
1466 "stability": "external",
1467 "summary": "The tags that you attach to this queue."
1468 },
1469 "immutable": true,
1470 "locationInModule": {
1471 "filename": "lib/sqs.generated.ts",
1472 "line": 161
1473 },
1474 "name": "tags",
1475 "optional": true,
1476 "type": {
1477 "collection": {
1478 "elementtype": {
1479 "fqn": "@aws-cdk/core.CfnTag"
1480 },
1481 "kind": "array"
1482 }
1483 }
1484 },
1485 {
1486 "abstract": true,
1487 "docs": {
1488 "custom": {
1489 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-visibilitytimeout"
1490 },
1491 "remarks": "This blocks other components from receiving the same message and gives the initial component time to process and delete the message from the queue.\n\nValues must be from 0 to 43,200 seconds (12 hours). If you don't specify a value, AWS CloudFormation uses the default value of 30 seconds.\n\nFor more information about Amazon SQS queue visibility timeouts, see [Visibility timeout](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html) in the *Amazon SQS Developer Guide* .",
1492 "stability": "external",
1493 "summary": "The length of time during which a message will be unavailable after a message is delivered from the queue."
1494 },
1495 "immutable": true,
1496 "locationInModule": {
1497 "filename": "lib/sqs.generated.ts",
1498 "line": 172
1499 },
1500 "name": "visibilityTimeout",
1501 "optional": true,
1502 "type": {
1503 "primitive": "number"
1504 }
1505 }
1506 ],
1507 "symbolId": "lib/sqs.generated:CfnQueueProps"
1508 },
1509 "@aws-cdk/aws-sqs.DeadLetterQueue": {
1510 "assembly": "@aws-cdk/aws-sqs",
1511 "datatype": true,
1512 "docs": {
1513 "stability": "stable",
1514 "summary": "Dead letter queue settings.",
1515 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as sqs from '@aws-cdk/aws-sqs';\n\ndeclare const queue: sqs.Queue;\nconst deadLetterQueue: sqs.DeadLetterQueue = {\n maxReceiveCount: 123,\n queue: queue,\n};",
1516 "custom": {
1517 "exampleMetadata": "fixture=_generated"
1518 }
1519 },
1520 "fqn": "@aws-cdk/aws-sqs.DeadLetterQueue",
1521 "kind": "interface",
1522 "locationInModule": {
1523 "filename": "lib/queue.ts",
1524 "line": 177
1525 },
1526 "name": "DeadLetterQueue",
1527 "properties": [
1528 {
1529 "abstract": true,
1530 "docs": {
1531 "stability": "stable",
1532 "summary": "The number of times a message can be unsuccesfully dequeued before being moved to the dead-letter queue."
1533 },
1534 "immutable": true,
1535 "locationInModule": {
1536 "filename": "lib/queue.ts",
1537 "line": 186
1538 },
1539 "name": "maxReceiveCount",
1540 "type": {
1541 "primitive": "number"
1542 }
1543 },
1544 {
1545 "abstract": true,
1546 "docs": {
1547 "stability": "stable",
1548 "summary": "The dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded."
1549 },
1550 "immutable": true,
1551 "locationInModule": {
1552 "filename": "lib/queue.ts",
1553 "line": 181
1554 },
1555 "name": "queue",
1556 "type": {
1557 "fqn": "@aws-cdk/aws-sqs.IQueue"
1558 }
1559 }
1560 ],
1561 "symbolId": "lib/queue:DeadLetterQueue"
1562 },
1563 "@aws-cdk/aws-sqs.DeduplicationScope": {
1564 "assembly": "@aws-cdk/aws-sqs",
1565 "docs": {
1566 "stability": "stable",
1567 "summary": "What kind of deduplication scope to apply."
1568 },
1569 "fqn": "@aws-cdk/aws-sqs.DeduplicationScope",
1570 "kind": "enum",
1571 "locationInModule": {
1572 "filename": "lib/queue.ts",
1573 "line": 214
1574 },
1575 "members": [
1576 {
1577 "docs": {
1578 "stability": "stable",
1579 "summary": "Deduplication occurs at the message group level."
1580 },
1581 "name": "MESSAGE_GROUP"
1582 },
1583 {
1584 "docs": {
1585 "stability": "stable",
1586 "summary": "Deduplication occurs at the message queue level."
1587 },
1588 "name": "QUEUE"
1589 }
1590 ],
1591 "name": "DeduplicationScope",
1592 "symbolId": "lib/queue:DeduplicationScope"
1593 },
1594 "@aws-cdk/aws-sqs.FifoThroughputLimit": {
1595 "assembly": "@aws-cdk/aws-sqs",
1596 "docs": {
1597 "stability": "stable",
1598 "summary": "Whether the FIFO queue throughput quota applies to the entire queue or per message group."
1599 },
1600 "fqn": "@aws-cdk/aws-sqs.FifoThroughputLimit",
1601 "kind": "enum",
1602 "locationInModule": {
1603 "filename": "lib/queue.ts",
1604 "line": 228
1605 },
1606 "members": [
1607 {
1608 "docs": {
1609 "stability": "stable",
1610 "summary": "Throughput quota applies per queue."
1611 },
1612 "name": "PER_QUEUE"
1613 },
1614 {
1615 "docs": {
1616 "stability": "stable",
1617 "summary": "Throughput quota applies per message group id."
1618 },
1619 "name": "PER_MESSAGE_GROUP_ID"
1620 }
1621 ],
1622 "name": "FifoThroughputLimit",
1623 "symbolId": "lib/queue:FifoThroughputLimit"
1624 },
1625 "@aws-cdk/aws-sqs.IQueue": {
1626 "assembly": "@aws-cdk/aws-sqs",
1627 "docs": {
1628 "stability": "stable",
1629 "summary": "Represents an SQS queue."
1630 },
1631 "fqn": "@aws-cdk/aws-sqs.IQueue",
1632 "interfaces": [
1633 "@aws-cdk/core.IResource"
1634 ],
1635 "kind": "interface",
1636 "locationInModule": {
1637 "filename": "lib/queue-base.ts",
1638 "line": 9
1639 },
1640 "methods": [
1641 {
1642 "abstract": true,
1643 "docs": {
1644 "remarks": "If this queue was created in this stack (`new Queue`), a queue policy\nwill be automatically created upon the first call to `addToPolicy`. If\nthe queue is imported (`Queue.import`), then this is a no-op.",
1645 "stability": "stable",
1646 "summary": "Adds a statement to the IAM resource policy associated with this queue."
1647 },
1648 "locationInModule": {
1649 "filename": "lib/queue-base.ts",
1650 "line": 45
1651 },
1652 "name": "addToResourcePolicy",
1653 "parameters": [
1654 {
1655 "name": "statement",
1656 "type": {
1657 "fqn": "@aws-cdk/aws-iam.PolicyStatement"
1658 }
1659 }
1660 ],
1661 "returns": {
1662 "type": {
1663 "fqn": "@aws-cdk/aws-iam.AddToResourcePolicyResult"
1664 }
1665 }
1666 },
1667 {
1668 "abstract": true,
1669 "docs": {
1670 "stability": "stable",
1671 "summary": "Grant the actions defined in queueActions to the identity Principal given on this SQS queue resource."
1672 },
1673 "locationInModule": {
1674 "filename": "lib/queue-base.ts",
1675 "line": 95
1676 },
1677 "name": "grant",
1678 "parameters": [
1679 {
1680 "docs": {
1681 "summary": "Principal to grant right to."
1682 },
1683 "name": "grantee",
1684 "type": {
1685 "fqn": "@aws-cdk/aws-iam.IGrantable"
1686 }
1687 },
1688 {
1689 "docs": {
1690 "summary": "The actions to grant."
1691 },
1692 "name": "queueActions",
1693 "type": {
1694 "primitive": "string"
1695 },
1696 "variadic": true
1697 }
1698 ],
1699 "returns": {
1700 "type": {
1701 "fqn": "@aws-cdk/aws-iam.Grant"
1702 }
1703 },
1704 "variadic": true
1705 },
1706 {
1707 "abstract": true,
1708 "docs": {
1709 "remarks": "This will grant the following permissions:\n\n - sqs:ChangeMessageVisibility\n - sqs:DeleteMessage\n - sqs:ReceiveMessage\n - sqs:GetQueueAttributes\n - sqs:GetQueueUrl",
1710 "stability": "stable",
1711 "summary": "Grant permissions to consume messages from a queue."
1712 },
1713 "locationInModule": {
1714 "filename": "lib/queue-base.ts",
1715 "line": 60
1716 },
1717 "name": "grantConsumeMessages",
1718 "parameters": [
1719 {
1720 "docs": {
1721 "summary": "Principal to grant consume rights to."
1722 },
1723 "name": "grantee",
1724 "type": {
1725 "fqn": "@aws-cdk/aws-iam.IGrantable"
1726 }
1727 }
1728 ],
1729 "returns": {
1730 "type": {
1731 "fqn": "@aws-cdk/aws-iam.Grant"
1732 }
1733 }
1734 },
1735 {
1736 "abstract": true,
1737 "docs": {
1738 "remarks": "This will grant the following permissions:\n\n - sqs:PurgeQueue\n - sqs:GetQueueAttributes\n - sqs:GetQueueUrl",
1739 "stability": "stable",
1740 "summary": "Grant an IAM principal permissions to purge all messages from the queue."
1741 },
1742 "locationInModule": {
1743 "filename": "lib/queue-base.ts",
1744 "line": 86
1745 },
1746 "name": "grantPurge",
1747 "parameters": [
1748 {
1749 "docs": {
1750 "summary": "Principal to grant send rights to."
1751 },
1752 "name": "grantee",
1753 "type": {
1754 "fqn": "@aws-cdk/aws-iam.IGrantable"
1755 }
1756 }
1757 ],
1758 "returns": {
1759 "type": {
1760 "fqn": "@aws-cdk/aws-iam.Grant"
1761 }
1762 }
1763 },
1764 {
1765 "abstract": true,
1766 "docs": {
1767 "remarks": "This will grant the following permissions:\n\n - sqs:SendMessage\n - sqs:GetQueueAttributes\n - sqs:GetQueueUrl",
1768 "stability": "stable",
1769 "summary": "Grant access to send messages to a queue to the given identity."
1770 },
1771 "locationInModule": {
1772 "filename": "lib/queue-base.ts",
1773 "line": 73
1774 },
1775 "name": "grantSendMessages",
1776 "parameters": [
1777 {
1778 "docs": {
1779 "summary": "Principal to grant send rights to."
1780 },
1781 "name": "grantee",
1782 "type": {
1783 "fqn": "@aws-cdk/aws-iam.IGrantable"
1784 }
1785 }
1786 ],
1787 "returns": {
1788 "type": {
1789 "fqn": "@aws-cdk/aws-iam.Grant"
1790 }
1791 }
1792 },
1793 {
1794 "abstract": true,
1795 "docs": {
1796 "stability": "stable",
1797 "summary": "Return the given named metric for this Queue."
1798 },
1799 "locationInModule": {
1800 "filename": "lib/sqs-augmentations.generated.ts",
1801 "line": 11
1802 },
1803 "name": "metric",
1804 "parameters": [
1805 {
1806 "name": "metricName",
1807 "type": {
1808 "primitive": "string"
1809 }
1810 },
1811 {
1812 "name": "props",
1813 "optional": true,
1814 "type": {
1815 "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions"
1816 }
1817 }
1818 ],
1819 "returns": {
1820 "type": {
1821 "fqn": "@aws-cdk/aws-cloudwatch.Metric"
1822 }
1823 }
1824 },
1825 {
1826 "abstract": true,
1827 "docs": {
1828 "remarks": "Maximum over 5 minutes",
1829 "stability": "stable",
1830 "summary": "The approximate age of the oldest non-deleted message in the queue."
1831 },
1832 "locationInModule": {
1833 "filename": "lib/sqs-augmentations.generated.ts",
1834 "line": 17
1835 },
1836 "name": "metricApproximateAgeOfOldestMessage",
1837 "parameters": [
1838 {
1839 "name": "props",
1840 "optional": true,
1841 "type": {
1842 "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions"
1843 }
1844 }
1845 ],
1846 "returns": {
1847 "type": {
1848 "fqn": "@aws-cdk/aws-cloudwatch.Metric"
1849 }
1850 }
1851 },
1852 {
1853 "abstract": true,
1854 "docs": {
1855 "remarks": "Maximum over 5 minutes",
1856 "stability": "stable",
1857 "summary": "The number of messages in the queue that are delayed and not available for reading immediately."
1858 },
1859 "locationInModule": {
1860 "filename": "lib/sqs-augmentations.generated.ts",
1861 "line": 23
1862 },
1863 "name": "metricApproximateNumberOfMessagesDelayed",
1864 "parameters": [
1865 {
1866 "name": "props",
1867 "optional": true,
1868 "type": {
1869 "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions"
1870 }
1871 }
1872 ],
1873 "returns": {
1874 "type": {
1875 "fqn": "@aws-cdk/aws-cloudwatch.Metric"
1876 }
1877 }
1878 },
1879 {
1880 "abstract": true,
1881 "docs": {
1882 "remarks": "Maximum over 5 minutes",
1883 "stability": "stable",
1884 "summary": "The number of messages that are in flight."
1885 },
1886 "locationInModule": {
1887 "filename": "lib/sqs-augmentations.generated.ts",
1888 "line": 29
1889 },
1890 "name": "metricApproximateNumberOfMessagesNotVisible",
1891 "parameters": [
1892 {
1893 "name": "props",
1894 "optional": true,
1895 "type": {
1896 "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions"
1897 }
1898 }
1899 ],
1900 "returns": {
1901 "type": {
1902 "fqn": "@aws-cdk/aws-cloudwatch.Metric"
1903 }
1904 }
1905 },
1906 {
1907 "abstract": true,
1908 "docs": {
1909 "remarks": "Maximum over 5 minutes",
1910 "stability": "stable",
1911 "summary": "The number of messages available for retrieval from the queue."
1912 },
1913 "locationInModule": {
1914 "filename": "lib/sqs-augmentations.generated.ts",
1915 "line": 35
1916 },
1917 "name": "metricApproximateNumberOfMessagesVisible",
1918 "parameters": [
1919 {
1920 "name": "props",
1921 "optional": true,
1922 "type": {
1923 "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions"
1924 }
1925 }
1926 ],
1927 "returns": {
1928 "type": {
1929 "fqn": "@aws-cdk/aws-cloudwatch.Metric"
1930 }
1931 }
1932 },
1933 {
1934 "abstract": true,
1935 "docs": {
1936 "remarks": "Sum over 5 minutes",
1937 "stability": "stable",
1938 "summary": "The number of ReceiveMessage API calls that did not return a message."
1939 },
1940 "locationInModule": {
1941 "filename": "lib/sqs-augmentations.generated.ts",
1942 "line": 41
1943 },
1944 "name": "metricNumberOfEmptyReceives",
1945 "parameters": [
1946 {
1947 "name": "props",
1948 "optional": true,
1949 "type": {
1950 "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions"
1951 }
1952 }
1953 ],
1954 "returns": {
1955 "type": {
1956 "fqn": "@aws-cdk/aws-cloudwatch.Metric"
1957 }
1958 }
1959 },
1960 {
1961 "abstract": true,
1962 "docs": {
1963 "remarks": "Sum over 5 minutes",
1964 "stability": "stable",
1965 "summary": "The number of messages deleted from the queue."
1966 },
1967 "locationInModule": {
1968 "filename": "lib/sqs-augmentations.generated.ts",
1969 "line": 47
1970 },
1971 "name": "metricNumberOfMessagesDeleted",
1972 "parameters": [
1973 {
1974 "name": "props",
1975 "optional": true,
1976 "type": {
1977 "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions"
1978 }
1979 }
1980 ],
1981 "returns": {
1982 "type": {
1983 "fqn": "@aws-cdk/aws-cloudwatch.Metric"
1984 }
1985 }
1986 },
1987 {
1988 "abstract": true,
1989 "docs": {
1990 "remarks": "Sum over 5 minutes",
1991 "stability": "stable",
1992 "summary": "The number of messages returned by calls to the ReceiveMessage action."
1993 },
1994 "locationInModule": {
1995 "filename": "lib/sqs-augmentations.generated.ts",
1996 "line": 53
1997 },
1998 "name": "metricNumberOfMessagesReceived",
1999 "parameters": [
2000 {
2001 "name": "props",
2002 "optional": true,
2003 "type": {
2004 "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions"
2005 }
2006 }
2007 ],
2008 "returns": {
2009 "type": {
2010 "fqn": "@aws-cdk/aws-cloudwatch.Metric"
2011 }
2012 }
2013 },
2014 {
2015 "abstract": true,
2016 "docs": {
2017 "remarks": "Sum over 5 minutes",
2018 "stability": "stable",
2019 "summary": "The number of messages added to a queue."
2020 },
2021 "locationInModule": {
2022 "filename": "lib/sqs-augmentations.generated.ts",
2023 "line": 59
2024 },
2025 "name": "metricNumberOfMessagesSent",
2026 "parameters": [
2027 {
2028 "name": "props",
2029 "optional": true,
2030 "type": {
2031 "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions"
2032 }
2033 }
2034 ],
2035 "returns": {
2036 "type": {
2037 "fqn": "@aws-cdk/aws-cloudwatch.Metric"
2038 }
2039 }
2040 },
2041 {
2042 "abstract": true,
2043 "docs": {
2044 "remarks": "Average over 5 minutes",
2045 "stability": "stable",
2046 "summary": "The size of messages added to a queue."
2047 },
2048 "locationInModule": {
2049 "filename": "lib/sqs-augmentations.generated.ts",
2050 "line": 65
2051 },
2052 "name": "metricSentMessageSize",
2053 "parameters": [
2054 {
2055 "name": "props",
2056 "optional": true,
2057 "type": {
2058 "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions"
2059 }
2060 }
2061 ],
2062 "returns": {
2063 "type": {
2064 "fqn": "@aws-cdk/aws-cloudwatch.Metric"
2065 }
2066 }
2067 }
2068 ],
2069 "name": "IQueue",
2070 "properties": [
2071 {
2072 "abstract": true,
2073 "docs": {
2074 "remarks": "If false, this is a standard queue.",
2075 "stability": "stable",
2076 "summary": "Whether this queue is an Amazon SQS FIFO queue."
2077 },
2078 "immutable": true,
2079 "locationInModule": {
2080 "filename": "lib/queue-base.ts",
2081 "line": 36
2082 },
2083 "name": "fifo",
2084 "type": {
2085 "primitive": "boolean"
2086 }
2087 },
2088 {
2089 "abstract": true,
2090 "docs": {
2091 "custom": {
2092 "attribute": "true"
2093 },
2094 "stability": "stable",
2095 "summary": "The ARN of this queue."
2096 },
2097 "immutable": true,
2098 "locationInModule": {
2099 "filename": "lib/queue-base.ts",
2100 "line": 14
2101 },
2102 "name": "queueArn",
2103 "type": {
2104 "primitive": "string"
2105 }
2106 },
2107 {
2108 "abstract": true,
2109 "docs": {
2110 "custom": {
2111 "attribute": "true"
2112 },
2113 "stability": "stable",
2114 "summary": "The name of this queue."
2115 },
2116 "immutable": true,
2117 "locationInModule": {
2118 "filename": "lib/queue-base.ts",
2119 "line": 26
2120 },
2121 "name": "queueName",
2122 "type": {
2123 "primitive": "string"
2124 }
2125 },
2126 {
2127 "abstract": true,
2128 "docs": {
2129 "custom": {
2130 "attribute": "true"
2131 },
2132 "stability": "stable",
2133 "summary": "The URL of this queue."
2134 },
2135 "immutable": true,
2136 "locationInModule": {
2137 "filename": "lib/queue-base.ts",
2138 "line": 20
2139 },
2140 "name": "queueUrl",
2141 "type": {
2142 "primitive": "string"
2143 }
2144 },
2145 {
2146 "abstract": true,
2147 "docs": {
2148 "stability": "stable",
2149 "summary": "If this queue is server-side encrypted, this is the KMS encryption key."
2150 },
2151 "immutable": true,
2152 "locationInModule": {
2153 "filename": "lib/queue-base.ts",
2154 "line": 31
2155 },
2156 "name": "encryptionMasterKey",
2157 "optional": true,
2158 "type": {
2159 "fqn": "@aws-cdk/aws-kms.IKey"
2160 }
2161 }
2162 ],
2163 "symbolId": "lib/queue-base:IQueue"
2164 },
2165 "@aws-cdk/aws-sqs.Queue": {
2166 "assembly": "@aws-cdk/aws-sqs",
2167 "base": "@aws-cdk/aws-sqs.QueueBase",
2168 "docs": {
2169 "stability": "stable",
2170 "summary": "A new Amazon SQS queue.",
2171 "example": "// An sqs queue for unsuccessful invocations of a lambda function\nimport * as sqs from '@aws-cdk/aws-sqs';\n\nconst deadLetterQueue = new sqs.Queue(this, 'DeadLetterQueue');\n\nconst myFn = new lambda.Function(this, 'Fn', {\n runtime: lambda.Runtime.NODEJS_14_X,\n handler: 'index.handler',\n code: lambda.Code.fromInline('// your code'),\n // sqs queue for unsuccessful invocations\n onFailure: new destinations.SqsDestination(deadLetterQueue),\n});",
2172 "custom": {
2173 "exampleMetadata": "infused"
2174 }
2175 },
2176 "fqn": "@aws-cdk/aws-sqs.Queue",
2177 "initializer": {
2178 "docs": {
2179 "stability": "stable"
2180 },
2181 "locationInModule": {
2182 "filename": "lib/queue.ts",
2183 "line": 330
2184 },
2185 "parameters": [
2186 {
2187 "name": "scope",
2188 "type": {
2189 "fqn": "constructs.Construct"
2190 }
2191 },
2192 {
2193 "name": "id",
2194 "type": {
2195 "primitive": "string"
2196 }
2197 },
2198 {
2199 "name": "props",
2200 "optional": true,
2201 "type": {
2202 "fqn": "@aws-cdk/aws-sqs.QueueProps"
2203 }
2204 }
2205 ]
2206 },
2207 "kind": "class",
2208 "locationInModule": {
2209 "filename": "lib/queue.ts",
2210 "line": 242
2211 },
2212 "methods": [
2213 {
2214 "docs": {
2215 "stability": "stable",
2216 "summary": "Import an existing SQS queue provided an ARN."
2217 },
2218 "locationInModule": {
2219 "filename": "lib/queue.ts",
2220 "line": 251
2221 },
2222 "name": "fromQueueArn",
2223 "parameters": [
2224 {
2225 "docs": {
2226 "summary": "The parent creating construct."
2227 },
2228 "name": "scope",
2229 "type": {
2230 "fqn": "constructs.Construct"
2231 }
2232 },
2233 {
2234 "docs": {
2235 "summary": "The construct's name."
2236 },
2237 "name": "id",
2238 "type": {
2239 "primitive": "string"
2240 }
2241 },
2242 {
2243 "docs": {
2244 "summary": "queue ARN (i.e. arn:aws:sqs:us-east-2:444455556666:queue1)."
2245 },
2246 "name": "queueArn",
2247 "type": {
2248 "primitive": "string"
2249 }
2250 }
2251 ],
2252 "returns": {
2253 "type": {
2254 "fqn": "@aws-cdk/aws-sqs.IQueue"
2255 }
2256 },
2257 "static": true
2258 },
2259 {
2260 "docs": {
2261 "stability": "stable",
2262 "summary": "Import an existing queue."
2263 },
2264 "locationInModule": {
2265 "filename": "lib/queue.ts",
2266 "line": 258
2267 },
2268 "name": "fromQueueAttributes",
2269 "parameters": [
2270 {
2271 "name": "scope",
2272 "type": {
2273 "fqn": "constructs.Construct"
2274 }
2275 },
2276 {
2277 "name": "id",
2278 "type": {
2279 "primitive": "string"
2280 }
2281 },
2282 {
2283 "name": "attrs",
2284 "type": {
2285 "fqn": "@aws-cdk/aws-sqs.QueueAttributes"
2286 }
2287 }
2288 ],
2289 "returns": {
2290 "type": {
2291 "fqn": "@aws-cdk/aws-sqs.IQueue"
2292 }
2293 },
2294 "static": true
2295 }
2296 ],
2297 "name": "Queue",
2298 "properties": [
2299 {
2300 "docs": {
2301 "remarks": "Set by subclasses.",
2302 "stability": "stable",
2303 "summary": "Controls automatic creation of policy objects."
2304 },
2305 "immutable": true,
2306 "locationInModule": {
2307 "filename": "lib/queue.ts",
2308 "line": 328
2309 },
2310 "name": "autoCreatePolicy",
2311 "overrides": "@aws-cdk/aws-sqs.QueueBase",
2312 "protected": true,
2313 "type": {
2314 "primitive": "boolean"
2315 }
2316 },
2317 {
2318 "docs": {
2319 "remarks": "If false, this is a standard queue.",
2320 "stability": "stable",
2321 "summary": "Whether this queue is an Amazon SQS FIFO queue."
2322 },
2323 "immutable": true,
2324 "locationInModule": {
2325 "filename": "lib/queue.ts",
2326 "line": 321
2327 },
2328 "name": "fifo",
2329 "overrides": "@aws-cdk/aws-sqs.QueueBase",
2330 "type": {
2331 "primitive": "boolean"
2332 }
2333 },
2334 {
2335 "docs": {
2336 "stability": "stable",
2337 "summary": "The ARN of this queue."
2338 },
2339 "immutable": true,
2340 "locationInModule": {
2341 "filename": "lib/queue.ts",
2342 "line": 301
2343 },
2344 "name": "queueArn",
2345 "overrides": "@aws-cdk/aws-sqs.QueueBase",
2346 "type": {
2347 "primitive": "string"
2348 }
2349 },
2350 {
2351 "docs": {
2352 "stability": "stable",
2353 "summary": "The name of this queue."
2354 },
2355 "immutable": true,
2356 "locationInModule": {
2357 "filename": "lib/queue.ts",
2358 "line": 306
2359 },
2360 "name": "queueName",
2361 "overrides": "@aws-cdk/aws-sqs.QueueBase",
2362 "type": {
2363 "primitive": "string"
2364 }
2365 },
2366 {
2367 "docs": {
2368 "stability": "stable",
2369 "summary": "The URL of this queue."
2370 },
2371 "immutable": true,
2372 "locationInModule": {
2373 "filename": "lib/queue.ts",
2374 "line": 311
2375 },
2376 "name": "queueUrl",
2377 "overrides": "@aws-cdk/aws-sqs.QueueBase",
2378 "type": {
2379 "primitive": "string"
2380 }
2381 },
2382 {
2383 "docs": {
2384 "stability": "stable",
2385 "summary": "If this queue is configured with a dead-letter queue, this is the dead-letter queue settings."
2386 },
2387 "immutable": true,
2388 "locationInModule": {
2389 "filename": "lib/queue.ts",
2390 "line": 326
2391 },
2392 "name": "deadLetterQueue",
2393 "optional": true,
2394 "type": {
2395 "fqn": "@aws-cdk/aws-sqs.DeadLetterQueue"
2396 }
2397 },
2398 {
2399 "docs": {
2400 "stability": "stable",
2401 "summary": "If this queue is encrypted, this is the KMS key."
2402 },
2403 "immutable": true,
2404 "locationInModule": {
2405 "filename": "lib/queue.ts",
2406 "line": 316
2407 },
2408 "name": "encryptionMasterKey",
2409 "optional": true,
2410 "overrides": "@aws-cdk/aws-sqs.QueueBase",
2411 "type": {
2412 "fqn": "@aws-cdk/aws-kms.IKey"
2413 }
2414 }
2415 ],
2416 "symbolId": "lib/queue:Queue"
2417 },
2418 "@aws-cdk/aws-sqs.QueueAttributes": {
2419 "assembly": "@aws-cdk/aws-sqs",
2420 "datatype": true,
2421 "docs": {
2422 "stability": "stable",
2423 "summary": "Reference to a queue.",
2424 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as sqs from '@aws-cdk/aws-sqs';\nconst queueAttributes: sqs.QueueAttributes = {\n queueArn: 'queueArn',\n\n // the properties below are optional\n fifo: false,\n keyArn: 'keyArn',\n queueName: 'queueName',\n queueUrl: 'queueUrl',\n};",
2425 "custom": {
2426 "exampleMetadata": "fixture=_generated"
2427 }
2428 },
2429 "fqn": "@aws-cdk/aws-sqs.QueueAttributes",
2430 "kind": "interface",
2431 "locationInModule": {
2432 "filename": "lib/queue-base.ts",
2433 "line": 252
2434 },
2435 "name": "QueueAttributes",
2436 "properties": [
2437 {
2438 "abstract": true,
2439 "docs": {
2440 "stability": "stable",
2441 "summary": "The ARN of the queue."
2442 },
2443 "immutable": true,
2444 "locationInModule": {
2445 "filename": "lib/queue-base.ts",
2446 "line": 256
2447 },
2448 "name": "queueArn",
2449 "type": {
2450 "primitive": "string"
2451 }
2452 },
2453 {
2454 "abstract": true,
2455 "docs": {
2456 "default": "- if fifo is not specified, the property will be determined based on the queue name (not possible for FIFO queues imported from a token)",
2457 "remarks": "In case of a FIFO queue which is imported from a token, this value has to be explicitly set to true.",
2458 "stability": "stable",
2459 "summary": "Whether this queue is an Amazon SQS FIFO queue. If false, this is a standard queue."
2460 },
2461 "immutable": true,
2462 "locationInModule": {
2463 "filename": "lib/queue-base.ts",
2464 "line": 286
2465 },
2466 "name": "fifo",
2467 "optional": true,
2468 "type": {
2469 "primitive": "boolean"
2470 }
2471 },
2472 {
2473 "abstract": true,
2474 "docs": {
2475 "default": "- None",
2476 "stability": "stable",
2477 "summary": "KMS encryption key, if this queue is server-side encrypted by a KMS key."
2478 },
2479 "immutable": true,
2480 "locationInModule": {
2481 "filename": "lib/queue-base.ts",
2482 "line": 277
2483 },
2484 "name": "keyArn",
2485 "optional": true,
2486 "type": {
2487 "primitive": "string"
2488 }
2489 },
2490 {
2491 "abstract": true,
2492 "docs": {
2493 "default": "if queue name is not specified, the name will be derived from the queue ARN",
2494 "stability": "stable",
2495 "summary": "The name of the queue."
2496 },
2497 "immutable": true,
2498 "locationInModule": {
2499 "filename": "lib/queue-base.ts",
2500 "line": 270
2501 },
2502 "name": "queueName",
2503 "optional": true,
2504 "type": {
2505 "primitive": "string"
2506 }
2507 },
2508 {
2509 "abstract": true,
2510 "docs": {
2511 "default": "- 'https://sqs.<region-endpoint>/<account-ID>/<queue-name>'",
2512 "see": "https://docs.aws.amazon.com/sdk-for-net/v2/developer-guide/QueueURL.html",
2513 "stability": "stable",
2514 "summary": "The URL of the queue."
2515 },
2516 "immutable": true,
2517 "locationInModule": {
2518 "filename": "lib/queue-base.ts",
2519 "line": 264
2520 },
2521 "name": "queueUrl",
2522 "optional": true,
2523 "type": {
2524 "primitive": "string"
2525 }
2526 }
2527 ],
2528 "symbolId": "lib/queue-base:QueueAttributes"
2529 },
2530 "@aws-cdk/aws-sqs.QueueBase": {
2531 "abstract": true,
2532 "assembly": "@aws-cdk/aws-sqs",
2533 "base": "@aws-cdk/core.Resource",
2534 "docs": {
2535 "stability": "stable",
2536 "summary": "Reference to a new or existing Amazon SQS queue."
2537 },
2538 "fqn": "@aws-cdk/aws-sqs.QueueBase",
2539 "initializer": {
2540 "docs": {
2541 "stability": "stable"
2542 },
2543 "locationInModule": {
2544 "filename": "lib/resource.ts",
2545 "line": 150
2546 },
2547 "parameters": [
2548 {
2549 "name": "scope",
2550 "type": {
2551 "fqn": "constructs.Construct"
2552 }
2553 },
2554 {
2555 "name": "id",
2556 "type": {
2557 "primitive": "string"
2558 }
2559 },
2560 {
2561 "name": "props",
2562 "optional": true,
2563 "type": {
2564 "fqn": "@aws-cdk/core.ResourceProps"
2565 }
2566 }
2567 ]
2568 },
2569 "interfaces": [
2570 "@aws-cdk/aws-sqs.IQueue"
2571 ],
2572 "kind": "class",
2573 "locationInModule": {
2574 "filename": "lib/queue-base.ts",
2575 "line": 101
2576 },
2577 "methods": [
2578 {
2579 "docs": {
2580 "remarks": "If this queue was created in this stack (`new Queue`), a queue policy\nwill be automatically created upon the first call to `addToPolicy`. If\nthe queue is imported (`Queue.import`), then this is a no-op.",
2581 "stability": "stable",
2582 "summary": "Adds a statement to the IAM resource policy associated with this queue."
2583 },
2584 "locationInModule": {
2585 "filename": "lib/queue-base.ts",
2586 "line": 144
2587 },
2588 "name": "addToResourcePolicy",
2589 "overrides": "@aws-cdk/aws-sqs.IQueue",
2590 "parameters": [
2591 {
2592 "name": "statement",
2593 "type": {
2594 "fqn": "@aws-cdk/aws-iam.PolicyStatement"
2595 }
2596 }
2597 ],
2598 "returns": {
2599 "type": {
2600 "fqn": "@aws-cdk/aws-iam.AddToResourcePolicyResult"
2601 }
2602 }
2603 },
2604 {
2605 "docs": {
2606 "stability": "stable",
2607 "summary": "Grant the actions defined in queueActions to the identity Principal given on this SQS queue resource."
2608 },
2609 "locationInModule": {
2610 "filename": "lib/queue-base.ts",
2611 "line": 240
2612 },
2613 "name": "grant",
2614 "overrides": "@aws-cdk/aws-sqs.IQueue",
2615 "parameters": [
2616 {
2617 "docs": {
2618 "summary": "Principal to grant right to."
2619 },
2620 "name": "grantee",
2621 "type": {
2622 "fqn": "@aws-cdk/aws-iam.IGrantable"
2623 }
2624 },
2625 {
2626 "docs": {
2627 "summary": "The actions to grant."
2628 },
2629 "name": "actions",
2630 "type": {
2631 "primitive": "string"
2632 },
2633 "variadic": true
2634 }
2635 ],
2636 "returns": {
2637 "type": {
2638 "fqn": "@aws-cdk/aws-iam.Grant"
2639 }
2640 },
2641 "variadic": true
2642 },
2643 {
2644 "docs": {
2645 "remarks": "This will grant the following permissions:\n\n - sqs:ChangeMessageVisibility\n - sqs:DeleteMessage\n - sqs:ReceiveMessage\n - sqs:GetQueueAttributes\n - sqs:GetQueueUrl",
2646 "stability": "stable",
2647 "summary": "Grant permissions to consume messages from a queue."
2648 },
2649 "locationInModule": {
2650 "filename": "lib/queue-base.ts",
2651 "line": 176
2652 },
2653 "name": "grantConsumeMessages",
2654 "overrides": "@aws-cdk/aws-sqs.IQueue",
2655 "parameters": [
2656 {
2657 "docs": {
2658 "summary": "Principal to grant consume rights to."
2659 },
2660 "name": "grantee",
2661 "type": {
2662 "fqn": "@aws-cdk/aws-iam.IGrantable"
2663 }
2664 }
2665 ],
2666 "returns": {
2667 "type": {
2668 "fqn": "@aws-cdk/aws-iam.Grant"
2669 }
2670 }
2671 },
2672 {
2673 "docs": {
2674 "remarks": "This will grant the following permissions:\n\n - sqs:PurgeQueue\n - sqs:GetQueueAttributes\n - sqs:GetQueueUrl",
2675 "stability": "stable",
2676 "summary": "Grant an IAM principal permissions to purge all messages from the queue."
2677 },
2678 "locationInModule": {
2679 "filename": "lib/queue-base.ts",
2680 "line": 226
2681 },
2682 "name": "grantPurge",
2683 "overrides": "@aws-cdk/aws-sqs.IQueue",
2684 "parameters": [
2685 {
2686 "docs": {
2687 "summary": "Principal to grant send rights to."
2688 },
2689 "name": "grantee",
2690 "type": {
2691 "fqn": "@aws-cdk/aws-iam.IGrantable"
2692 }
2693 }
2694 ],
2695 "returns": {
2696 "type": {
2697 "fqn": "@aws-cdk/aws-iam.Grant"
2698 }
2699 }
2700 },
2701 {
2702 "docs": {
2703 "remarks": "This will grant the following permissions:\n\n - sqs:SendMessage\n - sqs:GetQueueAttributes\n - sqs:GetQueueUrl",
2704 "stability": "stable",
2705 "summary": "Grant access to send messages to a queue to the given identity."
2706 },
2707 "locationInModule": {
2708 "filename": "lib/queue-base.ts",
2709 "line": 202
2710 },
2711 "name": "grantSendMessages",
2712 "overrides": "@aws-cdk/aws-sqs.IQueue",
2713 "parameters": [
2714 {
2715 "docs": {
2716 "summary": "Principal to grant send rights to."
2717 },
2718 "name": "grantee",
2719 "type": {
2720 "fqn": "@aws-cdk/aws-iam.IGrantable"
2721 }
2722 }
2723 ],
2724 "returns": {
2725 "type": {
2726 "fqn": "@aws-cdk/aws-iam.Grant"
2727 }
2728 }
2729 },
2730 {
2731 "docs": {
2732 "stability": "stable",
2733 "summary": "Return the given named metric for this Queue."
2734 },
2735 "locationInModule": {
2736 "filename": "lib/sqs-augmentations.generated.ts",
2737 "line": 71
2738 },
2739 "name": "metric",
2740 "overrides": "@aws-cdk/aws-sqs.IQueue",
2741 "parameters": [
2742 {
2743 "name": "metricName",
2744 "type": {
2745 "primitive": "string"
2746 }
2747 },
2748 {
2749 "name": "props",
2750 "optional": true,
2751 "type": {
2752 "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions"
2753 }
2754 }
2755 ],
2756 "returns": {
2757 "type": {
2758 "fqn": "@aws-cdk/aws-cloudwatch.Metric"
2759 }
2760 }
2761 },
2762 {
2763 "docs": {
2764 "remarks": "Maximum over 5 minutes",
2765 "stability": "stable",
2766 "summary": "The approximate age of the oldest non-deleted message in the queue."
2767 },
2768 "locationInModule": {
2769 "filename": "lib/sqs-augmentations.generated.ts",
2770 "line": 77
2771 },
2772 "name": "metricApproximateAgeOfOldestMessage",
2773 "overrides": "@aws-cdk/aws-sqs.IQueue",
2774 "parameters": [
2775 {
2776 "name": "props",
2777 "optional": true,
2778 "type": {
2779 "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions"
2780 }
2781 }
2782 ],
2783 "returns": {
2784 "type": {
2785 "fqn": "@aws-cdk/aws-cloudwatch.Metric"
2786 }
2787 }
2788 },
2789 {
2790 "docs": {
2791 "remarks": "Maximum over 5 minutes",
2792 "stability": "stable",
2793 "summary": "The number of messages in the queue that are delayed and not available for reading immediately."
2794 },
2795 "locationInModule": {
2796 "filename": "lib/sqs-augmentations.generated.ts",
2797 "line": 83
2798 },
2799 "name": "metricApproximateNumberOfMessagesDelayed",
2800 "overrides": "@aws-cdk/aws-sqs.IQueue",
2801 "parameters": [
2802 {
2803 "name": "props",
2804 "optional": true,
2805 "type": {
2806 "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions"
2807 }
2808 }
2809 ],
2810 "returns": {
2811 "type": {
2812 "fqn": "@aws-cdk/aws-cloudwatch.Metric"
2813 }
2814 }
2815 },
2816 {
2817 "docs": {
2818 "remarks": "Maximum over 5 minutes",
2819 "stability": "stable",
2820 "summary": "The number of messages that are in flight."
2821 },
2822 "locationInModule": {
2823 "filename": "lib/sqs-augmentations.generated.ts",
2824 "line": 89
2825 },
2826 "name": "metricApproximateNumberOfMessagesNotVisible",
2827 "overrides": "@aws-cdk/aws-sqs.IQueue",
2828 "parameters": [
2829 {
2830 "name": "props",
2831 "optional": true,
2832 "type": {
2833 "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions"
2834 }
2835 }
2836 ],
2837 "returns": {
2838 "type": {
2839 "fqn": "@aws-cdk/aws-cloudwatch.Metric"
2840 }
2841 }
2842 },
2843 {
2844 "docs": {
2845 "remarks": "Maximum over 5 minutes",
2846 "stability": "stable",
2847 "summary": "The number of messages available for retrieval from the queue."
2848 },
2849 "locationInModule": {
2850 "filename": "lib/sqs-augmentations.generated.ts",
2851 "line": 95
2852 },
2853 "name": "metricApproximateNumberOfMessagesVisible",
2854 "overrides": "@aws-cdk/aws-sqs.IQueue",
2855 "parameters": [
2856 {
2857 "name": "props",
2858 "optional": true,
2859 "type": {
2860 "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions"
2861 }
2862 }
2863 ],
2864 "returns": {
2865 "type": {
2866 "fqn": "@aws-cdk/aws-cloudwatch.Metric"
2867 }
2868 }
2869 },
2870 {
2871 "docs": {
2872 "remarks": "Sum over 5 minutes",
2873 "stability": "stable",
2874 "summary": "The number of ReceiveMessage API calls that did not return a message."
2875 },
2876 "locationInModule": {
2877 "filename": "lib/sqs-augmentations.generated.ts",
2878 "line": 101
2879 },
2880 "name": "metricNumberOfEmptyReceives",
2881 "overrides": "@aws-cdk/aws-sqs.IQueue",
2882 "parameters": [
2883 {
2884 "name": "props",
2885 "optional": true,
2886 "type": {
2887 "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions"
2888 }
2889 }
2890 ],
2891 "returns": {
2892 "type": {
2893 "fqn": "@aws-cdk/aws-cloudwatch.Metric"
2894 }
2895 }
2896 },
2897 {
2898 "docs": {
2899 "remarks": "Sum over 5 minutes",
2900 "stability": "stable",
2901 "summary": "The number of messages deleted from the queue."
2902 },
2903 "locationInModule": {
2904 "filename": "lib/sqs-augmentations.generated.ts",
2905 "line": 107
2906 },
2907 "name": "metricNumberOfMessagesDeleted",
2908 "overrides": "@aws-cdk/aws-sqs.IQueue",
2909 "parameters": [
2910 {
2911 "name": "props",
2912 "optional": true,
2913 "type": {
2914 "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions"
2915 }
2916 }
2917 ],
2918 "returns": {
2919 "type": {
2920 "fqn": "@aws-cdk/aws-cloudwatch.Metric"
2921 }
2922 }
2923 },
2924 {
2925 "docs": {
2926 "remarks": "Sum over 5 minutes",
2927 "stability": "stable",
2928 "summary": "The number of messages returned by calls to the ReceiveMessage action."
2929 },
2930 "locationInModule": {
2931 "filename": "lib/sqs-augmentations.generated.ts",
2932 "line": 113
2933 },
2934 "name": "metricNumberOfMessagesReceived",
2935 "overrides": "@aws-cdk/aws-sqs.IQueue",
2936 "parameters": [
2937 {
2938 "name": "props",
2939 "optional": true,
2940 "type": {
2941 "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions"
2942 }
2943 }
2944 ],
2945 "returns": {
2946 "type": {
2947 "fqn": "@aws-cdk/aws-cloudwatch.Metric"
2948 }
2949 }
2950 },
2951 {
2952 "docs": {
2953 "remarks": "Sum over 5 minutes",
2954 "stability": "stable",
2955 "summary": "The number of messages added to a queue."
2956 },
2957 "locationInModule": {
2958 "filename": "lib/sqs-augmentations.generated.ts",
2959 "line": 119
2960 },
2961 "name": "metricNumberOfMessagesSent",
2962 "overrides": "@aws-cdk/aws-sqs.IQueue",
2963 "parameters": [
2964 {
2965 "name": "props",
2966 "optional": true,
2967 "type": {
2968 "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions"
2969 }
2970 }
2971 ],
2972 "returns": {
2973 "type": {
2974 "fqn": "@aws-cdk/aws-cloudwatch.Metric"
2975 }
2976 }
2977 },
2978 {
2979 "docs": {
2980 "remarks": "Average over 5 minutes",
2981 "stability": "stable",
2982 "summary": "The size of messages added to a queue."
2983 },
2984 "locationInModule": {
2985 "filename": "lib/sqs-augmentations.generated.ts",
2986 "line": 125
2987 },
2988 "name": "metricSentMessageSize",
2989 "overrides": "@aws-cdk/aws-sqs.IQueue",
2990 "parameters": [
2991 {
2992 "name": "props",
2993 "optional": true,
2994 "type": {
2995 "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions"
2996 }
2997 }
2998 ],
2999 "returns": {
3000 "type": {
3001 "fqn": "@aws-cdk/aws-cloudwatch.Metric"
3002 }
3003 }
3004 },
3005 {
3006 "docs": {
3007 "remarks": "This method can be implemented by derived constructs in order to perform\nvalidation logic. It is called on all constructs before synthesis.",
3008 "stability": "stable",
3009 "summary": "Validate the current construct."
3010 },
3011 "locationInModule": {
3012 "filename": "lib/queue-base.ts",
3013 "line": 157
3014 },
3015 "name": "validate",
3016 "overrides": "@aws-cdk/core.Construct",
3017 "protected": true,
3018 "returns": {
3019 "type": {
3020 "collection": {
3021 "elementtype": {
3022 "primitive": "string"
3023 },
3024 "kind": "array"
3025 }
3026 }
3027 }
3028 }
3029 ],
3030 "name": "QueueBase",
3031 "properties": [
3032 {
3033 "abstract": true,
3034 "docs": {
3035 "remarks": "Set by subclasses.",
3036 "stability": "stable",
3037 "summary": "Controls automatic creation of policy objects."
3038 },
3039 "immutable": true,
3040 "locationInModule": {
3041 "filename": "lib/queue-base.ts",
3042 "line": 133
3043 },
3044 "name": "autoCreatePolicy",
3045 "protected": true,
3046 "type": {
3047 "primitive": "boolean"
3048 }
3049 },
3050 {
3051 "abstract": true,
3052 "docs": {
3053 "remarks": "If false, this is a standard queue.",
3054 "stability": "stable",
3055 "summary": "Whether this queue is an Amazon SQS FIFO queue."
3056 },
3057 "immutable": true,
3058 "locationInModule": {
3059 "filename": "lib/queue-base.ts",
3060 "line": 126
3061 },
3062 "name": "fifo",
3063 "overrides": "@aws-cdk/aws-sqs.IQueue",
3064 "type": {
3065 "primitive": "boolean"
3066 }
3067 },
3068 {
3069 "abstract": true,
3070 "docs": {
3071 "stability": "stable",
3072 "summary": "The ARN of this queue."
3073 },
3074 "immutable": true,
3075 "locationInModule": {
3076 "filename": "lib/queue-base.ts",
3077 "line": 106
3078 },
3079 "name": "queueArn",
3080 "overrides": "@aws-cdk/aws-sqs.IQueue",
3081 "type": {
3082 "primitive": "string"
3083 }
3084 },
3085 {
3086 "abstract": true,
3087 "docs": {
3088 "stability": "stable",
3089 "summary": "The name of this queue."
3090 },
3091 "immutable": true,
3092 "locationInModule": {
3093 "filename": "lib/queue-base.ts",
3094 "line": 116
3095 },
3096 "name": "queueName",
3097 "overrides": "@aws-cdk/aws-sqs.IQueue",
3098 "type": {
3099 "primitive": "string"
3100 }
3101 },
3102 {
3103 "abstract": true,
3104 "docs": {
3105 "stability": "stable",
3106 "summary": "The URL of this queue."
3107 },
3108 "immutable": true,
3109 "locationInModule": {
3110 "filename": "lib/queue-base.ts",
3111 "line": 111
3112 },
3113 "name": "queueUrl",
3114 "overrides": "@aws-cdk/aws-sqs.IQueue",
3115 "type": {
3116 "primitive": "string"
3117 }
3118 },
3119 {
3120 "abstract": true,
3121 "docs": {
3122 "stability": "stable",
3123 "summary": "If this queue is server-side encrypted, this is the KMS encryption key."
3124 },
3125 "immutable": true,
3126 "locationInModule": {
3127 "filename": "lib/queue-base.ts",
3128 "line": 121
3129 },
3130 "name": "encryptionMasterKey",
3131 "optional": true,
3132 "overrides": "@aws-cdk/aws-sqs.IQueue",
3133 "type": {
3134 "fqn": "@aws-cdk/aws-kms.IKey"
3135 }
3136 }
3137 ],
3138 "symbolId": "lib/queue-base:QueueBase"
3139 },
3140 "@aws-cdk/aws-sqs.QueueEncryption": {
3141 "assembly": "@aws-cdk/aws-sqs",
3142 "docs": {
3143 "stability": "stable",
3144 "summary": "What kind of encryption to apply to this queue.",
3145 "example": "// Use managed key\nnew sqs.Queue(this, 'Queue', {\n encryption: sqs.QueueEncryption.KMS_MANAGED,\n});\n\n// Use custom key\nconst myKey = new kms.Key(this, 'Key');\n\nnew sqs.Queue(this, 'Queue', {\n encryption: sqs.QueueEncryption.KMS,\n encryptionMasterKey: myKey,\n});",
3146 "custom": {
3147 "exampleMetadata": "infused"
3148 }
3149 },
3150 "fqn": "@aws-cdk/aws-sqs.QueueEncryption",
3151 "kind": "enum",
3152 "locationInModule": {
3153 "filename": "lib/queue.ts",
3154 "line": 192
3155 },
3156 "members": [
3157 {
3158 "docs": {
3159 "stability": "stable",
3160 "summary": "Messages in the queue are not encrypted."
3161 },
3162 "name": "UNENCRYPTED"
3163 },
3164 {
3165 "docs": {
3166 "stability": "stable",
3167 "summary": "Server-side KMS encryption with a master key managed by SQS."
3168 },
3169 "name": "KMS_MANAGED"
3170 },
3171 {
3172 "docs": {
3173 "remarks": "If `encryptionKey` is specified, this key will be used, otherwise, one will be defined.",
3174 "stability": "stable",
3175 "summary": "Server-side encryption with a KMS key managed by the user."
3176 },
3177 "name": "KMS"
3178 }
3179 ],
3180 "name": "QueueEncryption",
3181 "symbolId": "lib/queue:QueueEncryption"
3182 },
3183 "@aws-cdk/aws-sqs.QueuePolicy": {
3184 "assembly": "@aws-cdk/aws-sqs",
3185 "base": "@aws-cdk/core.Resource",
3186 "docs": {
3187 "remarks": "Policies define the operations that are allowed on this resource.\n\nYou almost never need to define this construct directly.\n\nAll AWS resources that support resource policies have a method called\n`addToResourcePolicy()`, which will automatically create a new resource\npolicy if one doesn't exist yet, otherwise it will add to the existing\npolicy.\n\nPrefer to use `addToResourcePolicy()` instead.",
3188 "stability": "stable",
3189 "summary": "The policy for an SQS Queue.",
3190 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as sqs from '@aws-cdk/aws-sqs';\n\ndeclare const queue: sqs.Queue;\nconst queuePolicy = new sqs.QueuePolicy(this, 'MyQueuePolicy', {\n queues: [queue],\n});",
3191 "custom": {
3192 "exampleMetadata": "fixture=_generated"
3193 }
3194 },
3195 "fqn": "@aws-cdk/aws-sqs.QueuePolicy",
3196 "initializer": {
3197 "docs": {
3198 "stability": "stable"
3199 },
3200 "locationInModule": {
3201 "filename": "lib/policy.ts",
3202 "line": 37
3203 },
3204 "parameters": [
3205 {
3206 "name": "scope",
3207 "type": {
3208 "fqn": "constructs.Construct"
3209 }
3210 },
3211 {
3212 "name": "id",
3213 "type": {
3214 "primitive": "string"
3215 }
3216 },
3217 {
3218 "name": "props",
3219 "type": {
3220 "fqn": "@aws-cdk/aws-sqs.QueuePolicyProps"
3221 }
3222 }
3223 ]
3224 },
3225 "kind": "class",
3226 "locationInModule": {
3227 "filename": "lib/policy.ts",
3228 "line": 31
3229 },
3230 "name": "QueuePolicy",
3231 "properties": [
3232 {
3233 "docs": {
3234 "stability": "stable",
3235 "summary": "The IAM policy document for this policy."
3236 },
3237 "immutable": true,
3238 "locationInModule": {
3239 "filename": "lib/policy.ts",
3240 "line": 35
3241 },
3242 "name": "document",
3243 "type": {
3244 "fqn": "@aws-cdk/aws-iam.PolicyDocument"
3245 }
3246 },
3247 {
3248 "docs": {
3249 "custom": {
3250 "attribute": "true"
3251 },
3252 "remarks": "This attribute temporarily existed in CloudFormation, and then was removed again.",
3253 "stability": "stable",
3254 "summary": "Not currently supported by AWS CloudFormation."
3255 },
3256 "immutable": true,
3257 "locationInModule": {
3258 "filename": "lib/policy.ts",
3259 "line": 53
3260 },
3261 "name": "queuePolicyId",
3262 "type": {
3263 "primitive": "string"
3264 }
3265 }
3266 ],
3267 "symbolId": "lib/policy:QueuePolicy"
3268 },
3269 "@aws-cdk/aws-sqs.QueuePolicyProps": {
3270 "assembly": "@aws-cdk/aws-sqs",
3271 "datatype": true,
3272 "docs": {
3273 "stability": "stable",
3274 "summary": "Properties to associate SQS queues with a policy.",
3275 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as sqs from '@aws-cdk/aws-sqs';\n\ndeclare const queue: sqs.Queue;\nconst queuePolicyProps: sqs.QueuePolicyProps = {\n queues: [queue],\n};",
3276 "custom": {
3277 "exampleMetadata": "fixture=_generated"
3278 }
3279 },
3280 "fqn": "@aws-cdk/aws-sqs.QueuePolicyProps",
3281 "kind": "interface",
3282 "locationInModule": {
3283 "filename": "lib/policy.ts",
3284 "line": 10
3285 },
3286 "name": "QueuePolicyProps",
3287 "properties": [
3288 {
3289 "abstract": true,
3290 "docs": {
3291 "stability": "stable",
3292 "summary": "The set of queues this policy applies to."
3293 },
3294 "immutable": true,
3295 "locationInModule": {
3296 "filename": "lib/policy.ts",
3297 "line": 14
3298 },
3299 "name": "queues",
3300 "type": {
3301 "collection": {
3302 "elementtype": {
3303 "fqn": "@aws-cdk/aws-sqs.IQueue"
3304 },
3305 "kind": "array"
3306 }
3307 }
3308 }
3309 ],
3310 "symbolId": "lib/policy:QueuePolicyProps"
3311 },
3312 "@aws-cdk/aws-sqs.QueueProps": {
3313 "assembly": "@aws-cdk/aws-sqs",
3314 "datatype": true,
3315 "docs": {
3316 "stability": "stable",
3317 "summary": "Properties for creating a new Queue.",
3318 "example": "// Use managed key\nnew sqs.Queue(this, 'Queue', {\n encryption: sqs.QueueEncryption.KMS_MANAGED,\n});\n\n// Use custom key\nconst myKey = new kms.Key(this, 'Key');\n\nnew sqs.Queue(this, 'Queue', {\n encryption: sqs.QueueEncryption.KMS,\n encryptionMasterKey: myKey,\n});",
3319 "custom": {
3320 "exampleMetadata": "infused"
3321 }
3322 },
3323 "fqn": "@aws-cdk/aws-sqs.QueueProps",
3324 "kind": "interface",
3325 "locationInModule": {
3326 "filename": "lib/queue.ts",
3327 "line": 11
3328 },
3329 "name": "QueueProps",
3330 "properties": [
3331 {
3332 "abstract": true,
3333 "docs": {
3334 "default": "false",
3335 "remarks": "During the deduplication interval (5 minutes), Amazon SQS treats\nmessages that are sent with identical content (excluding attributes) as\nduplicates and delivers only one copy of the message.\n\nIf you don't enable content-based deduplication and you want to deduplicate\nmessages, provide an explicit deduplication ID in your SendMessage() call.\n\n(Only applies to FIFO queues.)",
3336 "stability": "stable",
3337 "summary": "Specifies whether to enable content-based deduplication."
3338 },
3339 "immutable": true,
3340 "locationInModule": {
3341 "filename": "lib/queue.ts",
3342 "line": 139
3343 },
3344 "name": "contentBasedDeduplication",
3345 "optional": true,
3346 "type": {
3347 "primitive": "boolean"
3348 }
3349 },
3350 {
3351 "abstract": true,
3352 "docs": {
3353 "default": "Duration.minutes(5)",
3354 "remarks": "The value must be an integer between 60 (1 minute) and 86,400 (24\nhours). The default is 300 (5 minutes).",
3355 "stability": "stable",
3356 "summary": "The length of time that Amazon SQS reuses a data key before calling KMS again."
3357 },
3358 "immutable": true,
3359 "locationInModule": {
3360 "filename": "lib/queue.ts",
3361 "line": 116
3362 },
3363 "name": "dataKeyReuse",
3364 "optional": true,
3365 "type": {
3366 "fqn": "@aws-cdk/core.Duration"
3367 }
3368 },
3369 {
3370 "abstract": true,
3371 "docs": {
3372 "default": "no dead-letter queue",
3373 "stability": "stable",
3374 "summary": "Send messages to this queue if they were unsuccessfully dequeued a number of times."
3375 },
3376 "immutable": true,
3377 "locationInModule": {
3378 "filename": "lib/queue.ts",
3379 "line": 82
3380 },
3381 "name": "deadLetterQueue",
3382 "optional": true,
3383 "type": {
3384 "fqn": "@aws-cdk/aws-sqs.DeadLetterQueue"
3385 }
3386 },
3387 {
3388 "abstract": true,
3389 "docs": {
3390 "default": "DeduplicationScope.QUEUE",
3391 "remarks": "(Only applies to FIFO queues.)",
3392 "stability": "stable",
3393 "summary": "For high throughput for FIFO queues, specifies whether message deduplication occurs at the message group or queue level."
3394 },
3395 "immutable": true,
3396 "locationInModule": {
3397 "filename": "lib/queue.ts",
3398 "line": 149
3399 },
3400 "name": "deduplicationScope",
3401 "optional": true,
3402 "type": {
3403 "fqn": "@aws-cdk/aws-sqs.DeduplicationScope"
3404 }
3405 },
3406 {
3407 "abstract": true,
3408 "docs": {
3409 "default": "0",
3410 "remarks": "You can specify an integer value of 0 to 900 (15 minutes). The default\nvalue is 0.",
3411 "stability": "stable",
3412 "summary": "The time in seconds that the delivery of all messages in the queue is delayed."
3413 },
3414 "immutable": true,
3415 "locationInModule": {
3416 "filename": "lib/queue.ts",
3417 "line": 39
3418 },
3419 "name": "deliveryDelay",
3420 "optional": true,
3421 "type": {
3422 "fqn": "@aws-cdk/core.Duration"
3423 }
3424 },
3425 {
3426 "abstract": true,
3427 "docs": {
3428 "default": "Unencrypted",
3429 "remarks": "Be aware that encryption is not available in all regions, please see the docs\nfor current availability details.",
3430 "stability": "stable",
3431 "summary": "Whether the contents of the queue are encrypted, and by what type of key."
3432 },
3433 "immutable": true,
3434 "locationInModule": {
3435 "filename": "lib/queue.ts",
3436 "line": 92
3437 },
3438 "name": "encryption",
3439 "optional": true,
3440 "type": {
3441 "fqn": "@aws-cdk/aws-sqs.QueueEncryption"
3442 }
3443 },
3444 {
3445 "abstract": true,
3446 "docs": {
3447 "default": "If encryption is set to KMS and not specified, a key will be created.",
3448 "remarks": "Individual messages will be encrypted using data keys. The data keys in\nturn will be encrypted using this key, and reused for a maximum of\n`dataKeyReuseSecs` seconds.\n\nIf the 'encryptionMasterKey' property is set, 'encryption' type will be\nimplicitly set to \"KMS\".",
3449 "stability": "stable",
3450 "summary": "External KMS master key to use for queue encryption."
3451 },
3452 "immutable": true,
3453 "locationInModule": {
3454 "filename": "lib/queue.ts",
3455 "line": 106
3456 },
3457 "name": "encryptionMasterKey",
3458 "optional": true,
3459 "type": {
3460 "fqn": "@aws-cdk/aws-kms.IKey"
3461 }
3462 },
3463 {
3464 "abstract": true,
3465 "docs": {
3466 "default": "false, unless queueName ends in '.fifo' or 'contentBasedDeduplication' is true.",
3467 "stability": "stable",
3468 "summary": "Whether this a first-in-first-out (FIFO) queue."
3469 },
3470 "immutable": true,
3471 "locationInModule": {
3472 "filename": "lib/queue.ts",
3473 "line": 123
3474 },
3475 "name": "fifo",
3476 "optional": true,
3477 "type": {
3478 "primitive": "boolean"
3479 }
3480 },
3481 {
3482 "abstract": true,
3483 "docs": {
3484 "default": "FifoThroughputLimit.PER_QUEUE",
3485 "remarks": "(Only applies to FIFO queues.)",
3486 "stability": "stable",
3487 "summary": "For high throughput for FIFO queues, specifies whether the FIFO queue throughput quota applies to the entire queue or per message group."
3488 },
3489 "immutable": true,
3490 "locationInModule": {
3491 "filename": "lib/queue.ts",
3492 "line": 159
3493 },
3494 "name": "fifoThroughputLimit",
3495 "optional": true,
3496 "type": {
3497 "fqn": "@aws-cdk/aws-sqs.FifoThroughputLimit"
3498 }
3499 },
3500 {
3501 "abstract": true,
3502 "docs": {
3503 "default": "256KiB",
3504 "remarks": "You can specify an integer value from 1024 bytes (1 KiB) to 262144 bytes\n(256 KiB). The default value is 262144 (256 KiB).",
3505 "stability": "stable",
3506 "summary": "The limit of how many bytes that a message can contain before Amazon SQS rejects it."
3507 },
3508 "immutable": true,
3509 "locationInModule": {
3510 "filename": "lib/queue.ts",
3511 "line": 49
3512 },
3513 "name": "maxMessageSizeBytes",
3514 "optional": true,
3515 "type": {
3516 "primitive": "number"
3517 }
3518 },
3519 {
3520 "abstract": true,
3521 "docs": {
3522 "default": "CloudFormation-generated name",
3523 "remarks": "If specified and this is a FIFO queue, must end in the string '.fifo'.",
3524 "stability": "stable",
3525 "summary": "A name for the queue."
3526 },
3527 "immutable": true,
3528 "locationInModule": {
3529 "filename": "lib/queue.ts",
3530 "line": 19
3531 },
3532 "name": "queueName",
3533 "optional": true,
3534 "type": {
3535 "primitive": "string"
3536 }
3537 },
3538 {
3539 "abstract": true,
3540 "docs": {
3541 "default": "0",
3542 "remarks": "Does not wait if set to 0, otherwise waits this amount of seconds\nby default for messages to arrive.\n\nFor more information, see Amazon SQS Long Poll.",
3543 "stability": "stable",
3544 "summary": "Default wait time for ReceiveMessage calls."
3545 },
3546 "immutable": true,
3547 "locationInModule": {
3548 "filename": "lib/queue.ts",
3549 "line": 61
3550 },
3551 "name": "receiveMessageWaitTime",
3552 "optional": true,
3553 "type": {
3554 "fqn": "@aws-cdk/core.Duration"
3555 }
3556 },
3557 {
3558 "abstract": true,
3559 "docs": {
3560 "default": "RemovalPolicy.DESTROY",
3561 "remarks": "Even though queues are technically stateful, their contents are transient and it\nis common to add and remove Queues while rearchitecting your application. The\ndefault is therefore `DESTROY`. Change it to `RETAIN` if the messages are so\nvaluable that accidentally losing them would be unacceptable.",
3562 "stability": "stable",
3563 "summary": "Policy to apply when the queue is removed from the stack."
3564 },
3565 "immutable": true,
3566 "locationInModule": {
3567 "filename": "lib/queue.ts",
3568 "line": 171
3569 },
3570 "name": "removalPolicy",
3571 "optional": true,
3572 "type": {
3573 "fqn": "@aws-cdk/core.RemovalPolicy"
3574 }
3575 },
3576 {
3577 "abstract": true,
3578 "docs": {
3579 "default": "Duration.days(4)",
3580 "remarks": "You can specify an integer value from 60 seconds (1 minute) to 1209600\nseconds (14 days). The default value is 345600 seconds (4 days).",
3581 "stability": "stable",
3582 "summary": "The number of seconds that Amazon SQS retains a message."
3583 },
3584 "immutable": true,
3585 "locationInModule": {
3586 "filename": "lib/queue.ts",
3587 "line": 29
3588 },
3589 "name": "retentionPeriod",
3590 "optional": true,
3591 "type": {
3592 "fqn": "@aws-cdk/core.Duration"
3593 }
3594 },
3595 {
3596 "abstract": true,
3597 "docs": {
3598 "default": "Duration.seconds(30)",
3599 "remarks": "After dequeuing, the processor has this much time to handle the message\nand delete it from the queue before it becomes visible again for dequeueing\nby another processor.\n\nValues must be from 0 to 43200 seconds (12 hours). If you don't specify\na value, AWS CloudFormation uses the default value of 30 seconds.",
3600 "stability": "stable",
3601 "summary": "Timeout of processing a single message."
3602 },
3603 "immutable": true,
3604 "locationInModule": {
3605 "filename": "lib/queue.ts",
3606 "line": 75
3607 },
3608 "name": "visibilityTimeout",
3609 "optional": true,
3610 "type": {
3611 "fqn": "@aws-cdk/core.Duration"
3612 }
3613 }
3614 ],
3615 "symbolId": "lib/queue:QueueProps"
3616 }
3617 },
3618 "version": "1.202.0",
3619 "fingerprint": "**********"
3620}
\No newline at end of file