<a id="cli-aws-cloudformation-update-stack-instances"></a>

# update-stack-instances

## Description

Updates the parameter values for stack instances for the specified accounts, within the specified Amazon Web Services Regions. A stack instance refers to a stack in a specific account and Region.

You can only update stack instances in Amazon Web Services Regions and accounts where they already exist; to create additional stack instances, use [CreateStackInstances](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CreateStackInstances.html) .

During StackSet updates, any parameters overridden for a stack instance aren’t updated, but retain their overridden value.

You can only update the parameter *values* that are specified in the StackSet. To add or delete a parameter itself, use [UpdateStackSet](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html) to update the StackSet template. If you add a parameter to a template, before you can override the parameter value specified in the StackSet you must first use [UpdateStackSet](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html) to update all stack instances with the updated template and parameter value specified in the StackSet. Once a stack instance has been updated with the new parameter, you can then override the parameter value using `UpdateStackInstances` .

#### NOTE
The maximum number of organizational unit (OUs) supported by a `UpdateStackInstances` operation is 50.

If you need more than 50, consider the following options:

* *Batch processing:* If you don’t want to expose your OU hierarchy, split up the operations into multiple calls with less than 50 OUs each.
* *Parent OU strategy:* If you don’t mind exposing the OU hierarchy, target a parent OU that contains all desired child OUs.

See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/UpdateStackInstances)

## Synopsis

```
  update-stack-instances
--stack-set-name <value>
[--accounts <value>]
[--deployment-targets <value>]
--regions <value>
[--parameter-overrides <value>]
[--operation-preferences <value>]
[--operation-id <value>]
[--call-as <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]
[--help]
```

## Options

`--stack-set-name` (string) [required]

> The name or unique ID of the StackSet associated with the stack instances.

> Constraints:

> * pattern: `[a-zA-Z][-a-zA-Z0-9]*(?::[a-zA-Z0-9]{8}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{12})?`

`--accounts` (list)

> [Self-managed permissions] The account IDs of one or more Amazon Web Services accounts in which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and Amazon Web Services Regions.

> You can specify `Accounts` or `DeploymentTargets` , but not both.

> (string)

> > Constraints:

> > * pattern: `^[0-9]{12}$`

Syntax:

```
"string" "string" ...
```

`--deployment-targets` (structure)

> [Service-managed permissions] The Organizations accounts in which you want to update parameter values for stack instances. If your update targets OUs, the overridden parameter values only apply to the accounts that are currently in the target OUs and their child OUs. Accounts added to the target OUs and their child OUs in the future won’t use the overridden values.

> You can specify `Accounts` or `DeploymentTargets` , but not both.

> Accounts -> (list)

> > The Amazon Web Services account IDs where you want to perform stack operations. How these accounts are used depends on the `AccountFilterType` property.

> > If you have many account numbers, you can provide those accounts using the `AccountsUrl` property instead.

> > (string)

> > > Constraints:

> > > * pattern: `^[0-9]{12}$`

> AccountsUrl -> (string)

> > The Amazon S3 URL path to a file that contains a list of Amazon Web Services account IDs. The file format must be either `.csv` or `.txt` , and the data can be comma-separated or new-line-separated. There is currently a 10MB limit for the data (approximately 800,000 accounts).

> > This property serves the same purpose as `Accounts` but allows you to specify a large number of accounts.

> > Constraints:

> > * min: `1`
> > * max: `5120`
> > * pattern: `(s3://|http(s?)://).+`

> OrganizationalUnitIds -> (list)

> > The organization root ID or organizational unit (OU) IDs where you want to perform stack operations. CloudFormation will perform operations on accounts within these OUs and their child OUs.

> > (string)

> > > Constraints:

> > > * pattern: `^(ou-[a-z0-9]{4,32}-[a-z0-9]{8,32}|r-[a-z0-9]{4,32})$`

> AccountFilterType -> (string)

