Merge pull request #1223 from awslabs/AddExistingStateMachine

feat(aws-sqs-pipes-stepfunctions
awslabs · Oct 22, 2024 · 3ee0c41 · 3ee0c41
2 parents 722bae3 + 898cdbe
commit 3ee0c41
Show file tree

Hide file tree

Showing 13 changed files with 1,782 additions and 12 deletions.
diff --git a/source/patterns/@aws-solutions-constructs/aws-sqs-pipes-stepfunctions/lib/index.ts b/source/patterns/@aws-solutions-constructs/aws-sqs-pipes-stepfunctions/lib/index.ts
@@ -82,9 +82,13 @@ export interface SqsToPipesToStepfunctionsProps {
   // *******************
 
   /**
-   * 	User provided props for the sfn.StateMachine.
+   * 	User provided props for the sfn.StateMachine. This or existingStateMachine is required
    */
-  readonly stateMachineProps: sfn.StateMachineProps,
+  readonly stateMachineProps?: sfn.StateMachineProps,
+  /**
+   * Optional existing state machine to incorporate into the construct
+   */
+  readonly existingStateMachineObj?: sfn.StateMachine,
   /**
    * Whether to create recommended CloudWatch alarms
    *
@@ -143,7 +147,7 @@ export interface SqsToPipesToStepfunctionsProps {
 
 export class SqsToPipesToStepfunctions extends Construct {
   public readonly stateMachine: sfn.StateMachine;
-  public readonly stateMachineLogGroup: logs.ILogGroup;
+  public readonly stateMachineLogGroup?: logs.ILogGroup;
   public readonly cloudwatchAlarms?: cloudwatch.Alarm[];
   public readonly sqsQueue: sqs.Queue;
   public readonly deadLetterQueue?: sqs.DeadLetterQueue;
@@ -180,14 +184,18 @@ export class SqsToPipesToStepfunctions extends Construct {
     this.deadLetterQueue = buildQueueResponse.dlq;
 
     // Create the State Machine
-    const buildStateMachineResponse = defaults.buildStateMachine(this, defaults.idPlaceholder, {
-      stateMachineProps: props.stateMachineProps,
-      logGroupProps: props.logGroupProps,
-      createCloudWatchAlarms: props.createCloudWatchAlarms,
-    });
-    this.stateMachine = buildStateMachineResponse.stateMachine;
-    this.stateMachineLogGroup = buildStateMachineResponse.logGroup;
-    this.cloudwatchAlarms = buildStateMachineResponse.cloudWatchAlarms;
+    if (!props.existingStateMachineObj) {
+      const buildStateMachineResponse = defaults.buildStateMachine(this, defaults.idPlaceholder, {
+        stateMachineProps: props.stateMachineProps!,  // CheckStateMachineProps ensures this is defined if existingStateMachineObj is not
+        logGroupProps: props.logGroupProps,
+        createCloudWatchAlarms: props.createCloudWatchAlarms,
+      });
+      this.stateMachine = buildStateMachineResponse.stateMachine;
+      this.stateMachineLogGroup = buildStateMachineResponse.logGroup;
+      this.cloudwatchAlarms = buildStateMachineResponse.cloudWatchAlarms;
+    } else {
+      this.stateMachine = props.existingStateMachineObj;
+    }
 
     // Create the pipe to connect the queue and state machine
     const buildPipeResponse = defaults.BuildPipe(this, id, {

diff --git a/...aws-sqs-pipes-stepfunctions/test/integ.sqspstp-existing-state-machine.js.snapshot/cdk.out b/...aws-sqs-pipes-stepfunctions/test/integ.sqspstp-existing-state-machine.js.snapshot/cdk.out
@@ -0,0 +1 @@
+{"version":"38.0.1"}
diff --git a/...-sqs-pipes-stepfunctions/test/integ.sqspstp-existing-state-machine.js.snapshot/integ.json b/...-sqs-pipes-stepfunctions/test/integ.sqspstp-existing-state-machine.js.snapshot/integ.json
@@ -0,0 +1,12 @@
+{
+  "version": "38.0.1",
+  "testCases": {
+    "sqspstp-existing-state-machine/Integ/DefaultTest": {
+      "stacks": [
+        "sqspstp-existing-state-machine"
+      ],
+      "assertionStack": "sqspstp-existing-state-machine/Integ/DefaultTest/DeployAssert",
+      "assertionStackName": "sqspstpexistingstatemachineIntegDefaultTestDeployAssertE03331F3"
+    }
+  }
+}
diff --git a/...s-pipes-stepfunctions/test/integ.sqspstp-existing-state-machine.js.snapshot/manifest.json b/...s-pipes-stepfunctions/test/integ.sqspstp-existing-state-machine.js.snapshot/manifest.json
@@ -0,0 +1,181 @@
+{
+  "version": "38.0.1",
+  "artifacts": {
+    "sqspstpexistingstatemachineIntegDefaultTestDeployAssertE03331F3.assets": {
+      "type": "cdk:asset-manifest",
+      "properties": {
+        "file": "sqspstpexistingstatemachineIntegDefaultTestDeployAssertE03331F3.assets.json",
+        "requiresBootstrapStackVersion": 6,
+        "bootstrapStackVersionSsmParameter": "/cdk-bootstrap/hnb659fds/version"
+      }
+    },
+    "sqspstpexistingstatemachineIntegDefaultTestDeployAssertE03331F3": {
+      "type": "aws:cloudformation:stack",
+      "environment": "aws://unknown-account/unknown-region",
+      "properties": {
+        "templateFile": "sqspstpexistingstatemachineIntegDefaultTestDeployAssertE03331F3.template.json",
+        "terminationProtection": false,
+        "validateOnSynth": false,
+        "notificationArns": [],
+        "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}/21fbb51d7b23f6a6c262b46a9caee79d744a3ac019fd45422d988b96d44b2a22.json",
+        "requiresBootstrapStackVersion": 6,
+        "bootstrapStackVersionSsmParameter": "/cdk-bootstrap/hnb659fds/version",
+        "additionalDependencies": [
+          "sqspstpexistingstatemachineIntegDefaultTestDeployAssertE03331F3.assets"
+        ],
+        "lookupRole": {
+          "arn": "arn:${AWS::Partition}:iam::${AWS::AccountId}:role/cdk-hnb659fds-lookup-role-${AWS::AccountId}-${AWS::Region}",
+          "requiresBootstrapStackVersion": 8,
+          "bootstrapStackVersionSsmParameter": "/cdk-bootstrap/hnb659fds/version"
+        }
+      },
+      "dependencies": [
+        "sqspstpexistingstatemachineIntegDefaultTestDeployAssertE03331F3.assets"
+      ],
+      "metadata": {
+        "/sqspstp-existing-state-machine/Integ/DefaultTest/DeployAssert/BootstrapVersion": [
+          {
+            "type": "aws:cdk:logicalId",
+            "data": "BootstrapVersion"
+          }
+        ],
+        "/sqspstp-existing-state-machine/Integ/DefaultTest/DeployAssert/CheckBootstrapVersion": [
+          {
+            "type": "aws:cdk:logicalId",
+            "data": "CheckBootstrapVersion"
+          }
+        ]
+      },
+      "displayName": "sqspstp-existing-state-machine/Integ/DefaultTest/DeployAssert"
+    },
+    "sqspstp-existing-state-machine.assets": {
+      "type": "cdk:asset-manifest",
+      "properties": {
+        "file": "sqspstp-existing-state-machine.assets.json",
+        "requiresBootstrapStackVersion": 6,
+        "bootstrapStackVersionSsmParameter": "/cdk-bootstrap/hnb659fds/version"
+      }
+    },
+    "sqspstp-existing-state-machine": {
+      "type": "aws:cloudformation:stack",
+      "environment": "aws://unknown-account/unknown-region",
+      "properties": {
+        "templateFile": "sqspstp-existing-state-machine.template.json",
+        "terminationProtection": false,
+        "validateOnSynth": false,
+        "notificationArns": [],
+        "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}/efb8bb9236fcf45e0d14ab1780f81cd6356f45fa6efd47a3ac79e7f913fa8fb6.json",
+        "requiresBootstrapStackVersion": 6,
+        "bootstrapStackVersionSsmParameter": "/cdk-bootstrap/hnb659fds/version",
+        "additionalDependencies": [
+          "sqspstp-existing-state-machine.assets"
+        ],
+        "lookupRole": {
+          "arn": "arn:${AWS::Partition}:iam::${AWS::AccountId}:role/cdk-hnb659fds-lookup-role-${AWS::AccountId}-${AWS::Region}",
+          "requiresBootstrapStackVersion": 8,
+          "bootstrapStackVersionSsmParameter": "/cdk-bootstrap/hnb659fds/version"
+        }
+      },
+      "dependencies": [
+        "sqspstp-existing-state-machine.assets"
+      ],
+      "metadata": {
+        "/sqspstp-existing-state-machine/lambdas3stp-test-state-machine/ServiceRole/Resource": [
+          {
+            "type": "aws:cdk:logicalId",
+            "data": "lambdas3stpteststatemachineServiceRole06C303CC"
+          }
+        ],
+        "/sqspstp-existing-state-machine/lambdas3stp-test-state-machine/Resource": [
+          {
+            "type": "aws:cdk:logicalId",
+            "data": "lambdas3stpteststatemachine14912CBC"
+          }
+        ],
+        "/sqspstp-existing-state-machine/s3stp-test-state-machine/Role/Resource": [
+          {
+            "type": "aws:cdk:logicalId",
+            "data": "s3stpteststatemachineRoleF95DAD26"
+          }
+        ],
+        "/sqspstp-existing-state-machine/s3stp-test-state-machine/Role/DefaultPolicy/Resource": [
+          {
+            "type": "aws:cdk:logicalId",
+            "data": "s3stpteststatemachineRoleDefaultPolicy9B0BD12F"
+          }
+        ],
+        "/sqspstp-existing-state-machine/s3stp-test-state-machine/Resource": [
+          {
+            "type": "aws:cdk:logicalId",
+            "data": "s3stpteststatemachine6717B458"
+          }
+        ],
+        "/sqspstp-existing-state-machine/test-sqs-pipes-states-construct/queue-dlq/Resource": [
+          {
+            "type": "aws:cdk:logicalId",
+            "data": "testsqspipesstatesconstructqueuedlq420A82FD"
+          }
+        ],
+        "/sqspstp-existing-state-machine/test-sqs-pipes-states-construct/queue-dlq/Policy/Resource": [
+          {
+            "type": "aws:cdk:logicalId",
+            "data": "testsqspipesstatesconstructqueuedlqPolicyB1D70483"
+          }
+        ],
+        "/sqspstp-existing-state-machine/test-sqs-pipes-states-construct/queue/Resource": [
+          {
+            "type": "aws:cdk:logicalId",
+            "data": "testsqspipesstatesconstructqueueA7C76715"
+          }
+        ],
+        "/sqspstp-existing-state-machine/test-sqs-pipes-states-construct/queue/Policy/Resource": [
+          {
+            "type": "aws:cdk:logicalId",
+            "data": "testsqspipesstatesconstructqueuePolicyFD32B562"
+          }
+        ],
+        "/sqspstp-existing-state-machine/test-sqs-pipes-states-construct/PipeRole--test-sqs-pipes-states-construct/Resource": [
+          {
+            "type": "aws:cdk:logicalId",
+            "data": "testsqspipesstatesconstructPipeRoletestsqspipesstatesconstruct2CC9A13C"
+          }
+        ],
+        "/sqspstp-existing-state-machine/test-sqs-pipes-states-construct/LogGroup-test-sqs-pipes-states-construct/Resource": [
+          {
+            "type": "aws:cdk:logicalId",
+            "data": "testsqspipesstatesconstructLogGrouptestsqspipesstatesconstructF827FE15"
+          }
+        ],
+        "/sqspstp-existing-state-machine/test-sqs-pipes-states-construct/pipe-test-sqs-pipes-states-construct": [
+          {
+            "type": "aws:cdk:logicalId",
+            "data": "testsqspipesstatesconstructpipetestsqspipesstatesconstruct71A64A15"
+          }
+        ],
+        "/sqspstp-existing-state-machine/BootstrapVersion": [
+          {
+            "type": "aws:cdk:logicalId",
+            "data": "BootstrapVersion"
+          }
+        ],
+        "/sqspstp-existing-state-machine/CheckBootstrapVersion": [
+          {
+            "type": "aws:cdk:logicalId",
+            "data": "CheckBootstrapVersion"
+          }
+        ]
+      },
+      "displayName": "sqspstp-existing-state-machine"
+    },
+    "Tree": {
+      "type": "cdk:tree",
+      "properties": {
+        "file": "tree.json"
+      }
+    }
+  }
+}
diff --git a/...teg.sqspstp-existing-state-machine.js.snapshot/sqspstp-existing-state-machine.assets.json b/...teg.sqspstp-existing-state-machine.js.snapshot/sqspstp-existing-state-machine.assets.json
@@ -0,0 +1,19 @@
+{
+  "version": "38.0.1",
+  "files": {
+    "efb8bb9236fcf45e0d14ab1780f81cd6356f45fa6efd47a3ac79e7f913fa8fb6": {
+      "source": {
+        "path": "sqspstp-existing-state-machine.template.json",
+        "packaging": "file"
+      },
+      "destinations": {
+        "current_account-current_region": {
+          "bucketName": "cdk-hnb659fds-assets-${AWS::AccountId}-${AWS::Region}",
+          "objectKey": "efb8bb9236fcf45e0d14ab1780f81cd6356f45fa6efd47a3ac79e7f913fa8fb6.json",
+          "assumeRoleArn": "arn:${AWS::Partition}:iam::${AWS::AccountId}:role/cdk-hnb659fds-file-publishing-role-${AWS::AccountId}-${AWS::Region}"
+        }
+      }
+    }
+  },
+  "dockerImages": {}
+}