New resource: aws_cloudformaton_stack_instances

[alexknez]

Description

Introduces regions parameter (List of strings) as a list of regions where stack set instance should be created instead of region.

• Move from aws_cloudformation_stack_set_instance to aws_cloudformation_stack_instances
• Update new aws_cloudformation_stack_instances to AWS SDK v2
• Create Sweeper that will work for multi-region, multi-account (Not urgent since sweeping the stack set removes the stack instances)
• Add state move functionality (Requires framework, this resource is plugin SDK v2)

Relations

Closes #24752

References

Output from Acceptance Testing

% make t T=TestAccCloudFormationStackInstances_ K=cloudformation
make: Verifying source code with gofmt...
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go1.22.6 test ./internal/service/cloudformation/... -v -count 1 -parallel 20 -run='TestAccCloudFormationStackInstances_'  -timeout 360m
=== RUN   TestAccCloudFormationStackInstances_basic
=== PAUSE TestAccCloudFormationStackInstances_basic
=== RUN   TestAccCloudFormationStackInstances_disappears
=== PAUSE TestAccCloudFormationStackInstances_disappears
=== RUN   TestAccCloudFormationStackInstances_Disappears_stackSet
=== PAUSE TestAccCloudFormationStackInstances_Disappears_stackSet
=== RUN   TestAccCloudFormationStackInstances_Multi_increaseRegions
=== PAUSE TestAccCloudFormationStackInstances_Multi_increaseRegions
=== RUN   TestAccCloudFormationStackInstances_Multi_decreaseRegions
=== PAUSE TestAccCloudFormationStackInstances_Multi_decreaseRegions
=== RUN   TestAccCloudFormationStackInstances_Multi_swapRegions
=== PAUSE TestAccCloudFormationStackInstances_Multi_swapRegions
=== RUN   TestAccCloudFormationStackInstances_parameterOverrides
=== PAUSE TestAccCloudFormationStackInstances_parameterOverrides
=== RUN   TestAccCloudFormationStackInstances_deploymentTargets
=== PAUSE TestAccCloudFormationStackInstances_deploymentTargets
=== RUN   TestAccCloudFormationStackInstances_DeploymentTargets_emptyOU
=== PAUSE TestAccCloudFormationStackInstances_DeploymentTargets_emptyOU
=== RUN   TestAccCloudFormationStackInstances_operationPreferences
=== PAUSE TestAccCloudFormationStackInstances_operationPreferences
=== RUN   TestAccCloudFormationStackInstances_concurrencyMode
=== PAUSE TestAccCloudFormationStackInstances_concurrencyMode
=== RUN   TestAccCloudFormationStackInstances_delegatedAdministrator
=== PAUSE TestAccCloudFormationStackInstances_delegatedAdministrator
=== CONT  TestAccCloudFormationStackInstances_basic
=== CONT  TestAccCloudFormationStackInstances_parameterOverrides
=== CONT  TestAccCloudFormationStackInstances_operationPreferences
=== CONT  TestAccCloudFormationStackInstances_Multi_increaseRegions
=== CONT  TestAccCloudFormationStackInstances_deploymentTargets
=== CONT  TestAccCloudFormationStackInstances_Multi_swapRegions
=== CONT  TestAccCloudFormationStackInstances_Multi_decreaseRegions
=== CONT  TestAccCloudFormationStackInstances_DeploymentTargets_emptyOU
=== CONT  TestAccCloudFormationStackInstances_delegatedAdministrator
=== CONT  TestAccCloudFormationStackInstances_Disappears_stackSet
=== CONT  TestAccCloudFormationStackInstances_concurrencyMode
=== CONT  TestAccCloudFormationStackInstances_disappears
=== NAME  TestAccCloudFormationStackInstances_deploymentTargets
    stack_instances_test.go:321: this AWS account must be the management account of an AWS Organization
--- SKIP: TestAccCloudFormationStackInstances_deploymentTargets (1.64s)
=== NAME  TestAccCloudFormationStackInstances_DeploymentTargets_emptyOU
    stack_instances_test.go:370: this AWS account must be the management account of an AWS Organization
--- SKIP: TestAccCloudFormationStackInstances_DeploymentTargets_emptyOU (1.73s)
=== NAME  TestAccCloudFormationStackInstances_operationPreferences
    stack_instances_test.go:416: this AWS account must be the management account of an AWS Organization
--- SKIP: TestAccCloudFormationStackInstances_operationPreferences (1.83s)
=== NAME  TestAccCloudFormationStackInstances_concurrencyMode
    stack_instances_test.go:451: this AWS account must be the management account of an AWS Organization
--- SKIP: TestAccCloudFormationStackInstances_concurrencyMode (12.92s)
=== NAME  TestAccCloudFormationStackInstances_delegatedAdministrator
    stack_instances_test.go:502: this AWS account must be the management account of an AWS Organization
--- SKIP: TestAccCloudFormationStackInstances_delegatedAdministrator (23.97s)
--- PASS: TestAccCloudFormationStackInstances_Disappears_stackSet (75.82s)
--- PASS: TestAccCloudFormationStackInstances_basic (76.71s)
--- PASS: TestAccCloudFormationStackInstances_disappears (84.93s)
--- PASS: TestAccCloudFormationStackInstances_Multi_increaseRegions (116.15s)
--- PASS: TestAccCloudFormationStackInstances_Multi_decreaseRegions (124.94s)
--- PASS: TestAccCloudFormationStackInstances_Multi_swapRegions (127.58s)
--- PASS: TestAccCloudFormationStackInstances_parameterOverrides (150.30s)
PASS
ok  	github.com/hashicorp/terraform-provider-aws/internal/service/cloudformation	155.489s

In organization account:

% make t T=TestAccCloudFormationStackInstances_ K=cloudformation P=3
make: Verifying source code with gofmt...
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go1.22.6 test ./internal/service/cloudformation/... -v -count 1 -parallel 3 -run='TestAccCloudFormationStackInstances_'  -timeout 360m
=== RUN   TestAccCloudFormationStackInstances_basic
=== PAUSE TestAccCloudFormationStackInstances_basic
=== RUN   TestAccCloudFormationStackInstances_disappears
=== PAUSE TestAccCloudFormationStackInstances_disappears
=== RUN   TestAccCloudFormationStackInstances_Disappears_stackSet
=== PAUSE TestAccCloudFormationStackInstances_Disappears_stackSet
=== RUN   TestAccCloudFormationStackInstances_Multi_increaseRegions
=== PAUSE TestAccCloudFormationStackInstances_Multi_increaseRegions
=== RUN   TestAccCloudFormationStackInstances_Multi_decreaseRegions
=== PAUSE TestAccCloudFormationStackInstances_Multi_decreaseRegions
=== RUN   TestAccCloudFormationStackInstances_Multi_swapRegions
=== PAUSE TestAccCloudFormationStackInstances_Multi_swapRegions
=== RUN   TestAccCloudFormationStackInstances_parameterOverrides
=== PAUSE TestAccCloudFormationStackInstances_parameterOverrides
=== RUN   TestAccCloudFormationStackInstances_deploymentTargets
=== PAUSE TestAccCloudFormationStackInstances_deploymentTargets
=== RUN   TestAccCloudFormationStackInstances_DeploymentTargets_emptyOU
=== PAUSE TestAccCloudFormationStackInstances_DeploymentTargets_emptyOU
=== RUN   TestAccCloudFormationStackInstances_operationPreferences
=== PAUSE TestAccCloudFormationStackInstances_operationPreferences
=== RUN   TestAccCloudFormationStackInstances_concurrencyMode
=== PAUSE TestAccCloudFormationStackInstances_concurrencyMode
=== RUN   TestAccCloudFormationStackInstances_delegatedAdministrator
=== PAUSE TestAccCloudFormationStackInstances_delegatedAdministrator
=== CONT  TestAccCloudFormationStackInstances_basic
=== CONT  TestAccCloudFormationStackInstances_parameterOverrides
=== CONT  TestAccCloudFormationStackInstances_Multi_increaseRegions
--- PASS: TestAccCloudFormationStackInstances_basic (74.77s)
=== CONT  TestAccCloudFormationStackInstances_Multi_swapRegions
--- PASS: TestAccCloudFormationStackInstances_Multi_increaseRegions (114.69s)
=== CONT  TestAccCloudFormationStackInstances_delegatedAdministrator
    stack_instances_test.go:488: this AWS account must not be the management account of an AWS Organization
--- SKIP: TestAccCloudFormationStackInstances_delegatedAdministrator (1.25s)
=== CONT  TestAccCloudFormationStackInstances_Disappears_stackSet
--- PASS: TestAccCloudFormationStackInstances_parameterOverrides (150.56s)
=== CONT  TestAccCloudFormationStackInstances_disappears
--- PASS: TestAccCloudFormationStackInstances_Disappears_stackSet (72.29s)
=== CONT  TestAccCloudFormationStackInstances_Multi_decreaseRegions
--- PASS: TestAccCloudFormationStackInstances_Multi_swapRegions (115.30s)
=== CONT  TestAccCloudFormationStackInstances_concurrencyMode
--- PASS: TestAccCloudFormationStackInstances_disappears (83.30s)
=== CONT  TestAccCloudFormationStackInstances_DeploymentTargets_emptyOU
--- PASS: TestAccCloudFormationStackInstances_concurrencyMode (83.36s)
=== CONT  TestAccCloudFormationStackInstances_deploymentTargets
--- PASS: TestAccCloudFormationStackInstances_Multi_decreaseRegions (112.44s)
=== CONT  TestAccCloudFormationStackInstances_operationPreferences
--- PASS: TestAccCloudFormationStackInstances_DeploymentTargets_emptyOU (70.29s)
--- PASS: TestAccCloudFormationStackInstances_deploymentTargets (96.43s)
--- PASS: TestAccCloudFormationStackInstances_operationPreferences (83.18s)
PASS
ok  	github.com/hashicorp/terraform-provider-aws/internal/service/cloudformation	391.038s

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

[agandrabur]

I did some tests for this version,
resourceStackSetInstanceDelete function needs to use the operation_preferences block otherwise the operations are run sequentially, even though I set

  operation_preferences {
    region_concurrency_type      = "PARALLEL"
    max_concurrent_count         = 20
    failure_tolerance_percentage = 100
  }

[alexknez]

I did some tests for this version, resourceStackSetInstanceDelete function needs to use the operation_preferences block otherwise the operations are run sequentially, even though I set

  operation_preferences {
    region_concurrency_type      = "PARALLEL"
    max_concurrent_count         = 20
    failure_tolerance_percentage = 100
  }

Good point @agandrabur. Added in the last commit.

[AdamTylerLynch]

🔴 Flagging this PR as it breaks compatibility buy changing the schema. We can not beak compatibility of existing resources/datasources.

[ewbankkit]

We can have both region and regions (with a check that both are not set, e.g. via ExactlyOneOf) and then over time deprecate region. This is a highly-upvoted request that we have on the roadmap for this quarter.

[YakDriver]

@alexknez I'm working on this PR, doing the items in the op ☝️ above. Let me know if you are going to work on this so we can coordinate and not overwrite each other.

[0xVak]

Is this still being worked on? Last update was a month ago.

[nkraemer-sysdig]

Any updates here? We are currently using multiple aws_cloudformation_stack_set_instance objects with managed_execution = true on the aws_cloudformation_stack_set as a workaround, but it would be great to be able to properly leverage multi-region stackset instances, and hence make use of region_concurrency_type.

[nzjoseph]

@YakDriver is this change still on your radar?

[ronhanson]

Hope this will make the cut.
This would be great to have that feature as the actual doc is confusing, with such existing region_concurrency_type or region_order parameters letting us think we can do multi region deployment when we cannot.

[YakDriver]

LGTM 🎉

Regular account:

