Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. cloudformation
  5. StackSetInstance
AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-aws

aws.cloudformation.StackSetInstance

Explore with Pulumi AI

aws logo
AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-aws

    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.StackSet 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 resource destroy, ensure retain_stack has been set to true in the state first. This must be completed before a deployment that would destroy the resource.

    Example Usage

    Basic Usage

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

const example = new aws.cloudformation.StackSetInstance("example", {
    accountId: "123456789012",
    region: "us-east-1",
    stackSetName: exampleAwsCloudformationStackSet.name,
});

    import pulumi
import pulumi_aws as aws

example = aws.cloudformation.StackSetInstance("example",
    account_id="123456789012",
    region="us-east-1",
    stack_set_name=example_aws_cloudformation_stack_set["name"])

    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.NewStackSetInstance(ctx, "example", &cloudformation.StackSetInstanceArgs{
			AccountId:    pulumi.String("123456789012"),
			Region:       pulumi.String("us-east-1"),
			StackSetName: pulumi.Any(exampleAwsCloudformationStackSet.Name),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.CloudFormation.StackSetInstance("example", new()
    {
        AccountId = "123456789012",
        Region = "us-east-1",
        StackSetName = exampleAwsCloudformationStackSet.Name,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.cloudformation.StackSetInstance;
import com.pulumi.aws.cloudformation.StackSetInstanceArgs;
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 StackSetInstance("example", StackSetInstanceArgs.builder()
            .accountId("123456789012")
            .region("us-east-1")
            .stackSetName(exampleAwsCloudformationStackSet.name())
            .build());

    }
}

    resources:
  example:
    type: aws:cloudformation:StackSetInstance
    properties:
      accountId: '123456789012'
      region: us-east-1
      stackSetName: ${exampleAwsCloudformationStackSet.name}

    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,
});

    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)

    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
})
}

    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,
    });

});

    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.applyValue(getPolicyDocumentResult -> getPolicyDocumentResult.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.applyValue(getPolicyDocumentResult -> getPolicyDocumentResult.json()))
            .role(aWSCloudFormationStackSetExecutionRole.name())
            .build());

    }
}

    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:
              - '*'

    Example Deployment across Organizations account

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

const example = new aws.cloudformation.StackSetInstance("example", {
    deploymentTargets: {
        organizationalUnitIds: [exampleAwsOrganizationsOrganization.roots[0].id],
    },
    region: "us-east-1",
    stackSetName: exampleAwsCloudformationStackSet.name,
});

    import pulumi
import pulumi_aws as aws

example = aws.cloudformation.StackSetInstance("example",
    deployment_targets={
        "organizational_unit_ids": [example_aws_organizations_organization["roots"][0]["id"]],
    },
    region="us-east-1",
    stack_set_name=example_aws_cloudformation_stack_set["name"])

    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.NewStackSetInstance(ctx, "example", &cloudformation.StackSetInstanceArgs{
			DeploymentTargets: &cloudformation.StackSetInstanceDeploymentTargetsArgs{
				OrganizationalUnitIds: pulumi.StringArray{
					exampleAwsOrganizationsOrganization.Roots[0].Id,
				},
			},
			Region:       pulumi.String("us-east-1"),
			StackSetName: pulumi.Any(exampleAwsCloudformationStackSet.Name),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

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

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.cloudformation.StackSetInstance;
import com.pulumi.aws.cloudformation.StackSetInstanceArgs;
import com.pulumi.aws.cloudformation.inputs.StackSetInstanceDeploymentTargetsArgs;
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 StackSetInstance("example", StackSetInstanceArgs.builder()
            .deploymentTargets(StackSetInstanceDeploymentTargetsArgs.builder()
                .organizationalUnitIds(exampleAwsOrganizationsOrganization.roots()[0].id())
                .build())
            .region("us-east-1")
            .stackSetName(exampleAwsCloudformationStackSet.name())
            .build());

    }
}

    resources:
  example:
    type: aws:cloudformation:StackSetInstance
    properties:
      deploymentTargets:
        organizationalUnitIds:
          - ${exampleAwsOrganizationsOrganization.roots[0].id}
      region: us-east-1
      stackSetName: ${exampleAwsCloudformationStackSet.name}

    Create StackSetInstance Resource

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

    Constructor syntax

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

@overload
def StackSetInstance(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     stack_set_name: Optional[str] = None,
                     account_id: Optional[str] = None,
                     call_as: Optional[str] = None,
                     deployment_targets: Optional[StackSetInstanceDeploymentTargetsArgs] = None,
                     operation_preferences: Optional[StackSetInstanceOperationPreferencesArgs] = None,
                     parameter_overrides: Optional[Mapping[str, str]] = None,
                     region: Optional[str] = None,
                     retain_stack: Optional[bool] = None)
    func NewStackSetInstance(ctx *Context, name string, args StackSetInstanceArgs, opts ...ResourceOption) (*StackSetInstance, error)
    public StackSetInstance(string name, StackSetInstanceArgs args, CustomResourceOptions? opts = null)
    public StackSetInstance(String name, StackSetInstanceArgs args)
public StackSetInstance(String name, StackSetInstanceArgs args, CustomResourceOptions options)

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

    Parameters

    name string
    The unique name of the resource.
    args StackSetInstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args StackSetInstanceArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args StackSetInstanceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args StackSetInstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args StackSetInstanceArgs
    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 stackSetInstanceResource = new Aws.CloudFormation.StackSetInstance("stackSetInstanceResource", new()
{
    StackSetName = "string",
    AccountId = "string",
    CallAs = "string",
    DeploymentTargets = new Aws.CloudFormation.Inputs.StackSetInstanceDeploymentTargetsArgs
    {
        AccountFilterType = "string",
        Accounts = new[]
        {
            "string",
        },
        AccountsUrl = "string",
        OrganizationalUnitIds = new[]
        {
            "string",
        },
    },
    OperationPreferences = new Aws.CloudFormation.Inputs.StackSetInstanceOperationPreferencesArgs
    {
        ConcurrencyMode = "string",
        FailureToleranceCount = 0,
        FailureTolerancePercentage = 0,
        MaxConcurrentCount = 0,
        MaxConcurrentPercentage = 0,
        RegionConcurrencyType = "string",
        RegionOrders = new[]
        {
            "string",
        },
    },
    ParameterOverrides = 
    {
        { "string", "string" },
    },
    Region = "string",
    RetainStack = false,
});

    example, err := cloudformation.NewStackSetInstance(ctx, "stackSetInstanceResource", &cloudformation.StackSetInstanceArgs{
	StackSetName: pulumi.String("string"),
	AccountId:    pulumi.String("string"),
	CallAs:       pulumi.String("string"),
	DeploymentTargets: &cloudformation.StackSetInstanceDeploymentTargetsArgs{
		AccountFilterType: pulumi.String("string"),
		Accounts: pulumi.StringArray{
			pulumi.String("string"),
		},
		AccountsUrl: pulumi.String("string"),
		OrganizationalUnitIds: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	OperationPreferences: &cloudformation.StackSetInstanceOperationPreferencesArgs{
		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"),
	},
	Region:      pulumi.String("string"),
	RetainStack: pulumi.Bool(false),
})

    var stackSetInstanceResource = new StackSetInstance("stackSetInstanceResource", StackSetInstanceArgs.builder()
    .stackSetName("string")
    .accountId("string")
    .callAs("string")
    .deploymentTargets(StackSetInstanceDeploymentTargetsArgs.builder()
        .accountFilterType("string")
        .accounts("string")
        .accountsUrl("string")
        .organizationalUnitIds("string")
        .build())
    .operationPreferences(StackSetInstanceOperationPreferencesArgs.builder()
        .concurrencyMode("string")
        .failureToleranceCount(0)
        .failureTolerancePercentage(0)
        .maxConcurrentCount(0)
        .maxConcurrentPercentage(0)
        .regionConcurrencyType("string")
        .regionOrders("string")
        .build())
    .parameterOverrides(Map.of("string", "string"))
    .region("string")
    .retainStack(false)
    .build());

    stack_set_instance_resource = aws.cloudformation.StackSetInstance("stackSetInstanceResource",
    stack_set_name="string",
    account_id="string",
    call_as="string",
    deployment_targets={
        "accountFilterType": "string",
        "accounts": ["string"],
        "accountsUrl": "string",
        "organizationalUnitIds": ["string"],
    },
    operation_preferences={
        "concurrencyMode": "string",
        "failureToleranceCount": 0,
        "failureTolerancePercentage": 0,
        "maxConcurrentCount": 0,
        "maxConcurrentPercentage": 0,
        "regionConcurrencyType": "string",
        "regionOrders": ["string"],
    },
    parameter_overrides={
        "string": "string",
    },
    region="string",
    retain_stack=False)

    const stackSetInstanceResource = new aws.cloudformation.StackSetInstance("stackSetInstanceResource", {
    stackSetName: "string",
    accountId: "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",
    },
    region: "string",
    retainStack: false,
});

    type: aws:cloudformation:StackSetInstance
