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

fix(scheduler-alpha): remove targetOverrides prop from Schedule #31799

Merged
merged 3 commits into from
Oct 21, 2024

Conversation

samson-keung
Copy link
Contributor

@samson-keung samson-keung commented Oct 17, 2024

Issue # (if applicable)

N/A

Reason for this change

The targetOverrides prop is adding confusion to the API as it override what is set on the target. A better way to reuse target props would be:

const targetBaseProps = { input: ...someInput... }

const schedule1 = new Schedule(this, 'Schedule', {
    scheduleExpression: ScheduleExpression.cron({ day: '20' }),
    target: new targets.LambdaInvoke(props.func, {
        ...targetBaseProps,
        // override whatever or not to override
        }),
    }),
});

Description of changes

Removed targetOverrides prop and the related tests. Also updated the integ test which was using the prop.

Description of how you validated changes

Removing a prop so n/a.

Checklist


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


BREAKING CHANGE: This PR removes the targetOverrides prop from the Schedule construct.

@github-actions github-actions bot added the p2 label Oct 17, 2024
@aws-cdk-automation aws-cdk-automation requested a review from a team October 17, 2024 22:50
@mergify mergify bot added the contribution/core This is a PR that came from AWS. label Oct 17, 2024
Copy link
Collaborator

@aws-cdk-automation aws-cdk-automation left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@samson-keung samson-keung changed the title feat(scheduler-alpha): remove targetOverrides prop from Schedule fix(scheduler-alpha): remove targetOverrides prop from Schedule Oct 17, 2024
@aws-cdk-automation aws-cdk-automation dismissed their stale review October 17, 2024 22:57

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

@samson-keung samson-keung marked this pull request as ready for review October 18, 2024 03:19
@aws-cdk-automation aws-cdk-automation added the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Oct 18, 2024
/**
* The customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data.
*/
readonly key?: kms.IKey;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we mean to remove this key property as part of this change?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes. Removing it from the interface as it is not being used currently. I would like to start with minimal exposed APIs, then we can add more in the future if needed.

@@ -285,25 +285,6 @@ const target = new targets.LambdaInvoke(fn, {
});
```

## Overriding Target Properties
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we know if this is a common use case? If so it may be worth keeping this README section with your updated suggestion for overriding target props

Copy link
Contributor Author

@samson-keung samson-keung Oct 20, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this is common use case. If we see the need in the future, we can add.

@aws-cdk-automation aws-cdk-automation removed the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Oct 19, 2024
Copy link
Contributor

@gracelu0 gracelu0 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

Copy link
Contributor

mergify bot commented Oct 21, 2024

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
Copy link
Collaborator

AWS CodeBuild CI Report

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

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

@mergify mergify bot merged commit be4154b into aws:main Oct 21, 2024
9 checks passed
Copy link
Contributor

mergify bot commented Oct 21, 2024

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

Copy link

Comments on closed issues and PRs are hard for our team to see.
If you need help, please open a new issue that references this one.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Oct 21, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
contribution/core This is a PR that came from AWS. p2
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants