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


843
844
845
846
847
848
849
850
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 843

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


843
844
845
846
847
848
849
850
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 843

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

#operation_preferencesTypes::StackSetOperationPreferences

Preferences for how AWS CloudFormation performs this stack set operation.



843
844
845
846
847
848
849
850
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 843

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


843
844
845
846
847
848
849
850
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 843

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


843
844
845
846
847
848
849
850
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 843

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