AWS CloudFormation Stack Set Instance

aws_cloudformation_stack_set_instance (Terraform)

The Stack Set Instance in CloudFormation can be configured in Terraform with the resource name aws_cloudformation_stack_set_instance. The following sections describe 5 examples of how to use the resource and its parameters.

Example Usage from GitHub

Checkmarx/kics

resource "aws_cloudformation_stack_set_instance" "positive1" {
  account_id     = "123456789012"
  region         = "us-east-1"
  stack_set_name = aws_cloudformation_stack_set.example.name
  retain_stack   = false
}

leonidweinbergcx/mykics

resource "aws_cloudformation_stack_set_instance" "positive1" {
  account_id     = "123456789012"
  region         = "us-east-1"
  stack_set_name = aws_cloudformation_stack_set.example.name
  retain_stack   = false
}

asannou/terraform-aws-cloudformation-stackset

resource "aws_cloudformation_stack_set_instance" "instances" {
  count          = length(var.regions)
  region         = var.regions[count.index]
  account_id     = data.aws_caller_identity.identity.account_id
  stack_set_name = var.stack_set_name
  depends_on     = [var.module_depends_on]

mikamakusa/terraform

resource "aws_cloudformation_stack_set_instance" "stack_set_instance" {
  count          = length(var.stack_set_instance)
  stack_set_name = element(var.stack_set_name, lookup(var.stack_set_instance[count.index], "stack_set_id"))
  region         = lookup(var.stack_set_instance[count.index], "region")
  retain_stack   = lookup(var.stack_set_instance[count.index], "retain_stack")

Checkmarx/kics

resource "aws_cloudformation_stack_set_instance" "negative1" {
  account_id     = "123456789012"
  region         = "us-east-1"
  stack_set_name = aws_cloudformation_stack_set.example.name
  retain_stack     = true

Parameters

• account_id optional computed - string
• id optional computed - string
• parameter_overrides optional - map from string to string
• region optional computed - string
• retain_stack optional - bool
• stack_id optional computed - string
• stack_set_name required - string
• timeouts single block
  • create optional - string
  • delete optional - string
  • update optional - string

Explanation in Terraform Registry

Manages a CloudFormation StackSet Instance. Instances are managed in the account and region of the StackSet after the target account permissions have been configured. Additional information about StackSets can be found in the AWS CloudFormation User Guide.

NOTE: All target accounts must have an IAM Role created that matches the name of the execution role configured in the StackSet (the execution_role_name argument in the aws_cloudformation_stack_set resource) in a trust relationship with the administrative account or administration IAM Role. The execution role must have appropriate permissions to manage resources defined in the template along with those required for StackSets to operate. See the AWS CloudFormation User Guide for more details. NOTE: To retain the Stack during Terraform resource destroy, ensure retain_stack = true has been successfully applied into the Terraform state first. This must be completed before an apply that would destroy the resource.