Skip to content

Commit

Permalink
docs: remove non-usable workflow type
Browse files Browse the repository at this point in the history
### Description

The documentation of the resource [`ami_imagebuilder_workflow`](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/imagebuilder_workflow)  mentions for the argument `type`
>  Valid values: BUILD, TEST, DISTRIBUTION.

Image Builder handles the  workflow type DISTRIBUTION, it cannot be configured by users.
When trying to do so, for example using the code snippet provided as part of #39785 

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

the API returns the error ` The value supplied for parameter 'type' is not valid. Custom distribution workflows are not supported.`

This pull request is to update the documentation for the resource.

### Relations

Closes #39785 

### References

[Here](#39785 (comment)) I explained the current situation.

### Output from Acceptance Testing

Not required. Only documentation changed.
  • Loading branch information
stefanfreitagrwe committed Oct 23, 2024
1 parent 972f2ad commit c26dc3c
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion website/docs/r/imagebuilder_workflow.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ description: |-

Terraform resource for managing an AWS EC2 Image Builder Workflow.

-> Image Builder manages the workflows for the distribution stage. Therefore, using the DISTRIBUTION workflow type results in an error.

## Example Usage

### Basic Usage
Expand Down Expand Up @@ -55,7 +57,7 @@ resource "aws_imagebuilder_workflow" "example" {
The following arguments are required:

* `name` - (Required) Name of the workflow.
* `type` - (Required) Type of the workflow. Valid values: `BUILD`, `TEST`, `DISTRIBUTION`.
* `type` - (Required) Type of the workflow. Valid values: `BUILD`, `TEST`.
* `version` - (Required) Version of the workflow.

The following arguments are optional:
Expand Down

0 comments on commit c26dc3c

Please sign in to comment.