Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. cloudformation
  5. StackInstances
AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws

aws.cloudformation.StackInstances

Explore with Pulumi AI

AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws

Example Usage

Basic Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.cloudformation.StackInstances("example", {
    accounts: [
        "123456789012",
        "234567890123",
    ],
    regions: [
        "us-east-1",
        "us-west-2",
    ],
    stackSetName: exampleAwsCloudformationStackSet.name,
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.cloudformation.StackInstances("example",
    accounts=[
        "123456789012",
        "234567890123",
    ],
    regions=[
        "us-east-1",
        "us-west-2",
    ],
    stack_set_name=example_aws_cloudformation_stack_set["name"])
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/cloudformation"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudformation.NewStackInstances(ctx, "example", &cloudformation.StackInstancesArgs{
			Accounts: pulumi.StringArray{
				pulumi.String("123456789012"),
				pulumi.String("234567890123"),
			},
			Regions: pulumi.StringArray{
				pulumi.String("us-east-1"),
				pulumi.String("us-west-2"),
			},
			StackSetName: pulumi.Any(exampleAwsCloudformationStackSet.Name),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.CloudFormation.StackInstances("example", new()
    {
        Accounts = new[]
        {
            "123456789012",
            "234567890123",
        },
        Regions = new[]
        {
            "us-east-1",
            "us-west-2",
        },
        StackSetName = exampleAwsCloudformationStackSet.Name,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.cloudformation.StackInstances;
import com.pulumi.aws.cloudformation.StackInstancesArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new StackInstances("example", StackInstancesArgs.builder()
            .accounts(            
                "123456789012",
                "234567890123")
            .regions(            
                "us-east-1",
                "us-west-2")
            .stackSetName(exampleAwsCloudformationStackSet.name())
            .build());

    }
}
Copy
resources:
  example:
    type: aws:cloudformation:StackInstances
    properties:
      accounts:
        - '123456789012'
        - '234567890123'
      regions:
        - us-east-1
        - us-west-2
      stackSetName: ${exampleAwsCloudformationStackSet.name}
Copy

Example IAM Setup in Target Account

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const aWSCloudFormationStackSetExecutionRoleAssumeRolePolicy = aws.iam.getPolicyDocument({
    statements: [{
        actions: ["sts:AssumeRole"],
        effect: "Allow",
        principals: [{
            identifiers: [aWSCloudFormationStackSetAdministrationRole.arn],
            type: "AWS",
        }],
    }],
});
const aWSCloudFormationStackSetExecutionRole = new aws.iam.Role("AWSCloudFormationStackSetExecutionRole", {
    assumeRolePolicy: aWSCloudFormationStackSetExecutionRoleAssumeRolePolicy.then(aWSCloudFormationStackSetExecutionRoleAssumeRolePolicy => aWSCloudFormationStackSetExecutionRoleAssumeRolePolicy.json),
    name: "AWSCloudFormationStackSetExecutionRole",
});
// Documentation: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html
// Additional IAM permissions necessary depend on the resources defined in the StackSet template
const aWSCloudFormationStackSetExecutionRoleMinimumExecutionPolicy = aws.iam.getPolicyDocument({
    statements: [{
        actions: [
            "cloudformation:*",
            "s3:*",
            "sns:*",
        ],
        effect: "Allow",
        resources: ["*"],
    }],
});
const aWSCloudFormationStackSetExecutionRoleMinimumExecutionPolicyRolePolicy = new aws.iam.RolePolicy("AWSCloudFormationStackSetExecutionRole_MinimumExecutionPolicy", {
    name: "MinimumExecutionPolicy",
    policy: aWSCloudFormationStackSetExecutionRoleMinimumExecutionPolicy.then(aWSCloudFormationStackSetExecutionRoleMinimumExecutionPolicy => aWSCloudFormationStackSetExecutionRoleMinimumExecutionPolicy.json),
    role: aWSCloudFormationStackSetExecutionRole.name,
});
Copy
import pulumi
import pulumi_aws as aws

a_ws_cloud_formation_stack_set_execution_role_assume_role_policy = aws.iam.get_policy_document(statements=[{
    "actions": ["sts:AssumeRole"],
    "effect": "Allow",
    "principals": [{
        "identifiers": [a_ws_cloud_formation_stack_set_administration_role["arn"]],
        "type": "AWS",
    }],
}])
a_ws_cloud_formation_stack_set_execution_role = aws.iam.Role("AWSCloudFormationStackSetExecutionRole",
    assume_role_policy=a_ws_cloud_formation_stack_set_execution_role_assume_role_policy.json,
    name="AWSCloudFormationStackSetExecutionRole")
# Documentation: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html
# Additional IAM permissions necessary depend on the resources defined in the StackSet template
a_ws_cloud_formation_stack_set_execution_role_minimum_execution_policy = aws.iam.get_policy_document(statements=[{
    "actions": [
        "cloudformation:*",
        "s3:*",
        "sns:*",
    ],
    "effect": "Allow",
    "resources": ["*"],
}])
a_ws_cloud_formation_stack_set_execution_role_minimum_execution_policy_role_policy = aws.iam.RolePolicy("AWSCloudFormationStackSetExecutionRole_MinimumExecutionPolicy",
    name="MinimumExecutionPolicy",
    policy=a_ws_cloud_formation_stack_set_execution_role_minimum_execution_policy.json,
    role=a_ws_cloud_formation_stack_set_execution_role.name)
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/iam"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
aWSCloudFormationStackSetExecutionRoleAssumeRolePolicy, err := iam.GetPolicyDocument(ctx, &iam.GetPolicyDocumentArgs{
Statements: []iam.GetPolicyDocumentStatement{
{
Actions: []string{
"sts:AssumeRole",
},
Effect: pulumi.StringRef("Allow"),
Principals: []iam.GetPolicyDocumentStatementPrincipal{
{
Identifiers: interface{}{
aWSCloudFormationStackSetAdministrationRole.Arn,
},
Type: "AWS",
},
},
},
},
}, nil);
if err != nil {
return err
}
aWSCloudFormationStackSetExecutionRole, err := iam.NewRole(ctx, "AWSCloudFormationStackSetExecutionRole", &iam.RoleArgs{
AssumeRolePolicy: pulumi.String(aWSCloudFormationStackSetExecutionRoleAssumeRolePolicy.Json),
Name: pulumi.String("AWSCloudFormationStackSetExecutionRole"),
})
if err != nil {
return err
}
// Documentation: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html
// Additional IAM permissions necessary depend on the resources defined in the StackSet template
aWSCloudFormationStackSetExecutionRoleMinimumExecutionPolicy, err := iam.GetPolicyDocument(ctx, &iam.GetPolicyDocumentArgs{
Statements: []iam.GetPolicyDocumentStatement{
{
Actions: []string{
"cloudformation:*",
"s3:*",
"sns:*",
},
Effect: pulumi.StringRef("Allow"),
Resources: []string{
"*",
},
},
},
}, nil);
if err != nil {
return err
}
_, err = iam.NewRolePolicy(ctx, "AWSCloudFormationStackSetExecutionRole_MinimumExecutionPolicy", &iam.RolePolicyArgs{
Name: pulumi.String("MinimumExecutionPolicy"),
Policy: pulumi.String(aWSCloudFormationStackSetExecutionRoleMinimumExecutionPolicy.Json),
Role: aWSCloudFormationStackSetExecutionRole.Name,
})
if err != nil {
return err
}
return nil
})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var aWSCloudFormationStackSetExecutionRoleAssumeRolePolicy = Aws.Iam.GetPolicyDocument.Invoke(new()
    {
        Statements = new[]
        {
            new Aws.Iam.Inputs.GetPolicyDocumentStatementInputArgs
            {
                Actions = new[]
                {
                    "sts:AssumeRole",
                },
                Effect = "Allow",
                Principals = new[]
                {
                    new Aws.Iam.Inputs.GetPolicyDocumentStatementPrincipalInputArgs
                    {
                        Identifiers = new[]
                        {
                            aWSCloudFormationStackSetAdministrationRole.Arn,
                        },
                        Type = "AWS",
                    },
                },
            },
        },
    });

    var aWSCloudFormationStackSetExecutionRole = new Aws.Iam.Role("AWSCloudFormationStackSetExecutionRole", new()
    {
        AssumeRolePolicy = aWSCloudFormationStackSetExecutionRoleAssumeRolePolicy.Apply(getPolicyDocumentResult => getPolicyDocumentResult.Json),
        Name = "AWSCloudFormationStackSetExecutionRole",
    });

    // Documentation: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html
    // Additional IAM permissions necessary depend on the resources defined in the StackSet template
    var aWSCloudFormationStackSetExecutionRoleMinimumExecutionPolicy = Aws.Iam.GetPolicyDocument.Invoke(new()
    {
        Statements = new[]
        {
            new Aws.Iam.Inputs.GetPolicyDocumentStatementInputArgs
            {
                Actions = new[]
                {
                    "cloudformation:*",
                    "s3:*",
                    "sns:*",
                },
                Effect = "Allow",
                Resources = new[]
                {
                    "*",
                },
            },
        },
    });

    var aWSCloudFormationStackSetExecutionRoleMinimumExecutionPolicyRolePolicy = new Aws.Iam.RolePolicy("AWSCloudFormationStackSetExecutionRole_MinimumExecutionPolicy", new()
    {
        Name = "MinimumExecutionPolicy",
        Policy = aWSCloudFormationStackSetExecutionRoleMinimumExecutionPolicy.Apply(getPolicyDocumentResult => getPolicyDocumentResult.Json),
        Role = aWSCloudFormationStackSetExecutionRole.Name,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.iam.IamFunctions;
import com.pulumi.aws.iam.inputs.GetPolicyDocumentArgs;
import com.pulumi.aws.iam.Role;
import com.pulumi.aws.iam.RoleArgs;
import com.pulumi.aws.iam.RolePolicy;
import com.pulumi.aws.iam.RolePolicyArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var aWSCloudFormationStackSetExecutionRoleAssumeRolePolicy = IamFunctions.getPolicyDocument(GetPolicyDocumentArgs.builder()
            .statements(GetPolicyDocumentStatementArgs.builder()
                .actions("sts:AssumeRole")
                .effect("Allow")
                .principals(GetPolicyDocumentStatementPrincipalArgs.builder()
                    .identifiers(aWSCloudFormationStackSetAdministrationRole.arn())
                    .type("AWS")
                    .build())
                .build())
            .build());

        var aWSCloudFormationStackSetExecutionRole = new Role("aWSCloudFormationStackSetExecutionRole", RoleArgs.builder()
            .assumeRolePolicy(aWSCloudFormationStackSetExecutionRoleAssumeRolePolicy.json())
            .name("AWSCloudFormationStackSetExecutionRole")
            .build());

        // Documentation: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html
        // Additional IAM permissions necessary depend on the resources defined in the StackSet template
        final var aWSCloudFormationStackSetExecutionRoleMinimumExecutionPolicy = IamFunctions.getPolicyDocument(GetPolicyDocumentArgs.builder()
            .statements(GetPolicyDocumentStatementArgs.builder()
                .actions(                
                    "cloudformation:*",
                    "s3:*",
                    "sns:*")
                .effect("Allow")
                .resources("*")
                .build())
            .build());

        var aWSCloudFormationStackSetExecutionRoleMinimumExecutionPolicyRolePolicy = new RolePolicy("aWSCloudFormationStackSetExecutionRoleMinimumExecutionPolicyRolePolicy", RolePolicyArgs.builder()
            .name("MinimumExecutionPolicy")
            .policy(aWSCloudFormationStackSetExecutionRoleMinimumExecutionPolicy.json())
            .role(aWSCloudFormationStackSetExecutionRole.name())
            .build());

    }
}
Copy
resources:
  aWSCloudFormationStackSetExecutionRole:
    type: aws:iam:Role
    name: AWSCloudFormationStackSetExecutionRole
    properties:
      assumeRolePolicy: ${aWSCloudFormationStackSetExecutionRoleAssumeRolePolicy.json}
      name: AWSCloudFormationStackSetExecutionRole
  aWSCloudFormationStackSetExecutionRoleMinimumExecutionPolicyRolePolicy:
    type: aws:iam:RolePolicy
    name: AWSCloudFormationStackSetExecutionRole_MinimumExecutionPolicy
    properties:
      name: MinimumExecutionPolicy
      policy: ${aWSCloudFormationStackSetExecutionRoleMinimumExecutionPolicy.json}
      role: ${aWSCloudFormationStackSetExecutionRole.name}
variables:
  aWSCloudFormationStackSetExecutionRoleAssumeRolePolicy:
    fn::invoke:
      function: aws:iam:getPolicyDocument
      arguments:
        statements:
          - actions:
              - sts:AssumeRole
            effect: Allow
            principals:
              - identifiers:
                  - ${aWSCloudFormationStackSetAdministrationRole.arn}
                type: AWS
  # Documentation: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html
  # Additional IAM permissions necessary depend on the resources defined in the StackSet template
  aWSCloudFormationStackSetExecutionRoleMinimumExecutionPolicy:
    fn::invoke:
      function: aws:iam:getPolicyDocument
      arguments:
        statements:
          - actions:
              - cloudformation:*
              - s3:*
              - sns:*
            effect: Allow
            resources:
              - '*'
Copy

Example Deployment across Organizations account

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.cloudformation.StackInstances("example", {
    deploymentTargets: {
        organizationalUnitIds: [exampleAwsOrganizationsOrganization.roots[0].id],
    },
    regions: [
        "us-west-2",
        "us-east-1",
    ],
    stackSetName: exampleAwsCloudformationStackSet.name,
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.cloudformation.StackInstances("example",
    deployment_targets={
        "organizational_unit_ids": [example_aws_organizations_organization["roots"][0]["id"]],
    },
    regions=[
        "us-west-2",
        "us-east-1",
    ],
    stack_set_name=example_aws_cloudformation_stack_set["name"])
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/cloudformation"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudformation.NewStackInstances(ctx, "example", &cloudformation.StackInstancesArgs{
			DeploymentTargets: &cloudformation.StackInstancesDeploymentTargetsArgs{
				OrganizationalUnitIds: pulumi.StringArray{
					exampleAwsOrganizationsOrganization.Roots[0].Id,
				},
			},
			Regions: pulumi.StringArray{
				pulumi.String("us-west-2"),
				pulumi.String("us-east-1"),
			},
			StackSetName: pulumi.Any(exampleAwsCloudformationStackSet.Name),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.CloudFormation.StackInstances("example", new()
    {
        DeploymentTargets = new Aws.CloudFormation.Inputs.StackInstancesDeploymentTargetsArgs
        {
            OrganizationalUnitIds = new[]
            {
                exampleAwsOrganizationsOrganization.Roots[0].Id,
            },
        },
        Regions = new[]
        {
            "us-west-2",
            "us-east-1",
        },
        StackSetName = exampleAwsCloudformationStackSet.Name,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.cloudformation.StackInstances;
import com.pulumi.aws.cloudformation.StackInstancesArgs;
import com.pulumi.aws.cloudformation.inputs.StackInstancesDeploymentTargetsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new StackInstances("example", StackInstancesArgs.builder()
            .deploymentTargets(StackInstancesDeploymentTargetsArgs.builder()
                .organizationalUnitIds(exampleAwsOrganizationsOrganization.roots()[0].id())
                .build())
            .regions(            
                "us-west-2",
                "us-east-1")
            .stackSetName(exampleAwsCloudformationStackSet.name())
            .build());

    }
}
Copy
resources:
  example:
    type: aws:cloudformation:StackInstances
    properties:
      deploymentTargets:
        organizationalUnitIds:
          - ${exampleAwsOrganizationsOrganization.roots[0].id}
      regions:
        - us-west-2
        - us-east-1
      stackSetName: ${exampleAwsCloudformationStackSet.name}
Copy

Create StackInstances Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new StackInstances(name: string, args: StackInstancesArgs, opts?: CustomResourceOptions);
@overload
def StackInstances(resource_name: str,
                   args: StackInstancesArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def StackInstances(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   stack_set_name: Optional[str] = None,
                   accounts: Optional[Sequence[str]] = None,
                   call_as: Optional[str] = None,
                   deployment_targets: Optional[StackInstancesDeploymentTargetsArgs] = None,
                   operation_preferences: Optional[StackInstancesOperationPreferencesArgs] = None,
                   parameter_overrides: Optional[Mapping[str, str]] = None,
                   regions: Optional[Sequence[str]] = None,
                   retain_stacks: Optional[bool] = None)
func NewStackInstances(ctx *Context, name string, args StackInstancesArgs, opts ...ResourceOption) (*StackInstances, error)
public StackInstances(string name, StackInstancesArgs args, CustomResourceOptions? opts = null)
public StackInstances(String name, StackInstancesArgs args)
public StackInstances(String name, StackInstancesArgs args, CustomResourceOptions options)

type: aws:cloudformation:StackInstances
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. StackInstancesArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. StackInstancesArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. StackInstancesArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. StackInstancesArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. StackInstancesArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var stackInstancesResource = new Aws.CloudFormation.StackInstances("stackInstancesResource", new()
{
    StackSetName = "string",
    Accounts = new[]
    {
        "string",
    },
    CallAs = "string",
    DeploymentTargets = new Aws.CloudFormation.Inputs.StackInstancesDeploymentTargetsArgs
    {
        AccountFilterType = "string",
        Accounts = new[]
        {
            "string",
        },
        AccountsUrl = "string",
        OrganizationalUnitIds = new[]
        {
            "string",
        },
    },
    OperationPreferences = new Aws.CloudFormation.Inputs.StackInstancesOperationPreferencesArgs
    {
        ConcurrencyMode = "string",
        FailureToleranceCount = 0,
        FailureTolerancePercentage = 0,
        MaxConcurrentCount = 0,
        MaxConcurrentPercentage = 0,
        RegionConcurrencyType = "string",
        RegionOrders = new[]
        {
            "string",
        },
    },
    ParameterOverrides = 
    {
        { "string", "string" },
    },
    Regions = new[]
    {
        "string",
    },
    RetainStacks = false,
});
Copy
example, err := cloudformation.NewStackInstances(ctx, "stackInstancesResource", &cloudformation.StackInstancesArgs{
	StackSetName: pulumi.String("string"),
	Accounts: pulumi.StringArray{
		pulumi.String("string"),
	},
	CallAs: pulumi.String("string"),
	DeploymentTargets: &cloudformation.StackInstancesDeploymentTargetsArgs{
		AccountFilterType: pulumi.String("string"),
		Accounts: pulumi.StringArray{
			pulumi.String("string"),
		},
		AccountsUrl: pulumi.String("string"),
		OrganizationalUnitIds: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	OperationPreferences: &cloudformation.StackInstancesOperationPreferencesArgs{
		ConcurrencyMode:            pulumi.String("string"),
		FailureToleranceCount:      pulumi.Int(0),
		FailureTolerancePercentage: pulumi.Int(0),
		MaxConcurrentCount:         pulumi.Int(0),
		MaxConcurrentPercentage:    pulumi.Int(0),
		RegionConcurrencyType:      pulumi.String("string"),
		RegionOrders: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	ParameterOverrides: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Regions: pulumi.StringArray{
		pulumi.String("string"),
	},
	RetainStacks: pulumi.Bool(false),
})
Copy
var stackInstancesResource = new StackInstances("stackInstancesResource", StackInstancesArgs.builder()
    .stackSetName("string")
    .accounts("string")
    .callAs("string")
    .deploymentTargets(StackInstancesDeploymentTargetsArgs.builder()
        .accountFilterType("string")
        .accounts("string")
        .accountsUrl("string")
        .organizationalUnitIds("string")
        .build())
    .operationPreferences(StackInstancesOperationPreferencesArgs.builder()
        .concurrencyMode("string")
        .failureToleranceCount(0)
        .failureTolerancePercentage(0)
        .maxConcurrentCount(0)
        .maxConcurrentPercentage(0)
        .regionConcurrencyType("string")
        .regionOrders("string")
        .build())
    .parameterOverrides(Map.of("string", "string"))
    .regions("string")
    .retainStacks(false)
    .build());
Copy
stack_instances_resource = aws.cloudformation.StackInstances("stackInstancesResource",
    stack_set_name="string",
    accounts=["string"],
    call_as="string",
    deployment_targets={
        "account_filter_type": "string",
        "accounts": ["string"],
        "accounts_url": "string",
        "organizational_unit_ids": ["string"],
    },
    operation_preferences={
        "concurrency_mode": "string",
        "failure_tolerance_count": 0,
        "failure_tolerance_percentage": 0,
        "max_concurrent_count": 0,
        "max_concurrent_percentage": 0,
        "region_concurrency_type": "string",
        "region_orders": ["string"],
    },
    parameter_overrides={
        "string": "string",
    },
    regions=["string"],
    retain_stacks=False)
Copy
const stackInstancesResource = new aws.cloudformation.StackInstances("stackInstancesResource", {
    stackSetName: "string",
    accounts: ["string"],
    callAs: "string",
    deploymentTargets: {
        accountFilterType: "string",
        accounts: ["string"],
        accountsUrl: "string",
        organizationalUnitIds: ["string"],
    },
    operationPreferences: {
        concurrencyMode: "string",
        failureToleranceCount: 0,
        failureTolerancePercentage: 0,
        maxConcurrentCount: 0,
        maxConcurrentPercentage: 0,
        regionConcurrencyType: "string",
        regionOrders: ["string"],
    },
    parameterOverrides: {
        string: "string",
    },
    regions: ["string"],
    retainStacks: false,
});
Copy
type: aws:cloudformation:StackInstances
properties:
    accounts:
        - string
    callAs: string
    deploymentTargets:
        accountFilterType: string
        accounts:
            - string
        accountsUrl: string
        organizationalUnitIds:
            - string
    operationPreferences:
        concurrencyMode: string
        failureToleranceCount: 0
        failureTolerancePercentage: 0
        maxConcurrentCount: 0
        maxConcurrentPercentage: 0
        regionConcurrencyType: string
        regionOrders:
            - string
    parameterOverrides:
        string: string
    regions:
        - string
    retainStacks: false
    stackSetName: string
Copy

StackInstances Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The StackInstances resource accepts the following input properties:

StackSetName
This property is required.
Changes to this property will trigger replacement.
string

Name of the stack set.

The following arguments are optional:

Accounts List<string>
Accounts where you want to create stack instances in the specified regions. You can specify either accounts or deployment_targets, but not both.
CallAs string
Whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account. Valid values: SELF (default), DELEGATED_ADMIN.
DeploymentTargets StackInstancesDeploymentTargets
AWS Organizations accounts for which to create stack instances in the regions. stack sets doesn't deploy stack instances to the organization management account, even if the organization management account is in your organization or in an OU in your organization. Drift detection is not possible for most of this argument. See deployment_targets below.
OperationPreferences StackInstancesOperationPreferences
Preferences for how AWS CloudFormation performs a stack set operation. See operation_preferences below.
ParameterOverrides Dictionary<string, string>
Key-value map of input parameters to override from the stack set for these instances. This argument's drift detection is limited to the first account and region since each instance can have unique parameters.
Regions List<string>
Regions where you want to create stack instances in the specified accounts.
RetainStacks bool
Whether to remove the stack instances from the stack set, but not delete the stacks. You can't reassociate a retained stack or add an existing, saved stack to a new stack set. To retain the stack, ensure retain_stacks = true has been successfully applied before an apply that would destroy the resource. Defaults to false.
StackSetName
This property is required.
Changes to this property will trigger replacement.
string

Name of the stack set.

The following arguments are optional:

Accounts []string
Accounts where you want to create stack instances in the specified regions. You can specify either accounts or deployment_targets, but not both.
CallAs string
Whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account. Valid values: SELF (default), DELEGATED_ADMIN.
DeploymentTargets StackInstancesDeploymentTargetsArgs
AWS Organizations accounts for which to create stack instances in the regions. stack sets doesn't deploy stack instances to the organization management account, even if the organization management account is in your organization or in an OU in your organization. Drift detection is not possible for most of this argument. See deployment_targets below.
OperationPreferences StackInstancesOperationPreferencesArgs
Preferences for how AWS CloudFormation performs a stack set operation. See operation_preferences below.
ParameterOverrides map[string]string
Key-value map of input parameters to override from the stack set for these instances. This argument's drift detection is limited to the first account and region since each instance can have unique parameters.
Regions []string
Regions where you want to create stack instances in the specified accounts.
RetainStacks bool
Whether to remove the stack instances from the stack set, but not delete the stacks. You can't reassociate a retained stack or add an existing, saved stack to a new stack set. To retain the stack, ensure retain_stacks = true has been successfully applied before an apply that would destroy the resource. Defaults to false.
stackSetName
This property is required.
Changes to this property will trigger replacement.
String

Name of the stack set.

The following arguments are optional:

accounts List<String>
Accounts where you want to create stack instances in the specified regions. You can specify either accounts or deployment_targets, but not both.
callAs String
Whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account. Valid values: SELF (default), DELEGATED_ADMIN.
deploymentTargets StackInstancesDeploymentTargets
AWS Organizations accounts for which to create stack instances in the regions. stack sets doesn't deploy stack instances to the organization management account, even if the organization management account is in your organization or in an OU in your organization. Drift detection is not possible for most of this argument. See deployment_targets below.
operationPreferences StackInstancesOperationPreferences
Preferences for how AWS CloudFormation performs a stack set operation. See operation_preferences below.
parameterOverrides Map<String,String>
Key-value map of input parameters to override from the stack set for these instances. This argument's drift detection is limited to the first account and region since each instance can have unique parameters.
regions List<String>
Regions where you want to create stack instances in the specified accounts.
retainStacks Boolean
Whether to remove the stack instances from the stack set, but not delete the stacks. You can't reassociate a retained stack or add an existing, saved stack to a new stack set. To retain the stack, ensure retain_stacks = true has been successfully applied before an apply that would destroy the resource. Defaults to false.
stackSetName
This property is required.
Changes to this property will trigger replacement.
string

Name of the stack set.

The following arguments are optional:

accounts string[]
Accounts where you want to create stack instances in the specified regions. You can specify either accounts or deployment_targets, but not both.
callAs string
Whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account. Valid values: SELF (default), DELEGATED_ADMIN.
deploymentTargets StackInstancesDeploymentTargets
AWS Organizations accounts for which to create stack instances in the regions. stack sets doesn't deploy stack instances to the organization management account, even if the organization management account is in your organization or in an OU in your organization. Drift detection is not possible for most of this argument. See deployment_targets below.
operationPreferences StackInstancesOperationPreferences
Preferences for how AWS CloudFormation performs a stack set operation. See operation_preferences below.
parameterOverrides {[key: string]: string}
Key-value map of input parameters to override from the stack set for these instances. This argument's drift detection is limited to the first account and region since each instance can have unique parameters.
regions string[]
Regions where you want to create stack instances in the specified accounts.
retainStacks boolean
Whether to remove the stack instances from the stack set, but not delete the stacks. You can't reassociate a retained stack or add an existing, saved stack to a new stack set. To retain the stack, ensure retain_stacks = true has been successfully applied before an apply that would destroy the resource. Defaults to false.
stack_set_name
This property is required.
Changes to this property will trigger replacement.
str

Name of the stack set.

The following arguments are optional:

accounts Sequence[str]
Accounts where you want to create stack instances in the specified regions. You can specify either accounts or deployment_targets, but not both.
call_as str
Whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account. Valid values: SELF (default), DELEGATED_ADMIN.
deployment_targets StackInstancesDeploymentTargetsArgs
AWS Organizations accounts for which to create stack instances in the regions. stack sets doesn't deploy stack instances to the organization management account, even if the organization management account is in your organization or in an OU in your organization. Drift detection is not possible for most of this argument. See deployment_targets below.
operation_preferences StackInstancesOperationPreferencesArgs
Preferences for how AWS CloudFormation performs a stack set operation. See operation_preferences below.
parameter_overrides Mapping[str, str]
Key-value map of input parameters to override from the stack set for these instances. This argument's drift detection is limited to the first account and region since each instance can have unique parameters.
regions Sequence[str]
Regions where you want to create stack instances in the specified accounts.
retain_stacks bool
Whether to remove the stack instances from the stack set, but not delete the stacks. You can't reassociate a retained stack or add an existing, saved stack to a new stack set. To retain the stack, ensure retain_stacks = true has been successfully applied before an apply that would destroy the resource. Defaults to false.
stackSetName
This property is required.
Changes to this property will trigger replacement.
String

Name of the stack set.

The following arguments are optional:

accounts List<String>
Accounts where you want to create stack instances in the specified regions. You can specify either accounts or deployment_targets, but not both.
callAs String
Whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account. Valid values: SELF (default), DELEGATED_ADMIN.
deploymentTargets Property Map
AWS Organizations accounts for which to create stack instances in the regions. stack sets doesn't deploy stack instances to the organization management account, even if the organization management account is in your organization or in an OU in your organization. Drift detection is not possible for most of this argument. See deployment_targets below.
operationPreferences Property Map
Preferences for how AWS CloudFormation performs a stack set operation. See operation_preferences below.
parameterOverrides Map<String>
Key-value map of input parameters to override from the stack set for these instances. This argument's drift detection is limited to the first account and region since each instance can have unique parameters.
regions List<String>
Regions where you want to create stack instances in the specified accounts.
retainStacks Boolean
Whether to remove the stack instances from the stack set, but not delete the stacks. You can't reassociate a retained stack or add an existing, saved stack to a new stack set. To retain the stack, ensure retain_stacks = true has been successfully applied before an apply that would destroy the resource. Defaults to false.

Outputs

All input properties are implicitly available as output properties. Additionally, the StackInstances resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
StackInstanceSummaries List<StackInstancesStackInstanceSummary>
List of stack instances created from an organizational unit deployment target. This may not always be set depending on whether CloudFormation returns summaries for your configuration. See stack_instance_summaries.
StackSetId string
Name or unique ID of the stack set that the stack instance is associated with.
Id string
The provider-assigned unique ID for this managed resource.
StackInstanceSummaries []StackInstancesStackInstanceSummary
List of stack instances created from an organizational unit deployment target. This may not always be set depending on whether CloudFormation returns summaries for your configuration. See stack_instance_summaries.
StackSetId string
Name or unique ID of the stack set that the stack instance is associated with.
id String
The provider-assigned unique ID for this managed resource.
stackInstanceSummaries List<StackInstancesStackInstanceSummary>
List of stack instances created from an organizational unit deployment target. This may not always be set depending on whether CloudFormation returns summaries for your configuration. See stack_instance_summaries.
stackSetId String
Name or unique ID of the stack set that the stack instance is associated with.
id string
The provider-assigned unique ID for this managed resource.
stackInstanceSummaries StackInstancesStackInstanceSummary[]
List of stack instances created from an organizational unit deployment target. This may not always be set depending on whether CloudFormation returns summaries for your configuration. See stack_instance_summaries.
stackSetId string
Name or unique ID of the stack set that the stack instance is associated with.
id str
The provider-assigned unique ID for this managed resource.
stack_instance_summaries Sequence[StackInstancesStackInstanceSummary]
List of stack instances created from an organizational unit deployment target. This may not always be set depending on whether CloudFormation returns summaries for your configuration. See stack_instance_summaries.
stack_set_id str
Name or unique ID of the stack set that the stack instance is associated with.
id String
The provider-assigned unique ID for this managed resource.
stackInstanceSummaries List<Property Map>
List of stack instances created from an organizational unit deployment target. This may not always be set depending on whether CloudFormation returns summaries for your configuration. See stack_instance_summaries.
stackSetId String
Name or unique ID of the stack set that the stack instance is associated with.

Look up Existing StackInstances Resource

Get an existing StackInstances resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: StackInstancesState, opts?: CustomResourceOptions): StackInstances
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        accounts: Optional[Sequence[str]] = None,
        call_as: Optional[str] = None,
        deployment_targets: Optional[StackInstancesDeploymentTargetsArgs] = None,
        operation_preferences: Optional[StackInstancesOperationPreferencesArgs] = None,
        parameter_overrides: Optional[Mapping[str, str]] = None,
        regions: Optional[Sequence[str]] = None,
        retain_stacks: Optional[bool] = None,
        stack_instance_summaries: Optional[Sequence[StackInstancesStackInstanceSummaryArgs]] = None,
        stack_set_id: Optional[str] = None,
        stack_set_name: Optional[str] = None) -> StackInstances
func GetStackInstances(ctx *Context, name string, id IDInput, state *StackInstancesState, opts ...ResourceOption) (*StackInstances, error)
public static StackInstances Get(string name, Input<string> id, StackInstancesState? state, CustomResourceOptions? opts = null)
public static StackInstances get(String name, Output<String> id, StackInstancesState state, CustomResourceOptions options)
resources:  _:    type: aws:cloudformation:StackInstances    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Accounts List<string>
Accounts where you want to create stack instances in the specified regions. You can specify either accounts or deployment_targets, but not both.
CallAs string
Whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account. Valid values: SELF (default), DELEGATED_ADMIN.
DeploymentTargets StackInstancesDeploymentTargets
AWS Organizations accounts for which to create stack instances in the regions. stack sets doesn't deploy stack instances to the organization management account, even if the organization management account is in your organization or in an OU in your organization. Drift detection is not possible for most of this argument. See deployment_targets below.
OperationPreferences StackInstancesOperationPreferences
Preferences for how AWS CloudFormation performs a stack set operation. See operation_preferences below.
ParameterOverrides Dictionary<string, string>
Key-value map of input parameters to override from the stack set for these instances. This argument's drift detection is limited to the first account and region since each instance can have unique parameters.
Regions List<string>
Regions where you want to create stack instances in the specified accounts.
RetainStacks bool
Whether to remove the stack instances from the stack set, but not delete the stacks. You can't reassociate a retained stack or add an existing, saved stack to a new stack set. To retain the stack, ensure retain_stacks = true has been successfully applied before an apply that would destroy the resource. Defaults to false.
StackInstanceSummaries List<StackInstancesStackInstanceSummary>
List of stack instances created from an organizational unit deployment target. This may not always be set depending on whether CloudFormation returns summaries for your configuration. See stack_instance_summaries.
StackSetId string
Name or unique ID of the stack set that the stack instance is associated with.
StackSetName Changes to this property will trigger replacement. string

Name of the stack set.

The following arguments are optional:

Accounts []string
Accounts where you want to create stack instances in the specified regions. You can specify either accounts or deployment_targets, but not both.
CallAs string
Whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account. Valid values: SELF (default), DELEGATED_ADMIN.
DeploymentTargets StackInstancesDeploymentTargetsArgs
AWS Organizations accounts for which to create stack instances in the regions. stack sets doesn't deploy stack instances to the organization management account, even if the organization management account is in your organization or in an OU in your organization. Drift detection is not possible for most of this argument. See deployment_targets below.
OperationPreferences StackInstancesOperationPreferencesArgs
Preferences for how AWS CloudFormation performs a stack set operation. See operation_preferences below.
ParameterOverrides map[string]string
Key-value map of input parameters to override from the stack set for these instances. This argument's drift detection is limited to the first account and region since each instance can have unique parameters.
Regions []string
Regions where you want to create stack instances in the specified accounts.
RetainStacks bool
Whether to remove the stack instances from the stack set, but not delete the stacks. You can't reassociate a retained stack or add an existing, saved stack to a new stack set. To retain the stack, ensure retain_stacks = true has been successfully applied before an apply that would destroy the resource. Defaults to false.
StackInstanceSummaries []StackInstancesStackInstanceSummaryArgs
List of stack instances created from an organizational unit deployment target. This may not always be set depending on whether CloudFormation returns summaries for your configuration. See stack_instance_summaries.
StackSetId string
Name or unique ID of the stack set that the stack instance is associated with.
StackSetName Changes to this property will trigger replacement. string

Name of the stack set.

The following arguments are optional:

accounts List<String>
Accounts where you want to create stack instances in the specified regions. You can specify either accounts or deployment_targets, but not both.
callAs String
Whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account. Valid values: SELF (default), DELEGATED_ADMIN.
deploymentTargets StackInstancesDeploymentTargets
AWS Organizations accounts for which to create stack instances in the regions. stack sets doesn't deploy stack instances to the organization management account, even if the organization management account is in your organization or in an OU in your organization. Drift detection is not possible for most of this argument. See deployment_targets below.
operationPreferences StackInstancesOperationPreferences
Preferences for how AWS CloudFormation performs a stack set operation. See operation_preferences below.
parameterOverrides Map<String,String>
Key-value map of input parameters to override from the stack set for these instances. This argument's drift detection is limited to the first account and region since each instance can have unique parameters.
regions List<String>
Regions where you want to create stack instances in the specified accounts.
retainStacks Boolean
Whether to remove the stack instances from the stack set, but not delete the stacks. You can't reassociate a retained stack or add an existing, saved stack to a new stack set. To retain the stack, ensure retain_stacks = true has been successfully applied before an apply that would destroy the resource. Defaults to false.
stackInstanceSummaries List<StackInstancesStackInstanceSummary>
List of stack instances created from an organizational unit deployment target. This may not always be set depending on whether CloudFormation returns summaries for your configuration. See stack_instance_summaries.
stackSetId String
Name or unique ID of the stack set that the stack instance is associated with.
stackSetName Changes to this property will trigger replacement. String

Name of the stack set.

The following arguments are optional:

accounts string[]
Accounts where you want to create stack instances in the specified regions. You can specify either accounts or deployment_targets, but not both.
callAs string
Whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account. Valid values: SELF (default), DELEGATED_ADMIN.
deploymentTargets StackInstancesDeploymentTargets
AWS Organizations accounts for which to create stack instances in the regions. stack sets doesn't deploy stack instances to the organization management account, even if the organization management account is in your organization or in an OU in your organization. Drift detection is not possible for most of this argument. See deployment_targets below.
operationPreferences StackInstancesOperationPreferences
Preferences for how AWS CloudFormation performs a stack set operation. See operation_preferences below.
parameterOverrides {[key: string]: string}
Key-value map of input parameters to override from the stack set for these instances. This argument's drift detection is limited to the first account and region since each instance can have unique parameters.
regions string[]
Regions where you want to create stack instances in the specified accounts.
retainStacks boolean
Whether to remove the stack instances from the stack set, but not delete the stacks. You can't reassociate a retained stack or add an existing, saved stack to a new stack set. To retain the stack, ensure retain_stacks = true has been successfully applied before an apply that would destroy the resource. Defaults to false.
stackInstanceSummaries StackInstancesStackInstanceSummary[]
List of stack instances created from an organizational unit deployment target. This may not always be set depending on whether CloudFormation returns summaries for your configuration. See stack_instance_summaries.
stackSetId string
Name or unique ID of the stack set that the stack instance is associated with.
stackSetName Changes to this property will trigger replacement. string

Name of the stack set.

The following arguments are optional:

accounts Sequence[str]
Accounts where you want to create stack instances in the specified regions. You can specify either accounts or deployment_targets, but not both.
call_as str
Whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account. Valid values: SELF (default), DELEGATED_ADMIN.
deployment_targets StackInstancesDeploymentTargetsArgs
AWS Organizations accounts for which to create stack instances in the regions. stack sets doesn't deploy stack instances to the organization management account, even if the organization management account is in your organization or in an OU in your organization. Drift detection is not possible for most of this argument. See deployment_targets below.
operation_preferences StackInstancesOperationPreferencesArgs
Preferences for how AWS CloudFormation performs a stack set operation. See operation_preferences below.
parameter_overrides Mapping[str, str]
Key-value map of input parameters to override from the stack set for these instances. This argument's drift detection is limited to the first account and region since each instance can have unique parameters.
regions Sequence[str]
Regions where you want to create stack instances in the specified accounts.
retain_stacks bool
Whether to remove the stack instances from the stack set, but not delete the stacks. You can't reassociate a retained stack or add an existing, saved stack to a new stack set. To retain the stack, ensure retain_stacks = true has been successfully applied before an apply that would destroy the resource. Defaults to false.
stack_instance_summaries Sequence[StackInstancesStackInstanceSummaryArgs]
List of stack instances created from an organizational unit deployment target. This may not always be set depending on whether CloudFormation returns summaries for your configuration. See stack_instance_summaries.
stack_set_id str
Name or unique ID of the stack set that the stack instance is associated with.
stack_set_name Changes to this property will trigger replacement. str

Name of the stack set.

The following arguments are optional:

accounts List<String>
Accounts where you want to create stack instances in the specified regions. You can specify either accounts or deployment_targets, but not both.
callAs String
Whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account. Valid values: SELF (default), DELEGATED_ADMIN.
deploymentTargets Property Map
AWS Organizations accounts for which to create stack instances in the regions. stack sets doesn't deploy stack instances to the organization management account, even if the organization management account is in your organization or in an OU in your organization. Drift detection is not possible for most of this argument. See deployment_targets below.
operationPreferences Property Map
Preferences for how AWS CloudFormation performs a stack set operation. See operation_preferences below.
parameterOverrides Map<String>
Key-value map of input parameters to override from the stack set for these instances. This argument's drift detection is limited to the first account and region since each instance can have unique parameters.
regions List<String>
Regions where you want to create stack instances in the specified accounts.
retainStacks Boolean
Whether to remove the stack instances from the stack set, but not delete the stacks. You can't reassociate a retained stack or add an existing, saved stack to a new stack set. To retain the stack, ensure retain_stacks = true has been successfully applied before an apply that would destroy the resource. Defaults to false.
stackInstanceSummaries List<Property Map>
List of stack instances created from an organizational unit deployment target. This may not always be set depending on whether CloudFormation returns summaries for your configuration. See stack_instance_summaries.
stackSetId String
Name or unique ID of the stack set that the stack instance is associated with.
stackSetName Changes to this property will trigger replacement. String

Name of the stack set.

The following arguments are optional:

Supporting Types

StackInstancesDeploymentTargets
, StackInstancesDeploymentTargetsArgs

AccountFilterType Changes to this property will trigger replacement. string
Limit deployment targets to individual accounts or include additional accounts with provided OUs. Valid values: INTERSECTION, DIFFERENCE, UNION, NONE.
Accounts List<string>
List of accounts to deploy stack set updates.
AccountsUrl string
S3 URL of the file containing the list of accounts.
OrganizationalUnitIds List<string>
Organization root ID or organizational unit (OU) IDs to which stack sets deploy.
AccountFilterType Changes to this property will trigger replacement. string
Limit deployment targets to individual accounts or include additional accounts with provided OUs. Valid values: INTERSECTION, DIFFERENCE, UNION, NONE.
Accounts []string
List of accounts to deploy stack set updates.
AccountsUrl string
S3 URL of the file containing the list of accounts.
OrganizationalUnitIds []string
Organization root ID or organizational unit (OU) IDs to which stack sets deploy.
accountFilterType Changes to this property will trigger replacement. String
Limit deployment targets to individual accounts or include additional accounts with provided OUs. Valid values: INTERSECTION, DIFFERENCE, UNION, NONE.
accounts List<String>
List of accounts to deploy stack set updates.
accountsUrl String
S3 URL of the file containing the list of accounts.
organizationalUnitIds List<String>
Organization root ID or organizational unit (OU) IDs to which stack sets deploy.
accountFilterType Changes to this property will trigger replacement. string
Limit deployment targets to individual accounts or include additional accounts with provided OUs. Valid values: INTERSECTION, DIFFERENCE, UNION, NONE.
accounts string[]
List of accounts to deploy stack set updates.
accountsUrl string
S3 URL of the file containing the list of accounts.
organizationalUnitIds string[]
Organization root ID or organizational unit (OU) IDs to which stack sets deploy.
account_filter_type Changes to this property will trigger replacement. str
Limit deployment targets to individual accounts or include additional accounts with provided OUs. Valid values: INTERSECTION, DIFFERENCE, UNION, NONE.
accounts Sequence[str]
List of accounts to deploy stack set updates.
accounts_url str
S3 URL of the file containing the list of accounts.
organizational_unit_ids Sequence[str]
Organization root ID or organizational unit (OU) IDs to which stack sets deploy.
accountFilterType Changes to this property will trigger replacement. String
Limit deployment targets to individual accounts or include additional accounts with provided OUs. Valid values: INTERSECTION, DIFFERENCE, UNION, NONE.
accounts List<String>
List of accounts to deploy stack set updates.
accountsUrl String
S3 URL of the file containing the list of accounts.
organizationalUnitIds List<String>
Organization root ID or organizational unit (OU) IDs to which stack sets deploy.

StackInstancesOperationPreferences
, StackInstancesOperationPreferencesArgs

ConcurrencyMode string
How the concurrency level behaves during the operation execution. Valid values are STRICT_FAILURE_TOLERANCE and SOFT_FAILURE_TOLERANCE.
FailureToleranceCount int
Number of accounts, per region, for which this operation can fail before CloudFormation stops the operation in that region.
FailureTolerancePercentage int
Percentage of accounts, per region, for which this stack operation can fail before CloudFormation stops the operation in that region.
MaxConcurrentCount int
Maximum number of accounts in which to perform this operation at one time.
MaxConcurrentPercentage int
Maximum percentage of accounts in which to perform this operation at one time.
RegionConcurrencyType string
Concurrency type of deploying stack sets operations in regions, could be in parallel or one region at a time. Valid values are SEQUENTIAL and PARALLEL.
RegionOrders List<string>
Order of the regions where you want to perform the stack operation.
ConcurrencyMode string
How the concurrency level behaves during the operation execution. Valid values are STRICT_FAILURE_TOLERANCE and SOFT_FAILURE_TOLERANCE.
FailureToleranceCount int
Number of accounts, per region, for which this operation can fail before CloudFormation stops the operation in that region.
FailureTolerancePercentage int
Percentage of accounts, per region, for which this stack operation can fail before CloudFormation stops the operation in that region.
MaxConcurrentCount int
Maximum number of accounts in which to perform this operation at one time.
MaxConcurrentPercentage int
Maximum percentage of accounts in which to perform this operation at one time.
RegionConcurrencyType string
Concurrency type of deploying stack sets operations in regions, could be in parallel or one region at a time. Valid values are SEQUENTIAL and PARALLEL.
RegionOrders []string
Order of the regions where you want to perform the stack operation.
concurrencyMode String
How the concurrency level behaves during the operation execution. Valid values are STRICT_FAILURE_TOLERANCE and SOFT_FAILURE_TOLERANCE.
failureToleranceCount Integer
Number of accounts, per region, for which this operation can fail before CloudFormation stops the operation in that region.
failureTolerancePercentage Integer
Percentage of accounts, per region, for which this stack operation can fail before CloudFormation stops the operation in that region.
maxConcurrentCount Integer
Maximum number of accounts in which to perform this operation at one time.
maxConcurrentPercentage Integer
Maximum percentage of accounts in which to perform this operation at one time.
regionConcurrencyType String
Concurrency type of deploying stack sets operations in regions, could be in parallel or one region at a time. Valid values are SEQUENTIAL and PARALLEL.
regionOrders List<String>
Order of the regions where you want to perform the stack operation.
concurrencyMode string
How the concurrency level behaves during the operation execution. Valid values are STRICT_FAILURE_TOLERANCE and SOFT_FAILURE_TOLERANCE.
failureToleranceCount number
Number of accounts, per region, for which this operation can fail before CloudFormation stops the operation in that region.
failureTolerancePercentage number
Percentage of accounts, per region, for which this stack operation can fail before CloudFormation stops the operation in that region.
maxConcurrentCount number
Maximum number of accounts in which to perform this operation at one time.
maxConcurrentPercentage number
Maximum percentage of accounts in which to perform this operation at one time.
regionConcurrencyType string
Concurrency type of deploying stack sets operations in regions, could be in parallel or one region at a time. Valid values are SEQUENTIAL and PARALLEL.
regionOrders string[]
Order of the regions where you want to perform the stack operation.
concurrency_mode str
How the concurrency level behaves during the operation execution. Valid values are STRICT_FAILURE_TOLERANCE and SOFT_FAILURE_TOLERANCE.
failure_tolerance_count int
Number of accounts, per region, for which this operation can fail before CloudFormation stops the operation in that region.
failure_tolerance_percentage int
Percentage of accounts, per region, for which this stack operation can fail before CloudFormation stops the operation in that region.
max_concurrent_count int
Maximum number of accounts in which to perform this operation at one time.
max_concurrent_percentage int
Maximum percentage of accounts in which to perform this operation at one time.
region_concurrency_type str
Concurrency type of deploying stack sets operations in regions, could be in parallel or one region at a time. Valid values are SEQUENTIAL and PARALLEL.
region_orders Sequence[str]
Order of the regions where you want to perform the stack operation.
concurrencyMode String
How the concurrency level behaves during the operation execution. Valid values are STRICT_FAILURE_TOLERANCE and SOFT_FAILURE_TOLERANCE.
failureToleranceCount Number
Number of accounts, per region, for which this operation can fail before CloudFormation stops the operation in that region.
failureTolerancePercentage Number
Percentage of accounts, per region, for which this stack operation can fail before CloudFormation stops the operation in that region.
maxConcurrentCount Number
Maximum number of accounts in which to perform this operation at one time.
maxConcurrentPercentage Number
Maximum percentage of accounts in which to perform this operation at one time.
regionConcurrencyType String
Concurrency type of deploying stack sets operations in regions, could be in parallel or one region at a time. Valid values are SEQUENTIAL and PARALLEL.
regionOrders List<String>
Order of the regions where you want to perform the stack operation.

StackInstancesStackInstanceSummary
, StackInstancesStackInstanceSummaryArgs

AccountId string
Account ID in which the instance is deployed.
DetailedStatus string
Detailed status of the stack instance. Values include PENDING, RUNNING, SUCCEEDED, FAILED, CANCELLED, INOPERABLE, SKIPPED_SUSPENDED_ACCOUNT, FAILED_IMPORT.
DriftStatus string
Status of the stack instance's actual configuration compared to the expected template and parameter configuration of the stack set to which it belongs. Values include DRIFTED, IN_SYNC, UNKNOWN, NOT_CHECKED.
OrganizationalUnitId string
Organization root ID or organizational unit (OU) IDs that you specified for deployment_targets.
Region string
Region that the stack instance is associated with.
StackId string
ID of the stack instance.
StackSetId string
Name or unique ID of the stack set that the stack instance is associated with.
Status string
Status of the stack instance, in terms of its synchronization with its associated stack set. Values include CURRENT, OUTDATED, INOPERABLE.
StatusReason string
Explanation for the specific status code assigned to this stack instance.
AccountId string
Account ID in which the instance is deployed.
DetailedStatus string
Detailed status of the stack instance. Values include PENDING, RUNNING, SUCCEEDED, FAILED, CANCELLED, INOPERABLE, SKIPPED_SUSPENDED_ACCOUNT, FAILED_IMPORT.
DriftStatus string
Status of the stack instance's actual configuration compared to the expected template and parameter configuration of the stack set to which it belongs. Values include DRIFTED, IN_SYNC, UNKNOWN, NOT_CHECKED.
OrganizationalUnitId string
Organization root ID or organizational unit (OU) IDs that you specified for deployment_targets.
Region string
Region that the stack instance is associated with.
StackId string
ID of the stack instance.
StackSetId string
Name or unique ID of the stack set that the stack instance is associated with.
Status string
Status of the stack instance, in terms of its synchronization with its associated stack set. Values include CURRENT, OUTDATED, INOPERABLE.
StatusReason string
Explanation for the specific status code assigned to this stack instance.
accountId String
Account ID in which the instance is deployed.
detailedStatus String
Detailed status of the stack instance. Values include PENDING, RUNNING, SUCCEEDED, FAILED, CANCELLED, INOPERABLE, SKIPPED_SUSPENDED_ACCOUNT, FAILED_IMPORT.
driftStatus String
Status of the stack instance's actual configuration compared to the expected template and parameter configuration of the stack set to which it belongs. Values include DRIFTED, IN_SYNC, UNKNOWN, NOT_CHECKED.
organizationalUnitId String
Organization root ID or organizational unit (OU) IDs that you specified for deployment_targets.
region String
Region that the stack instance is associated with.
stackId String
ID of the stack instance.
stackSetId String
Name or unique ID of the stack set that the stack instance is associated with.
status String
Status of the stack instance, in terms of its synchronization with its associated stack set. Values include CURRENT, OUTDATED, INOPERABLE.
statusReason String
Explanation for the specific status code assigned to this stack instance.
accountId string
Account ID in which the instance is deployed.
detailedStatus string
Detailed status of the stack instance. Values include PENDING, RUNNING, SUCCEEDED, FAILED, CANCELLED, INOPERABLE, SKIPPED_SUSPENDED_ACCOUNT, FAILED_IMPORT.
driftStatus string
Status of the stack instance's actual configuration compared to the expected template and parameter configuration of the stack set to which it belongs. Values include DRIFTED, IN_SYNC, UNKNOWN, NOT_CHECKED.
organizationalUnitId string
Organization root ID or organizational unit (OU) IDs that you specified for deployment_targets.
region string
Region that the stack instance is associated with.
stackId string
ID of the stack instance.
stackSetId string
Name or unique ID of the stack set that the stack instance is associated with.
status string
Status of the stack instance, in terms of its synchronization with its associated stack set. Values include CURRENT, OUTDATED, INOPERABLE.
statusReason string
Explanation for the specific status code assigned to this stack instance.
account_id str
Account ID in which the instance is deployed.
detailed_status str
Detailed status of the stack instance. Values include PENDING, RUNNING, SUCCEEDED, FAILED, CANCELLED, INOPERABLE, SKIPPED_SUSPENDED_ACCOUNT, FAILED_IMPORT.
drift_status str
Status of the stack instance's actual configuration compared to the expected template and parameter configuration of the stack set to which it belongs. Values include DRIFTED, IN_SYNC, UNKNOWN, NOT_CHECKED.
organizational_unit_id str
Organization root ID or organizational unit (OU) IDs that you specified for deployment_targets.
region str
Region that the stack instance is associated with.
stack_id str
ID of the stack instance.
stack_set_id str
Name or unique ID of the stack set that the stack instance is associated with.
status str
Status of the stack instance, in terms of its synchronization with its associated stack set. Values include CURRENT, OUTDATED, INOPERABLE.
status_reason str
Explanation for the specific status code assigned to this stack instance.
accountId String
Account ID in which the instance is deployed.
detailedStatus String
Detailed status of the stack instance. Values include PENDING, RUNNING, SUCCEEDED, FAILED, CANCELLED, INOPERABLE, SKIPPED_SUSPENDED_ACCOUNT, FAILED_IMPORT.
driftStatus String
Status of the stack instance's actual configuration compared to the expected template and parameter configuration of the stack set to which it belongs. Values include DRIFTED, IN_SYNC, UNKNOWN, NOT_CHECKED.
organizationalUnitId String
Organization root ID or organizational unit (OU) IDs that you specified for deployment_targets.
region String
Region that the stack instance is associated with.
stackId String
ID of the stack instance.
stackSetId String
Name or unique ID of the stack set that the stack instance is associated with.
status String
Status of the stack instance, in terms of its synchronization with its associated stack set. Values include CURRENT, OUTDATED, INOPERABLE.
statusReason String
Explanation for the specific status code assigned to this stack instance.

Import

Import CloudFormation stack instances that target OUs, using the stack set name, call_as, and “OU” separated by commas (,). For example:

Using pulumi import, import CloudFormation stack instances using the stack set name and call_as separated by commas (,). If you are importing a stack instance targeting OUs, see the example below. For example:

$ pulumi import aws:cloudformation/stackInstances:StackInstances example example,SELF
Copy

Using pulumi import, Import CloudFormation stack instances that target OUs, using the stack set name, call_as, and “OU” separated by commas (,). For example:

$ pulumi import aws:cloudformation/stackInstances:StackInstances example example,SELF,OU
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.
AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws