Navigation Guide
You are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.

UpdateStackSetCommand

Updates the stack set and associated stack instances in the specified accounts and Amazon Web Services Regions.

Even if the stack set operation created by updating the stack set fails (completely or partially, below or above a specified failure tolerance), the stack set is updated with your changes. Subsequent CreateStackInstances calls on the specified stack set use the updated stack set.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { CloudFormationClient, UpdateStackSetCommand } from "@aws-sdk/client-cloudformation"; // ES Modules import
// const { CloudFormationClient, UpdateStackSetCommand } = require("@aws-sdk/client-cloudformation"); // CommonJS import
const client = new CloudFormationClient(config);
const input = { // UpdateStackSetInput
  StackSetName: "STRING_VALUE", // required
  Description: "STRING_VALUE",
  TemplateBody: "STRING_VALUE",
  TemplateURL: "STRING_VALUE",
  UsePreviousTemplate: true || false,
  Parameters: [ // Parameters
    { // Parameter
      ParameterKey: "STRING_VALUE",
      ParameterValue: "STRING_VALUE",
      UsePreviousValue: true || false,
      ResolvedValue: "STRING_VALUE",
    },
  ],
  Capabilities: [ // Capabilities
    "CAPABILITY_IAM" || "CAPABILITY_NAMED_IAM" || "CAPABILITY_AUTO_EXPAND",
  ],
  Tags: [ // Tags
    { // Tag
      Key: "STRING_VALUE", // required
      Value: "STRING_VALUE", // required
    },
  ],
  OperationPreferences: { // StackSetOperationPreferences
    RegionConcurrencyType: "SEQUENTIAL" || "PARALLEL",
    RegionOrder: [ // RegionList
      "STRING_VALUE",
    ],
    FailureToleranceCount: Number("int"),
    FailureTolerancePercentage: Number("int"),
    MaxConcurrentCount: Number("int"),
    MaxConcurrentPercentage: Number("int"),
    ConcurrencyMode: "STRICT_FAILURE_TOLERANCE" || "SOFT_FAILURE_TOLERANCE",
  },
  AdministrationRoleARN: "STRING_VALUE",
  ExecutionRoleName: "STRING_VALUE",
  DeploymentTargets: { // DeploymentTargets
    Accounts: [ // AccountList
      "STRING_VALUE",
    ],
    AccountsUrl: "STRING_VALUE",
    OrganizationalUnitIds: [ // OrganizationalUnitIdList
      "STRING_VALUE",
    ],
    AccountFilterType: "NONE" || "INTERSECTION" || "DIFFERENCE" || "UNION",
  },
  PermissionModel: "SERVICE_MANAGED" || "SELF_MANAGED",
  AutoDeployment: { // AutoDeployment
    Enabled: true || false,
    RetainStacksOnAccountRemoval: true || false,
  },
  OperationId: "STRING_VALUE",
  Accounts: [
    "STRING_VALUE",
  ],
  Regions: [
    "STRING_VALUE",
  ],
  CallAs: "SELF" || "DELEGATED_ADMIN",
  ManagedExecution: { // ManagedExecution
    Active: true || false,
  },
};
const command = new UpdateStackSetCommand(input);
const response = await client.send(command);
// { // UpdateStackSetOutput
//   OperationId: "STRING_VALUE",
// };

UpdateStackSetCommand Input

See UpdateStackSetCommandInput for more details

