Add other feedback Leonardo

aws · Oct 15, 2024 · f785509 · f785509
1 parent d668e3b
commit f785509
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 3 deletions.
diff --git a/packages/@aws-cdk/aws-pipes-targets-alpha/lib/cloudwatch-logs.ts b/packages/@aws-cdk/aws-pipes-targets-alpha/lib/cloudwatch-logs.ts
@@ -26,8 +26,9 @@ export interface CloudWatchLogsTargetParameters {
   /**
    * The JSON path expression that references the timestamp in the payload.
    *
-   * @example
-   * '$.data.timestamp'
+   * This is the time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
+   *
+   * @example '$.data.timestamp'
    *
    * @see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetcloudwatchlogsparameters.html#cfn-pipes-pipe-pipetargetcloudwatchlogsparameters-timestamp
    * @default - current time
@@ -36,7 +37,7 @@ export interface CloudWatchLogsTargetParameters {
 }
 
 /**
- * A EventBridge Pipes target that sends messages to a CloudWatch Logs log group.
+ * An EventBridge Pipes target that sends messages to a CloudWatch Logs log group.
  */
 export class CloudWatchLogsTarget implements ITarget {
   private logGroup: ILogGroup;

diff --git a/packages/@aws-cdk/aws-pipes-targets-alpha/test/integ.cloudwatch-logs.ts b/packages/@aws-cdk/aws-pipes-targets-alpha/test/integ.cloudwatch-logs.ts
@@ -4,6 +4,13 @@ import { ExpectedResult, IntegTest } from '@aws-cdk/integ-tests-alpha';
 import * as cdk from 'aws-cdk-lib';
 import { CloudWatchLogsTarget } from '../lib';
 
+/*
+ * This integration test sends a message to an SQS queue and validates
+ * that the message is logged in the CloudWatch Logs log group.
+ *
+ * SQS (pipe source) --> CloudWatch Logs log group (pipe target)
+ */
+
 const app = new cdk.App();
 const stack = new cdk.Stack(app, 'aws-cdk-pipes-targets-cwl');
 const sourceQueue = new cdk.aws_sqs.Queue(stack, 'SourceQueue');
@@ -41,6 +48,7 @@ const logEvents = test.assertions.awsApiCall('CloudWatchLogs', 'filterLogEvents'
 
 const message = putMessageOnQueue.next(logEvents);
 
+// verify the message made it from the queue and is logged in the log group
 message.assertAtPath('events.0.message', ExpectedResult.stringLikeRegexp(body)).waitForAssertions({
   totalTimeout: cdk.Duration.minutes(1),
   interval: cdk.Duration.seconds(15),