Class: Aws::CloudFormation::Types::DeleteStackInstancesInput

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 DeleteStackInstancesInput 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,
  },
  retain_stacks: false, # required
  operation_id: "ClientRequestToken",
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#accounts ⇒ Array<String>

The names of the AWS accounts that you want to delete stack instances for.

Returns:

  • (Array<String>) 


1551
1552
1553
1554
1555
1556
1557
1558
1559
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 1551

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

#operation_id ⇒ String

The unique identifier for this stack set operation.

If you don’t specify an operation ID, the SDK generates one automatically.

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 can retry stack set operation requests to ensure that AWS CloudFormation successfully received them.

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) 


1551
1552
1553
1554
1555
1556
1557
1558
1559
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 1551

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

#operation_preferences ⇒ Types::StackSetOperationPreferences

Preferences for how AWS CloudFormation performs this stack set operation.

Returns:



1551
1552
1553
1554
1555
1556
1557
1558
1559
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 1551

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

#regions ⇒ Array<String>

The regions where you want to delete stack set instances.

Returns:

  • (Array<String>) 


1551
1552
1553
1554
1555
1556
1557
1558
1559
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 1551

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

#retain_stacks ⇒ Boolean

Removes the stack instances from the specified stack set, but doesn’t delete the stacks. You can’t reassociate a retained stack or add an existing, saved stack to a new stack set.

For more information, see [Stack set operation options].

[1]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options

Returns:

  • (Boolean) 


1551
1552
1553
1554
1555
1556
1557
1558
1559
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 1551

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

#stack_set_name ⇒ String

The name or unique ID of the stack set that you want to delete stack instances for.

Returns:

  • (String) 


1551
1552
1553
1554
1555
1556
1557
1558
1559
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 1551

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