feat(scheduler-alpha): target properties override #27603

lpizzinidev · 2023-10-19T06:40:56Z

Allows to override a Schedule target's properties.
Supported properties: input, maxEventAge, and retryAttempts.

Example:

declare const target: targets.LambdaInvoke;

const oneTimeSchedule = new Schedule(this, 'Schedule', {
    schedule: ScheduleExpression.rate(cdk.Duration.hours(12)),
    target,
    targetOverrides: {
        input: ScheduleTargetInput.fromText("Overriding Target Input"),
        maxEventAge: Duration.seconds(180),
        retryAttempts: 5,
    },
});

Closes #27545.

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

aws-cdk-automation · 2023-10-23T00:09:18Z

This PR cannot be merged because it has conflicts. Please resolve them. The PR will be considered stale and closed if it remains in an unmergeable state.

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.

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

lpizzinidev · 2023-10-23T07:47:16Z

Exemption Request.
Not sure why this got tagged pr/needs-cli-test-run.

kaizencc

Thanks @lpizzinidev! Super minor comments, otherwise i think we are gtg

kaizencc · 2023-10-23T23:13:19Z

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

+   *
+   * @default - The target's maximumEventAgeInSeconds is used.
+   */
+  readonly maximumEventAge?: Duration;


it's called maxEventAge in schedule-targets, lets call it that here too

kaizencc · 2023-10-23T23:14:13Z

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

+   *
+   * @default - The target's input is used.
+   */
+  readonly input?: ScheduleTargetInput;


Suggested change

readonly input?: ScheduleTargetInput;

readonly input?: ScheduleTargetInput;

kaizencc · 2023-10-23T23:14:23Z

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

+   *
+   * @default - The target's maximumEventAgeInSeconds is used.
+   */
+  readonly maximumEventAge?: Duration;


Suggested change

readonly maximumEventAge?: Duration;

readonly maximumEventAge?: Duration;

kaizencc · 2023-10-23T23:17:03Z

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

+   *
+   * @default - The target's maximumRetryAttempts is used.
+   */
+  readonly maximumRetryAttempts?: number;


Suggested change

readonly maximumRetryAttempts?: number;

readonly maxRetryAttempts?: number;

Renamed to retryAttempts as in target class.

Pull request has been modified.

kaizencc

One last nit @lpizzinidev

kaizencc · 2023-10-24T14:23:09Z

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

