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

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#accountsArray<String>

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

Returns:

  • (Array<String>)


2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2055

class DeleteStackInstancesInput < Struct.new(
  :stack_set_name,
  :accounts,
  :deployment_targets,
  :regions,
  :operation_preferences,
  :retain_stacks,
  :operation_id,
  :call_as)
  SENSITIVE = []
  include Aws::Structure
end

#call_asString

[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 in the CloudFormation User Guide.

Returns:

  • (String)


2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2055

class DeleteStackInstancesInput < Struct.new(
  :stack_set_name,
  :accounts,
  :deployment_targets,
  :regions,
  :operation_preferences,
  :retain_stacks,
  :operation_id,
  :call_as)
  SENSITIVE = []
  include Aws::Structure
end

#deployment_targetsTypes::DeploymentTargets

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

You can specify Accounts or DeploymentTargets, but not both.



2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2055

class DeleteStackInstancesInput < Struct.new(
  :stack_set_name,
  :accounts,
  :deployment_targets,
  :regions,
  :operation_preferences,
  :retain_stacks,
  :operation_id,
  :call_as)
  SENSITIVE = []
  include Aws::Structure
end

#operation_idString

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.

Returns:

  • (String)


2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2055

class DeleteStackInstancesInput < Struct.new(
  :stack_set_name,
  :accounts,
  :deployment_targets,
  :regions,
  :operation_preferences,
  :retain_stacks,
  :operation_id,
  :call_as)
  SENSITIVE = []
  include Aws::Structure
end

#operation_preferencesTypes::StackSetOperationPreferences

Preferences for how CloudFormation performs this stack set operation.



2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2055

class DeleteStackInstancesInput < Struct.new(
  :stack_set_name,
  :accounts,
  :deployment_targets,
  :regions,
  :operation_preferences,
  :retain_stacks,
  :operation_id,
  :call_as)
  SENSITIVE = []
  include Aws::Structure
end

#regionsArray<String>

The Regions where you want to delete stack set instances.

Returns:

  • (Array<String>)


2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2055

class DeleteStackInstancesInput < Struct.new(
  :stack_set_name,
  :accounts,
  :deployment_targets,
  :regions,
  :operation_preferences,
  :retain_stacks,
  :operation_id,
  :call_as)
  SENSITIVE = []
  include Aws::Structure
end

#retain_stacksBoolean

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.

Returns:

  • (Boolean)


2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2055

class DeleteStackInstancesInput < Struct.new(
  :stack_set_name,
  :accounts,
  :deployment_targets,
  :regions,
  :operation_preferences,
  :retain_stacks,
  :operation_id,
  :call_as)
  SENSITIVE = []
  include Aws::Structure
end

#stack_set_nameString

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

Returns:

  • (String)


2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2055

class DeleteStackInstancesInput < Struct.new(
  :stack_set_name,
  :accounts,
  :deployment_targets,
  :regions,
  :operation_preferences,
  :retain_stacks,
  :operation_id,
  :call_as)
  SENSITIVE = []
  include Aws::Structure
end