New Data Source: aws_workspaces_image

[Tensho]

Community Note

• Please vote on this pull request by adding a 👍 reaction to the original pull request comment to help the community and maintainers prioritize this request
• Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for pull request followers and do not help prioritize the request

Release note for CHANGELOG:

New Data Source: aws_workspaces_image (#11428)

Example

data "aws_workspaces_image" "example" {
  image_id = "wsi-ten5h0y19"
}

TODO

• Create aws_workspaces_image resource before inspecting it with the described data source

Acceptance Tests

$ AWS_WORKSPACES_IMAGE_ID=wsi-vwtykwqyx AWS_DEFAULT_REGION=us-east-1 make testacc TEST=./aws TESTARGS='-run=TestAccDataSourceAwsWorkspacesImage_basic'
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go test ./aws -v -count 1 -parallel 20 -run=TestAccDataSourceAwsWorkspacesImage_basic -timeout 120m
=== RUN   TestAccDataSourceAwsWorkspacesImage_basic
=== PAUSE TestAccDataSourceAwsWorkspacesImage_basic
=== CONT  TestAccDataSourceAwsWorkspacesImage_basic
--- PASS: TestAccDataSourceAwsWorkspacesImage_basic (30.84s)
PASS
ok  	github.com/terraform-providers/terraform-provider-aws/aws	34.844s

References

• Support for AWS Workspaces

[Tensho]

Unfortunately, it's not possible to create an image with the API at the moment, I've requested corresponding API action with AWS Support ticket.
The current test passes for the manually created image in AWS Web Management Console.

[ewbankkit]

Will probably want to check len(resp.Images) > 0 here.
See #11837.

[Tensho]

Good point, will add

[gdavison]

Looks good, @Tensho. A couple changes to make.

[gdavison]

This won't pass in our testing environments, since the image is owned by your account.

We could add an environment variable for the image ID and have a pre-check function that checks for the environment variable. Alternatively, there are API functions to import AMIs as Workspace images.

[Tensho]

I like the idea with environment variable, will add the pre-check for now. Unfortunately, ImportWorkspaceImage API works only with Windows. I've submitted respective feature request to AWS Support last year. Is it OK to create aws_workspace_image Terraform resource only for Windows, while AWS supports Linux images too?

[gdavison]

Yes, we can do that. We'll just need to document that it only supports Windows images because of the AWS API

[Tensho]

Unfortunately, even Windows images could be imported only with BYOL, which looks like a totally separate feature.

[Tensho]

@gdavison Thank you, I've added fixes according to your review, please let me know if I can do anything else here 🙇

[gdavison]

The test will need to be updated to handle arbitrary image ids

[gdavison]

Since we're retrieving a WorkSpaces Image using an arbitrary ID, we won't know these values beforehand. You might be able to test this by retrieving the API resource by ID, and then comparing the values in the Terraform resource state. testAccCheckEfsMountTarget() is an example of the approach you could take

[Tensho]

testAccCheckEfsMountTarget() retrieves actual resource attributes within AWS API, but doesn't test them against state 😄 But I got the idea, you meant item 2 at Anatomy of an Acceptance Test – testAccCheckCloudWatchDashboardExists().

[Tensho]

Fixed

[gdavison]

If the environment variable isn't set, this should skip the test instead of failing

[Tensho]

Fixed

[Tensho]

@gdavison FIxed, check it out again.

[gdavison]

Looking good. It will need to be rebased, and I have a few suggested changes.

[gdavison]

We can remove the state attribute, since it is more of a run-time property, not a configuration property.

[Tensho]

But this is a data source, not a resource. Don't we need to get info about any possible attribute there?

[Tensho]

@gdavison Adjusted according to your comments. Please let me know if you need anything else 🙇

I also work on aws_workspaces_workspace data source, but I've stuck with one test. If you have some time to look there, please could you guide me the right direction 🙇

[Tensho]

@gdavison @ewbankkit Hi ^_^ Please could you check it again?

[gdavison]

LGTM 🚀

--- PASS: TestAccDataSourceAwsWorkspacesImage_basic (54.32s)

[Tensho]

@gdavison Thank you 🙇

[ghost]

This has been released in version 3.8.0 of the Terraform AWS provider. Please see the Terraform documentation on provider versioning or reach out if you need any assistance upgrading.

For further feature requests or bug reports with this functionality, please create a new GitHub issue following the template for triage. Thanks!

[ghost]

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.

If you feel this issue should be reopened, we encourage creating a new issue linking back to this one for added context. Thanks!