Apply suggestions from code review

Co-authored-by: Momo Kornher <mail@moritzkornher.de>
aws · May 14, 2024 · fc63265 · fc63265
1 parent 71acc78
commit fc63265
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 8 deletions.
diff --git a/packages/@aws-cdk/aws-pipes-targets-alpha/README.md b/packages/@aws-cdk/aws-pipes-targets-alpha/README.md
@@ -30,7 +30,7 @@ Pipe targets are the end point of a EventBridge Pipe.
 The following targets are supported:
 
 1. `targets.SqsTarget`: [Send event source to a Queue](#amazon-sqs)
-2. `targets.StateMachineTarget`: [Start a State Machine from an event source](#aws-step-functions)
+2. `targets.SfnStateMachine`: [Invoke a State Machine from an event source](#aws-step-functions)
 
 ### Amazon SQS
 
@@ -69,7 +69,7 @@ const pipe = new pipes.Pipe(this, 'Pipe', {
 });
 ```
 
-### AWS Step Functions
+### AWS Step Functions State Machine
 
 A State Machine can be used as a target for a pipe. The State Machine will be invoked with the (enriched/filtered) source payload.
 
@@ -85,7 +85,7 @@ const pipe = new pipes.Pipe(this, 'Pipe', {
 });
 ```
 
-Specifying the Invocation Type of the State Machine.
+Specifying the Invocation Type when the target State Machine is invoked:
 
 ```ts
 declare const sourceQueue: sqs.Queue;
@@ -104,7 +104,7 @@ const pipe = new pipes.Pipe(this, 'Pipe', {
 });
 ```
 
-The target input can be transformed:
+The input to the target State Machine can be transformed:
 
 ```ts
 declare const sourceQueue: sqs.Queue;

diff --git a/packages/@aws-cdk/aws-pipes-targets-alpha/lib/stepfunctions.ts b/packages/@aws-cdk/aws-pipes-targets-alpha/lib/stepfunctions.ts
@@ -4,7 +4,7 @@ import * as sfn from 'aws-cdk-lib/aws-stepfunctions';
 import { StateMachine, StateMachineType } from 'aws-cdk-lib/aws-stepfunctions';
 
 /**
- * StateMachine StepFunction target properties.
+ * Parameters for the SfnStateMachine target
  */
 export interface StateMachineTargetParameters {
   /**
@@ -16,7 +16,7 @@ export interface StateMachineTargetParameters {
   readonly inputTransformation?: IInputTransformation;
 
   /**
-   * Specify whether to invoke the Step Functions state machine synchronously (`REQUEST_RESPONSE`) or asynchronously (`FIRE_AND_FORGET`).
+   * Specify whether to invoke the State Machine synchronously (`REQUEST_RESPONSE`) or asynchronously (`FIRE_AND_FORGET`).
    *
    * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetsqsqueueparameters.html#cfn-pipes-pipe-pipetargetsqsqueueparameters-messagededuplicationid
    * @default StateMachineInvocationType.FIRE_AND_FORGET
@@ -25,7 +25,7 @@ export interface StateMachineTargetParameters {
 }
 
 /**
- * InvocationType for invoking StepFunction.
+ * InvocationType for invoking the State Machine.
  * @see https://docs.aws.amazon.com/eventbridge/latest/pipes-reference/API_PipeTargetStateMachineParameters.html
  */
 export enum StateMachineInvocationType {
@@ -41,7 +41,7 @@ export enum StateMachineInvocationType {
 }
 
 /**
- * An EventBridge Pipes target that sends messages to a StepFunction.
+ * An EventBridge Pipes target that sends messages to an AWS Step Functions State Machine.
  */
 export class StateMachineTarget implements ITarget {
   public readonly targetArn: string;