feat(scheduler): ScheduleGroup #26196

filletofish · 2023-07-02T18:58:37Z

This PR contains implementation of ScheduleGroup.

A Schedule is the main resource in Amazon EventBridge Scheduler, this PR adds ScheduleGroup which can be used to group Schedules and on which Schedule depends.

Every AWS account comes with a default group for schedules. Customers can also create a custom groups to organise schedules that share a common purpose or belong to the same environment.

Schedule has a property group that determines what group is the schedule associated with.

To be able to test adding schedules to the group I have added property group to private class Schedule and used Lazy functionality to be able to update group of the schedule dynamically.

Implementation is based on RFC: https://github.com/aws/aws-cdk-rfcs/blob/master/text/0474-event-bridge-scheduler-l2.md

Advances #23394

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

aws-cdk-automation

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

gitpod-io · 2023-07-02T19:20:25Z

filletofish · 2023-07-02T19:26:34Z

packages/@aws-cdk/aws-scheduler-alpha/lib/group.ts

+  /**
+   * Grant list and get schedule permissions for schedules in this group to the given principal
+   */
+  grantReadSchedules(identity: iam.IGrantable): iam.Grant;


Compared to RFC I have updated the method names for granting permissions. From grantRead to grantReadSchedules - to be more precise that the method grants permissions to manage schedules in the group, not the permissions for the group itself.

There are IAM permissions for the schedules and for the groups.

packages/@aws-cdk/aws-scheduler-alpha/lib/group.ts

packages/@aws-cdk/aws-scheduler-alpha/lib/private/schedule.ts

Jacco · 2023-07-05T05:16:55Z

packages/@aws-cdk/aws-scheduler-alpha/lib/group.ts

+      resourceName: this.physicalName,
+    });
+    this.groupName = this.physicalName;
+  }


I think a call to applyRemovalPolicy is missing here? This means the removalPolicy from the props will not be emitted to CloudFormation. (+ that needs a test)

Thanks! I have actually missed that.

@default RemovalPolicy.RETAIN

Are we sure that we want the default to be RETAIN?

packages/@aws-cdk/aws-scheduler-alpha/lib/private/schedule.ts

✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.

Plus this commit fixes access modifiers for methods in group.ts

kaizencc

Thanks @filletofish and @Jacco for the great start. have a few api questions but nothing major

packages/@aws-cdk/aws-scheduler-alpha/lib/group.ts

packages/@aws-cdk/aws-scheduler-alpha/lib/private/schedule.ts

- Remove addSchedules method - Update readme - Apply removal policy

Pull request has been modified.

packages/@aws-cdk/aws-scheduler-alpha/README.md

kaizencc · 2023-07-18T19:33:03Z

packages/@aws-cdk/aws-scheduler-alpha/README.md