> > Refines which accounts will have stack operations performed on them by specifying how to use the `Accounts` and `OrganizationalUnitIds` properties together.

> > The following values determine how CloudFormation selects target accounts:

> > * `INTERSECTION` : Performs stack operations only on specific individual accounts within the selected OUs. Only accounts that are both specified in the `Accounts` property and belong to the specified OUs will be targeted.
> > * `DIFFERENCE` : Performs stack operations on all accounts in the selected OUs except for specific accounts listed in the `Accounts` property. This enables you to exclude certain accounts within an OU, such as suspended accounts.
> > * `UNION` : Performs stack operations on the specified OUs plus additional individual accounts listed in the `Accounts` property. This is the default value if `AccountFilterType` is not provided. This lets you target an entire OU and individual accounts from a different OU in one request. Note that `UNION` is not supported for `CreateStackInstances` operations.
> > * `NONE` : Performs stack operations on all accounts in the specified organizational units (OUs).

> > Possible values:

> > * `NONE`
> > * `INTERSECTION`
> > * `DIFFERENCE`
> > * `UNION`

Shorthand Syntax:

```
Accounts=string,string,AccountsUrl=string,OrganizationalUnitIds=string,string,AccountFilterType=string
```

JSON Syntax:

```json
{
  "Accounts": ["string", ...],
  "AccountsUrl": "string",
  "OrganizationalUnitIds": ["string", ...],
  "AccountFilterType": "NONE"|"INTERSECTION"|"DIFFERENCE"|"UNION"
}
```

`--regions` (list) [required]

> The names of one or more Amazon Web Services Regions in which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and Amazon Web Services Regions.

> (string)

> > Constraints:

> > * pattern: `^[a-zA-Z0-9-]{1,128}$`

Syntax:

```
"string" "string" ...
```

`--parameter-overrides` (list)

> A list of input parameters whose values you want to update for the specified stack instances.

> Any overridden parameter values will be applied to all stack instances in the specified accounts and Amazon Web Services Regions. When specifying parameters and their values, be aware of how CloudFormation sets parameter values during stack instance update operations:

> * To override the current value for a parameter, include the parameter and specify its value.
> * To leave an overridden parameter set to its present value, include the parameter and specify `UsePreviousValue` as `true` . (You can’t specify both a value and set `UsePreviousValue` to `true` .)
> * To set an overridden parameter back to the value specified in the StackSet, specify a parameter list but don’t include the parameter in the list.
> * To leave all parameters set to their present values, don’t specify this property at all.

> During StackSet updates, any parameter values overridden for a stack instance aren’t updated, but retain their overridden value.

> You can only override the parameter *values* that are specified in the StackSet. To add or delete a parameter itself, use `UpdateStackSet` to update the StackSet template. If you add a parameter to a template, before you can override the parameter value specified in the StackSet you must first use [UpdateStackSet](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html) to update all stack instances with the updated template and parameter value specified in the StackSet. Once a stack instance has been updated with the new parameter, you can then override the parameter value using `UpdateStackInstances` .

> (structure)

> > The `Parameter` data type.

> > ParameterKey -> (string)

> > > The key associated with the parameter. If you don’t specify a key and value for a particular parameter, CloudFormation uses the default value that’s specified in your template.

> > ParameterValue -> (string)

> > > The input value associated with the parameter.

> > UsePreviousValue -> (boolean)

> > > During a stack update, use the existing parameter value that the stack is using for a given parameter key. If you specify `true` , do not specify a parameter value.

> > ResolvedValue -> (string)

> > > Read-only. The value that corresponds to a Systems Manager parameter key. This field is returned only for Systems Manager parameter types in the template. For more information, see [Specify existing resources at runtime with CloudFormation-supplied parameter types](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-supplied-parameter-types.html) in the *CloudFormation User Guide* .

Shorthand Syntax:

```
ParameterKey=string,ParameterValue=string,UsePreviousValue=boolean,ResolvedValue=string ...
```

JSON Syntax:

```json
[
  {
    "ParameterKey": "string",
    "ParameterValue": "string",
    "UsePreviousValue": true|false,
    "ResolvedValue": "string"
  }
  ...
]
```

`--operation-preferences` (structure)

> Preferences for how CloudFormation performs this StackSet operation.

> RegionConcurrencyType -> (string)

> > The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time.

> > Possible values:

> > * `SEQUENTIAL`
> > * `PARALLEL`

> RegionOrder -> (list)

> > The order of the Regions where you want to perform the stack operation.

> > (string)

> > > Constraints:

> > > * pattern: `^[a-zA-Z0-9-]{1,128}$`

> FailureToleranceCount -> (integer)

> > The number of accounts per Region this operation can fail in before CloudFormation stops the operation in that Region. If the operation is stopped in a Region, CloudFormation doesn’t attempt the operation in any subsequent Regions.

> > You can specify either `FailureToleranceCount` or `FailureTolerancePercentage` , but not both.

> > By default, `0` is specified.

> > Constraints:

> > * min: `0`

> FailureTolerancePercentage -> (integer)

> > The percentage of accounts per Region this stack operation can fail in before CloudFormation stops the operation in that Region. If the operation is stopped in a Region, CloudFormation doesn’t attempt the operation in any subsequent Regions.

> > When calculating the number of accounts based on the specified percentage, CloudFormation rounds *down* to the next whole number.

> > You can specify either `FailureToleranceCount` or `FailureTolerancePercentage` , but not both.

> > By default, `0` is specified.

> > Constraints:

> > * min: `0`
> > * max: `100`

> MaxConcurrentCount -> (integer)

> > The maximum number of accounts in which to perform this operation at one time. This can depend on the value of `FailureToleranceCount` depending on your `ConcurrencyMode` . `MaxConcurrentCount` is at most one more than the `FailureToleranceCount` if you’re using `STRICT_FAILURE_TOLERANCE` .

> > Note that this setting lets you specify the *maximum* for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

> > You can specify either `MaxConcurrentCount` or `MaxConcurrentPercentage` , but not both.

> > By default, `1` is specified.

> > Constraints:

> > * min: `1`

> MaxConcurrentPercentage -> (integer)

> > The maximum percentage of accounts in which to perform this operation at one time.

> > When calculating the number of accounts based on the specified percentage, CloudFormation rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, CloudFormation sets the number as one instead.

> > Note that this setting lets you specify the *maximum* for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

> > You can specify either `MaxConcurrentCount` or `MaxConcurrentPercentage` , but not both.

> > By default, `1` is specified.

> > Constraints:

> > * min: `1`
> > * max: `100`

> ConcurrencyMode -> (string)

> > Specifies how the concurrency level behaves during the operation execution.

> > * `STRICT_FAILURE_TOLERANCE` : This option dynamically lowers the concurrency level to ensure the number of failed accounts never exceeds the value of `FailureToleranceCount` +1. The initial actual concurrency is set to the lower of either the value of the `MaxConcurrentCount` , or the value of `FailureToleranceCount` +1. The actual concurrency is then reduced proportionally by the number of failures. This is the default behavior. If failure tolerance or Maximum concurrent accounts are set to percentages, the behavior is similar.
> > * `SOFT_FAILURE_TOLERANCE` : This option decouples `FailureToleranceCount` from the actual concurrency. This allows StackSet operations to run at the concurrency level set by the `MaxConcurrentCount` value, or `MaxConcurrentPercentage` , regardless of the number of failures.

> > Possible values:

> > * `STRICT_FAILURE_TOLERANCE`
> > * `SOFT_FAILURE_TOLERANCE`

Shorthand Syntax:

```
RegionConcurrencyType=string,RegionOrder=string,string,FailureToleranceCount=integer,FailureTolerancePercentage=integer,MaxConcurrentCount=integer,MaxConcurrentPercentage=integer,ConcurrencyMode=string
```

JSON Syntax:

```json
{
  "RegionConcurrencyType": "SEQUENTIAL"|"PARALLEL",
  "RegionOrder": ["string", ...],
  "FailureToleranceCount": integer,
  "FailureTolerancePercentage": integer,
  "MaxConcurrentCount": integer,
  "MaxConcurrentPercentage": integer,
  "ConcurrencyMode": "STRICT_FAILURE_TOLERANCE"|"SOFT_FAILURE_TOLERANCE"
}
```

`--operation-id` (string)

> The unique identifier for this StackSet operation.

> The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the StackSet operation only once, even if you retry the request multiple times. You might retry StackSet operation requests to ensure that CloudFormation successfully received them.

> If you don’t specify an operation ID, the SDK generates one automatically.

> Constraints:

> * min: `1`
> * max: `128`
> * pattern: `[a-zA-Z0-9][-a-zA-Z0-9]*`

`--call-as` (string)

> [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 StackSets 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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) in the *CloudFormation User Guide* .

> Possible values:

> * `SELF`
> * `DELEGATED_ADMIN`

`--cli-input-json` | `--cli-input-yaml` (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by `--generate-cli-skeleton`. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with `--cli-input-yaml`.

`--generate-cli-skeleton` (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value `input`, prints a sample input JSON that can be used as an argument for `--cli-input-json`. Similarly, if provided `yaml-input` it will print a sample input YAML that can be used with `--cli-input-yaml`. If provided with the value `output`, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

## Global Options

`--debug` (boolean)

Turn on debug logging.

`--endpoint-url` (string)

Override command’s default URL with the given URL.

`--no-verify-ssl` (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

`--no-paginate` (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

`--output` (string)

The formatting style for command output.

* json
* text
* table
* yaml
* yaml-stream
* off

`--query` (string)

A JMESPath query to use in filtering the response data.

`--profile` (string)

Use a specific profile from your credential file.

`--region` (string)

The region to use. Overrides config/env settings.

`--version` (string)

Display the version of this tool.

`--color` (string)

Turn on/off color output.

* on
* off
* auto

`--no-sign-request` (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

`--ca-bundle` (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

`--cli-read-timeout` (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

`--cli-connect-timeout` (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

`--cli-binary-format` (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob `fileb://` will always be treated as binary and use the file contents directly regardless of the `cli-binary-format` setting. When using `file://` the file contents will need to properly formatted for the configured `cli-binary-format`.

* base64
* raw-in-base64-out

`--no-cli-pager` (boolean)

Disable cli pager for output.

`--cli-auto-prompt` (boolean)

Automatically prompt for CLI input parameters.

`--no-cli-auto-prompt` (boolean)

Disable automatically prompt for CLI input parameters.

`--cli-error-format` (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

* legacy
* json
* yaml
* text
* table
* enhanced

`--help` (boolean)

Display help for the command/subcommand.

## Examples

#### NOTE
To use the following examples, you must have the AWS CLI installed and configured. See the [Getting started guide](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html) in the *AWS CLI User Guide* for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See [Using quotation marks with strings](https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-quoting-strings.html) in the *AWS CLI User Guide* .

**To update stack instances**

The following `update-stack-instances` example retries an update on stack instances in two accounts in two regions with the most recent settings. The specified fault tolerance setting ensures that the update is attempted in all accounts and regions, even if some stacks cannot be updated.

```bash
aws cloudformation update-stack-instances \
    --stack-set-name my-stack-set \
    --accounts 123456789012 123456789111 \
    --regions us-east-1 us-west-2 \
    --operation-preferences FailureToleranceCount=3
```

Output:

```json
{
    "OperationId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
}
```

For more information, see [Update CloudFormation StackSets](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-update.html) in the *AWS CloudFormation User Guide*.

## Output

OperationId -> (string)

> The unique identifier for this StackSet operation.

> Constraints:

> * min: `1`
> * max: `128`
> * pattern: `[a-zA-Z0-9][-a-zA-Z0-9]*`