% make t T=TestAccCloudFormationStackInstances_ K=cloudformation
make: Verifying source code with gofmt...
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go1.22.6 test ./internal/service/cloudformation/... -v -count 1 -parallel 20 -run='TestAccCloudFormationStackInstances_'  -timeout 360m
=== RUN   TestAccCloudFormationStackInstances_basic
=== PAUSE TestAccCloudFormationStackInstances_basic
=== RUN   TestAccCloudFormationStackInstances_disappears
=== PAUSE TestAccCloudFormationStackInstances_disappears
=== RUN   TestAccCloudFormationStackInstances_Disappears_stackSet
=== PAUSE TestAccCloudFormationStackInstances_Disappears_stackSet
=== RUN   TestAccCloudFormationStackInstances_Multi_increaseRegions
=== PAUSE TestAccCloudFormationStackInstances_Multi_increaseRegions
=== RUN   TestAccCloudFormationStackInstances_Multi_decreaseRegions
=== PAUSE TestAccCloudFormationStackInstances_Multi_decreaseRegions
=== RUN   TestAccCloudFormationStackInstances_Multi_swapRegions
=== PAUSE TestAccCloudFormationStackInstances_Multi_swapRegions
=== RUN   TestAccCloudFormationStackInstances_parameterOverrides
=== PAUSE TestAccCloudFormationStackInstances_parameterOverrides
=== RUN   TestAccCloudFormationStackInstances_deploymentTargets
=== PAUSE TestAccCloudFormationStackInstances_deploymentTargets
=== RUN   TestAccCloudFormationStackInstances_DeploymentTargets_emptyOU
=== PAUSE TestAccCloudFormationStackInstances_DeploymentTargets_emptyOU
=== RUN   TestAccCloudFormationStackInstances_operationPreferences
=== PAUSE TestAccCloudFormationStackInstances_operationPreferences
=== RUN   TestAccCloudFormationStackInstances_concurrencyMode
=== PAUSE TestAccCloudFormationStackInstances_concurrencyMode
=== RUN   TestAccCloudFormationStackInstances_delegatedAdministrator
=== PAUSE TestAccCloudFormationStackInstances_delegatedAdministrator
=== CONT  TestAccCloudFormationStackInstances_basic
=== CONT  TestAccCloudFormationStackInstances_parameterOverrides
=== CONT  TestAccCloudFormationStackInstances_operationPreferences
=== CONT  TestAccCloudFormationStackInstances_Multi_increaseRegions
=== CONT  TestAccCloudFormationStackInstances_delegatedAdministrator
=== CONT  TestAccCloudFormationStackInstances_Disappears_stackSet
=== CONT  TestAccCloudFormationStackInstances_concurrencyMode
=== CONT  TestAccCloudFormationStackInstances_Multi_swapRegions
=== CONT  TestAccCloudFormationStackInstances_disappears
=== CONT  TestAccCloudFormationStackInstances_Multi_decreaseRegions
=== CONT  TestAccCloudFormationStackInstances_DeploymentTargets_emptyOU
=== CONT  TestAccCloudFormationStackInstances_deploymentTargets
    stack_instances_test.go:321: this AWS account must be the management account of an AWS Organization
--- SKIP: TestAccCloudFormationStackInstances_deploymentTargets (1.71s)
=== NAME  TestAccCloudFormationStackInstances_operationPreferences
    stack_instances_test.go:416: this AWS account must be the management account of an AWS Organization
--- SKIP: TestAccCloudFormationStackInstances_operationPreferences (1.82s)
=== NAME  TestAccCloudFormationStackInstances_delegatedAdministrator
    stack_instances_test.go:502: this AWS account must be the management account of an AWS Organization
=== NAME  TestAccCloudFormationStackInstances_concurrencyMode
    stack_instances_test.go:451: this AWS account must be the management account of an AWS Organization
--- SKIP: TestAccCloudFormationStackInstances_concurrencyMode (11.50s)
--- SKIP: TestAccCloudFormationStackInstances_delegatedAdministrator (12.25s)
=== NAME  TestAccCloudFormationStackInstances_DeploymentTargets_emptyOU
    stack_instances_test.go:370: this AWS account must be the management account of an AWS Organization
--- SKIP: TestAccCloudFormationStackInstances_DeploymentTargets_emptyOU (12.44s)
--- PASS: TestAccCloudFormationStackInstances_basic (77.51s)
--- PASS: TestAccCloudFormationStackInstances_Disappears_stackSet (81.00s)
--- PASS: TestAccCloudFormationStackInstances_disappears (82.98s)
--- PASS: TestAccCloudFormationStackInstances_Multi_increaseRegions (115.82s)
--- PASS: TestAccCloudFormationStackInstances_Multi_decreaseRegions (116.66s)
--- PASS: TestAccCloudFormationStackInstances_Multi_swapRegions (121.40s)
--- PASS: TestAccCloudFormationStackInstances_parameterOverrides (149.46s)
PASS
ok  	github.com/hashicorp/terraform-provider-aws/internal/service/cloudformation	154.691s

Org account:

