local

Documentation

Index

• type File
  • func (f *File) Annotate(a infer.Annotator)
  • func (*File) Check(ctx p.Context, name string, oldInputs, newInputs resource.PropertyMap) (FileArgs, []p.CheckFailure, error)
  • func (*File) Create(ctx p.Context, name string, input FileArgs, preview bool) (id string, output FileState, err error)
  • func (*File) Delete(ctx p.Context, id string, props FileState) error
  • func (*File) Diff(ctx p.Context, id string, olds FileState, news FileArgs) (p.DiffResponse, error)
  • func (l *File) Read(ctx p.Context, id string, inputs FileArgs, state FileState) (canonicalID string, normalizedInputs FileArgs, normalizedState FileState, ...)
  • func (*File) Update(ctx p.Context, id string, olds FileState, news FileArgs, preview bool) (FileState, error)
  • func (*File) WireDependencies(f infer.FieldSelector, args *FileArgs, state *FileState)
• type FileArgs
  • func (f *FileArgs) Annotate(a infer.Annotator)
• type FileState
  • func (f *FileState) Annotate(a infer.Annotator)
• type Link
  • func (l *Link) Annotate(a infer.Annotator)
  • func (l *Link) Check(ctx p.Context, name string, oldInputs, newInputs resource.PropertyMap) (LinkArgs, []p.CheckFailure, error)
  • func (l *Link) Create(ctx p.Context, name string, input LinkArgs, preview bool) (string, LinkState, error)
  • func (l *Link) Delete(ctx p.Context, id string, props LinkState) error
  • func (l *Link) Diff(ctx p.Context, id string, olds LinkState, news LinkArgs) (p.DiffResponse, error)
  • func (l *Link) Read(ctx p.Context, id string, inputs LinkArgs, state LinkState) (canonicalID string, normalizedInputs LinkArgs, normalizedState LinkState, ...)
  • func (l *Link) Update(ctx p.Context, name string, olds LinkState, news LinkArgs, preview bool) (LinkState, error)
• type LinkArgs
  • func (l *LinkArgs) Annotate(a infer.Annotator)
• type LinkState
  • func (l *LinkState) Annotate(a infer.Annotator)

Types

type File

type File struct{}

func (*File) Annotate

func (f *File) Annotate(a infer.Annotator)

func (*File) Check

func (*File) Check(ctx p.Context, name string, oldInputs, newInputs resource.PropertyMap) (FileArgs, []p.CheckFailure, error)

func (*File) Create

func (*File) Create(ctx p.Context, name string, input FileArgs, preview bool) (id string, output FileState, err error)

func (*File) Delete

func (*File) Delete(ctx p.Context, id string, props FileState) error

func (*File) Diff

func (*File) Diff(ctx p.Context, id string, olds FileState, news FileArgs) (p.DiffResponse, error)

func (*File) Read

func (l *File) Read(ctx p.Context, id string, inputs FileArgs, state FileState) (
	canonicalID string, normalizedInputs FileArgs, normalizedState FileState, err error)

func (*File) Update

func (*File) Update(ctx p.Context, id string, olds FileState, news FileArgs, preview bool) (FileState, error)

func (*File) WireDependencies

func (*File) WireDependencies(f infer.FieldSelector, args *FileArgs, state *FileState)

type FileArgs

type FileArgs struct {
	Path    string   `pulumi:"path"`
	Content []string `pulumi:"content"`
	Force   bool     `pulumi:"force,optional"`
}

func (*FileArgs) Annotate

func (f *FileArgs) Annotate(a infer.Annotator)

type FileState

type FileState struct {
	Path    string   `pulumi:"path"`
	Force   bool     `pulumi:"force"`
	Content []string `pulumi:"content"`
}

func (*FileState) Annotate

func (f *FileState) Annotate(a infer.Annotator)

type Link

type Link struct{}

Each resource has a controlling struct. Resource behavior is determined by implementing methods on the controlling struct. The `Create` method is mandatory, but other methods are optional. - Check: Remap inputs before they are typed. - Diff: Change how instances of a resource are compared. - Update: Mutate a resource in place. - Read: Get the state of a resource from the backing provider. - Delete: Custom logic when the resource is deleted. - Annotate: Describe fields and set defaults for a resource. - WireDependencies: Control how outputs and secrets flows through values.

func (*Link) Annotate

func (l *Link) Annotate(a infer.Annotator)

func (*Link) Check

func (l *Link) Check(ctx p.Context, name string, oldInputs, newInputs resource.PropertyMap) (LinkArgs, []p.CheckFailure, error)

func (*Link) Create

func (l *Link) Create(ctx p.Context, name string, input LinkArgs, preview bool) (string, LinkState, error)

All resources must implement Create at a minumum.

func (*Link) Delete

func (l *Link) Delete(ctx p.Context, id string, props LinkState) error

func (*Link) Diff

func (l *Link) Diff(ctx p.Context, id string, olds LinkState, news LinkArgs) (p.DiffResponse, error)

func (*Link) Read

func (l *Link) Read(ctx p.Context, id string, inputs LinkArgs, state LinkState) (
	canonicalID string, normalizedInputs LinkArgs, normalizedState LinkState, err error)

func (*Link) Update

func (l *Link) Update(ctx p.Context, name string, olds LinkState, news LinkArgs, preview bool) (LinkState, error)

type LinkArgs

type LinkArgs struct {
	Source    *string `pulumi:"source"`
	Target    *string `pulumi:"target"`
	Overwrite *bool   `pulumi:"overwrite,optional"`
	Retain    *bool   `pulumi:"retain,optional"`
	Recursive *bool   `pulumi:"recursive,optional"`
}

Each resource has in input struct, defining what arguments it accepts.

func (*LinkArgs) Annotate

func (l *LinkArgs) Annotate(a infer.Annotator)

type LinkState

type LinkState struct {
	// It is generally a good idea to embed args in outputs, but it isn't strictly necessary.
	LinkArgs
	Linked  *bool     `pulumi:"linked"`
	IsDir   *bool     `pulumi:"isDir"`
	Targets *[]string `pulumi:"targets"`
}

Each resource has a state, describing the fields that exist on the created resource.

func (*LinkState) Annotate

func (l *LinkState) Annotate(a infer.Annotator)