-TODO: Group is not yet implemented. See section in [L2 Event Bridge Scheduler RFC](https://github.com/aws/aws-cdk-rfcs/blob/master/text/0474-event-bridge-scheduler-l2.md)
+Your AWS account comes with a default scheduler group. You can access default group in CDK with:
+
+```text


these examples can be in ts now? Since they should be fully implemented right. Then you will also have to double check with yarn rosetta:extract --strict or else the PR build may fail :)

Updated now, good catch

packages/@aws-cdk/aws-scheduler-alpha/README.md

packages/@aws-cdk/aws-scheduler-alpha/lib/private/schedule.ts

mergify · 2023-07-22T02:25:56Z

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

Pull request has been modified.

mergify · 2023-07-24T19:01:11Z

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

aws-cdk-automation · 2023-07-24T19:27:23Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
Commit ID: b792f76
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

mergify · 2023-07-24T19:27:49Z

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

This PR contains implementation of ScheduleGroup. A Schedule is the main resource in Amazon EventBridge Scheduler, this PR adds ScheduleGroup which can be used to group Schedules and on which Schedule depends. Every AWS account comes with a default group for schedules. Customers can also create a custom groups to organise schedules that share a common purpose or belong to the same environment. Schedule has a property `group` that determines what group is the schedule associated with. To be able to test adding schedules to the group I have added property `group` to private class `Schedule` and used `Lazy` functionality to be able to update `group` of the schedule dynamically. Implementation is based on RFC: https://github.com/aws/aws-cdk-rfcs/blob/master/text/0474-event-bridge-scheduler-l2.md Advances aws#23394 ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*

Implement Schedule Group

043ab0b

github-actions bot added the beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK label Jul 2, 2023

aws-cdk-automation requested a review from a team July 2, 2023 18:58

github-actions bot added the p2 label Jul 2, 2023

aws-cdk-automation previously requested changes Jul 2, 2023

View reviewed changes

filletofish added 2 commits July 2, 2023 19:19

Use schedule from private sub-package

c97bb52

Update README.md

6462b60

filletofish commented Jul 2, 2023

View reviewed changes

packages/@aws-cdk/aws-scheduler-alpha/lib/group.ts Outdated Show resolved Hide resolved

filletofish marked this pull request as ready for review July 2, 2023 19:31

Jacco reviewed Jul 5, 2023

View reviewed changes

packages/@aws-cdk/aws-scheduler-alpha/lib/private/schedule.ts Outdated Show resolved Hide resolved

Jacco reviewed Jul 5, 2023

View reviewed changes

packages/@aws-cdk/aws-scheduler-alpha/lib/private/schedule.ts Show resolved Hide resolved

kaizencc added the pr-linter/exempt-integ-test The PR linter will not require integ test changes label Jul 5, 2023

Fix build by depending on ISchedule instead of Schedule

68ccc82

Plus this commit fixes access modifiers for methods in group.ts

aws-cdk-automation added the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Jul 6, 2023

kaizencc previously requested changes Jul 6, 2023

View reviewed changes

kaizencc self-assigned this Jul 6, 2023

kaizencc changed the title ~~feat(schedule): ScheduleGroup~~ feat(scheduler): ScheduleGroup Jul 6, 2023

aws-cdk-automation removed the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Jul 6, 2023

Update with pr comments

6150b10

- Remove addSchedules method - Update readme - Apply removal policy

aws-cdk-automation added the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Jul 13, 2023

kaizencc reviewed Jul 18, 2023

View reviewed changes

kaizencc and others added 2 commits July 18, 2023 15:39

Apply suggestions from code review

e083f0c

Update readme examples to TS

76d2c25

kaizencc previously approved these changes Jul 22, 2023

View reviewed changes

Merge branch 'main' into feat/23394-schedule-group

ab8367e

Merge branch 'main' into feat/23394-schedule-group

510c43d

kaizencc approved these changes Jul 24, 2023

View reviewed changes

Merge branch 'main' into feat/23394-schedule-group

b792f76

mergify bot merged commit 27dc8ff into aws:main Jul 24, 2023
6 checks passed

github-actions bot mentioned this pull request Aug 1, 2023

Monthly PRs metrics report - July 2023 #26583

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(scheduler): ScheduleGroup #26196

feat(scheduler): ScheduleGroup #26196

filletofish commented Jul 2, 2023 •

edited

aws-cdk-automation left a comment

gitpod-io bot commented Jul 2, 2023

filletofish Jul 2, 2023 •

edited

Jacco Jul 5, 2023 •

edited

filletofish Jul 13, 2023

kaizencc left a comment

kaizencc Jul 18, 2023

filletofish Jul 21, 2023

mergify bot commented Jul 22, 2023

mergify bot commented Jul 24, 2023

aws-cdk-automation commented Jul 24, 2023

mergify bot commented Jul 24, 2023

feat(scheduler): ScheduleGroup #26196

feat(scheduler): ScheduleGroup #26196

Conversation

filletofish commented Jul 2, 2023 • edited

aws-cdk-automation left a comment

Choose a reason for hiding this comment

gitpod-io bot commented Jul 2, 2023

filletofish Jul 2, 2023 • edited

Choose a reason for hiding this comment

Jacco Jul 5, 2023 • edited

Choose a reason for hiding this comment

filletofish Jul 13, 2023

Choose a reason for hiding this comment

kaizencc left a comment

Choose a reason for hiding this comment

kaizencc Jul 18, 2023

Choose a reason for hiding this comment

filletofish Jul 21, 2023

Choose a reason for hiding this comment

mergify bot commented Jul 22, 2023

mergify bot commented Jul 24, 2023

aws-cdk-automation commented Jul 24, 2023

AWS CodeBuild CI Report

mergify bot commented Jul 24, 2023

filletofish commented Jul 2, 2023 •

edited

filletofish Jul 2, 2023 •

edited

Jacco Jul 5, 2023 •

edited