Parameter	Type	Description
`StackSetName` Required	`string \| undefined`	The name or unique ID of the stack set that you want to update.
`Accounts`	`string[] \| undefined`	[Self-managed permissions] The accounts in which to update associated stack instances. If you specify accounts, you must also specify the Amazon Web Services Regions in which to update stack set instances. To update all the stack instances associated with this stack set, don't specify the `Accounts` or `Regions` properties. If the stack set update includes changes to the template (that is, if the `TemplateBody` or `TemplateURL` properties are specified), or the `Parameters` property, CloudFormation marks all stack instances with a status of `OUTDATED` prior to updating the stack instances in the specified accounts and Amazon Web Services Regions. If the stack set update does not include changes to the template or parameters, CloudFormation updates the stack instances in the specified accounts and Amazon Web Services Regions, while leaving all other stack instances with their existing stack instance status.
`AdministrationRoleARN`	`string \| undefined`	[Self-managed permissions] The Amazon Resource Name (ARN) of the IAM role to use to update this stack set. Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Grant self-managed permissions in the CloudFormation User Guide. If you specified a customized administrator role when you created the stack set, you must specify a customized administrator role, even if it is the same customized administrator role used with this stack set previously.
`AutoDeployment`	`AutoDeployment \| undefined`	[Service-managed permissions] Describes whether StackSets automatically deploys to Organizations accounts that are added to a target organization or organizational unit (OU). For more information, see Manage automatic deployments for CloudFormation StackSets that use service-managed permissions in the CloudFormation User Guide. If you specify `AutoDeployment`, don't specify `DeploymentTargets` or `Regions`.
`CallAs`	`CallAs \| undefined`	[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account. By default, `SELF` is specified. Use `SELF` for stack sets with self-managed permissions. If you are signed in to the management account, specify `SELF`. If you are signed in to a delegated administrator account, specify `DELEGATED_ADMIN`. Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.
`Capabilities`	`Capability[] \| undefined`	In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to update the stack set and its associated stack instances. `CAPABILITY_IAM` and `CAPABILITY_NAMED_IAM` Some stack templates might include resources that can affect permissions in your Amazon Web Services account, for example, by creating new IAM users. For those stacks sets, you must explicitly acknowledge this by specifying one of these capabilities. The following IAM resources require you to specify either the `CAPABILITY_IAM` or `CAPABILITY_NAMED_IAM` capability. If you have IAM resources, you can specify either capability. If you have IAM resources with custom names, you must specify `CAPABILITY_NAMED_IAM`. If you don't specify either of these capabilities, CloudFormation returns an `InsufficientCapabilities` error. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary. AWS::IAM::AccessKey AWS::IAM::Group AWS::IAM::InstanceProfile AWS::IAM::Policy AWS::IAM::Role AWS::IAM::User AWS::IAM::UserToGroupAddition For more information, see Acknowledging IAM resources in CloudFormation templates . `CAPABILITY_AUTO_EXPAND` Some templates reference macros. If your stack set template references one or more macros, you must update the stack set directly from the processed template, without first reviewing the resulting changes in a change set. To update the stack set directly, you must acknowledge this capability. For more information, see Perform custom processing on CloudFormation templates with template macros . Stack sets with service-managed permissions do not currently support the use of macros in templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.) Even if you specify this capability for a stack set with service-managed permissions, if you reference a macro in your template the stack set operation will fail.
`DeploymentTargets`	`DeploymentTargets \| undefined`	[Service-managed permissions] The Organizations accounts in which to update associated stack instances. To update all the stack instances associated with this stack set, do not specify `DeploymentTargets` or `Regions`. If the stack set update includes changes to the template (that is, if `TemplateBody` or `TemplateURL` is specified), or the `Parameters`, CloudFormation marks all stack instances with a status of `OUTDATED` prior to updating the stack instances in the specified accounts and Amazon Web Services Regions. If the stack set update doesn't include changes to the template or parameters, CloudFormation updates the stack instances in the specified accounts and Regions, while leaving all other stack instances with their existing stack instance status.
`Description`	`string \| undefined`	A brief description of updates that you are making.
`ExecutionRoleName`	`string \| undefined`	[Self-managed permissions] The name of the IAM execution role to use to update the stack set. If you do not specify an execution role, CloudFormation uses the `AWSCloudFormationStackSetExecutionRole` role for the stack set operation. Specify an IAM role only if you are using customized execution roles to control which stack resources users and groups can include in their stack sets. If you specify a customized execution role, CloudFormation uses that role to update the stack. If you do not specify a customized execution role, CloudFormation performs the update using the role previously associated with the stack set, so long as you have permissions to perform operations on the stack set.
`ManagedExecution`	`ManagedExecution \| undefined`	Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.
`OperationId`	`string \| undefined`	The unique ID for this stack set operation. The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that CloudFormation successfully received them. If you don't specify an operation ID, CloudFormation generates one automatically. Repeating this stack set operation with a new operation ID retries all stack instances whose status is `OUTDATED`.
`OperationPreferences`	`StackSetOperationPreferences \| undefined`	Preferences for how CloudFormation performs this stack set operation.
`Parameters`	`Parameter[] \| undefined`	A list of input parameters for the stack set template.
`PermissionModel`	`PermissionModels \| undefined`	Describes how the IAM roles required for stack set operations are created. You cannot modify `PermissionModel` if there are stack instances associated with your stack set. With `self-managed` permissions, you must create the administrator and execution roles required to deploy to target accounts. For more information, see Grant self-managed permissions . With `service-managed` permissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by Organizations. For more information, see Activate trusted access for stack sets with Organizations .
`Regions`	`string[] \| undefined`	The Amazon Web Services Regions in which to update associated stack instances. If you specify Regions, you must also specify accounts in which to update stack set instances. To update all the stack instances associated with this stack set, do not specify the `Accounts` or `Regions` properties. If the stack set update includes changes to the template (that is, if the `TemplateBody` or `TemplateURL` properties are specified), or the `Parameters` property, CloudFormation marks all stack instances with a status of `OUTDATED` prior to updating the stack instances in the specified accounts and Regions. If the stack set update does not include changes to the template or parameters, CloudFormation updates the stack instances in the specified accounts and Regions, while leaving all other stack instances with their existing stack instance status.
`Tags`	`Tag[] \| undefined`	The key-value pairs to associate with this stack set and the stacks created from it. CloudFormation also propagates these tags to supported resources that are created in the stacks. You can specify a maximum number of 50 tags. If you specify tags for this parameter, those tags replace any list of tags that are currently associated with this stack set. This means: If you don't specify this parameter, CloudFormation doesn't modify the stack's tags. If you specify any tags using this parameter, you must specify all the tags that you want associated with this stack set, even tags you've specified before (for example, when creating the stack set or during a previous update of the stack set.). Any tags that you don't include in the updated list of tags are removed from the stack set, and therefore from the stacks and resources as well. If you specify an empty value, CloudFormation removes all currently associated tags. If you specify new tags as part of an `UpdateStackSet` action, CloudFormation checks to see if you have the required IAM permission to tag resources. If you omit tags that are currently associated with the stack set from the list of tags you specify, CloudFormation assumes that you want to remove those tags from the stack set, and checks to see if you have permission to untag resources. If you don't have the necessary permission(s), the entire `UpdateStackSet` action fails with an `access denied` error, and the stack set is not updated.
`TemplateBody`	`string \| undefined`	The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes. Conditional: You must specify only one of the following parameters: `TemplateBody` or `TemplateURL`—or set `UsePreviousTemplate` to true.
`TemplateURL`	`string \| undefined`	The URL of a file that contains the template body. The URL must point to a template (maximum size: 1 MB) that is located in an Amazon S3 bucket or a Systems Manager document. The location for an Amazon S3 bucket must start with `https://`. Conditional: You must specify only one of the following parameters: `TemplateBody` or `TemplateURL`—or set `UsePreviousTemplate` to true.
`UsePreviousTemplate`	`boolean \| undefined`	Use the existing template that's associated with the stack set that you're updating. Conditional: You must specify only one of the following parameters: `TemplateBody` or `TemplateURL`—or set `UsePreviousTemplate` to true.

UpdateStackSetCommand Output

See UpdateStackSetCommandOutput for details

Parameter	Type	Description
`$metadata` Required	`ResponseMetadata`	Metadata pertaining to this request.
`OperationId`	`string \| undefined`	The unique ID for this stack set operation.

Throws

Name	Fault	Details
InvalidOperationException	client	The specified operation isn't valid.
OperationIdAlreadyExistsException	client	The specified operation ID already exists.
OperationInProgressException	client	Another operation is currently in progress for this stack set. Only one operation can be performed for a stack set at a given time.
StackInstanceNotFoundException	client	The specified stack instance doesn't exist.
StackSetNotFoundException	client	The specified stack set doesn't exist.
StaleRequestException	client	Another operation has been performed on this stack set since the specified operation was performed.
CloudFormationServiceException		Base exception class for all service exceptions from CloudFormation service.

Getting Started

References

UpdateStackSetCommand

Example Syntax

UpdateStackSetCommand Input

UpdateStackSetCommand Output

Throws

Table of Contents

Search