r/aws_apigateway_stage: add deployment_id to canary_settings

[johnsonaj]

Description

Relations

Closes #27326.

References

Output from Acceptance Testing

% make testacc TESTARGS='-run=TestAccAPIGateway_serial/Stage' PKG=apigateway

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=TestAccAPIGateway_serial/Stage -timeout 360m
2024/10/30 10:29:25 Initializing Terraform AWS Provider...
--- PASS: TestAccAPIGateway_serial (3343.02s)
    --- PASS: TestAccAPIGateway_serial/Stage (3343.02s)
        --- PASS: TestAccAPIGateway_serial/Stage/WAF (57.56s)
        --- PASS: TestAccAPIGateway_serial/Stage/CanarySettings (55.22s)
        --- PASS: TestAccAPIGateway_serial/Stage/AccessLogSettings (56.80s)
        --- PASS: TestAccAPIGateway_serial/Stage/AccessLogSettings_kinesis (163.86s)
        --- PASS: TestAccAPIGateway_serial/Stage/basic (87.78s)
        --- PASS: TestAccAPIGateway_serial/Stage/tags (1164.21s)
            --- PASS: TestAccAPIGateway_serial/Stage/tags/EmptyTag_OnUpdate_Add (48.80s)
            --- PASS: TestAccAPIGateway_serial/Stage/tags/DefaultTags_nonOverlapping (69.67s)
            --- PASS: TestAccAPIGateway_serial/Stage/tags/ComputedTag_OnCreate (32.69s)
            --- PASS: TestAccAPIGateway_serial/Stage/tags/ComputedTag_OnUpdate_Add (84.11s)
            --- PASS: TestAccAPIGateway_serial/Stage/tags/ComputedTag_OnUpdate_Replace (38.98s)
            --- PASS: TestAccAPIGateway_serial/Stage/tags/EmptyTag_OnCreate (50.00s)
            --- PASS: TestAccAPIGateway_serial/Stage/tags/DefaultTags_emptyResourceTag (29.71s)
            --- PASS: TestAccAPIGateway_serial/Stage/tags/DefaultTags_nullNonOverlappingResourceTag (76.54s)
            --- PASS: TestAccAPIGateway_serial/Stage/tags/IgnoreTags_Overlap_DefaultTag (43.79s)
            --- PASS: TestAccAPIGateway_serial/Stage/tags/basic (88.75s)
            --- PASS: TestAccAPIGateway_serial/Stage/tags/null (42.00s)
            --- PASS: TestAccAPIGateway_serial/Stage/tags/EmptyMap (108.80s)
            --- PASS: TestAccAPIGateway_serial/Stage/tags/EmptyTag_OnUpdate_Replace (50.22s)
            --- PASS: TestAccAPIGateway_serial/Stage/tags/DefaultTags_overlapping (52.09s)
            --- PASS: TestAccAPIGateway_serial/Stage/tags/DefaultTags_nullOverlappingResourceTag (58.47s)
            --- PASS: TestAccAPIGateway_serial/Stage/tags/AddOnUpdate (34.78s)
            --- PASS: TestAccAPIGateway_serial/Stage/tags/DefaultTags_providerOnly (80.09s)
            --- PASS: TestAccAPIGateway_serial/Stage/tags/DefaultTags_updateToProviderOnly (78.82s)
            --- PASS: TestAccAPIGateway_serial/Stage/tags/DefaultTags_updateToResourceOnly (34.30s)
            --- PASS: TestAccAPIGateway_serial/Stage/tags/IgnoreTags_Overlap_ResourceTag (61.59s)
        --- PASS: TestAccAPIGateway_serial/Stage/disappears (22.68s)
        --- PASS: TestAccAPIGateway_serial/Stage/disappears_restAPI (61.18s)
        --- PASS: TestAccAPIGateway_serial/Stage/Cache (851.84s)
        --- PASS: TestAccAPIGateway_serial/Stage/CacheSizeCacheDisabled (821.90s)
PASS
ok  	github.com/hashicorp/terraform-provider-aws/internal/service/apigateway	3349.357s

% make testacc TESTARGS='-run=TestAccAPIGatewayDeployment_' PKG=apigateway

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/10/30 08:59:16 Initializing Terraform AWS Provider...
--- PASS: TestAccAPIGatewayDeployment_deploymentCanarySettings (27.26s)
--- PASS: TestAccAPIGatewayDeployment_StageName_emptyString (31.71s)
--- PASS: TestAccAPIGatewayDeployment_triggers (61.12s)
--- PASS: TestAccAPIGatewayDeployment_variables (83.95s)
--- PASS: TestAccAPIGatewayDeployment_stageName (115.56s)
--- PASS: TestAccAPIGatewayDeployment_basic (195.04s)
--- PASS: TestAccAPIGatewayDeployment_description (208.39s)
--- PASS: TestAccAPIGatewayDeployment_stageDescription (211.23s)
--- PASS: TestAccAPIGatewayDeployment_Disappears_restAPI (426.35s)
--- PASS: TestAccAPIGatewayDeployment_disappears (586.79s)
--- PASS: TestAccAPIGatewayDeployment_conflictingConnectionType (705.34s)
PASS
ok  	github.com/hashicorp/terraform-provider-aws/internal/service/apigateway	739.083s

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

