Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

(synthetics): documentation of canary schedule expression only supports rate #16392

Closed
mprencipe opened this issue Sep 6, 2021 · 3 comments
Closed
Labels
@aws-cdk/aws-synthetics Related to Amazon CloudWatch Synthetics documentation This is a problem with documentation. effort/small Small work item – less than a day of effort feature-request A feature should be added or improved. good first issue Related to contributions. See CONTRIBUTING.md p2

Comments

@mprencipe
Copy link
Contributor

According to the CDK reference documentation the Canary schedule expression only supports rate.
https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-synthetics.Schedule.html

According to this documentation the scheduling configuration is much more flexible https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_cron.html


This is a 📕 documentation issue

@mprencipe mprencipe added documentation This is a problem with documentation. feature-request A feature should be added or improved. needs-triage This issue or PR still needs to be triaged. labels Sep 6, 2021
@github-actions github-actions bot added the @aws-cdk/aws-synthetics Related to Amazon CloudWatch Synthetics label Sep 6, 2021
@kaizencc
Copy link
Contributor

kaizencc commented Sep 7, 2021

Currently you can use synthetics.Schedule.expression('cron(0 10 * * ? *)') to specify a cron expression for canaries. The documentation here should reflect that, I agree.

I also think that we should have a static cron method in the schedule class for easier usability though - there are similar methods in autoscaling and application autoscaling.

@kaizencc kaizencc added p2 and removed needs-triage This issue or PR still needs to be triaged. labels Sep 7, 2021
@kaizencc kaizencc added the effort/small Small work item – less than a day of effort label Sep 7, 2021
@kaizencc kaizencc added the good first issue Related to contributions. See CONTRIBUTING.md label Sep 7, 2021
@kaizencc
Copy link
Contributor

#16402 should have closed this issue

@github-actions
Copy link

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
@aws-cdk/aws-synthetics Related to Amazon CloudWatch Synthetics documentation This is a problem with documentation. effort/small Small work item – less than a day of effort feature-request A feature should be added or improved. good first issue Related to contributions. See CONTRIBUTING.md p2
Projects
None yet
Development

No branches or pull requests

3 participants