class Aws::CloudFormation::Types::DeleteStackInstancesInput

@note When making an API call, you may pass DeleteStackInstancesInput

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
      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,
      },
      retain_stacks: false, # required
      operation_id: "ClientRequestToken",
      call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
    }

@!attribute [rw] stack_set_name

The name or unique ID of the stack set that you want to delete stack
instances for.
@return [String]

@!attribute [rw] accounts

\[Self-managed permissions\] The names of the Amazon Web Services
accounts that you want to delete stack instances for.

You can specify `Accounts` or `DeploymentTargets`, but not both.
@return [Array<String>]

@!attribute [rw] deployment_targets

\[Service-managed permissions\] The Organizations accounts from
which to delete stack instances.

You can specify `Accounts` or `DeploymentTargets`, but not both.
@return [Types::DeploymentTargets]

@!attribute [rw] regions

The Amazon Web Services Regions where you want to delete stack set
instances.
@return [Array<String>]

@!attribute [rw] operation_preferences

Preferences for how CloudFormation performs this stack set
operation.
@return [Types::StackSetOperationPreferences]

@!attribute [rw] retain_stacks

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

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

@!attribute [rw] operation_id

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 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 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.
@return [String]

@!attribute [rw] call_as

\[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]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DeleteStackInstancesInput AWS API Documentation

Constants

SENSITIVE