aws_synthetics : Support for cloudwatch canary group

[argenstijn]

Describe the feature

In AWS you can group cloudwatch canaries into groups. Can this be supported from CDK perpective?

Use Case

I want to monitor multiple canaries based on the group.

Proposed Solution

No response

Other Information

No response

Acknowledgements

• I may be able to implement this feature request
• This feature might incur a breaking change

CDK version used

2.187.0

Environment details (OS name and version, etc.)

windows

[pahud]

Yes we should have a PR to

1. Implement a new L2 construct synthetics.Group.
2. Add a property (e.g., group: synthetics.IGroup) to synthetics.CanaryProps.
3. Update the synthetics.Canary construct to handle the association, likely by updating the resourceArns property of the associated CfnGroup.

With that, the user experience would be like

class MyCanaryStack extends cdk.Stack {
  constructor(scope: cdk.App, id: string, props?: cdk.StackProps) {
    super(scope, id, props);

    // 1. Define the Canary Group (using the hypothetical new L2 construct)
    const myCanaryGroup = new synthetics.Group(this, 'MyWebAppCanaries', {
      groupName: 'my-web-app-monitors',
      // Potentially other group properties if available
    });

    // 2. Define the Canary Code
    const canaryCode = synthetics.Code.fromAsset(path.join(__dirname, 'canary-handler'));

    // 3. Create a Canary and associate it with the group
    const myCanary = new synthetics.Canary(this, 'MyHomepageCanary', {
      canaryName: 'my-homepage-checker',
      runtime: synthetics.Runtime.SYNTHETICS_NODEJS_PUPPETEER_6_2,
      test: synthetics.Test.custom({
        code: canaryCode,
        handler: 'index.handler', // Assuming canary-handler/index.js
      }),
      schedule: synthetics.Schedule.rate(cdk.Duration.minutes(5)),
      // --- This is the proposed new property ---
      group: myCanaryGroup,
      // --- --------------------------------- ---
    });

    // (Optional) Add another canary to the same group
    const loginCanary = new synthetics.Canary(this, 'MyLoginCanary', {
        canaryName: 'my-login-checker',
        runtime: synthetics.Runtime.SYNTHETICS_NODEJS_PUPPETEER_6_2,
        test: synthetics.Test.custom({
            code: synthetics.Code.fromAsset(path.join(__dirname, 'login-canary-handler')),
            handler: 'login.handler',
        }),
        schedule: synthetics.Schedule.rate(cdk.Duration.minutes(15)),
        group: myCanaryGroup, // Associate with the same group
    });

    // Output the group ARN (assuming the L2 construct exposes it)
    new cdk.CfnOutput(this, 'CanaryGroupArn', {
        value: myCanaryGroup.groupArn,
    });
  }
}

Making this a p2 and we welcome PRs.