[ aws . cloudformation ]

create-stack-instances

Description

Creates 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 must specify at least one value for either Accounts or DeploymentTargets , and you must specify at least one value for Regions .

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-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>]

Options

--stack-set-name (string)

The name or unique ID of the stack set that you want to create stack instances from.

--accounts (list)

[Self-managed permissions] The names of one or more Amazon Web Services accounts that you want to create stack instances in the specified Region(s) for.

You can specify Accounts or DeploymentTargets , but not both.

(string)

Syntax:

"string" "string" ...

--deployment-targets (structure)

[Service-managed permissions] The Organizations accounts for which to create stack instances in the specified Amazon Web Services Regions.

You can specify Accounts or DeploymentTargets , but not both.

Accounts -> (list)

The names of one or more Amazon Web Services accounts for which you want to deploy stack set updates.

(string)

AccountsUrl -> (string)

Returns the value of the AccountsUrl property.

OrganizationalUnitIds -> (list)

The organization root ID or organizational unit (OU) IDs to which StackSets deploys.

(string)

Shorthand Syntax:

Accounts=string,string,AccountsUrl=string,OrganizationalUnitIds=string,string

JSON Syntax:

{
  "Accounts": ["string", ...],
  "AccountsUrl": "string",
  "OrganizationalUnitIds": ["string", ...]
}

--regions (list)

The names of one or more Amazon Web Services Regions where you want to create stack instances using the specified Amazon Web Services accounts.

(string)

Syntax:

"string" "string" ...

--parameter-overrides (list)

A list of stack set parameters whose values you want to override in the selected 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 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 stack set, 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 stack set 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 stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template.

(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 SSM parameter key. This field is returned only for ` SSM https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html#aws-ssm-parameter-types`__ parameter types in the template.

Shorthand Syntax:

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

JSON Syntax:

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

--operation-preferences (structure)

Preferences for how CloudFormation performs this stack set operation.

RegionConcurrencyType -> (string)

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

RegionOrder -> (list)

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

(string)

FailureToleranceCount -> (integer)

The number of accounts, per Region, for which this operation can fail 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.

Conditional: You must specify either FailureToleranceCount or FailureTolerancePercentage (but not both).

By default, 0 is specified.

FailureTolerancePercentage -> (integer)

The percentage of accounts, per Region, for which this stack operation can fail 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.

Conditional: You must specify either FailureToleranceCount or FailureTolerancePercentage , but not both.

By default, 0 is specified.

MaxConcurrentCount -> (integer)

The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of FailureToleranceCount .``MaxConcurrentCount`` is at most one more than the FailureToleranceCount .

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.

Conditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage , but not both.

By default, 1 is specified.

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.

Conditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage , but not both.

By default, 1 is specified.

Shorthand Syntax:

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

JSON Syntax:

{
  "RegionConcurrencyType": "SEQUENTIAL"|"PARALLEL",
  "RegionOrder": ["string", ...],
  "FailureToleranceCount": integer,
  "FailureTolerancePercentage": integer,
  "MaxConcurrentCount": integer,
  "MaxConcurrentPercentage": integer
}

--operation-id (string)

The unique identifier 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, the SDK generates one automatically.

Repeating this stack set operation with a new operation ID retries all stack instances whose status is OUTDATED .

--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 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 .

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.

See ‘aws help’ for descriptions of global parameters.

Examples

To create stack instances

The following create-stack-instances example creates instances of a stack set in two accounts and in four regions. The fault tolerance setting ensures that the update is attempted in all accounts and regions, even if some stacks cannot be created.

aws cloudformation create-stack-instances \
    --stack-set-name my-stack-set \
    --accounts 123456789012 223456789012 \
    --regions us-east-1 us-east-2 us-west-1 us-west-2 \
    --operation-preferences FailureToleranceCount=7

Output:

{
    "OperationId": "d7995c31-83c2-xmpl-a3d4-e9ca2811563f"
}

To create a stack set, use the create-stack-set command.

Output

OperationId -> (string)

The unique identifier for this stack set operation.