You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cloudformation/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"], # required
  regions: ["Region"], # required
  parameter_overrides: [
    {
      parameter_key: "ParameterKey",
      parameter_value: "ParameterValue",
      use_previous_value: false,
      resolved_value: "ParameterValue",
    },
  ],
  operation_preferences: {
    region_order: ["Region"],
    failure_tolerance_count: 1,
    failure_tolerance_percentage: 1,
    max_concurrent_count: 1,
    max_concurrent_percentage: 1,
  },
  operation_id: "ClientRequestToken",
}

Instance Attribute Summary collapse

Instance Attribute Details

#accountsArray<String>

The names of one or more AWS accounts that you want to create stack instances in the specified region(s) for.

Returns:

  • (Array<String>)


966
967
968
969
970
971
972
973
974
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 966

class CreateStackInstancesInput < Struct.new(
  :stack_set_name,
  :accounts,
  :regions,
  :parameter_overrides,
  :operation_preferences,
  :operation_id)
  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 AWS 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 AWS 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)


966
967
968
969
970
971
972
973
974
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 966

class CreateStackInstancesInput < Struct.new(
  :stack_set_name,
  :accounts,
  :regions,
  :parameter_overrides,
  :operation_preferences,
  :operation_id)
  include Aws::Structure
end

#operation_preferencesTypes::StackSetOperationPreferences

Preferences for how AWS CloudFormation performs this stack set operation.



966
967
968
969
970
971
972
973
974
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 966

class CreateStackInstancesInput < Struct.new(
  :stack_set_name,
  :accounts,
  :regions,
  :parameter_overrides,
  :operation_preferences,
  :operation_id)
  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 AWS 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 a parameter set to its present value, you can do one of the following:

    • Do not include the parameter in the list.

    • Include the parameter and specify UsePreviousValue as true. (You cannot specify both a value and set UsePreviousValue to true.)

  • To set all overridden parameter back to the values specified in the stack set, specify a parameter list but do not include any parameters.

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

Returns:



966
967
968
969
970
971
972
973
974
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 966

class CreateStackInstancesInput < Struct.new(
  :stack_set_name,
  :accounts,
  :regions,
  :parameter_overrides,
  :operation_preferences,
  :operation_id)
  include Aws::Structure
end

#regionsArray<String>

The names of one or more regions where you want to create stack instances using the specified AWS account(s).

Returns:

  • (Array<String>)


966
967
968
969
970
971
972
973
974
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 966

class CreateStackInstancesInput < Struct.new(
  :stack_set_name,
  :accounts,
  :regions,
  :parameter_overrides,
  :operation_preferences,
  :operation_id)
  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)


966
967
968
969
970
971
972
973
974
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 966

class CreateStackInstancesInput < Struct.new(
  :stack_set_name,
  :accounts,
  :regions,
  :parameter_overrides,
  :operation_preferences,
  :operation_id)
  include Aws::Structure
end