Add docs on integration test

aws · Nov 2, 2024 · a89b4f3 · a89b4f3
1 parent 840a8aa
commit a89b4f3
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 3 deletions.
diff --git a/packages/@aws-cdk/aws-pipes-targets-alpha/lib/api-destination.ts b/packages/@aws-cdk/aws-pipes-targets-alpha/lib/api-destination.ts
@@ -43,7 +43,7 @@ export interface ApiDestinationTargetParameters {
 }
 
 /**
- * A EventBridge Pipes target that sends messages to an EventBridge API destination.
+ * An EventBridge Pipes target that sends messages to an EventBridge API destination.
  */
 export class ApiDestinationTarget implements ITarget {
   private destination: IApiDestination;

diff --git a/packages/@aws-cdk/aws-pipes-targets-alpha/lib/api-gateway.ts b/packages/@aws-cdk/aws-pipes-targets-alpha/lib/api-gateway.ts
@@ -61,7 +61,7 @@ export interface ApiGatewayTargetParameters {
 }
 
 /**
- * A EventBridge Pipes target that sends messages to an EventBridge API destination.
+ * An EventBridge Pipes target that sends messages to an EventBridge API destination.
  */
 export class ApiGatewayTarget implements ITarget {
   private restApi: IRestApi;

diff --git a/packages/@aws-cdk/aws-pipes-targets-alpha/test/integ.api-gateway.ts b/packages/@aws-cdk/aws-pipes-targets-alpha/test/integ.api-gateway.ts
@@ -10,7 +10,14 @@ const app = new cdk.App();
 const stack = new cdk.Stack(app, 'aws-cdk-pipes-targets-api-gw');
 const sourceQueue = new cdk.aws_sqs.Queue(stack, 'SourceQueue');
 
-// SQS (pipe source) --> API Gateway REST API (pipe target) --> Lambda function
+/*
+ * This integration test sends a message to an SQS queue which invokes
+ * the REST API. There is a Lambda function on the backend of the REST API.
+ * We check that the Lambda function was invoked, proving that the message
+ * made it through the pipe.
+ *
+ * SQS (pipe source) --> API Gateway REST API (pipe target) --> Lambda function
+ */
 
 const fn = new lambda.Function(stack, 'ConnectHandler', {
   runtime: lambda.Runtime.NODEJS_LATEST,