Skip to content

Delete Stack Instances

cloudformation_delete_stack_instances R Documentation

Deletes stack instances for the specified accounts, in the specified Amazon Web Services Regions

Description

Deletes stack instances for the specified accounts, in the specified Amazon Web Services Regions.

Usage

cloudformation_delete_stack_instances(StackSetName, Accounts,
  DeploymentTargets, Regions, OperationPreferences, RetainStacks,
  OperationId, CallAs)

Arguments

StackSetName

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

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.

DeploymentTargets

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

You can specify Accounts or DeploymentTargets, but not both.

Regions

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

OperationPreferences

Preferences for how CloudFormation performs this stack set operation.

RetainStacks

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

OperationId

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.

CallAs

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

Value

A list with the following syntax: 

list(
  OperationId = "string"
)

Request syntax

svc$delete_stack_instances(
  StackSetName = "string",
  Accounts = list(
    "string"
  ),
  DeploymentTargets = list(
    Accounts = list(
      "string"
    ),
    AccountsUrl = "string",
    OrganizationalUnitIds = list(
      "string"
    ),
    AccountFilterType = "NONE"|"INTERSECTION"|"DIFFERENCE"|"UNION"
  ),
  Regions = list(
    "string"
  ),
  OperationPreferences = list(
    RegionConcurrencyType = "SEQUENTIAL"|"PARALLEL",
    RegionOrder = list(
      "string"
    ),
    FailureToleranceCount = 123,
    FailureTolerancePercentage = 123,
    MaxConcurrentCount = 123,
    MaxConcurrentPercentage = 123,
    ConcurrencyMode = "STRICT_FAILURE_TOLERANCE"|"SOFT_FAILURE_TOLERANCE"
  ),
  RetainStacks = TRUE|FALSE,
  OperationId = "string",
  CallAs = "SELF"|"DELEGATED_ADMIN"
)