feat(aws-constructs-factories): add a factory for sqs queues (#1131)

* Refactor buildQueue to include creating Dead Letter Queues * Include id in dlg id, refresh integ tests * Update for DLQ id * Clean up test details from DLQ id change, ignore files * Implement construct and tests * Inexplicable typo?!? * Final edits * Enable key rotation on existing key test
awslabs · Jun 11, 2024 · b35b9b8 · b35b9b8
1 parent 65028ad
commit b35b9b8
Show file tree

Hide file tree

Showing 240 changed files with 8,835 additions and 4,646 deletions.
diff --git a/source/patterns/@aws-solutions-constructs/aws-apigateway-sqs/lib/index.ts b/source/patterns/@aws-solutions-constructs/aws-apigateway-sqs/lib/index.ts
@@ -211,24 +211,19 @@ export class ApiGatewayToSqs extends Construct {
       `'deleteRequestTemplate', 'additionalDeleteRequestTemplates', 'deleteIntegrationResponses'`);
     }
 
-    // Setup the dead letter queue, if applicable
-    this.deadLetterQueue = defaults.buildDeadLetterQueue(this, {
-      existingQueueObj: props.existingQueueObj,
-      deployDeadLetterQueue: props.deployDeadLetterQueue,
-      deadLetterQueueProps: props.deadLetterQueueProps,
-      maxReceiveCount: props.maxReceiveCount
-    });
-
     // Setup the queue
     const buildQueueResponse = defaults.buildQueue(this, 'queue', {
       existingQueueObj: props.existingQueueObj,
       queueProps: props.queueProps,
-      deadLetterQueue: this.deadLetterQueue,
+      deployDeadLetterQueue: props.deployDeadLetterQueue,
+      deadLetterQueueProps: props.deadLetterQueueProps,
+      maxReceiveCount: props.maxReceiveCount,
       enableEncryptionWithCustomerManagedKey: props.enableEncryptionWithCustomerManagedKey,
       encryptionKey: props.encryptionKey,
       encryptionKeyProps: props.encryptionKeyProps
     });
     this.sqsQueue = buildQueueResponse.queue;
+    this.deadLetterQueue = buildQueueResponse.dlq;
 
     // Setup the API Gateway
     const globalRestApiResponse = defaults.GlobalRestApi(this, props.apiGatewayProps, props.logGroupProps);

