HostKit.Plan (host_kit v0.1.0-beta.0)

Copy Markdown View Source

Structural plan generated from a HostKit project.

Summary

Types

t()

Functions

build(project, opts \\ [])
down(plan, opts \\ [])

Builds a down/rollback plan from an existing plan.

Types

t()

@type t() :: %HostKit.Plan{
  changes: [HostKit.Change.t()],
  diagnostics: HostKit.Diagnostics.t(),
  opts: keyword(),
  project: HostKit.Project.t(),
  resources: [struct()],
  summary: map()
}

Functions

build(project, opts \\ [])

@spec build(
  HostKit.Project.t(),
  keyword()
) :: {:ok, t()} | {:error, HostKit.Diagnostics.t() | term()}

down(plan, opts \\ [])

@spec down(
  t(),
  keyword()
) :: {:ok, t()} | {:error, term()}

Builds a down/rollback plan from an existing plan.