aws-cloudformation / aws-cloudformation/cloudformation-cli-java-plugin

Reusing code between resources

Open
#335 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Java
Stars
30
Forks
48
PR merge metrics
No merged PRs in 30d

Description

Hi, I'm from AWS IoT, we have a question/feature request.

Our handlers across different resources use the same code for exception translations and listing resource tags. These resources reside in the same GitHub repository, yet, since each resource has its own Maven project, we're unable to reuse that common code and haven't seen solutions in other repositories.

Specific examples from our AWS IoT repo (code is still in PRs):
1. Exception translation code - [link](https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-iot/blob/09e62a47f99448c366eb7eaceb8c8ea76f8d6d36/aws-iot-securityprofile/src/main/java/com/amazonaws/iot/securityprofile/Translator.java#L295). We have this method in the Translator class for each resource.
1. `listTags` method (calls IoT::ListTagsForResource) - [link](https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-iot/blob/09e62a47f99448c366eb7eaceb8c8ea76f8d6d36/aws-iot-securityprofile/src/main/java/com/amazonaws/iot/securityprofile/HandlerUtils.java#L46).

For both of these, we're able to reuse the code between handlers for the same resource, but we had to copy paste this piece of code for each resource.

Is there a solution available for our use case?

Contributor guide

Open the contributing guide

Research direction

Start with the linked AWS IoT examples in Translator.java and HandlerUtils.java, focusing on the exception translation and listTags methods that are duplicated across resource Maven projects. Then inspect how this Java plugin generates separate projects and determine whether shared code can be supported. Done means documenting or implementing a concrete reuse approach for these handlers.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
build-system, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.