optdestroy

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 Message(message string) Option
  • func Parallel(n int) Option
  • func Target(urns []string) Option
  • func TargetDependents() Option
• type Options

Types

type Option

type Option interface {
	ApplyOption(*Options)
}

Option is a parameter to be applied to a Stack.Destroy() operation

func Message

func Message(message string) Option

Message (optional) to associate with the destroy operation

func Parallel

func Parallel(n int) Option

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 Target

func Target(urns []string) Option

Target specifies an exclusive list of resource URNs to destroy

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
}

Options is an implementation detail