localstack

Documentation

Index

• Constants
• type Stack
  • func New() *Stack
  • func (s *Stack) EndpointURL() string
  • func (s *Stack) Start(forceRestart bool, opts ...StackOption) error
  • func (s *Stack) Stop() error
• type StackOption
  • func WithContext(ctx context.Context) StackOption
  • func WithInitScriptMount(initScriptDirPath string, completeLogLine string) (StackOption, error)
  • func WithInitTimeout(timeout int) StackOption
  • func WithNotInitWait() StackOption
  • func WithReuseExisting() StackOption

Constants

const FixedPort = Port + "/tcp"

const LocalStackImage = "localstack/localstack:3.0"

const Port = "4566"

Types

type Stack

type Stack struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

func New

func New() *Stack

New returns the current stack instance

func (*Stack) EndpointURL

func (s *Stack) EndpointURL() string

func (*Stack) Start

func (s *Stack) Start(forceRestart bool, opts ...StackOption) error

Start starts the stack instance with options, forces a restart if required

func (*Stack) Stop

func (s *Stack) Stop() error

Stop stops the stack instance

type StackOption

type StackOption func(s *Stack)

func WithContext

func WithContext(ctx context.Context) StackOption

func WithInitScriptMount

func WithInitScriptMount(initScriptDirPath string, completeLogLine string) (StackOption, error)

WithInitScriptMount configures the instance with init scripts and waits for a specific line from the script to show as ready to continue

func WithInitTimeout

func WithInitTimeout(timeout int) StackOption

func WithNotInitWait

func WithNotInitWait() StackOption

func WithReuseExisting

func WithReuseExisting() StackOption