r/aws_db_instance: Fix resource leak on error during creation.

[mergenci]

Description

This PR saves RDS instance ID to terraform state upon an error while waiting for instance to become available after creation, so that the resource doesn't leak.

I implemented a one-liner fix for the sake of simplicity. From what I understand from Resource Contribution Guidelines, the instance ID should be set before the wait operation:

Implements Immediate Resource ID Set During Create: Immediately after calling the API creation function, the resource ID should be set with d.SetId() before other API operations or returning the Read function.

I would be happy to update my fix, if maintainers see the necessity.

After applying the fix, Terraform becomes aware that the resource exists and plans accordingly:

aws_db_instance.test-leak-on-error: Refreshing state... [id=db-AJV6CK25YN67FTTDM3YXTF2XLL]

Terraform used the selected providers to generate the following execution plan. Resource actions are indicated with the following symbols:
-/+ destroy and then create replacement

Terraform will perform the following actions:

  # aws_db_instance.test-leak-on-error is tainted, so must be replaced
-/+ resource "aws_db_instance" "test-leak-on-error" {
      <omitted for brevity>
    }

Plan: 1 to add, 0 to change, 1 to destroy.

Relations

Closes #38251

References

Output from Acceptance Testing

% make testacc TESTS=TestAccRDSInstance_basic PKG=rds
make: Verifying source code with gofmt...
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go1.22.4 test ./internal/service/rds/... -v -count 1 -parallel 20 -run='TestAccRDSInstance_basic'  -timeout 360m
=== RUN   TestAccRDSInstance_basic
=== PAUSE TestAccRDSInstance_basic
=== CONT  TestAccRDSInstance_basic
--- PASS: TestAccRDSInstance_basic (488.24s)
PASS
ok  	github.com/hashicorp/terraform-provider-aws/internal/service/rds	492.697s

% make testacc TESTS=TestAccRDSInstance_identifierPrefix PKG=rds
make: Verifying source code with gofmt...
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go1.22.4 test ./internal/service/rds/... -v -count 1 -parallel 20 -run='TestAccRDSInstance_identifierPrefix'  -timeout 360m
=== RUN   TestAccRDSInstance_identifierPrefix
=== PAUSE TestAccRDSInstance_identifierPrefix
=== CONT  TestAccRDSInstance_identifierPrefix
--- PASS: TestAccRDSInstance_identifierPrefix (538.03s)
PASS
ok  	github.com/hashicorp/terraform-provider-aws/internal/service/rds	542.365s

% make testacc TESTS=TestAccRDSInstance_identifierGenerated PKG=rds
make: Verifying source code with gofmt...
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go1.22.4 test ./internal/service/rds/... -v -count 1 -parallel 20 -run='TestAccRDSInstance_identifierGenerated'  -timeout 360m
=== RUN   TestAccRDSInstance_identifierGenerated
=== PAUSE TestAccRDSInstance_identifierGenerated
=== CONT  TestAccRDSInstance_identifierGenerated
--- PASS: TestAccRDSInstance_identifierGenerated (536.69s)
PASS
ok  	github.com/hashicorp/terraform-provider-aws/internal/service/rds	541.081s

% make testacc TESTS=TestAccRDSInstance_disappears PKG=rds         
make: Verifying source code with gofmt...
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go1.22.4 test ./internal/service/rds/... -v -count 1 -parallel 20 -run='TestAccRDSInstance_disappears'  -timeout 360m
=== RUN   TestAccRDSInstance_disappears
=== PAUSE TestAccRDSInstance_disappears
=== CONT  TestAccRDSInstance_disappears
--- PASS: TestAccRDSInstance_disappears (491.49s)
PASS
ok  	github.com/hashicorp/terraform-provider-aws/internal/service/rds	495.906s

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

[github-actions]

Welcome @mergenci 👋

It looks like this is your first Pull Request submission to the Terraform AWS Provider! If you haven’t already done so please make sure you have checked out our CONTRIBUTOR guide and FAQ to make sure your contribution is adhering to best practice and has all the necessary elements in place for a successful approval.

Also take a look at our FAQ which details how we prioritize Pull Requests for inclusion.

Thanks again, and welcome to the community! 😃

[ewbankkit]

LGTM 🚀.

% make testacc TESTARGS='-run=TestAccRDSInstance_basic\|TestAccRDSInstance_ReplicateSourceDB_basic\|TestAccRDSInstance_SnapshotIdentifier_basic\|TestAccRDSInstance_RestoreToPointInTime_sourceIdentifier' PKG=rds ACCTEST_PARALLELISM=3
make: Verifying source code with gofmt...
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go1.22.4 test ./internal/service/rds/... -v -count 1 -parallel 3  -run=TestAccRDSInstance_basic\|TestAccRDSInstance_ReplicateSourceDB_basic\|TestAccRDSInstance_SnapshotIdentifier_basic\|TestAccRDSInstance_RestoreToPointInTime_sourceIdentifier -timeout 360m
=== RUN   TestAccRDSInstance_basic
=== PAUSE TestAccRDSInstance_basic
=== RUN   TestAccRDSInstance_ReplicateSourceDB_basic
=== PAUSE TestAccRDSInstance_ReplicateSourceDB_basic
=== RUN   TestAccRDSInstance_SnapshotIdentifier_basic
=== PAUSE TestAccRDSInstance_SnapshotIdentifier_basic
=== RUN   TestAccRDSInstance_RestoreToPointInTime_sourceIdentifier
=== PAUSE TestAccRDSInstance_RestoreToPointInTime_sourceIdentifier
=== CONT  TestAccRDSInstance_basic
=== CONT  TestAccRDSInstance_SnapshotIdentifier_basic
=== CONT  TestAccRDSInstance_ReplicateSourceDB_basic
--- PASS: TestAccRDSInstance_basic (529.25s)
=== CONT  TestAccRDSInstance_RestoreToPointInTime_sourceIdentifier
--- PASS: TestAccRDSInstance_SnapshotIdentifier_basic (1310.36s)
--- PASS: TestAccRDSInstance_ReplicateSourceDB_basic (1576.76s)
--- PASS: TestAccRDSInstance_RestoreToPointInTime_sourceIdentifier (1356.82s)
PASS
ok  	github.com/hashicorp/terraform-provider-aws/internal/service/rds	1890.883s

[ewbankkit]

@mergenci Thanks for the contribution 🎉 👏.

[mergenci]

Thank you @ewbankkit 🙏 I'm happy to also have the opportunity to learn from you.

[github-actions]

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