@@ -256,8 +256,22 @@ const target = new targets.LambdaInvoke(fn, {

 ## Overriding Target Properties 

-TODO: 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)
+If you wish to reuse the same target in multiple schedules, you can override target properties like `input`, 
+`maximumRetryAttempts` and `maximumEventAgeInSeconds` when creating a Schedule using the `targetOverrides` parameter:


Suggested change

`maximumRetryAttempts` and `maximumEventAgeInSeconds` when creating a Schedule using the `targetOverrides` parameter:

`retryAttempts` and `maxEventAge` when creating a Schedule using the `targetOverrides` parameter:

kaizencc · 2023-10-24T14:23:25Z

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

+    schedule: ScheduleExpression.rate(cdk.Duration.hours(12)),
+    target,
+    targetOverrides: {
+        input: ScheduleTargetInput.fromText("Overriding Target Input"),


Suggested change

input: ScheduleTargetInput.fromText("Overriding Target Input"),

input: ScheduleTargetInput.fromText('Overriding Target Input'),

kaizencc · 2023-10-24T14:43:30Z

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

        deadLetterConfig: targetConfig.deadLetterConfig,
-        retryPolicy: targetConfig.retryPolicy,
+        retryPolicy: retryPolicy.maximumEventAgeInSeconds || retryPolicy.maximumRetryAttempts ? retryPolicy : undefined,


I don't like this, it's unnecessarily complicated. And what if we add a prop to retryPolicy in the future? Lets add a function that creates a retryPolicy but returns undefined if no properties inside the object are defined

Pull request has been modified.

kaizencc

Thanks!

mergify · 2023-10-24T18:00:36Z

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-10-26T16:06:07Z

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-10-26T17:04:06Z

AWS CodeBuild CI Report

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

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

mergify · 2023-10-26T17:04:27Z

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).

Allows to override a `Schedule` target's properties. Supported properties: `input`, `maxEventAge`, and `retryAttempts`. Example: ```ts declare const target: targets.LambdaInvoke; const oneTimeSchedule = new Schedule(this, 'Schedule', { schedule: ScheduleExpression.rate(cdk.Duration.hours(12)), target, targetOverrides: { input: ScheduleTargetInput.fromText("Overriding Target Input"), maxEventAge: Duration.seconds(180), retryAttempts: 5, }, }); ``` Closes #27545. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*

feat(schedule-alpha): support target properties override

dd7ed9d

github-actions bot added effort/small Small work item – less than a day of effort feature-request A feature should be added or improved. p2 labels Oct 19, 2023

aws-cdk-automation requested a review from a team October 19, 2023 06:41

github-actions bot added the distinguished-contributor [Pilot] contributed 50+ PRs to the CDK label Oct 19, 2023

lpizzinidev added 2 commits October 19, 2023 08:56

merged main branch into awsgh-27545

51ab22e

fixed validation for maximumEventAgeInSeconds

ede8e75

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

merged main branch

22ce09d

lpizzinidev force-pushed the gh-27545 branch from 9f1288f to 22ce09d Compare October 23, 2023 07:16

aws-cdk-automation previously requested changes Oct 23, 2023

View reviewed changes

aws-cdk-automation added the pr/needs-cli-test-run This PR needs CLI tests run against it. label Oct 23, 2023

merged main branch

97aef76

aws-cdk-automation added the pr-linter/exemption-requested The contributor has requested an exemption to the PR Linter feedback. label Oct 23, 2023

kaizencc removed pr/needs-cli-test-run This PR needs CLI tests run against it. feature-request A feature should be added or improved. labels Oct 23, 2023

kaizencc previously requested changes Oct 23, 2023

View reviewed changes

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

variables renaming and documentation cleanup

b8ac3e7

lpizzinidev force-pushed the gh-27545 branch from e4cccde to b8ac3e7 Compare October 24, 2023 08:22

github-actions bot added the feature-request A feature should be added or improved. label Oct 24, 2023

lpizzinidev requested a review from kaizencc October 24, 2023 10:05

kaizencc previously requested changes Oct 24, 2023

View reviewed changes

fixed README and policy generation

a3c91ef

lpizzinidev force-pushed the gh-27545 branch from 9184426 to a3c91ef Compare October 24, 2023 16:03

kaizencc previously approved these changes Oct 24, 2023

View reviewed changes

kaizencc changed the title ~~feat(schedule-alpha): support target properties override~~ feat(schedule-alpha): target properties override Oct 24, 2023

kaizencc changed the title ~~feat(schedule-alpha): target properties override~~ feat(scheduler-alpha): target properties override Oct 26, 2023

Merge branch 'main' into awsgh-27545

7a7a66e

kaizencc approved these changes Oct 26, 2023

View reviewed changes

Merge branch 'main' into awsgh-27545

9001791

mergify bot merged commit 1433ff2 into aws:main Oct 26, 2023
9 checks passed

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

Monthly PR metrics report - October 2023 #27786

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(scheduler-alpha): target properties override #27603

feat(scheduler-alpha): target properties override #27603

lpizzinidev commented Oct 19, 2023 •

edited

Loading

aws-cdk-automation commented Oct 23, 2023

aws-cdk-automation left a comment

lpizzinidev commented Oct 23, 2023

kaizencc left a comment

kaizencc Oct 23, 2023

kaizencc Oct 23, 2023

kaizencc Oct 23, 2023

kaizencc Oct 23, 2023

lpizzinidev Oct 24, 2023

kaizencc left a comment

kaizencc Oct 24, 2023

kaizencc Oct 24, 2023

kaizencc Oct 24, 2023

kaizencc left a comment

mergify bot commented Oct 24, 2023

mergify bot commented Oct 26, 2023

aws-cdk-automation commented Oct 26, 2023

mergify bot commented Oct 26, 2023

	readonly input?: ScheduleTargetInput;
	readonly input?: ScheduleTargetInput;

	readonly maximumEventAge?: Duration;
	readonly maximumEventAge?: Duration;

	readonly maximumRetryAttempts?: number;
	readonly maxRetryAttempts?: number;

	`maximumRetryAttempts` and `maximumEventAgeInSeconds` when creating a Schedule using the `targetOverrides` parameter:
	`retryAttempts` and `maxEventAge` when creating a Schedule using the `targetOverrides` parameter:

	input: ScheduleTargetInput.fromText("Overriding Target Input"),
	input: ScheduleTargetInput.fromText('Overriding Target Input'),

feat(scheduler-alpha): target properties override #27603

feat(scheduler-alpha): target properties override #27603

Conversation

lpizzinidev commented Oct 19, 2023 • edited Loading

aws-cdk-automation commented Oct 23, 2023

aws-cdk-automation left a comment

Choose a reason for hiding this comment

lpizzinidev commented Oct 23, 2023

kaizencc left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kaizencc left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kaizencc left a comment

Choose a reason for hiding this comment

mergify bot commented Oct 24, 2023

mergify bot commented Oct 26, 2023

aws-cdk-automation commented Oct 26, 2023

AWS CodeBuild CI Report

mergify bot commented Oct 26, 2023

lpizzinidev commented Oct 19, 2023 •

edited

Loading