r/aws_api_gateway_stage: Support canary release deployment

[GiPPe]

Fix #2727 by adding the new canary_settings argument to api_gateway_stage.

The changes are coming from #2793. I have just addressed the reviewer's comments.

Motivation

With the release of canary deployments in API gateway I'd like to be able to:

[x] Create a canary deployment through terraform.
[x] Disable/delete a canary deployment through terraform.
[x] Update canary deployments through terraform.

I've implemented Create/Update/Delete in this pull request but did not attempt to implement promote, which I think can be accomplished today by promoting through AWS console/CLI then updating config and importing the promoted stage into terraform management.

Documentation

[x] Updated docs/r/aws_api_gateway_stage to include the new option/nested options.

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" comments, they generate extra noise for pull request followers and do not help prioritize the request

Closes #2727

Release note for CHANGELOG:

ENHANCEMENT
resource/api_gateway_stage: Add canary_settings argument

Output from acceptance testing:

$ make testacc TESTARGS="-run 'TestAccAWSAPIGatewayStage_*'"                                                                                  
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go test ./... -v -count 1 -parallel 20 -run 'TestAccAWSAPIGatewayStage_*' -timeout 120m
?   	github.com/terraform-providers/terraform-provider-aws	[no test files]
=== RUN   TestAccAWSAPIGatewayStage_basic
=== PAUSE TestAccAWSAPIGatewayStage_basic
=== RUN   TestAccAWSAPIGatewayStage_accessLogSettings
=== PAUSE TestAccAWSAPIGatewayStage_accessLogSettings
=== RUN   TestAccAWSAPIGatewayStage_canarySettings
=== PAUSE TestAccAWSAPIGatewayStage_canarySettings
=== CONT  TestAccAWSAPIGatewayStage_basic
=== CONT  TestAccAWSAPIGatewayStage_canarySettings
=== CONT  TestAccAWSAPIGatewayStage_accessLogSettings
--- PASS: TestAccAWSAPIGatewayStage_canarySettings (218.63s)
--- PASS: TestAccAWSAPIGatewayStage_accessLogSettings (251.85s)
--- PASS: TestAccAWSAPIGatewayStage_basic (408.13s)
PASS
ok  	github.com/terraform-providers/terraform-provider-aws/aws	408.178s
testing: warning: no tests to run
PASS
ok  	github.com/terraform-providers/terraform-provider-aws/aws/internal/flatmap	0.007s [no tests to run]
testing: warning: no tests to run
PASS
ok  	github.com/terraform-providers/terraform-provider-aws/aws/internal/keyvaluetags	0.016s [no tests to run]

[tjsousa]

Any news if support for canaries will come to the Terraform provider?

[rajarumugam71]

Any update on when we will get to see the support for canaries available on AWS Terraform provider?

[zhelding]

Pull request #21306 has significantly refactored the AWS Provider codebase. As a result, most PRs opened prior to the refactor now have merge conflicts that must be resolved before proceeding.

Specifically, PR #21306 relocated the code for all AWS resources and data sources from a single aws directory to a large number of separate directories in internal/service, each corresponding to a particular AWS service. This separation of code has also allowed for us to simplify the names of underlying functions -- while still avoiding namespace collisions.

We recognize that many pull requests have been open for some time without yet being addressed by our maintainers. Therefore, we want to make it clear that resolving these conflicts in no way affects the prioritization of a particular pull request. Once a pull request has been prioritized for review, the necessary changes will be made by a maintainer -- either directly or in collaboration with the pull request author.

For a more complete description of this refactor, including examples of how old filepaths and function names correspond to their new counterparts: please refer to issue #20000.

For a quick guide on how to amend your pull request to resolve the merge conflicts resulting from this refactor and bring it in line with our new code patterns: please refer to our Service Package Refactor Pull Request Guide.

[DrFaust92]

Superseded by #23754

[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.