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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cloudformation/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#accounts ⇒ Array<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>) 


2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 2059

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_as ⇒ String

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

Returns:

  • (String) 


2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 2059

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_targets ⇒ Types::DeploymentTargets

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

You can specify ‘Accounts` or `DeploymentTargets`, but not both.

Returns:



2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 2059

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


2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 2059

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_preferences ⇒ Types::StackSetOperationPreferences

Preferences for how CloudFormation performs this stack set operation.

Returns:



2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 2059

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

#regions ⇒ Array<String>

The Amazon Web Services Regions where you want to delete stack set instances.

Returns:

  • (Array<String>) 


2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 2059

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_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/what-is-cfnstacksets.html#stackset-ops-options

Returns:

  • (Boolean) 


2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 2059

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_name ⇒ String

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

Returns:

  • (String) 


2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 2059

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