feat(synthetics): add RunConfig parameters to Cloudwatch Synthetics Canary L2 construct

packages/@aws-cdk/aws-synthetics/README.md

@@ -45,6 +45,9 @@ const canary = new synthetics.Canary(this, 'MyCanary', {
     handler: 'index.handler',
   }),
   runtime: synthetics.Runtime.SYNTHETICS_NODEJS_2_0,
+  environment: {
+      URL: 'https://api.example.com/user/books/topbook/'
+  }
 });
 ```
 
@@ -57,7 +60,7 @@ const log = require('SyntheticsLogger');
 const pageLoadBlueprint = async function () {
 
     // INSERT URL here
-    const URL = "https://api.example.com/user/books/topbook/";
+    const URL =process.env.URL;
 
     let page = await synthetics.getPage();
     const response = await page.goto(URL, {waitUntil: 'domcontentloaded', timeout: 30000});

packages/@aws-cdk/aws-synthetics/lib/canary.ts

@@ -203,6 +203,45 @@ export interface CanaryProps {
    */
   readonly test: Test;
 
+  /**
+   * Key-value pairs that the Synthetics caches and makes available for your canary
+   * scripts. Use environment variables to apply configuration changes, such
+   * as test and production environment configurations, without changing your
+   * Canary script source code.
+   *
+   * @default - No environment variables.
+   */
+  readonly environment?: { [key: string]: string };
+
+  /**
+   * The function execution time (in seconds) after which Lambda terminates
+   * the function. Because the execution time affects cost, set this value
+   * based on the function's expected execution time.
+   *
+   * @default cdk.Duration.seconds(900)
+   */
+  readonly timeout?: cdk.Duration;
+
+  /**
+   * The amount of memory, in MB, that is allocated to your Lambda function.
+   * Lambda uses this value to proportionally allocate the amount of CPU
+   * power. For more information, see Resource Model in the AWS Lambda
+   * Developer Guide.
+   *
+   * @default 128
+   */
+  readonly memorySize?: number;
+
+  /**
+   * Specifies whether this canary is to use active AWS X-Ray tracing when it runs.
+   * Active tracing enables this canary run to be displayed in the ServiceLens and
+   * X-Ray service maps even if the canary does not hit an endpoint that has
+   * X-ray tracing enabled.
+   *
+   * @default false
+   */
+  readonly tracing?: boolean;
+
 }
 
 /**
@@ -264,6 +303,7 @@ export class Canary extends cdk.Resource {
       failureRetentionPeriod: props.failureRetentionPeriod?.toDays(),
       successRetentionPeriod: props.successRetentionPeriod?.toDays(),
       code: this.createCode(props),
+      runConfig: this.createRunConfig(props),
     });
 
     this.canaryId = resource.attrId;
@@ -384,6 +424,19 @@ export class Canary extends cdk.Resource {
     };
   }
 
+  /**
+   * Retruns a runConfig object
+   */
+  private createRunConfig(props:CanaryProps): CfnCanary.RunConfigProperty {
+    const DEFAULT_CANARY_TIMEOUT_IN_SECONDS = 900;
+    return {
+      timeoutInSeconds: props.timeout?.toSeconds() ?? DEFAULT_CANARY_TIMEOUT_IN_SECONDS,
+      activeTracing: props.tracing,
+      environmentVariables: props.environment,
+      memoryInMb: props.memorySize,
+    };
+  }
+
   /**
    * Creates a unique name for the canary. The generated name is the physical ID of the canary.
    */

packages/@aws-cdk/aws-synthetics/test/canary.test.ts

@@ -170,6 +170,41 @@ test('Runtime can be specified', () => {
   });
 });
 
+test('RunConfig attributes can be specified', () => {
+  // GIVEN
+  const stack = new Stack(new App(), 'canaries');
+  const environmentVariables = {
+    test_key_1: 'TEST_VALUE_1',
+    test_key_2: 'TEST_VALUE_2',
+  };
+  const timeout = 10;
+  const memorySize = 256;
+  const activateTracing = true;
+
+  // WHEN
+  new synthetics.Canary(stack, 'Canary', {
+    runtime: synthetics.Runtime.SYNTHETICS_1_0,
+    test: synthetics.Test.custom({
+      handler: 'index.handler',
+      code: synthetics.Code.fromInline('/* Synthetics handler code */'),
+    }),
+    environment: environmentVariables,
+    timeout: Duration.seconds(timeout),
+    memorySize: memorySize,
+    tracing: activateTracing,
+  });
+
+  // THEN
+  expect(stack).toHaveResourceLike('AWS::Synthetics::Canary', {
+    RunConfig: {
+      EnvironmentVariables: environmentVariables,
+      TimeoutInSeconds: timeout,
+      MemoryInMB: memorySize,
+      ActiveTracing: activateTracing,
+    },
+  });
+});
+
 test('Runtime can be customized', () => {
   // GIVEN
   const stack = new Stack(new App(), 'canaries');

packages/@aws-cdk/aws-synthetics/test/integ.canary.expected.json

@@ -108,7 +108,10 @@
           "DurationInSeconds": "0",
           "Expression": "rate(1 minute)"
         },
-        "StartCanaryAfterCreation": true
+        "StartCanaryAfterCreation": true,
+        "RunConfig": {
+            "TimeoutInSeconds":900
+        }
       }
     },
     "MyCanaryOneArtifactsBucketDF4A487D": {
@@ -264,7 +267,10 @@
           "DurationInSeconds": "0",
           "Expression": "rate(5 minutes)"
         },
-        "StartCanaryAfterCreation": true
+        "StartCanaryAfterCreation": true,
+        "RunConfig": {
+            "TimeoutInSeconds":900
+        }
       }
     },
     "MyCanaryTwoArtifactsBucket79B179B6": {
@@ -420,7 +426,10 @@
           "DurationInSeconds": "0",
           "Expression": "rate(5 minutes)"
         },
-        "StartCanaryAfterCreation": true
+        "StartCanaryAfterCreation": true,
+        "RunConfig": {
+            "TimeoutInSeconds":900
+        }
       }
     }
   },