resources

Documentation

Index

• type App
  • func (a App) Check(ctx provider.Context, name string, oldInputs resource.PropertyMap, ...) (AppArgs, []provider.CheckFailure, error)
  • func (App) Create(ctx provider.Context, name string, input AppArgs, preview bool) (string, AppState, error)
  • func (a App) Delete(ctx provider.Context, id string, props AppState) error
  • func (a App) Read(ctx provider.Context, id string, inputs AppArgs, state AppState) (canonicalID string, normalizedInputs AppArgs, normalizedState AppState, ...)
  • func (a App) Update(ctx provider.Context, id string, olds AppState, news AppArgs, preview bool) (AppState, error)
• type AppArgs
• type AppState
• type Environment
  • func (Environment) Create(ctx provider.Context, name string, input EnvironmentArgs, preview bool) (string, EnvironmentState, error)
  • func (e Environment) Delete(ctx provider.Context, id string, props EnvironmentState) error
  • func (e Environment) Read(ctx provider.Context, id string, inputs EnvironmentArgs, ...) (canonicalID string, normalizedInputs EnvironmentArgs, ...)
  • func (e Environment) Update(ctx provider.Context, id string, olds EnvironmentState, news EnvironmentArgs, ...) (EnvironmentState, error)
• type EnvironmentArgs
• type EnvironmentState
• type Project
  • func (Project) Create(ctx provider.Context, name string, input ProjectArgs, preview bool) (string, ProjectState, error)
  • func (p Project) Delete(ctx provider.Context, id string, props ProjectState) error
  • func (p Project) Read(ctx provider.Context, id string, inputs ProjectArgs, state ProjectState) (canonicalID string, normalizedInputs ProjectArgs, normalizedState ProjectState, ...)
  • func (p Project) Update(ctx provider.Context, id string, olds ProjectState, news ProjectArgs, ...) (ProjectState, error)
• type ProjectArgs
• type ProjectState

Types

type App

type App struct{}

func (App) Check

func (a App) Check(ctx provider.Context, name string, oldInputs resource.PropertyMap, newInputs resource.PropertyMap) (AppArgs, []provider.CheckFailure, error)

func (App) Create

func (App) Create(ctx provider.Context, name string, input AppArgs, preview bool) (string, AppState, error)

All resources must implement Create at a minumum.

func (App) Delete

func (a App) Delete(ctx provider.Context, id string, props AppState) error

func (App) Read

func (a App) Read(ctx provider.Context, id string, inputs AppArgs, state AppState) (canonicalID string, normalizedInputs AppArgs, normalizedState AppState, err error)

func (App) Update

func (a App) Update(ctx provider.Context, id string, olds AppState, news AppArgs, preview bool) (AppState, error)

type AppArgs

type AppArgs struct {
	// Fields projected into Pulumi must be public and hava a `pulumi:"..."` tag.
	// The pulumi tag doesn't need to match the field name, but its generally a
	// good idea.
	UserID               string                                    `pulumi:"userId"`
	ProjectID            string                                    `pulumi:"projectId"`
	EnvironmentID        string                                    `pulumi:"environmentId"`
	Name                 string                                    `pulumi:"name"`
	Enabled              bool                                      `pulumi:"enabled"`
	ResourcesInput       model.CreateAppResourcesInput             `pulumi:"resources"`
	BuildInput           model.CreateAppBuildInput                 `pulumi:"build,optional"`
	DeployInput          model.CreateAppDeployInput                `pulumi:"deploy"`
	GithubInput          *model.CreateAppGithubInput               `pulumi:"github,optional"`
	DockerInput          *model.CreateAppDockerInput               `pulumi:"docker,optional"`
	EnvironmentVariables []model.CreateAppEnvironmentVariableInput `pulumi:"environmentVariables,optional"`
}

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

type AppState

type AppState struct {
	// It is generally a good idea to embed args in outputs, but it isn't strictly necessary.
	AppArgs
	AppID     string    `pulumi:"appId"`
	UpdatedAt time.Time `pulumi:"updatedAt"`
}

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

type Environment

type Environment struct{}

func (Environment) Create

func (Environment) Create(ctx provider.Context, name string, input EnvironmentArgs, preview bool) (string, EnvironmentState, error)

All resources must implement Create at a minumum.

func (Environment) Delete

func (e Environment) Delete(ctx provider.Context, id string, props EnvironmentState) error

func (Environment) Read

func (e Environment) Read(ctx provider.Context, id string, inputs EnvironmentArgs, state EnvironmentState) (canonicalID string, normalizedInputs EnvironmentArgs, normalizedState EnvironmentState, err error)

func (Environment) Update

func (e Environment) Update(ctx provider.Context, id string, olds EnvironmentState, news EnvironmentArgs, preview bool) (EnvironmentState, error)

type EnvironmentArgs

type EnvironmentArgs struct {
	ProjectID string `pulumi:"projectId"`
	Name      string `pulumi:"name"`
}

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

type EnvironmentState

type EnvironmentState struct {
	// It is generally a good idea to embed args in outputs, but it isn't strictly necessary.
	EnvironmentArgs
	// Here we define a required output called result.
	EnvironmentID string    `pulumi:"environmentId"`
	UpdatedAt     time.Time `pulumi:"updatedAt"`
}

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

type Project

type Project struct{}

func (Project) Create

func (Project) Create(ctx provider.Context, name string, input ProjectArgs, preview bool) (string, ProjectState, error)

All resources must implement Create at a minumum.

func (Project) Delete

func (p Project) Delete(ctx provider.Context, id string, props ProjectState) error

func (Project) Read

func (p Project) Read(ctx provider.Context, id string, inputs ProjectArgs, state ProjectState) (canonicalID string, normalizedInputs ProjectArgs, normalizedState ProjectState, err error)

func (Project) Update

func (p Project) Update(ctx provider.Context, id string, olds ProjectState, news ProjectArgs, preview bool) (ProjectState, error)

type ProjectArgs

type ProjectArgs struct {
	// Fields projected into Pulumi must be public and hava a `pulumi:"..."` tag.
	// The pulumi tag doesn't need to match the field name, but its generally a
	// good idea.
	UserID string `pulumi:"userId"`
	Name   string `pulumi:"name"`
}

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

type ProjectState

type ProjectState struct {
	// It is generally a good idea to embed args in outputs, but it isn't strictly necessary.
	ProjectArgs
	// Here we define a required output called result.
	ProjectID string    `pulumi:"projectId"`
	UpdatedAt time.Time `pulumi:"updatedAt"`
}

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