Remove-VSStackSetInstances

Remove-VSStackSetInstances

SYNOPSIS

Removes Stack Set Instances.

SYNTAX

Remove-VSStackSetInstances [-StackSetName] <String> [[-Accounts] <String[]>] [[-OperationId] <String>]
 [[-OperationPreferences] <StackSetOperationPreferences>] [[-Regions] <String[]>] [[-RetainStacks] <Boolean>]
 [[-ProfileName] <String>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

PARAMETERS

-StackSetName

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

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Accounts

The names of the AWS accounts that you want to delete stack instances for.

Type: String[]
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

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

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-OperationPreferences

Preferences for how AWS CloudFormation performs this stack set operation.

Type: StackSetOperationPreferences
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Regions

The regions where you want to delete stack set instances.

Type: String[]
Parameter Sets: (All)
Aliases:

Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-RetainStacks

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.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 6
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-ProfileName

The name of the configuration profile to deploy the stack with. Defaults to $env:AWS_PROFILE, if set.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 7
Default value: $env:AWS_PROFILE
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

OUTPUTS

NOTES