choir(sfn): add documentation

aws · Feb 21, 2020 · e405aa0 · e405aa0
1 parent c7e8f56
commit e405aa0
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 3 deletions.
diff --git a/packages/@aws-cdk/aws-stepfunctions-tasks/lib/invoke-batch-job.ts b/packages/@aws-cdk/aws-stepfunctions-tasks/lib/invoke-batch-job.ts
@@ -3,6 +3,11 @@ import * as sfn from '@aws-cdk/aws-stepfunctions';
 import { Aws } from '@aws-cdk/core';
 import { getResourceArn } from './resource-arn-suffix';
 
+/**
+ * Properties for InvokeBatchJob
+ *
+ * @experimental
+ */
 export interface InvokeBatchJobProps {
   /**
    * The job definition used by this job.
@@ -37,11 +42,16 @@ export interface InvokeBatchJobProps {
   /**
    * The payload to be passed as parametrs to the batch job
    *
-   * @default undefined
+   * @default - No parameters are passed
    */
   readonly payload?: { [key: string]: any };
 }
 
+/**
+ * A Step Functions Task to invoke AWS Batch
+ *
+ * @experimental
+ */
 export class InvokeBatchJob implements sfn.IStepFunctionsTask {
   private readonly integrationPattern: sfn.ServiceIntegrationPattern;
 

diff --git a/packages/@aws-cdk/aws-stepfunctions-tasks/test/invoke-batch-job.test.ts b/packages/@aws-cdk/aws-stepfunctions-tasks/test/invoke-batch-job.test.ts
@@ -1,7 +1,6 @@
 import * as sfn from '@aws-cdk/aws-stepfunctions';
 import * as cdk from '@aws-cdk/core';
 import * as tasks from '../lib';
-import { Aws } from '@aws-cdk/core';
 
 let stack: cdk.Stack;
 
@@ -50,7 +49,7 @@ test('Task with all the parameters', () => {
     task: new tasks.InvokeBatchJob({
       jobDefinition: 'JobArn',
       jobName: 'JobName',
-      jobQueue: `arn:aws:batch:${Aws.REGION}:${Aws.ACCOUNT_ID}:job-queue/QueueArn`,
+      jobQueue: `arn:aws:batch:${cdk.Aws.REGION}:${cdk.Aws.ACCOUNT_ID}:job-queue/QueueArn`,
       payload: {
         foo: sfn.Data.stringAt('$.bar')
       },

diff --git a/packages/@aws-cdk/aws-stepfunctions/README.md b/packages/@aws-cdk/aws-stepfunctions/README.md
@@ -125,6 +125,7 @@ couple of the tasks available are:
 * `tasks.InvokeActivity` -- start an Activity (Activities represent a work
   queue that you poll on a compute fleet you manage yourself)
 * `tasks.InvokeFunction` -- invoke a Lambda function with function ARN
+* `tasks.InvokeBatchJob` -- invoke a Batch job
 * `tasks.RunLambdaTask` -- call Lambda as integrated service with magic ARN
 * `tasks.PublishToTopic` -- publish a message to an SNS topic
 * `tasks.SendToQueue` -- send a message to an SQS queue