[gdavison]

A couple changes to make in the tests for both resources and a schema change for aws_api_gateway_stage

[gdavison]

Looks good! 🚀

One tweak to documentation.

Not a blocker, but consider adding

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

to canary_settings and stage_description since neither can be set if stage_name isn't set

Also consider using resource.ParallelTest instead of resource.Test for TestAccAPIGatewayDeployment_deploymentCanarySettings

--- PASS: TestAccAPIGateway_serial (3664.84s)
--- PASS: TestAccAPIGateway_serial/Stage (3664.84s)
--- PASS: TestAccAPIGateway_serial/Stage/basic (87.04s)
--- PASS: TestAccAPIGateway_serial/Stage/disappears (40.31s)
--- PASS: TestAccAPIGateway_serial/Stage/CanarySettings (95.91s)
--- PASS: TestAccAPIGateway_serial/Stage/CacheSizeCacheDisabled (698.45s)
--- PASS: TestAccAPIGateway_serial/Stage/AccessLogSettings (92.00s)
--- PASS: TestAccAPIGateway_serial/Stage/AccessLogSettings_kinesis (110.29s)
--- PASS: TestAccAPIGateway_serial/Stage/WAF (187.21s)
--- PASS: TestAccAPIGateway_serial/Stage/tags (1515.31s)
--- PASS: TestAccAPIGateway_serial/Stage/tags/basic (74.55s)
--- PASS: TestAccAPIGateway_serial/Stage/tags/EmptyMap (64.66s)
--- PASS: TestAccAPIGateway_serial/Stage/tags/EmptyTag_OnUpdate_Replace (48.39s)
--- PASS: TestAccAPIGateway_serial/Stage/tags/DefaultTags_emptyResourceTag (54.79s)
--- PASS: TestAccAPIGateway_serial/Stage/tags/ComputedTag_OnUpdate_Add (145.25s)
--- PASS: TestAccAPIGateway_serial/Stage/tags/AddOnUpdate (74.80s)
--- PASS: TestAccAPIGateway_serial/Stage/tags/EmptyTag_OnUpdate_Add (85.71s)
--- PASS: TestAccAPIGateway_serial/Stage/tags/DefaultTags_overlapping (93.46s)
--- PASS: TestAccAPIGateway_serial/Stage/tags/DefaultTags_updateToProviderOnly (39.26s)
--- PASS: TestAccAPIGateway_serial/Stage/tags/null (50.65s)
--- PASS: TestAccAPIGateway_serial/Stage/tags/DefaultTags_providerOnly (88.82s)
--- PASS: TestAccAPIGateway_serial/Stage/tags/DefaultTags_updateToResourceOnly (93.91s)
--- PASS: TestAccAPIGateway_serial/Stage/tags/DefaultTags_nullOverlappingResourceTag (23.64s)
--- PASS: TestAccAPIGateway_serial/Stage/tags/ComputedTag_OnCreate (108.74s)
--- PASS: TestAccAPIGateway_serial/Stage/tags/ComputedTag_OnUpdate_Replace (47.96s)
--- PASS: TestAccAPIGateway_serial/Stage/tags/EmptyTag_OnCreate (72.77s)
--- PASS: TestAccAPIGateway_serial/Stage/tags/DefaultTags_nonOverlapping (149.53s)
--- PASS: TestAccAPIGateway_serial/Stage/tags/DefaultTags_nullNonOverlappingResourceTag (64.82s)
--- PASS: TestAccAPIGateway_serial/Stage/tags/IgnoreTags_Overlap_DefaultTag (74.98s)
--- PASS: TestAccAPIGateway_serial/Stage/tags/IgnoreTags_Overlap_ResourceTag (58.62s)
--- PASS: TestAccAPIGateway_serial/Stage/disappears_restAPI (24.84s)
--- PASS: TestAccAPIGateway_serial/Stage/Cache (813.47s)
--- PASS: TestAccAPIGatewayDeployment_deploymentCanarySettings (48.11s)
--- PASS: TestAccAPIGatewayDeployment_StageName_emptyString (31.90s)
--- PASS: TestAccAPIGatewayDeployment_description (45.88s)
--- PASS: TestAccAPIGatewayDeployment_stageName (56.65s)
--- PASS: TestAccAPIGatewayDeployment_stageDescription (130.17s)
--- PASS: TestAccAPIGatewayDeployment_conflictingConnectionType (136.15s)
--- PASS: TestAccAPIGatewayDeployment_triggers (177.67s)
--- PASS: TestAccAPIGatewayDeployment_variables (209.79s)
--- PASS: TestAccAPIGatewayDeployment_basic (259.49s)
--- PASS: TestAccAPIGatewayDeployment_Disappears_restAPI (377.61s)
--- PASS: TestAccAPIGatewayDeployment_disappears (561.81s)

changes made that make this stale

[github-actions]

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