docs/contributing: Initial Retries and Waiters documentation #17508
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Reference: #12844 Reference: #15792 Reference: #16796 This page is meant to serve as a reference for all the related retry and waiting logic present in the provider. Further enhancements could discuss resource timeouts in general, however there is some future uncertainty with that functionality so it is currently omitted.
ghost
added
size/XL
ewbankkit
reviewed
Feb 8, 2021
ewbankkit
reviewed
Feb 8, 2021
|
|
||
| const ( | ||
| // Maximum amount of time to wait for Example eventual consistency on creation | ||
| ExampleCreationTimeout = 2 * time.Minute |
There was a problem hiding this comment.
If Example is the service name and we are in a service-specific package, should this be CreationTimeout = 2 * time.Minute instead?
There was a problem hiding this comment.
Fixed in latest commit.
ewbankkit
reviewed
Feb 8, 2021
|
|
||
| const ( | ||
| // Maximum amount of time to wait for Example eventual consistency | ||
| ExampleTimeout = 2 * time.Minute |
There was a problem hiding this comment.
If Example is the service name and we are in a service-specific package, should this be PropagationTimeout = 2 * time.Minute instead (like it is for IAM)?
There was a problem hiding this comment.
Fixed in latest commit.
ewbankkit
reviewed
Feb 9, 2021
YakDriver
approved these changes
Feb 10, 2021
| @@ -172,7 +171,7 @@ Each AWS service API (and sometimes even operations within the same API) varies | |||
|
|
|||
| import ( | |||
| // ... other imports ... | |||
| // By convention, cross-service waiter imports are named {SERVICE}waiter | |||
| // By convention, cross-service waiter imports are aliased as {SERVICE}waiter | |||
|
|
||
| ### State Change Configuration and Functions | ||
|
|
||
| The [`resource.StateChangeConf` type](https://pkg.go.dev/github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource#StateChangeConf) along with its receiver methods [`WaitForState()`](https://pkg.go.dev/github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource#StateChangeConf.WaitForState) and [`WaitForStateContext()`](https://pkg.go.dev/github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource#StateChangeConf.WaitForStateContext) is a generic primitive for repeating operations in Terraform resource logic until desired value(s) are received. The "state change" in this case is generic to any value and not specific to the Terraform State. Among other functionality, it supports some of these desirable optional properties: |
There was a problem hiding this comment.
Suggested change
| The [`resource.StateChangeConf` type](https://pkg.go.dev/github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource#StateChangeConf) along with its receiver methods [`WaitForState()`](https://pkg.go.dev/github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource#StateChangeConf.WaitForState) and [`WaitForStateContext()`](https://pkg.go.dev/github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource#StateChangeConf.WaitForStateContext) is a generic primitive for repeating operations in Terraform resource logic until desired value(s) are received. The "state change" in this case is generic to any value and not specific to the Terraform State. Among other functionality, it supports some of these desirable optional properties: | |
| The [`resource.StateChangeConf` type](https://pkg.go.dev/github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource#StateChangeConf) along with its receiver methods [`WaitForState()`](https://pkg.go.dev/github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource#StateChangeConf.WaitForState) and [`WaitForStateContext()`](https://pkg.go.dev/github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource#StateChangeConf.WaitForStateContext) is a generic primitive for repeating operations in a Terraform resource until it receives desired values. The "state change," in this case, refers to values the Provider receives from AWS and not specifically the Terraform state. Among other capabilities, the type supports this particularly desirable yet optional functionality: |
bflad
commented
Feb 10, 2021
Co-authored-by: Dirk Avery <31492422+YakDriver@users.noreply.github.com> Co-authored-by: Kit Ewbank <Kit_Ewbank@hotmail.com>
|
This has been released in version 3.28.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! |
|
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! |
ghost
locked as resolved and limited conversation to collaborators
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Community Note
Closes #12844
Closes #15792
Reference: #16796
This page is meant to serve as a reference for all the related retry and waiting logic present in the provider. Further enhancements could discuss resource timeouts in general, however there is some future uncertainty with that functionality so it is currently omitted.
Output from acceptance testing: N/A (documentation)