Class: Aws::CloudFormation::Types::CreateStackInstancesInput

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cloudformation/types.rb

Overview

Note:

When making an API call, you may pass CreateStackInstancesInput data as a hash:

{
  stack_set_name: "StackSetName", # required
  accounts: ["Account"],
  deployment_targets: {
    accounts: ["Account"],
    accounts_url: "AccountsUrl",
    organizational_unit_ids: ["OrganizationalUnitId"],
  },
  regions: ["Region"], # required
  parameter_overrides: [
    {
      parameter_key: "ParameterKey",
      parameter_value: "ParameterValue",
      use_previous_value: false,
      resolved_value: "ParameterValue",
    },
  ],
  operation_preferences: {
    region_concurrency_type: "SEQUENTIAL", # accepts SEQUENTIAL, PARALLEL
    region_order: ["Region"],
    failure_tolerance_count: 1,
    failure_tolerance_percentage: 1,
    max_concurrent_count: 1,
    max_concurrent_percentage: 1,
  },
  operation_id: "ClientRequestToken",
  call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#accountsArray<String>

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

Returns:

  • (Array<String>)

1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
# File 'lib/aws-sdk-cloudformation/types.rb', line 1431

class CreateStackInstancesInput < Struct.new(
  :stack_set_name,
  :accounts,
  :deployment_targets,
  :regions,
  :parameter_overrides,
  :operation_preferences,
  :operation_id,
  :call_as)
  SENSITIVE = []
  include Aws::Structure
end

#call_asString

[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][1

    in the *CloudFormation

    User Guide*.

[1]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html

Returns:

  • (String)

1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
# File 'lib/aws-sdk-cloudformation/types.rb', line 1431

class CreateStackInstancesInput < Struct.new(
  :stack_set_name,
  :accounts,
  :deployment_targets,
  :regions,
  :parameter_overrides,
  :operation_preferences,
  :operation_id,
  :call_as)
  SENSITIVE = []
  include Aws::Structure
end

#deployment_targetsTypes::DeploymentTargets

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

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


1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
# File 'lib/aws-sdk-cloudformation/types.rb', line 1431

class CreateStackInstancesInput < Struct.new(
  :stack_set_name,
  :accounts,
  :deployment_targets,
  :regions,
  :parameter_overrides,
  :operation_preferences,
  :operation_id,
  :call_as)
  SENSITIVE = []
  include Aws::Structure
end

#operation_idString

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

**A suitable default value is auto-generated.** You should normally not need to pass this option.

Returns:

  • (String)

1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
# File 'lib/aws-sdk-cloudformation/types.rb', line 1431

class CreateStackInstancesInput < Struct.new(
  :stack_set_name,
  :accounts,
  :deployment_targets,
  :regions,
  :parameter_overrides,
  :operation_preferences,
  :operation_id,
  :call_as)
  SENSITIVE = []
  include Aws::Structure
end

#operation_preferencesTypes::StackSetOperationPreferences

Preferences for how CloudFormation performs this stack set operation.


1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
# File 'lib/aws-sdk-cloudformation/types.rb', line 1431

class CreateStackInstancesInput < Struct.new(
  :stack_set_name,
  :accounts,
  :deployment_targets,
  :regions,
  :parameter_overrides,
  :operation_preferences,
  :operation_id,
  :call_as)
  SENSITIVE = []
  include Aws::Structure
end

#parameter_overridesArray<Types::Parameter>

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 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 cannot 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 do not include the parameter in the list.

  • To leave all parameters set to their present values, do not specify this property at all.

During stack set updates, any parameter values overridden for a stack instance are not 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][1

to update the stack set template.

[1]: docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html

Returns:


1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
# File 'lib/aws-sdk-cloudformation/types.rb', line 1431

class CreateStackInstancesInput < Struct.new(
  :stack_set_name,
  :accounts,
  :deployment_targets,
  :regions,
  :parameter_overrides,
  :operation_preferences,
  :operation_id,
  :call_as)
  SENSITIVE = []
  include Aws::Structure
end

#regionsArray<String>

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

Returns:

  • (Array<String>)

1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
# File 'lib/aws-sdk-cloudformation/types.rb', line 1431

class CreateStackInstancesInput < Struct.new(
  :stack_set_name,
  :accounts,
  :deployment_targets,
  :regions,
  :parameter_overrides,
  :operation_preferences,
  :operation_id,
  :call_as)
  SENSITIVE = []
  include Aws::Structure
end

#stack_set_nameString

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

Returns:

  • (String)

1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
# File 'lib/aws-sdk-cloudformation/types.rb', line 1431

class CreateStackInstancesInput < Struct.new(
  :stack_set_name,
  :accounts,
  :deployment_targets,
  :regions,
  :parameter_overrides,
  :operation_preferences,
  :operation_id,
  :call_as)
  SENSITIVE = []
  include Aws::Structure
end