properties:
    accountId: 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
    region: string
    retainStack: false
    stackSetName: string

    StackSetInstance Resource Properties

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

    Inputs

    The StackSetInstance resource accepts the following input properties:

    StackSetName string
    Name of the StackSet.
    AccountId string
    Target AWS Account ID to create a Stack based on the StackSet. Defaults to current account.
    CallAs string
    Specifies 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 StackSetInstanceDeploymentTargets
    AWS Organizations accounts to which StackSets deploys. StackSets 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 this argument. See deployment_targets below.
    OperationPreferences StackSetInstanceOperationPreferences
    Preferences for how AWS CloudFormation performs a stack set operation.
    ParameterOverrides Dictionary<string, string>
    Key-value map of input parameters to override from the StackSet for this Instance.
    Region string
    Target AWS Region to create a Stack based on the StackSet. Defaults to current region.
    RetainStack bool
    During resource destroy, remove Instance from StackSet while keeping the Stack and its associated resources. Must be enabled in the state before destroy operation to take effect. You cannot reassociate a retained Stack or add an existing, saved Stack to a new StackSet. Defaults to false.
    StackSetName string
    Name of the StackSet.
    AccountId string
    Target AWS Account ID to create a Stack based on the StackSet. Defaults to current account.
    CallAs string
    Specifies 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 StackSetInstanceDeploymentTargetsArgs
    AWS Organizations accounts to which StackSets deploys. StackSets 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 this argument. See deployment_targets below.
    OperationPreferences StackSetInstanceOperationPreferencesArgs
    Preferences for how AWS CloudFormation performs a stack set operation.
    ParameterOverrides map[string]string
    Key-value map of input parameters to override from the StackSet for this Instance.
    Region string
    Target AWS Region to create a Stack based on the StackSet. Defaults to current region.
    RetainStack bool
    During resource destroy, remove Instance from StackSet while keeping the Stack and its associated resources. Must be enabled in the state before destroy operation to take effect. You cannot reassociate a retained Stack or add an existing, saved Stack to a new StackSet. Defaults to false.
    stackSetName String
    Name of the StackSet.
    accountId String
    Target AWS Account ID to create a Stack based on the StackSet. Defaults to current account.
    callAs String
    Specifies 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 StackSetInstanceDeploymentTargets
    AWS Organizations accounts to which StackSets deploys. StackSets 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 this argument. See deployment_targets below.
    operationPreferences StackSetInstanceOperationPreferences
    Preferences for how AWS CloudFormation performs a stack set operation.
    parameterOverrides Map<String,String>
    Key-value map of input parameters to override from the StackSet for this Instance.
    region String
    Target AWS Region to create a Stack based on the StackSet. Defaults to current region.
    retainStack Boolean
    During resource destroy, remove Instance from StackSet while keeping the Stack and its associated resources. Must be enabled in the state before destroy operation to take effect. You cannot reassociate a retained Stack or add an existing, saved Stack to a new StackSet. Defaults to false.
    stackSetName string
    Name of the StackSet.
    accountId string
    Target AWS Account ID to create a Stack based on the StackSet. Defaults to current account.
    callAs string
    Specifies 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 StackSetInstanceDeploymentTargets
    AWS Organizations accounts to which StackSets deploys. StackSets 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 this argument. See deployment_targets below.
    operationPreferences StackSetInstanceOperationPreferences
    Preferences for how AWS CloudFormation performs a stack set operation.
    parameterOverrides {[key: string]: string}
    Key-value map of input parameters to override from the StackSet for this Instance.
    region string
    Target AWS Region to create a Stack based on the StackSet. Defaults to current region.
    retainStack boolean
    During resource destroy, remove Instance from StackSet while keeping the Stack and its associated resources. Must be enabled in the state before destroy operation to take effect. You cannot reassociate a retained Stack or add an existing, saved Stack to a new StackSet. Defaults to false.
    stack_set_name str
    Name of the StackSet.
    account_id str
    Target AWS Account ID to create a Stack based on the StackSet. Defaults to current account.
    call_as str
    Specifies 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 StackSetInstanceDeploymentTargetsArgs
    AWS Organizations accounts to which StackSets deploys. StackSets 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 this argument. See deployment_targets below.
    operation_preferences StackSetInstanceOperationPreferencesArgs
    Preferences for how AWS CloudFormation performs a stack set operation.
    parameter_overrides Mapping[str, str]
    Key-value map of input parameters to override from the StackSet for this Instance.
    region str
    Target AWS Region to create a Stack based on the StackSet. Defaults to current region.
    retain_stack bool
    During resource destroy, remove Instance from StackSet while keeping the Stack and its associated resources. Must be enabled in the state before destroy operation to take effect. You cannot reassociate a retained Stack or add an existing, saved Stack to a new StackSet. Defaults to false.
    stackSetName String
    Name of the StackSet.
    accountId String
    Target AWS Account ID to create a Stack based on the StackSet. Defaults to current account.
    callAs String
    Specifies 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 to which StackSets deploys. StackSets 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 this argument. See deployment_targets below.
    operationPreferences Property Map
    Preferences for how AWS CloudFormation performs a stack set operation.
    parameterOverrides Map<String>
    Key-value map of input parameters to override from the StackSet for this Instance.
    region String
    Target AWS Region to create a Stack based on the StackSet. Defaults to current region.
    retainStack Boolean
    During resource destroy, remove Instance from StackSet while keeping the Stack and its associated resources. Must be enabled in the state before destroy operation to take effect. You cannot reassociate a retained Stack or add an existing, saved Stack to a new StackSet. Defaults to false.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    OrganizationalUnitId string
    Organizational unit ID in which the stack is deployed.
    StackId string
    Stack identifier.
    StackInstanceSummaries List<StackSetInstanceStackInstanceSummary>
    List of stack instances created from an organizational unit deployment target. This will only be populated when deployment_targets is set. See stack_instance_summaries.
    Id string
    The provider-assigned unique ID for this managed resource.
    OrganizationalUnitId string
    Organizational unit ID in which the stack is deployed.
    StackId string
    Stack identifier.
    StackInstanceSummaries []StackSetInstanceStackInstanceSummary
    List of stack instances created from an organizational unit deployment target. This will only be populated when deployment_targets is set. See stack_instance_summaries.
    id String
    The provider-assigned unique ID for this managed resource.
    organizationalUnitId String
    Organizational unit ID in which the stack is deployed.
    stackId String
    Stack identifier.
    stackInstanceSummaries List<StackSetInstanceStackInstanceSummary>
    List of stack instances created from an organizational unit deployment target. This will only be populated when deployment_targets is set. See stack_instance_summaries.
    id string
    The provider-assigned unique ID for this managed resource.
    organizationalUnitId string
    Organizational unit ID in which the stack is deployed.
    stackId string
    Stack identifier.
    stackInstanceSummaries StackSetInstanceStackInstanceSummary[]
    List of stack instances created from an organizational unit deployment target. This will only be populated when deployment_targets is set. See stack_instance_summaries.
    id str
    The provider-assigned unique ID for this managed resource.
    organizational_unit_id str
    Organizational unit ID in which the stack is deployed.
    stack_id str
    Stack identifier.
    stack_instance_summaries Sequence[StackSetInstanceStackInstanceSummary]
    List of stack instances created from an organizational unit deployment target. This will only be populated when deployment_targets is set. See stack_instance_summaries.
    id String
    The provider-assigned unique ID for this managed resource.
    organizationalUnitId String
    Organizational unit ID in which the stack is deployed.
    stackId String
    Stack identifier.
    stackInstanceSummaries List<Property Map>
    List of stack instances created from an organizational unit deployment target. This will only be populated when deployment_targets is set. See stack_instance_summaries.

    Look up Existing StackSetInstance Resource

    Get an existing StackSetInstance 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?: StackSetInstanceState, opts?: CustomResourceOptions): StackSetInstance
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_id: Optional[str] = None,
        call_as: Optional[str] = None,
        deployment_targets: Optional[StackSetInstanceDeploymentTargetsArgs] = None,
        operation_preferences: Optional[StackSetInstanceOperationPreferencesArgs] = None,
        organizational_unit_id: Optional[str] = None,
        parameter_overrides: Optional[Mapping[str, str]] = None,
        region: Optional[str] = None,
        retain_stack: Optional[bool] = None,
        stack_id: Optional[str] = None,
        stack_instance_summaries: Optional[Sequence[StackSetInstanceStackInstanceSummaryArgs]] = None,
        stack_set_name: Optional[str] = None) -> StackSetInstance
    func GetStackSetInstance(ctx *Context, name string, id IDInput, state *StackSetInstanceState, opts ...ResourceOption) (*StackSetInstance, error)
    public static StackSetInstance Get(string name, Input<string> id, StackSetInstanceState? state, CustomResourceOptions? opts = null)
    public static StackSetInstance get(String name, Output<String> id, StackSetInstanceState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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:
    AccountId string
    Target AWS Account ID to create a Stack based on the StackSet. Defaults to current account.
    CallAs string
    Specifies 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 StackSetInstanceDeploymentTargets
    AWS Organizations accounts to which StackSets deploys. StackSets 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 this argument. See deployment_targets below.
    OperationPreferences StackSetInstanceOperationPreferences
    Preferences for how AWS CloudFormation performs a stack set operation.
    OrganizationalUnitId string
    Organizational unit ID in which the stack is deployed.
    ParameterOverrides Dictionary<string, string>
    Key-value map of input parameters to override from the StackSet for this Instance.
    Region string
    Target AWS Region to create a Stack based on the StackSet. Defaults to current region.
    RetainStack bool
    During resource destroy, remove Instance from StackSet while keeping the Stack and its associated resources. Must be enabled in the state before destroy operation to take effect. You cannot reassociate a retained Stack or add an existing, saved Stack to a new StackSet. Defaults to false.
    StackId string
    Stack identifier.
    StackInstanceSummaries List<StackSetInstanceStackInstanceSummary>
    List of stack instances created from an organizational unit deployment target. This will only be populated when deployment_targets is set. See stack_instance_summaries.
    StackSetName string
    Name of the StackSet.
    AccountId string
    Target AWS Account ID to create a Stack based on the StackSet. Defaults to current account.
    CallAs string
    Specifies 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 StackSetInstanceDeploymentTargetsArgs
    AWS Organizations accounts to which StackSets deploys. StackSets 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 this argument. See deployment_targets below.
    OperationPreferences StackSetInstanceOperationPreferencesArgs
    Preferences for how AWS CloudFormation performs a stack set operation.
    OrganizationalUnitId string
    Organizational unit ID in which the stack is deployed.
    ParameterOverrides map[string]string
    Key-value map of input parameters to override from the StackSet for this Instance.
    Region string
    Target AWS Region to create a Stack based on the StackSet. Defaults to current region.
    RetainStack bool
    During resource destroy, remove Instance from StackSet while keeping the Stack and its associated resources. Must be enabled in the state before destroy operation to take effect. You cannot reassociate a retained Stack or add an existing, saved Stack to a new StackSet. Defaults to false.
    StackId string
    Stack identifier.
    StackInstanceSummaries []StackSetInstanceStackInstanceSummaryArgs
    List of stack instances created from an organizational unit deployment target. This will only be populated when deployment_targets is set. See stack_instance_summaries.
    StackSetName string
    Name of the StackSet.
    accountId String
    Target AWS Account ID to create a Stack based on the StackSet. Defaults to current account.
    callAs String
    Specifies 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 StackSetInstanceDeploymentTargets
    AWS Organizations accounts to which StackSets deploys. StackSets 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 this argument. See deployment_targets below.
    operationPreferences StackSetInstanceOperationPreferences
    Preferences for how AWS CloudFormation performs a stack set operation.
    organizationalUnitId String
    Organizational unit ID in which the stack is deployed.
    parameterOverrides Map<String,String>
    Key-value map of input parameters to override from the StackSet for this Instance.
    region String
    Target AWS Region to create a Stack based on the StackSet. Defaults to current region.
    retainStack Boolean
    During resource destroy, remove Instance from StackSet while keeping the Stack and its associated resources. Must be enabled in the state before destroy operation to take effect. You cannot reassociate a retained Stack or add an existing, saved Stack to a new StackSet. Defaults to false.
    stackId String
    Stack identifier.
    stackInstanceSummaries List<StackSetInstanceStackInstanceSummary>
    List of stack instances created from an organizational unit deployment target. This will only be populated when deployment_targets is set. See stack_instance_summaries.
    stackSetName String
    Name of the StackSet.
    accountId string
    Target AWS Account ID to create a Stack based on the StackSet. Defaults to current account.
    callAs string
    Specifies 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 StackSetInstanceDeploymentTargets
    AWS Organizations accounts to which StackSets deploys. StackSets 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 this argument. See deployment_targets below.
    operationPreferences StackSetInstanceOperationPreferences
    Preferences for how AWS CloudFormation performs a stack set operation.
    organizationalUnitId string
    Organizational unit ID in which the stack is deployed.
    parameterOverrides {[key: string]: string}
    Key-value map of input parameters to override from the StackSet for this Instance.
    region string
    Target AWS Region to create a Stack based on the StackSet. Defaults to current region.
    retainStack boolean
    During resource destroy, remove Instance from StackSet while keeping the Stack and its associated resources. Must be enabled in the state before destroy operation to take effect. You cannot reassociate a retained Stack or add an existing, saved Stack to a new StackSet. Defaults to false.
    stackId string
    Stack identifier.
    stackInstanceSummaries StackSetInstanceStackInstanceSummary[]
    List of stack instances created from an organizational unit deployment target. This will only be populated when deployment_targets is set. See stack_instance_summaries.
    stackSetName string
    Name of the StackSet.
    account_id str
    Target AWS Account ID to create a Stack based on the StackSet. Defaults to current account.
    call_as str
    Specifies 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 StackSetInstanceDeploymentTargetsArgs
    AWS Organizations accounts to which StackSets deploys. StackSets 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 this argument. See deployment_targets below.
    operation_preferences StackSetInstanceOperationPreferencesArgs
    Preferences for how AWS CloudFormation performs a stack set operation.
    organizational_unit_id str
    Organizational unit ID in which the stack is deployed.
    parameter_overrides Mapping[str, str]
    Key-value map of input parameters to override from the StackSet for this Instance.
    region str
    Target AWS Region to create a Stack based on the StackSet. Defaults to current region.
    retain_stack bool
    During resource destroy, remove Instance from StackSet while keeping the Stack and its associated resources. Must be enabled in the state before destroy operation to take effect. You cannot reassociate a retained Stack or add an existing, saved Stack to a new StackSet. Defaults to false.
    stack_id str
    Stack identifier.
    stack_instance_summaries Sequence[StackSetInstanceStackInstanceSummaryArgs]
    List of stack instances created from an organizational unit deployment target. This will only be populated when deployment_targets is set. See stack_instance_summaries.
    stack_set_name str
    Name of the StackSet.
    accountId String
    Target AWS Account ID to create a Stack based on the StackSet. Defaults to current account.
    callAs String
    Specifies 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 to which StackSets deploys. StackSets 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 this argument. See deployment_targets below.
    operationPreferences Property Map
    Preferences for how AWS CloudFormation performs a stack set operation.
    organizationalUnitId String
    Organizational unit ID in which the stack is deployed.
    parameterOverrides Map<String>
    Key-value map of input parameters to override from the StackSet for this Instance.
    region String
    Target AWS Region to create a Stack based on the StackSet. Defaults to current region.
    retainStack Boolean
    During resource destroy, remove Instance from StackSet while keeping the Stack and its associated resources. Must be enabled in the state before destroy operation to take effect. You cannot reassociate a retained Stack or add an existing, saved Stack to a new StackSet. Defaults to false.
    stackId String
    Stack identifier.
    stackInstanceSummaries List<Property Map>
    List of stack instances created from an organizational unit deployment target. This will only be populated when deployment_targets is set. See stack_instance_summaries.
    stackSetName String
    Name of the StackSet.

    Supporting Types

    StackSetInstanceDeploymentTargets, StackSetInstanceDeploymentTargetsArgs

    AccountFilterType 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 StackSets deploys.
    AccountFilterType 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 StackSets deploys.
    accountFilterType 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 StackSets deploys.
    accountFilterType 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 StackSets deploys.
    account_filter_type 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 StackSets deploys.
    accountFilterType 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 StackSets deploys.

    StackSetInstanceOperationPreferences, StackSetInstanceOperationPreferencesArgs

    ConcurrencyMode string
    Specifies 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 AWS CloudFormation stops the operation in that Region.
    FailureTolerancePercentage int
    Percentage of accounts, per Region, for which this stack operation can fail before AWS 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 StackSets 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 in where you want to perform the stack operation.
    ConcurrencyMode string
    Specifies 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 AWS CloudFormation stops the operation in that Region.
    FailureTolerancePercentage int
    Percentage of accounts, per Region, for which this stack operation can fail before AWS 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 StackSets 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 in where you want to perform the stack operation.
    concurrencyMode String
    Specifies 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 AWS CloudFormation stops the operation in that Region.
    failureTolerancePercentage Integer
    Percentage of accounts, per Region, for which this stack operation can fail before AWS 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 StackSets 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 in where you want to perform the stack operation.
    concurrencyMode string
    Specifies 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 AWS CloudFormation stops the operation in that Region.
    failureTolerancePercentage number
    Percentage of accounts, per Region, for which this stack operation can fail before AWS 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 StackSets 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 in where you want to perform the stack operation.
    concurrency_mode str
    Specifies 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 AWS CloudFormation stops the operation in that Region.
    failure_tolerance_percentage int
    Percentage of accounts, per Region, for which this stack operation can fail before AWS 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 StackSets 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 in where you want to perform the stack operation.
    concurrencyMode String
    Specifies 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 AWS CloudFormation stops the operation in that Region.
    failureTolerancePercentage Number
    Percentage of accounts, per Region, for which this stack operation can fail before AWS 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 StackSets 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 in where you want to perform the stack operation.

    StackSetInstanceStackInstanceSummary, StackSetInstanceStackInstanceSummaryArgs

    AccountId string
    Target AWS Account ID to create a Stack based on the StackSet. Defaults to current account.
    OrganizationalUnitId string
    Organizational unit ID in which the stack is deployed.
    StackId string
    Stack identifier.
    AccountId string
    Target AWS Account ID to create a Stack based on the StackSet. Defaults to current account.
    OrganizationalUnitId string
    Organizational unit ID in which the stack is deployed.
    StackId string
    Stack identifier.
    accountId String
    Target AWS Account ID to create a Stack based on the StackSet. Defaults to current account.
    organizationalUnitId String
    Organizational unit ID in which the stack is deployed.
    stackId String
    Stack identifier.
    accountId string
    Target AWS Account ID to create a Stack based on the StackSet. Defaults to current account.
    organizationalUnitId string
    Organizational unit ID in which the stack is deployed.
    stackId string
    Stack identifier.
    account_id str
    Target AWS Account ID to create a Stack based on the StackSet. Defaults to current account.
    organizational_unit_id str
    Organizational unit ID in which the stack is deployed.
    stack_id str
    Stack identifier.
    accountId String
    Target AWS Account ID to create a Stack based on the StackSet. Defaults to current account.
    organizationalUnitId String
    Organizational unit ID in which the stack is deployed.
    stackId String
    Stack identifier.

    Import

    Import CloudFormation StackSet Instances that target AWS Organizational Units using the StackSet name, a slash (/) separated list of organizational unit IDs, and target AWS Region separated by commas (,). For example:

    Import CloudFormation StackSet Instances when acting a delegated administrator in a member account using the StackSet name, target AWS account ID or slash (/) separated list of organizational unit IDs, target AWS Region and call_as value separated by commas (,). For example:

    Using pulumi import, import CloudFormation StackSet Instances that target an AWS Account ID using the StackSet name, target AWS account ID, and target AWS Region separated by commas (,). For example:

    $ pulumi import aws:cloudformation/stackSetInstance:StackSetInstance example example,123456789012,us-east-1

    Using pulumi import, import CloudFormation StackSet Instances that target AWS Organizational Units using the StackSet name, a slash (/) separated list of organizational unit IDs, and target AWS Region separated by commas (,). For example:

    $ pulumi import aws:cloudformation/stackSetInstance:StackSetInstance example example,ou-sdas-123123123/ou-sdas-789789789,us-east-1

    Using pulumi import, import CloudFormation StackSet Instances when acting a delegated administrator in a member account using the StackSet name, target AWS account ID or slash (/) separated list of organizational unit IDs, target AWS Region and call_as value separated by commas (,). For example:

    $ pulumi import aws:cloudformation/stackSetInstance:StackSetInstance example example,ou-sdas-123123123/ou-sdas-789789789,us-east-1,DELEGATED_ADMIN

    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 logo
    AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi
    pulumi/pulumi-aws