optrefresh

Documentation

Overview

Package optrefresh contains functional options to be used with stack refresh operations github.com/sdk/v2/go/x/auto Stack.Refresh(...optrefresh.Option)

Index

• type Option
  • func DebugLogging(debugOpts debug.LoggingOptions) Option
  • func ExpectNoChanges() Option
  • func Message(message string) Option
  • func Parallel(n int) Option
  • func ProgressStreams(writers ...io.Writer) Option
  • func Target(urns []string) Option
• type Options

Types

type Option

type Option interface {
	ApplyOption(*Options)
}

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

func DebugLogging

func DebugLogging(debugOpts debug.LoggingOptions) Option

func ExpectNoChanges

func ExpectNoChanges() Option

ExpectNoChanges will cause the preview to return an error if any changes occur

func Message

func Message(message string) Option

Message (optional) to associate with the refresh operation

func Parallel

func Parallel(n int) Option

Parallel is the number of resource operations to run in parallel at once during the refresh (1 for no parallelism). Defaults to unbounded. (default 2147483647)

func ProgressStreams

func ProgressStreams(writers ...io.Writer) Option

ProgressStreams allows specifying one or more io.Writers to redirect incremental refresh output

func Target

func Target(urns []string) Option

Target specifies an exclusive list of resource URNs to refresh

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 refresh operation
	Message string
	// Return an error if any changes occur during this preview
	ExpectNoChanges bool
	// Specify an exclusive list of resource URNs to re
	Target []string
	// ProgressStreams allows specifying one or more io.Writers to redirect incremental refresh output
	ProgressStreams []io.Writer
	// DebugLogOpts specifies additional settings for debug logging
	DebugLogOpts debug.LoggingOptions
}

Options is an implementation detail