Skip to content

Create Stack Instances

cloudformation_create_stack_instances R Documentation

Creates stack instances for the specified accounts, within the specified Amazon Web Services Regions

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.

Usage

cloudformation_create_stack_instances(StackSetName, Accounts,
  DeploymentTargets, Regions, ParameterOverrides, OperationPreferences,
  OperationId, CallAs)

Arguments

StackSetName

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

Accounts

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

DeploymentTargets

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

Regions

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

ParameterOverrides

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 update_stack_set to update the stack set template.

OperationPreferences

Preferences for how CloudFormation performs this stack set operation.

OperationId

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.

CallAs

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

Value

A list with the following syntax: 

list(
  OperationId = "string"
)

Request syntax

svc$create_stack_instances(
  StackSetName = "string",
  Accounts = list(
    "string"
  ),
  DeploymentTargets = list(
    Accounts = list(
      "string"
    ),
    AccountsUrl = "string",
    OrganizationalUnitIds = list(
      "string"
    ),
    AccountFilterType = "NONE"|"INTERSECTION"|"DIFFERENCE"|"UNION"
  ),
  Regions = list(
    "string"
  ),
  ParameterOverrides = list(
    list(
      ParameterKey = "string",
      ParameterValue = "string",
      UsePreviousValue = TRUE|FALSE,
      ResolvedValue = "string"
    )
  ),
  OperationPreferences = list(
    RegionConcurrencyType = "SEQUENTIAL"|"PARALLEL",
    RegionOrder = list(
      "string"
    ),
    FailureToleranceCount = 123,
    FailureTolerancePercentage = 123,
    MaxConcurrentCount = 123,
    MaxConcurrentPercentage = 123,
    ConcurrencyMode = "STRICT_FAILURE_TOLERANCE"|"SOFT_FAILURE_TOLERANCE"
  ),
  OperationId = "string",
  CallAs = "SELF"|"DELEGATED_ADMIN"
)