resource/aws_api_gateway_deployment: Reverts validation errors

[gdavison]

Description

The PR #39929 added the following validation to canary_settings and stage_description, since the values are ignored when stage_name is not set:

RequiredWith: []string{
	"stage_name",
},

This caused some users to have errors with their existing configurations.

Remove the validation error and add run-time warnings.

Also deprecates stage_name, stage_description, and canary_settings on the aws_api_gateway_deployment resource if favour of an explicit aws_api_gateway_stage.

Relations

Closes #39957

Output from Acceptance Testing

% make testacc PKG=apigateway TESTS=TestAccAPIGatewayDeployment_

--- PASS: TestAccAPIGatewayDeployment_variables (47.22s)
--- PASS: TestAccAPIGatewayDeployment_deploymentCanarySettings (47.46s)
--- PASS: TestAccAPIGatewayDeployment_Disappears_restAPI (47.70s)
--- PASS: TestAccAPIGatewayDeployment_conflictingConnectionType (91.50s)
--- PASS: TestAccAPIGatewayDeployment_stageName (119.71s)
--- PASS: TestAccAPIGatewayDeployment_disappears (130.63s)
--- PASS: TestAccAPIGatewayDeployment_basic (205.23s)
--- PASS: TestAccAPIGatewayDeployment_stageDescription (224.13s)
--- PASS: TestAccAPIGatewayDeployment_triggers (283.42s)
--- PASS: TestAccAPIGatewayDeployment_StageName_emptyString (425.85s)
--- PASS: TestAccAPIGatewayDeployment_description (476.43s)

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

[YakDriver]

LGTM 🎉

% make testacc PKG=apigateway TESTS=TestAccAPIGatewayDeployment_
make: Verifying source code with gofmt...
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go1.23.2 test ./internal/service/apigateway/... -v -count 1 -parallel 20 -run='TestAccAPIGatewayDeployment_'  -timeout 360m
2024/11/08 15:59:59 Initializing Terraform AWS Provider...
=== RUN   TestAccAPIGatewayDeployment_basic
=== PAUSE TestAccAPIGatewayDeployment_basic
=== RUN   TestAccAPIGatewayDeployment_disappears
=== PAUSE TestAccAPIGatewayDeployment_disappears
=== RUN   TestAccAPIGatewayDeployment_Disappears_restAPI
=== PAUSE TestAccAPIGatewayDeployment_Disappears_restAPI
=== RUN   TestAccAPIGatewayDeployment_triggers
=== PAUSE TestAccAPIGatewayDeployment_triggers
=== RUN   TestAccAPIGatewayDeployment_description
=== PAUSE TestAccAPIGatewayDeployment_description
=== RUN   TestAccAPIGatewayDeployment_stageDescription
=== PAUSE TestAccAPIGatewayDeployment_stageDescription
=== RUN   TestAccAPIGatewayDeployment_stageName
=== PAUSE TestAccAPIGatewayDeployment_stageName
=== RUN   TestAccAPIGatewayDeployment_StageName_emptyString
=== PAUSE TestAccAPIGatewayDeployment_StageName_emptyString
=== RUN   TestAccAPIGatewayDeployment_variables
=== PAUSE TestAccAPIGatewayDeployment_variables
=== RUN   TestAccAPIGatewayDeployment_conflictingConnectionType
=== PAUSE TestAccAPIGatewayDeployment_conflictingConnectionType
=== RUN   TestAccAPIGatewayDeployment_deploymentCanarySettings
=== PAUSE TestAccAPIGatewayDeployment_deploymentCanarySettings
=== CONT  TestAccAPIGatewayDeployment_basic
=== CONT  TestAccAPIGatewayDeployment_stageName
=== CONT  TestAccAPIGatewayDeployment_triggers
=== CONT  TestAccAPIGatewayDeployment_Disappears_restAPI
=== CONT  TestAccAPIGatewayDeployment_disappears
=== CONT  TestAccAPIGatewayDeployment_stageDescription
=== CONT  TestAccAPIGatewayDeployment_description
=== CONT  TestAccAPIGatewayDeployment_conflictingConnectionType
=== CONT  TestAccAPIGatewayDeployment_deploymentCanarySettings
=== CONT  TestAccAPIGatewayDeployment_variables
=== CONT  TestAccAPIGatewayDeployment_StageName_emptyString
--- PASS: TestAccAPIGatewayDeployment_variables (19.37s)
--- PASS: TestAccAPIGatewayDeployment_conflictingConnectionType (52.23s)
--- PASS: TestAccAPIGatewayDeployment_deploymentCanarySettings (84.93s)
--- PASS: TestAccAPIGatewayDeployment_stageName (89.21s)
--- PASS: TestAccAPIGatewayDeployment_basic (101.25s)
--- PASS: TestAccAPIGatewayDeployment_StageName_emptyString (121.78s)
--- PASS: TestAccAPIGatewayDeployment_triggers (285.24s)
--- PASS: TestAccAPIGatewayDeployment_Disappears_restAPI (317.64s)
--- PASS: TestAccAPIGatewayDeployment_stageDescription (369.29s)
--- PASS: TestAccAPIGatewayDeployment_description (405.94s)
--- PASS: TestAccAPIGatewayDeployment_disappears (675.58s)
PASS
ok  	github.com/hashicorp/terraform-provider-aws/internal/service/apigateway	679.509s

[github-actions]

This functionality has been released in v5.75.1 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!