New Resource: aws_quicksight_refresh_schedule

[g-dx]

Description

This PR adds a new aws_quicksight_refresh_schedule resource, allowing practitioners to manage scheduled refreshes of Quicksight data sets via Terraform.

Relations

Closes #30788
Relates To #10990 & #30744

References

• https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CreateRefreshSchedule.html
• https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DeleteRefreshSchedule.html
• https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeRefreshSchedule.html
• https://docs.aws.amazon.com/quicksight/latest/APIReference/API_ListRefreshSchedules.html
• https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateRefreshSchedule.html

Output from Acceptance Testing

make testacc PKG=quicksight TESTS=TestAccQuickSightRefreshSchedule_
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go test ./internal/service/quicksight/... -v -count 1 -parallel 20 -run='TestAccQuickSightRefreshSchedule_'  -timeout 180m
=== RUN   TestAccQuickSightRefreshSchedule_basic
=== PAUSE TestAccQuickSightRefreshSchedule_basic
=== RUN   TestAccQuickSightRefreshSchedule_disappears
=== PAUSE TestAccQuickSightRefreshSchedule_disappears
=== RUN   TestAccQuickSightRefreshSchedule_weeklyRefresh
=== PAUSE TestAccQuickSightRefreshSchedule_weeklyRefresh
=== RUN   TestAccQuickSightRefreshSchedule_monthlyRefresh
=== PAUSE TestAccQuickSightRefreshSchedule_monthlyRefresh
=== CONT  TestAccQuickSightRefreshSchedule_basic
=== CONT  TestAccQuickSightRefreshSchedule_weeklyRefresh
=== CONT  TestAccQuickSightRefreshSchedule_disappears
=== CONT  TestAccQuickSightRefreshSchedule_monthlyRefresh
--- PASS: TestAccQuickSightRefreshSchedule_disappears (27.80s)
--- PASS: TestAccQuickSightRefreshSchedule_weeklyRefresh (29.59s)
--- PASS: TestAccQuickSightRefreshSchedule_basic (30.83s)
--- PASS: TestAccQuickSightRefreshSchedule_monthlyRefresh (31.13s)
PASS
ok  	github.com/hashicorp/terraform-provider-aws/internal/service/quicksight	31.218s

[github-actions]

Community Note

Voting for Prioritization

• Please vote on this pull request by adding a 👍 reaction to the original post to help the community and maintainers prioritize this pull 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.

For Submitters

• Review the contribution guide relating to the type of change you are making to ensure all of the necessary steps have been taken.
• For new resources and data sources, use skaff to generate scaffolding with comments detailing common expectations.
• Whether or not the branch has been rebased will not impact prioritization, but doing so is always a welcome surprise.

[g-dx]

@jar-b - after further reading of the API docs I've realised that refresh schedules can be created from data sets which do not have refresh properties defined. The only requirement is that they must be of FULL_REFRESH type rather than INCREMENTAL_REFRESH.

Accordingly, I've reworked the acceptance tests in this PR to use QuickSight S3 data sources, as is done in the aws_quicksight_data_set tests, rather than Athena which avoids the problems you encountered on my other PR here: #30778 (comment)

As such this PR is ready to review and land! 👌

[jar-b]

Overall this looks in great shape, and really impressive to see a Plugin-Framework based resource given we haven't published any contributor documentation yet!

I do have one general suggestion, which is to align the schema a bit more closely with the API:

resource "aws_quicksight_refresh_schedule" "example" {
  # This is returned in both the root and inside the "RefreshSchedule" field of the 
  # DescribeRefreshSchedule API. To align with most other resources, this can stay 
  # at the schema root.
  arn =

  # Because this is required for delete calls (and the current Terraform ID), this could 
  # reasonably move into the root schema, despite technically being sent inside the 
  # schedule object for both create and update API calls.
  schedule_id = 

  aws_account_id =
  data_set_id    =

  schedule {
    refresh_type          = 
    # remove from here if moving to root
    schedule_id           = 
    start_after_date_time =
    schedule_frequency {
      interval        =
      time_of_the_day =
      timezone        =
      refresh_on_day {
        day_of_month =
        day_of_week  =
      }
    }
  }
}

The justification behind this is explained in the HashiCorp plugin best practices documentation, but specific to the AWS provider this design allows practitioners to swap more seamlessly between other tools (CLI, SDKs, etc.) and the Terraform provider.

In this case, the APIs do have some strange characteristics - such as Create using a Schedule field, while Describe calls it RefreshSchedule, or Arn being returned in two different levels of the Describe response - but moving most of the attributes inside a root schedule object is slightly more consistent with the AWS APIs.

[g-dx]

@jar-b - thanks for the review.

Will make those changes now.

[g-dx]

@jar-b - that should be those changes all ready.

I went with the following resource structure in the end:

resource "aws_quicksight_refresh_schedule" "schedule" {
  arn            = "..."
  aws_account_id = "0123456789"
  data_set_id    = "id"
  schedule_id    = "example"

  schedule {
    refresh_type          = "FULL_REFRESH"
    start_after_date_time = "2023-12-18T00:00:00",
    schedule_frequency {
      interval        = "WEEKLY"
      time_of_the_day = "00:00"
      timezone        = "Europe/London"
      refresh_on_day {
        day_of_month = "1"
        day_of_week  = "MONDAY"
      }
    }
  }
}

Not exactly sure how I managed to misread the API structure so badly in the first place!

[jar-b]

LGTM 🎉

$ make testacc PKG=quicksight TESTS=TestAccQuickSightRefreshSchedule_
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go test ./internal/service/quicksight/... -v -count 1 -parallel 20 -run='TestAccQuickSightRefreshSchedule_'  -timeout 180m
=== RUN   TestAccQuickSightRefreshSchedule_basic
=== PAUSE TestAccQuickSightRefreshSchedule_basic
=== RUN   TestAccQuickSightRefreshSchedule_disappears
=== PAUSE TestAccQuickSightRefreshSchedule_disappears
=== RUN   TestAccQuickSightRefreshSchedule_weeklyRefresh
=== PAUSE TestAccQuickSightRefreshSchedule_weeklyRefresh
=== RUN   TestAccQuickSightRefreshSchedule_monthlyRefresh
=== PAUSE TestAccQuickSightRefreshSchedule_monthlyRefresh
=== CONT  TestAccQuickSightRefreshSchedule_basic
=== CONT  TestAccQuickSightRefreshSchedule_weeklyRefresh
=== CONT  TestAccQuickSightRefreshSchedule_disappears
=== CONT  TestAccQuickSightRefreshSchedule_monthlyRefresh
--- PASS: TestAccQuickSightRefreshSchedule_disappears (29.51s)
--- PASS: TestAccQuickSightRefreshSchedule_weeklyRefresh (31.97s)
--- PASS: TestAccQuickSightRefreshSchedule_monthlyRefresh (32.03s)
--- PASS: TestAccQuickSightRefreshSchedule_basic (32.21s)
PASS
ok      github.com/hashicorp/terraform-provider-aws/internal/service/quicksight 35.375s

[jar-b]

Thanks for your contribution, @g-dx! 🥇 Really well done!

[github-actions]

This functionality has been released in v4.65.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. Thank you!

[github-actions]

I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.