param

Documentation

Index

• type Param
  • func (p *Param) Apply(context.Context) (resource.TaskStatus, error)
  • func (p *Param) Check(context.Context, resource.Renderer) (resource.TaskStatus, error)
  • func (p *Param) String() string
• type Preparer
  • func (p *Preparer) Prepare(ctx context.Context, render resource.Renderer) (resource.Task, error)

Types

type Param

type Param struct {
	resource.Status

	// the value of the parameter
	Val interface{} `export:"val"`
}

Param controls parameter flow inside execution

func (*Param) Apply

func (p *Param) Apply(context.Context) (resource.TaskStatus, error)

Apply doesn't do anything since params are final values

func (*Param) Check

func (p *Param) Check(context.Context, resource.Renderer) (resource.TaskStatus, error)

Check just returns the current value of the parameter. It should never have to change.

func (*Param) String

func (p *Param) String() string

String is the final value of this Param

type Preparer

type Preparer struct {
	// Default is an optional field that provides a default value if none is
	// provided to this parameter. If this field is not set, this param will be
	// treated as required.
	Default interface{} `hcl:"default"`
}

Preparer for params

Param controls the flow of values through `module` calls. You can use the `{{param "name"}}` template call anywhere you need the value of a param inside the current module.

func (*Preparer) Prepare

func (p *Preparer) Prepare(ctx context.Context, render resource.Renderer) (resource.Task, error)

Prepare a new task