New Data Source: aws_workspaces_workspace

[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_workspace`

Usage Example

Filter By Workspace ID

data "aws_workspaces_workspace" "test" {
  workspace_id = "ws-cj5xcxsz5"
}

Filter By Directory ID & User Name

data "aws_workspaces_workspace" "test" {
  directory_id = "d-9967252f57"
  user_name    = "alpha.test"
}

Notes

I haven't implemented a bundle_id filter intentionally, because it's already covered by the directory_id filter.

# May return multiple workspaces in different directories
data "aws_workspaces_workspace" "test" {
  bundle_id = "wsb-b0s22j3d7"
  user_name    = "alpha.test"
}

# bundle_id is redundant as user can have only 1 workspace in directory
data "aws_workspaces_workspace" "test" {
  directory_id = "d-9967252f57"
  bundle_id = "wsb-b0s22j3d7"
  user_name    = "alpha.test"
}

Acceptance Tests

$ make testacc TEST=./aws TESTARGS='-run=TestAccDataSourceAwsWorkspacesWorkspace' 
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go test ./aws -v -count 1 -parallel 1 -run=TestAccDataSourceAwsWorkspacesWorkspace -timeout 120m
=== RUN   TestAccDataSourceAwsWorkspacesWorkspace_byWorkspaceID
=== PAUSE TestAccDataSourceAwsWorkspacesWorkspace_byWorkspaceID
=== RUN   TestAccDataSourceAwsWorkspacesWorkspace_byDirectoryID_userName
=== PAUSE TestAccDataSourceAwsWorkspacesWorkspace_byDirectoryID_userName
=== RUN   TestAccDataSourceAwsWorkspacesWorkspace_workspaceIDAndDirectoryIDConflict
=== PAUSE TestAccDataSourceAwsWorkspacesWorkspace_workspaceIDAndDirectoryIDConflict
=== CONT  TestAccDataSourceAwsWorkspacesWorkspace_byWorkspaceID
--- PASS: TestAccDataSourceAwsWorkspacesWorkspace_byWorkspaceID (2083.29s)
=== CONT  TestAccDataSourceAwsWorkspacesWorkspace_workspaceIDAndDirectoryIDConflict
--- PASS: TestAccDataSourceAwsWorkspacesWorkspace_workspaceIDAndDirectoryIDConflict (2.99s)
=== CONT  TestAccDataSourceAwsWorkspacesWorkspace_byDirectoryID_userName
--- PASS: TestAccDataSourceAwsWorkspacesWorkspace_byDirectoryID_userName (2184.49s)
PASS
ok  	github.com/terraform-providers/terraform-provider-aws/aws	4274.536s

References

• DescribeWorkspaces API

[Tensho]

@gdavison Hi ^_^ Please could you help me to understand this issue?

$ AWS_DEFAULT_REGION=us-east-1 make testacc TEST=./aws TESTARGS='-run=TestAccDataSourceAwsWorkspacesWorkspace_byDirectoryID_userName'
...
 TestAccDataSourceAwsWorkspacesWorkspace_byDirectoryID_userName: testing.go:684: Step 0 error: After applying this step and refreshing, the plan was not empty:

        DIFF:

        UPDATE: data.aws_workspaces_workspace.test
          bundle_id:                      "" => "<computed>"
          computer_name:                  "" => "<computed>"
          directory_id:                   "" => "d-90677c9a02"
          id:                             "" => "<computed>"
          ip_address:                     "" => "<computed>"
          root_volume_encryption_enabled: "" => "<computed>"
          state:                          "" => "<computed>"
          user_name:                      "" => "Administrator"
          user_volume_encryption_enabled: "" => "<computed>"
          volume_encryption_key:          "" => "<computed>"
          workspace_properties:           "" => "<computed>"
...

I can't grasp why does the plan for data source is not empty. What does it mean?

[teamterraform]

Notification of Recent and Upcoming Changes to Contributions

Thank you for this contribution! There have been a few recent development changes that affect this pull request. We apologize for the inconvenience, especially if there have been long review delays up until now. Please note that this is automated message from an unmonitored account. See the FAQ for additional information on the maintainer team and review prioritization.

If you are unable to complete these updates, please leave a comment for the community and maintainers so someone can potentially continue the work. The maintainers will encourage other contributors to use the existing contribution as the base for additional changes as appropriate. Otherwise, contributions that do not receive updated code or comments from the original contributor may be closed in the future so the maintainers can focus on active items.

For the most up to date information about Terraform AWS Provider development, see the Contributing Guide. Additional technical debt changes can be tracked with the technical-debt label on issues.

As part of updating a pull request with these changes, the most current unit testing and linting will run. These may report issues that were not previously reported.

Action Required: Terraform 0.12 Syntax

Reference: #8950
Reference: #14417

Version 3 and later of the Terraform AWS Provider, which all existing contributions would potentially be added, only supports Terraform 0.12 and later. Certain syntax elements of Terraform 0.11 and earlier show deprecation warnings during runs with Terraform 0.12. Documentation and test configurations, such as those including deprecated string interpolations (some_attribute = "${aws_service_thing.example.id}") should be updated to the newer syntax (some_attribute = aws_service_thing.example.id). Contribution testing will automatically fail on older syntax in the near future. Please see the referenced issues for additional information.

Action Required: Terraform Plugin SDK Version 2

Reference: #14551

The Terraform AWS Provider has been upgraded to the latest version of the Terraform Plugin SDK. Generally, most changes to contributions should only involve updating Go import paths in source code files. Please see the referenced issue for additional information.

Action Required: Removal of website/aws.erb File

Reference: #14712

Any changes to the website/aws.erb file are no longer necessary and should be removed from this contribution to prevent merge issues in the near future when the file is removed from the repository. Please see the referenced issue for additional information.

Upcoming Change of Git Branch Naming

Reference: #14292

Development environments will need their upstream Git branch updated from master to main in the near future. Please see the referenced issue for additional information and scheduling.

Upcoming Change of GitHub Organization

Reference: #14715

This repository will be migrating from https://github.com/terraform-providers/terraform-provider-aws to https://github.com/hashicorp/terraform-provider-aws. No practitioner or developer action is anticipated and most GitHub functionality will automatically redirect to the new location. Go import paths including terraform-providers can remain for now. Please see the referenced issue for additional information and scheduling.

[gdavison]

I've never seen the error message "After applying this step and refreshing, the plan was not empty" for a data source. Is it possible that the error is about a resource, but it's buried in the output?

[Tensho]

@gdavison Fixed tests. please check it out again 🙇

[DrFaust92]

@Tensho, rebase to solve conflicts.

[DrFaust92]

getting errors:

=== CONT  TestAccDataSourceAwsWorkspacesWorkspace_byDirectoryID_userName
    data_source_aws_workspaces_workspace_test.go:49: Step 1/1 error: After applying this test step and performing a `terraform refresh`, the plan was not empty.
        stdout
        
        
        An execution plan has been generated and is shown below.
        Resource actions are indicated with the following symbols:
         <= read (data resources)
        
        Terraform will perform the following actions:
        
          # data.aws_workspaces_workspace.test will be read during apply
          # (config refers to values not yet known)
         <= data "aws_workspaces_workspace" "test"  {
              + bundle_id                      = (known after apply)
              + computer_name                  = (known after apply)
              + directory_id                   = "d-9267093919"
              + id                             = (known after apply)
              + ip_address                     = (known after apply)
              + root_volume_encryption_enabled = (known after apply)
              + state                          = (known after apply)
              + user_name                      = "Administrator"
              + user_volume_encryption_enabled = (known after apply)
              + volume_encryption_key          = (known after apply)
              + workspace_properties           = (known after apply)
            }
        
        Plan: 0 to add, 0 to change, 0 to destroy.



Error: workspace "ws-v6c832pkg" was not terminated: couldn't find resource (21 retries)


=== CONT  TestAccDataSourceAwsWorkspacesWorkspace_byDirectoryID_userName
    testing_new.go:62: Error running post-test destroy, there may be dangling resources: 2020/10/15 15:21:22 [DEBUG] Using modified User-Agent: Terraform/0.12.29 HashiCorp-terraform-exec/0.10.0
        
        Error: workspace "ws-v6c832pkg" was not terminated: couldn't find resource (21 retries)
        
        
--- FAIL: TestAccDataSourceAwsWorkspacesWorkspace_byDirectoryID_userName (1687.85s)

other are passing:

--- PASS: TestAccDataSourceAwsWorkspacesWorkspace_byWorkspaceID (1676.66s)
--- PASS: TestAccDataSourceAwsWorkspacesWorkspace_workspaceIDAndDirectoryIDConflict (5.82s)

[Tensho]

@ewbankkit Thanks for review 👍 I've fixed all the mentioned comments.

[ewbankkit]

LGTM.
(Unable to validate acceptance tests).

[breathingdust]

LGTM 🚀 Thanks @Tensho for the contribution!

Verified Acceptance Tests in Commercial (us-west-2)

make testacc TEST=./aws TESTARGS='-run=TestAccDataSourceAwsWorkspacesWorkspace'
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go test ./aws -v -count 1 -parallel 20 -run=TestAccDataSourceAwsWorkspacesWorkspace -timeout 120m
=== RUN   TestAccDataSourceAwsWorkspacesWorkspace_byWorkspaceID
=== PAUSE TestAccDataSourceAwsWorkspacesWorkspace_byWorkspaceID
=== RUN   TestAccDataSourceAwsWorkspacesWorkspace_byDirectoryID_userName
=== PAUSE TestAccDataSourceAwsWorkspacesWorkspace_byDirectoryID_userName
=== RUN   TestAccDataSourceAwsWorkspacesWorkspace_workspaceIDAndDirectoryIDConflict
=== PAUSE TestAccDataSourceAwsWorkspacesWorkspace_workspaceIDAndDirectoryIDConflict
=== CONT  TestAccDataSourceAwsWorkspacesWorkspace_byWorkspaceID
=== CONT  TestAccDataSourceAwsWorkspacesWorkspace_workspaceIDAndDirectoryIDConflict
=== CONT  TestAccDataSourceAwsWorkspacesWorkspace_byDirectoryID_userName
--- PASS: TestAccDataSourceAwsWorkspacesWorkspace_workspaceIDAndDirectoryIDConflict (2.78s)
--- PASS: TestAccDataSourceAwsWorkspacesWorkspace_byDirectoryID_userName (1742.16s)
--- PASS: TestAccDataSourceAwsWorkspacesWorkspace_byWorkspaceID (1815.05s)
PASS
ok  	github.com/terraform-providers/terraform-provider-aws/aws	1816.658s

[ghost]

This has been released in version 3.14.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!