Documentation ¶
Overview ¶
Package optdestroy contains functional options to be used with stack destroy operations github.com/sdk/v2/go/x/auto Stack.Destroy(...optdestroy.Option)
Index ¶
- type Option
- func ContinueOnError() Option
- func DebugLogging(debugOpts debug.LoggingOptions) Option
- func ErrorProgressStreams(writers ...io.Writer) Option
- func EventStreams(channels ...chan<- events.EngineEvent) Option
- func Message(message string) Option
- func Parallel(n int) Option
- func ProgressStreams(writers ...io.Writer) Option
- func Refresh() Option
- func ShowSecrets(show bool) Option
- func SuppressOutputs() Option
- func SuppressProgress() Option
- func Target(urns []string) Option
- func TargetDependents() Option
- func UserAgent(agent string) Option
- type Options
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Option ¶
type Option interface {
ApplyOption(*Options)
}
Option is a parameter to be applied to a Stack.Destroy() operation
func ContinueOnError ¶ added in v3.113.0
func ContinueOnError() Option
Continue to perform the destroy operation despite the occurrence of errors.
func DebugLogging ¶
func DebugLogging(debugOpts debug.LoggingOptions) Option
DebugLogging provides options for verbose logging to standard error, and enabling plugin logs.
func ErrorProgressStreams ¶ added in v3.37.0
ErrorProgressStreams allows specifying one or more io.Writers to redirect incremental destroy stderr
func EventStreams ¶
func EventStreams(channels ...chan<- events.EngineEvent) Option
EventStreams allows specifying one or more channels to receive the Pulumi event stream
func Parallel ¶
Parallel is the number of resource operations to run in parallel at once during the destroy (1 for no parallelism). Defaults to unbounded. (default 2147483647)
func ProgressStreams ¶
ProgressStreams allows specifying one or more io.Writers to redirect incremental destroy stdout
func Refresh ¶ added in v3.105.0
func Refresh() Option
Refresh will run a refresh before the destroy.
func ShowSecrets ¶ added in v3.35.1
ShowSecrets configures whether to show config secrets when they appear.
func SuppressOutputs ¶ added in v3.109.0
func SuppressOutputs() Option
Suppress display of stack outputs (in case they contain sensitive values)
func SuppressProgress ¶ added in v3.109.0
func SuppressProgress() Option
Suppress display of periodic progress dots
func TargetDependents ¶
func TargetDependents() Option
TargetDependents allows updating of dependent targets discovered but not specified in the Target list
type Options ¶
type Options struct { // Parallel is the number of resource operations to run in parallel at once // (1 for no parallelism). Defaults to unbounded. (default 2147483647) Parallel int // Message (optional) to associate with the destroy operation Message string // Specify an exclusive list of resource URNs to update Target []string // Allows updating of dependent targets discovered but not specified in the Target list TargetDependents bool // ProgressStreams allows specifying one or more io.Writers to redirect incremental destroy stdout ProgressStreams []io.Writer // ProgressStreams allows specifying one or more io.Writers to redirect incremental destroy stderr ErrorProgressStreams []io.Writer // EventStreams allows specifying one or more channels to receive the Pulumi event stream EventStreams []chan<- events.EngineEvent // DebugLogOpts specifies additional settings for debug logging DebugLogOpts debug.LoggingOptions // UserAgent specifies the agent responsible for the update, stored in backends as "environment.exec.agent" UserAgent string // Colorize output. Choices are: always, never, raw, auto (default "auto") Color string // Show config secrets when they appear. ShowSecrets *bool // Refresh will run a refresh before the destroy. Refresh bool // Suppress display of periodic progress dots SuppressProgress bool // Suppress display of stack outputs (in case they contain sensitive values) SuppressOutputs bool // Continue to perform the destroy operation despite the occurrence of errors. ContinueOnError bool }
Options is an implementation detail