Skip to content
New issue

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

#

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

Already on GitHub? # to your account

Jump to bottom

(aws-scheduler-targets-alpha): add support for universal targets #32328

Closed
1 of 2 tasks
sakurai-ryo opened this issue Nov 29, 2024 · 2 comments · Fixed by #32341
Closed
1 of 2 tasks

(aws-scheduler-targets-alpha): add support for universal targets #32328

sakurai-ryo opened this issue Nov 29, 2024 · 2 comments · Fixed by #32341
Labels
@aws-cdk/aws-scheduler Related to the AWS Scheduler service effort/small Small work item – less than a day of effort feature-request A feature should be added or improved. p2

Comments

@sakurai-ryo
Copy link
Contributor

Describe the feature

EventBridge Scheduler has a mechanism called Universal Target that calls a wide range of AWS APIs.
Supporting this mechanism in L2 Construct will make it easier to configure EventBridge Scheduler.
https://docs.aws.amazon.com/scheduler/latest/UserGuide/managing-targets-universal.html

Use Case

Currently, scheduler-targets only supports templated targets such as StartBuild and does not support universal targets.
If supported in L2, there are various usecases, such as stopping RDS.

Proposed Solution

Create a new UniversalTarget class that extends ScheduleTargetBase.

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

Environment details (OS name and version, etc.)

macos
@sakurai-ryo sakurai-ryo added feature-request A feature should be added or improved. needs-triage This issue or PR still needs to be triaged. labels Nov 29, 2024
@github-actions github-actions bot added the @aws-cdk/aws-scheduler Related to the AWS Scheduler service label Nov 29, 2024
@khushail khushail added investigating This issue is being investigated and/or work is in progress to resolve the issue. p2 and removed needs-triage This issue or PR still needs to be triaged. labels Nov 29, 2024
@khushail khushail self-assigned this Nov 29, 2024
@khushail
Copy link
Contributor

Thanks @sakurai-ryo for requesting this and volunteering for PR contribution. I can see that Cloudformation supports Universal as well as templated targets so it would be good to have this.
Looking forward to your PR!

@khushail khushail added effort/small Small work item – less than a day of effort and removed investigating This issue is being investigated and/or work is in progress to resolve the issue. labels Nov 29, 2024
@khushail khushail removed their assignment Nov 29, 2024
@github-actions github-actions bot mentioned this issue Dec 1, 2024
Open
@sakurai-ryo sakurai-ryo mentioned this issue Dec 1, 2024
Merged
1 task
mergify bot pushed a commit that referenced this issue Jan 13, 2025
@sakurai-ryo
feat(scheduler-targets): add support for universal target (#32341)
021e6d6 
### Issue # (if applicable)

Closes #32328

### Reason for this change


EventBridge Scheduler has a mechanism called Universal Target that calls a wide range of AWS APIs.
Supporting this mechanism in L2 Construct will make it easier to configure EventBridge Scheduler.
https://docs.aws.amazon.com/scheduler/latest/UserGuide/managing-targets-universal.html

### Description of changes

Added Universal construct targeting AWS APIs.
Users can execute any AWS API by passing service and action to Props.

According to the following documentation, the service must be lowercase, and the action must be camelCase, so that you can validate it.
`arn:aws:scheduler:::aws-sdk:service:apiAction`
https://docs.aws.amazon.com/scheduler/latest/UserGuide/managing-targets-universal.html#:~:text=schedule%20to%20target.-,Arn,-%E2%80%93%20The%20complete%20service

### Description of how you validated changes

Added unit tests and integration tests.

### Checklist
- [ ] My code adheres to the [CONTRIBUTING GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and [DESIGN GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md)

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
@mergify mergify bot closed this as completed in #32341 Jan 13, 2025
@github-actions GitHub Actions
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 Jan 13, 2025
mrgrain pushed a commit that referenced this issue Jan 14, 2025
@sakurai-ryo @mrgrain
feat(scheduler-targets): add support for universal target (#32341)
d571634 
### Issue # (if applicable)

Closes #32328

### Reason for this change


EventBridge Scheduler has a mechanism called Universal Target that calls a wide range of AWS APIs.
Supporting this mechanism in L2 Construct will make it easier to configure EventBridge Scheduler.
https://docs.aws.amazon.com/scheduler/latest/UserGuide/managing-targets-universal.html

### Description of changes

Added Universal construct targeting AWS APIs.
Users can execute any AWS API by passing service and action to Props.

According to the following documentation, the service must be lowercase, and the action must be camelCase, so that you can validate it.
`arn:aws:scheduler:::aws-sdk:service:apiAction`
https://docs.aws.amazon.com/scheduler/latest/UserGuide/managing-targets-universal.html#:~:text=schedule%20to%20target.-,Arn,-%E2%80%93%20The%20complete%20service

### Description of how you validated changes

Added unit tests and integration tests.

### Checklist
- [ ] My code adheres to the [CONTRIBUTING GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and [DESIGN GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md)

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
# for free to subscribe to this conversation on GitHub. Already have an account? #.
Assignees
No one assigned
Labels
@aws-cdk/aws-scheduler Related to the AWS Scheduler service effort/small Small work item – less than a day of effort feature-request A feature should be added or improved. p2
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat(scheduler-targets): add support for universal target sakurai-ryo/aws-cdk
2 participants
@sakurai-ryo @khushail