diff --git a/...-additional-request-templates.js.snapshot/apisqs-additional-request-templates.assets.json b/...-additional-request-templates.js.snapshot/apisqs-additional-request-templates.assets.json
@@ -1,15 +1,15 @@
 {
   "version": "36.0.0",
   "files": {
-    "2a042bc52d33519c4d240ec0cf74ff8ef74c42183f6dd3eb7e4ab111f1923884": {
+    "237b55862d962ca52c24fc3d92e931335fcdc7468cd58135ac481ef86c66d367": {
       "source": {
         "path": "apisqs-additional-request-templates.template.json",
         "packaging": "file"
       },
       "destinations": {
         "current_account-current_region": {
           "bucketName": "cdk-hnb659fds-assets-${AWS::AccountId}-${AWS::Region}",
-          "objectKey": "2a042bc52d33519c4d240ec0cf74ff8ef74c42183f6dd3eb7e4ab111f1923884.json",
+          "objectKey": "237b55862d962ca52c24fc3d92e931335fcdc7468cd58135ac481ef86c66d367.json",
           "assumeRoleArn": "arn:${AWS::Partition}:iam::${AWS::AccountId}:role/cdk-hnb659fds-file-publishing-role-${AWS::AccountId}-${AWS::Region}"
         }
       }

diff --git a/...dditional-request-templates.js.snapshot/apisqs-additional-request-templates.template.json b/...dditional-request-templates.js.snapshot/apisqs-additional-request-templates.template.json
@@ -1,15 +1,15 @@
 {
  "Description": "Integration Test for aws-apigateway-sqs",
  "Resources": {
-  "testapigatewaysqsdefaultdeadLetterQueue24467CAD": {
+  "testapigatewaysqsdefaultqueuedlqF08203A7": {
    "Type": "AWS::SQS::Queue",
    "Properties": {
     "KmsMasterKeyId": "alias/aws/sqs"
    },
    "UpdateReplacePolicy": "Delete",
    "DeletionPolicy": "Delete"
   },
-  "testapigatewaysqsdefaultdeadLetterQueuePolicyEF507332": {
+  "testapigatewaysqsdefaultqueuedlqPolicy3E4AECEE": {
    "Type": "AWS::SQS::QueuePolicy",
    "Properties": {
     "PolicyDocument": {
@@ -45,7 +45,7 @@
        },
        "Resource": {
         "Fn::GetAtt": [
-         "testapigatewaysqsdefaultdeadLetterQueue24467CAD",
+         "testapigatewaysqsdefaultqueuedlqF08203A7",
          "Arn"
         ]
        },
@@ -64,7 +64,7 @@
        },
        "Resource": {
         "Fn::GetAtt": [
-         "testapigatewaysqsdefaultdeadLetterQueue24467CAD",
+         "testapigatewaysqsdefaultqueuedlqF08203A7",
          "Arn"
         ]
        },
@@ -75,7 +75,7 @@
     },
     "Queues": [
      {
-      "Ref": "testapigatewaysqsdefaultdeadLetterQueue24467CAD"
+      "Ref": "testapigatewaysqsdefaultqueuedlqF08203A7"
      }
     ]
    }
@@ -87,7 +87,7 @@
     "RedrivePolicy": {
      "deadLetterTargetArn": {
       "Fn::GetAtt": [
-       "testapigatewaysqsdefaultdeadLetterQueue24467CAD",
+       "testapigatewaysqsdefaultqueuedlqF08203A7",
        "Arn"
       ]
      },

diff --git a/...s-apigateway-sqs/test/integ.apisqs-additional-request-templates.js.snapshot/manifest.json b/...s-apigateway-sqs/test/integ.apisqs-additional-request-templates.js.snapshot/manifest.json
@@ -66,7 +66,7 @@
         "validateOnSynth": false,
         "assumeRoleArn": "arn:${AWS::Partition}:iam::${AWS::AccountId}:role/cdk-hnb659fds-deploy-role-${AWS::AccountId}-${AWS::Region}",
         "cloudFormationExecutionRoleArn": "arn:${AWS::Partition}:iam::${AWS::AccountId}:role/cdk-hnb659fds-cfn-exec-role-${AWS::AccountId}-${AWS::Region}",
-        "stackTemplateAssetObjectUrl": "s3://cdk-hnb659fds-assets-${AWS::AccountId}-${AWS::Region}/2a042bc52d33519c4d240ec0cf74ff8ef74c42183f6dd3eb7e4ab111f1923884.json",
+        "stackTemplateAssetObjectUrl": "s3://cdk-hnb659fds-assets-${AWS::AccountId}-${AWS::Region}/237b55862d962ca52c24fc3d92e931335fcdc7468cd58135ac481ef86c66d367.json",
         "requiresBootstrapStackVersion": 6,
         "bootstrapStackVersionSsmParameter": "/cdk-bootstrap/hnb659fds/version",
         "additionalDependencies": [
@@ -82,16 +82,16 @@
         "apisqs-additional-request-templates.assets"
       ],
       "metadata": {
-        "/apisqs-additional-request-templates/test-api-gateway-sqs-default/deadLetterQueue/Resource": [
+        "/apisqs-additional-request-templates/test-api-gateway-sqs-default/queue-dlq/Resource": [
           {
             "type": "aws:cdk:logicalId",
-            "data": "testapigatewaysqsdefaultdeadLetterQueue24467CAD"
+            "data": "testapigatewaysqsdefaultqueuedlqF08203A7"
           }
         ],
-        "/apisqs-additional-request-templates/test-api-gateway-sqs-default/deadLetterQueue/Policy/Resource": [
+        "/apisqs-additional-request-templates/test-api-gateway-sqs-default/queue-dlq/Policy/Resource": [
           {
             "type": "aws:cdk:logicalId",
-            "data": "testapigatewaysqsdefaultdeadLetterQueuePolicyEF507332"
+            "data": "testapigatewaysqsdefaultqueuedlqPolicy3E4AECEE"
           }
         ],
         "/apisqs-additional-request-templates/test-api-gateway-sqs-default/queue/Resource": [
@@ -189,6 +189,24 @@
             "type": "aws:cdk:logicalId",
             "data": "CheckBootstrapVersion"
           }
+        ],
+        "testapigatewaysqsdefaultdeadLetterQueue24467CAD": [
+          {
+            "type": "aws:cdk:logicalId",
+            "data": "testapigatewaysqsdefaultdeadLetterQueue24467CAD",
+            "trace": [
+              "!!DESTRUCTIVE_CHANGES: WILL_DESTROY"
+            ]
+          }
+        ],
+        "testapigatewaysqsdefaultdeadLetterQueuePolicyEF507332": [
+          {
+            "type": "aws:cdk:logicalId",
+            "data": "testapigatewaysqsdefaultdeadLetterQueuePolicyEF507332",
+            "trace": [
+              "!!DESTRUCTIVE_CHANGES: WILL_DESTROY"
+            ]
+          }
         ]
       },
       "displayName": "apisqs-additional-request-templates"