[Bug]: aws_imagebuilder_workflow allows invalid value "DISTRIBUTION" for 'type' argument

[clarkhathawayaltview]

Terraform Core Version

1.9.7

AWS Provider Version

5.72.0

Affected Resource(s)

aws_imagebuilder_workflow

Expected Behavior

The argument type should only allow the values "BUILD" and "TEST" per the Image Builder workflow documentation

The image creation workflow framework includes the following two distinct stages.
...
The workflow framework also includes a distribution stage. However, Image Builder handles the workflows for that stage.

Actual Behavior

The documentation and implementation allow for the value "DISTRIBUTION" to be passed

Relevant Error/Panic Output Snippet

Error: creating Image Builder Workflow: InvalidParameterValueException: The value supplied for parameter 'type' is not valid. Custom distribution workflows are not supported.

Terraform Configuration Files

resource aws_imagebuilder_workflow codebuild-projects {
  name = "CodeBuildProjectsDistributionWorkflow"
  version = "1.0.0"
  type = "DISTRIBUTION"
  data = file("${path.module}/codebuild-projects-distribution.workflow.yaml")
}

Steps to Reproduce

Standard plan & apply.

Debug Output

No response

Panic Output

No response

Important Factoids

No response

References

No response

Would you like to implement a fix?

None

[github-actions]

Community Note

Voting for Prioritization

• Please vote on this issue by adding a 👍 reaction to the original post to help the community and maintainers prioritize this request.
• Please see our prioritization guide for information on how we prioritize.
• Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request.

Volunteering to Work on This Issue

• If you are interested in working on this issue, please leave a comment.
• If this would be your first contribution, please review the contribution guide.

[stefanfreitag]

Hello @clarkhathawayaltview!
Thank you for reporting this issue related to the imagebuilder workflow resource.

I had a brief look into the relevant provider code section and it seems to be the case that we verify the input against the types defined in the AWS SDK for Go.

I checked out the behavior of the AWS CLI and it also dislikes the type DISTRIBUTION.

❯ aws --version
aws-cli/2.17.5 Python/3.11.8 Linux/6.11.0-8-generic exe/x86_64.ubuntu.24

❯ aws imagebuilder create-workflow --name test --type DISTRIBUTION --semantic-version 0.0.1 --data "workflow"
An error occurred (InvalidParameterValueException) when calling the CreateWorkflow operation: The value supplied for parameter 'type' is not valid. Custom distribution workflows are not supported.

even as its listed a supported input

• AWS CLI v1
• AWS CLI v2

On our end we could potentially exclude DISTRIBUTION from the validation checks, e.g. by below code change

names.AttrType: {
  Type:         schema.TypeString,
  Required:     true,
  ForceNew:     true,
  // ValidateDiagFunc: enum.Validate[awstypes.WorkflowType](),
  ValidateFunc: validation.StringInSlice([]string{string(awstypes.WorkflowTypeBuild), string(awstypes.WorkflowTypeTest)}, false),
},

[clarkhathawayaltview]

Your explanation was roughly what I had imagined the problem was. It is frustrating that their API is designed in this way but I'm pleased to see a quick response on this issue.

[github-actions]

Warning

This issue has been closed, meaning that any additional comments are hard for our team to see. Please assume that the maintainers will not see them.

Ongoing conversations amongst community members are welcome, however, the issue will be locked after 30 days. Moving conversations to another venue, such as the AWS Provider forum, is recommended. If you have additional concerns, please open a new issue, referencing this one where needed.