Add ExecutionParameters to AthenaStartQueryExecution

Add missing `ExecutionParameters` option to `AthenaStartQueryExecution` step.
aws · Sep 25, 2023 · a970f7c · a970f7c
1 parent 7670bd1
commit a970f7c
Show file tree

Hide file tree

Showing 3 changed files with 63 additions and 0 deletions.
diff --git a/packages/aws-cdk-lib/aws-stepfunctions-tasks/README.md b/packages/aws-cdk-lib/aws-stepfunctions-tasks/README.md
@@ -257,6 +257,7 @@ const startQueryExecutionJob = new tasks.AthenaStartQueryExecution(this, 'Start
       objectKey: 'folder',
     },
   },
+  executionParameters: ['param1', 'param2'],
 });
 ```
 

diff --git a/packages/aws-cdk-lib/aws-stepfunctions-tasks/lib/athena/start-query-execution.ts b/packages/aws-cdk-lib/aws-stepfunctions-tasks/lib/athena/start-query-execution.ts
@@ -42,6 +42,13 @@ export interface AthenaStartQueryExecutionProps extends sfn.TaskStateBaseProps {
    * @default - No work group
    */
   readonly workGroup?: string;
+
+  /**
+   * A list of values for the parameters in a query.
+   *
+   * @default - No parameters
+   */
+  readonly executionParameters?: string[];
 }
 
 /**
@@ -209,6 +216,7 @@ export class AthenaStartQueryExecution extends sfn.TaskStateBase {
           OutputLocation: this.props.resultConfiguration?.outputLocation ? `s3://${this.props.resultConfiguration.outputLocation.bucketName}/${this.props.resultConfiguration.outputLocation.objectKey}/` : undefined,
         },
         WorkGroup: this.props?.workGroup,
+        ExecutionParameters: this.props.executionParameters,
       }),
     };
   }

diff --git a/packages/aws-cdk-lib/aws-stepfunctions-tasks/test/athena/start-query-execution.test.ts b/packages/aws-cdk-lib/aws-stepfunctions-tasks/test/athena/start-query-execution.test.ts
@@ -224,4 +224,58 @@ describe('Start Query Execution', () => {
       }),
     });
   });
+
+  test('execution parameters', () => {
+    // GIVEN
+    const stack = new cdk.Stack();
+
+    // WHEN
+    const task = new AthenaStartQueryExecution(stack, 'Query', {
+      queryString: 'CREATE DATABASE ?',
+      clientRequestToken: 'unique-client-request-token',
+      queryExecutionContext: {
+        databaseName: 'mydatabase',
+        catalogName: 'AwsDataCatalog',
+      },
+      resultConfiguration: {
+        outputLocation: {
+          bucketName: 'query-results-bucket',
+          objectKey: 'folder',
+        },
+      },
+      workGroup: 'primary',
+      executionParameters: 'database',
+    });
+
+    // THEN
+    expect(stack.resolve(task.toStateJson())).toEqual({
+      Type: 'Task',
+      Resource: {
+        'Fn::Join': [
+          '',
+          [
+            'arn:',
+            {
+              Ref: 'AWS::Partition',
+            },
+            ':states:::athena:startQueryExecution',
+          ],
+        ],
+      },
+      End: true,
+      Parameters: {
+        QueryString: 'CREATE DATABASE ?',
+        ClientRequestToken: 'unique-client-request-token',
+        QueryExecutionContext: {
+          Database: 'mydatabase',
+          Catalog: 'AwsDataCatalog',
+        },
+        ResultConfiguration: {
+          OutputLocation: 's3://query-results-bucket/folder/',
+        },
+        WorkGroup: 'primary',
+        ExecutionParameters: ['database'],
+      },
+    });
+  });
 });
-Original file line number
+Diff line change
@@ Expand Up @@
           objectKey: 'folder',
         },
       },
+      executionParameters: ['param1', 'param2'],
     });
     ```
@@ Expand Down @@