feat(synthetics): add maxRetries prop to configure automatic retries on canary runs

packages/@aws-cdk-testing/framework-integ/test/aws-synthetics/test/integ.canary.js.snapshot/canary-one.template.json

@@ -340,7 +340,10 @@
     "RuntimeVersion": "syn-nodejs-puppeteer-7.0",
     "Schedule": {
      "DurationInSeconds": "0",
-     "Expression": "rate(1 minute)"
+     "Expression": "rate(1 minute)",
+     "RetryConfig": {
+      "MaxRetries": 2
+     }
     },
     "StartCanaryAfterCreation": true,
     "Tags": [

packages/@aws-cdk-testing/framework-integ/test/aws-synthetics/test/integ.canary.ts

@@ -41,6 +41,7 @@ const inlineAsset = new Canary(stack, 'InlineAsset', {
   schedule: Schedule.rate(cdk.Duration.minutes(1)),
   artifactsBucketLocation: { bucket, prefix },
   runtime: Runtime.SYNTHETICS_NODEJS_PUPPETEER_7_0,
+  maxRetries: 2,
   cleanup: Cleanup.LAMBDA,
 });
 

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

@@ -138,6 +138,16 @@ export interface CanaryProps {
    */
   readonly schedule?: Schedule;
 
+  /**
+   * The amount of times the canary will automatically retry a failed run.
+   * This is only supported on the following runtimes or newer: `Runtime.SYNTHETICS_NODEJS_PUPPETEER_10_0`, `Runtime.SYNTHETICS_NODEJS_PLAYWRIGHT_2_0`, `Runtime.SYNTHETICS_PYTHON_SELENIUM_5_1`.
+   * Max retries can be set between 0 and 2. Canaries which time out after 10 minutes are automatically limited to one retry.
+   *
+   * @see https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_autoretry.html
+   * @default 0
+   */
+  readonly maxRetries?: number;
+
   /**
    * Whether or not the canary should start after creation.
    *
@@ -670,6 +680,9 @@ export class Canary extends cdk.Resource implements ec2.IConnectable {
     return {
       durationInSeconds: String(`${props.timeToLive?.toSeconds() ?? 0}`),
       expression: props.schedule?.expressionString ?? 'rate(5 minutes)',
+      retryConfig: {
+        maxRetries: props.maxRetries ?? 0,
+      },
     };
   }
 

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

@@ -22,6 +22,7 @@ test('Basic canary properties work', () => {
     failureRetentionPeriod: Duration.days(10),
     startAfterCreation: false,
     timeToLive: Duration.minutes(30),
+    maxRetries: 2,
     runtime: synthetics.Runtime.SYNTHETICS_NODEJS_PUPPETEER_8_0,
   });
 
@@ -31,7 +32,7 @@ test('Basic canary properties work', () => {
     SuccessRetentionPeriod: 10,
     FailureRetentionPeriod: 10,
     StartCanaryAfterCreation: false,
-    Schedule: Match.objectLike({ DurationInSeconds: '1800' }),
+    Schedule: Match.objectLike({ DurationInSeconds: '1800', RetryConfig: { MaxRetries: 2 } }),
     RuntimeVersion: 'syn-nodejs-puppeteer-8.0',
   });
 });