% make t T=TestAccCloudFormationStackInstances_ K=cloudformation P=3
make: Verifying source code with gofmt...
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go1.22.6 test ./internal/service/cloudformation/... -v -count 1 -parallel 3 -run='TestAccCloudFormationStackInstances_'  -timeout 360m
=== RUN   TestAccCloudFormationStackInstances_basic
=== PAUSE TestAccCloudFormationStackInstances_basic
=== RUN   TestAccCloudFormationStackInstances_disappears
=== PAUSE TestAccCloudFormationStackInstances_disappears
=== RUN   TestAccCloudFormationStackInstances_Disappears_stackSet
=== PAUSE TestAccCloudFormationStackInstances_Disappears_stackSet
=== RUN   TestAccCloudFormationStackInstances_Multi_increaseRegions
=== PAUSE TestAccCloudFormationStackInstances_Multi_increaseRegions
=== RUN   TestAccCloudFormationStackInstances_Multi_decreaseRegions
=== PAUSE TestAccCloudFormationStackInstances_Multi_decreaseRegions
=== RUN   TestAccCloudFormationStackInstances_Multi_swapRegions
=== PAUSE TestAccCloudFormationStackInstances_Multi_swapRegions
=== RUN   TestAccCloudFormationStackInstances_parameterOverrides
=== PAUSE TestAccCloudFormationStackInstances_parameterOverrides
=== RUN   TestAccCloudFormationStackInstances_deploymentTargets
=== PAUSE TestAccCloudFormationStackInstances_deploymentTargets
=== RUN   TestAccCloudFormationStackInstances_DeploymentTargets_emptyOU
=== PAUSE TestAccCloudFormationStackInstances_DeploymentTargets_emptyOU
=== RUN   TestAccCloudFormationStackInstances_operationPreferences
=== PAUSE TestAccCloudFormationStackInstances_operationPreferences
=== RUN   TestAccCloudFormationStackInstances_concurrencyMode
=== PAUSE TestAccCloudFormationStackInstances_concurrencyMode
=== RUN   TestAccCloudFormationStackInstances_delegatedAdministrator
=== PAUSE TestAccCloudFormationStackInstances_delegatedAdministrator
=== CONT  TestAccCloudFormationStackInstances_basic
=== CONT  TestAccCloudFormationStackInstances_parameterOverrides
=== CONT  TestAccCloudFormationStackInstances_operationPreferences
--- PASS: TestAccCloudFormationStackInstances_basic (82.38s)
=== CONT  TestAccCloudFormationStackInstances_delegatedAdministrator
    stack_instances_test.go:488: this AWS account must not be the management account of an AWS Organization
--- SKIP: TestAccCloudFormationStackInstances_delegatedAdministrator (1.20s)
=== CONT  TestAccCloudFormationStackInstances_Multi_increaseRegions
--- PASS: TestAccCloudFormationStackInstances_operationPreferences (136.01s)
=== CONT  TestAccCloudFormationStackInstances_Multi_swapRegions
--- PASS: TestAccCloudFormationStackInstances_parameterOverrides (153.74s)
=== CONT  TestAccCloudFormationStackInstances_Multi_decreaseRegions
--- PASS: TestAccCloudFormationStackInstances_Multi_increaseRegions (111.55s)
=== CONT  TestAccCloudFormationStackInstances_DeploymentTargets_emptyOU
--- PASS: TestAccCloudFormationStackInstances_Multi_swapRegions (114.01s)
=== CONT  TestAccCloudFormationStackInstances_concurrencyMode
--- PASS: TestAccCloudFormationStackInstances_DeploymentTargets_emptyOU (70.74s)
=== CONT  TestAccCloudFormationStackInstances_disappears
--- PASS: TestAccCloudFormationStackInstances_Multi_decreaseRegions (112.24s)
=== CONT  TestAccCloudFormationStackInstances_deploymentTargets
--- PASS: TestAccCloudFormationStackInstances_concurrencyMode (82.23s)
=== CONT  TestAccCloudFormationStackInstances_Disappears_stackSet
--- PASS: TestAccCloudFormationStackInstances_disappears (83.00s)
--- PASS: TestAccCloudFormationStackInstances_deploymentTargets (96.68s)
--- PASS: TestAccCloudFormationStackInstances_Disappears_stackSet (71.95s)
PASS
ok  	github.com/hashicorp/terraform-provider-aws/internal/service/cloudformation	409.239s

[YakDriver]

Sorry for the delays on this new resource!

[github-actions]

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