You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::CloudFormation::Types::DeleteStackInstancesInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::CloudFormation::Types::DeleteStackInstancesInput
- Defined in:
- (unknown)
Overview
When passing DeleteStackInstancesInput as input to an Aws::Client method, you can use a vanilla Hash:
{
stack_set_name: "StackSetName", # required
accounts: ["Account"],
deployment_targets: {
accounts: ["Account"],
organizational_unit_ids: ["OrganizationalUnitId"],
},
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",
}
Instance Attribute Summary collapse
-
#accounts ⇒ Array<String>
[
Self-managed
permissions] The names of the AWS accounts that you want to delete stack instances for. -
#deployment_targets ⇒ Types::DeploymentTargets
[
Service-managed
permissions] The AWS Organizations accounts from which to delete stack instances. -
#operation_id ⇒ String
The unique identifier for this stack set operation.
-
#operation_preferences ⇒ Types::StackSetOperationPreferences
Preferences for how AWS CloudFormation performs this stack set operation.
-
#regions ⇒ Array<String>
The Regions where you want to delete stack set instances.
-
#retain_stacks ⇒ Boolean
Removes the stack instances from the specified stack set, but doesn\'t delete the stacks.
-
#stack_set_name ⇒ String
The name or unique ID of the stack set that you want to delete stack instances for.
Instance Attribute Details
#accounts ⇒ Array<String>
[Self-managed
permissions] The names of the AWS accounts that you
want to delete stack instances for.
You can specify Accounts
or DeploymentTargets
, but not both.
#deployment_targets ⇒ Types::DeploymentTargets
[Service-managed
permissions] The AWS Organizations accounts from
which to delete stack instances.
You can specify Accounts
or DeploymentTargets
, but not both.
#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
.
#operation_preferences ⇒ Types::StackSetOperationPreferences
Preferences for how AWS CloudFormation performs this stack set operation.
#regions ⇒ Array<String>
The Regions where you want to delete stack set instances.
#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.
#stack_set_name ⇒ String
The name or unique ID of the stack set that you want to delete stack instances for.