local

Documentation

Index

• type Command
  • func GetCommand(ctx *pulumi.Context, name string, id pulumi.IDInput, state *CommandState, ...) (*Command, error)
  • func NewCommand(ctx *pulumi.Context, name string, args *CommandArgs, ...) (*Command, error)
  • func (*Command) ElementType() reflect.Type
  • func (i *Command) ToCommandOutput() CommandOutput
  • func (i *Command) ToCommandOutputWithContext(ctx context.Context) CommandOutput
• type CommandArgs
  • func (CommandArgs) ElementType() reflect.Type
• type CommandArray
  • func (CommandArray) ElementType() reflect.Type
  • func (i CommandArray) ToCommandArrayOutput() CommandArrayOutput
  • func (i CommandArray) ToCommandArrayOutputWithContext(ctx context.Context) CommandArrayOutput
• type CommandArrayInput
• type CommandArrayOutput
  • func (CommandArrayOutput) ElementType() reflect.Type
  • func (o CommandArrayOutput) Index(i pulumi.IntInput) CommandOutput
  • func (o CommandArrayOutput) ToCommandArrayOutput() CommandArrayOutput
  • func (o CommandArrayOutput) ToCommandArrayOutputWithContext(ctx context.Context) CommandArrayOutput
• type CommandInput
• type CommandMap
  • func (CommandMap) ElementType() reflect.Type
  • func (i CommandMap) ToCommandMapOutput() CommandMapOutput
  • func (i CommandMap) ToCommandMapOutputWithContext(ctx context.Context) CommandMapOutput
• type CommandMapInput
• type CommandMapOutput
  • func (CommandMapOutput) ElementType() reflect.Type
  • func (o CommandMapOutput) MapIndex(k pulumi.StringInput) CommandOutput
  • func (o CommandMapOutput) ToCommandMapOutput() CommandMapOutput
  • func (o CommandMapOutput) ToCommandMapOutputWithContext(ctx context.Context) CommandMapOutput
• type CommandOutput
  • func (CommandOutput) ElementType() reflect.Type
  • func (o CommandOutput) ToCommandOutput() CommandOutput
  • func (o CommandOutput) ToCommandOutputWithContext(ctx context.Context) CommandOutput
• type CommandState
  • func (CommandState) ElementType() reflect.Type

Types

type Command

type Command struct {
	pulumi.CustomResourceState

	// The command to run on create.
	Create pulumi.StringPtrOutput `pulumi:"create"`
	// The command to run on delete.
	Delete pulumi.StringPtrOutput `pulumi:"delete"`
	// The directory from which to run the command from. If `dir` does not exist, then
	// `Command` will fail.
	Dir pulumi.StringPtrOutput `pulumi:"dir"`
	// Additional environment variables available to the command's process.
	Environment pulumi.StringMapOutput `pulumi:"environment"`
	// The program and arguments to run the command.
	// For example: `["/bin/sh", "-c"]`
	Interpreter pulumi.StringArrayOutput `pulumi:"interpreter"`
	// The standard error of the command's process
	Stderr pulumi.StringOutput `pulumi:"stderr"`
	// The standard output of the command's process
	Stdout pulumi.StringOutput `pulumi:"stdout"`
	// The command to run on update.
	Update pulumi.StringPtrOutput `pulumi:"update"`
}

A local command to be executed. This command can be inserted into the life cycles of other resources using the `dependsOn` or `parent` resource options. A command is considered to have failed when it finished with a non-zero exit code. This will fail the CRUD step of the `Command` resource.

func GetCommand

func GetCommand(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *CommandState, opts ...pulumi.ResourceOption) (*Command, error)

GetCommand gets an existing Command resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewCommand

func NewCommand(ctx *pulumi.Context,
	name string, args *CommandArgs, opts ...pulumi.ResourceOption) (*Command, error)

NewCommand registers a new resource with the given unique name, arguments, and options.

func (*Command) ElementType

func (*Command) ElementType() reflect.Type

func (*Command) ToCommandOutput

func (i *Command) ToCommandOutput() CommandOutput

func (*Command) ToCommandOutputWithContext

func (i *Command) ToCommandOutputWithContext(ctx context.Context) CommandOutput

type CommandArgs

type CommandArgs struct {
	// The command to run on create.
	Create pulumi.StringPtrInput
	// The command to run on delete.
	Delete pulumi.StringPtrInput
	// The working directory in which to run the command from.
	Dir pulumi.StringPtrInput
	// Additional environment variables available to the command's process.
	Environment pulumi.StringMapInput
	// The program and arguments to run the command.
	// On Linux and macOS, defaults to: `["/bin/sh", "-c"]`. On Windows, defaults to: `["cmd", "/C"]`
	Interpreter pulumi.StringArrayInput
	// The command to run on update.
	Update pulumi.StringPtrInput
}

The set of arguments for constructing a Command resource.

func (CommandArgs) ElementType

func (CommandArgs) ElementType() reflect.Type

type CommandArray

type CommandArray []CommandInput

func (CommandArray) ElementType

func (CommandArray) ElementType() reflect.Type

func (CommandArray) ToCommandArrayOutput

func (i CommandArray) ToCommandArrayOutput() CommandArrayOutput

func (CommandArray) ToCommandArrayOutputWithContext

func (i CommandArray) ToCommandArrayOutputWithContext(ctx context.Context) CommandArrayOutput

type CommandArrayInput

type CommandArrayInput interface {
	pulumi.Input

	ToCommandArrayOutput() CommandArrayOutput
	ToCommandArrayOutputWithContext(context.Context) CommandArrayOutput
}

CommandArrayInput is an input type that accepts CommandArray and CommandArrayOutput values. You can construct a concrete instance of `CommandArrayInput` via:

CommandArray{ CommandArgs{...} }

type CommandArrayOutput

type CommandArrayOutput struct{ *pulumi.OutputState }

func (CommandArrayOutput) ElementType

func (CommandArrayOutput) ElementType() reflect.Type

func (CommandArrayOutput) Index

func (o CommandArrayOutput) Index(i pulumi.IntInput) CommandOutput

func (CommandArrayOutput) ToCommandArrayOutput

func (o CommandArrayOutput) ToCommandArrayOutput() CommandArrayOutput

func (CommandArrayOutput) ToCommandArrayOutputWithContext

func (o CommandArrayOutput) ToCommandArrayOutputWithContext(ctx context.Context) CommandArrayOutput

type CommandInput

type CommandInput interface {
	pulumi.Input

	ToCommandOutput() CommandOutput
	ToCommandOutputWithContext(ctx context.Context) CommandOutput
}

type CommandMap

type CommandMap map[string]CommandInput

func (CommandMap) ElementType

func (CommandMap) ElementType() reflect.Type

func (CommandMap) ToCommandMapOutput

func (i CommandMap) ToCommandMapOutput() CommandMapOutput

func (CommandMap) ToCommandMapOutputWithContext

func (i CommandMap) ToCommandMapOutputWithContext(ctx context.Context) CommandMapOutput

type CommandMapInput

type CommandMapInput interface {
	pulumi.Input

	ToCommandMapOutput() CommandMapOutput
	ToCommandMapOutputWithContext(context.Context) CommandMapOutput
}

CommandMapInput is an input type that accepts CommandMap and CommandMapOutput values. You can construct a concrete instance of `CommandMapInput` via:

CommandMap{ "key": CommandArgs{...} }

type CommandMapOutput

type CommandMapOutput struct{ *pulumi.OutputState }

func (CommandMapOutput) ElementType

func (CommandMapOutput) ElementType() reflect.Type

func (CommandMapOutput) MapIndex

func (o CommandMapOutput) MapIndex(k pulumi.StringInput) CommandOutput

func (CommandMapOutput) ToCommandMapOutput

func (o CommandMapOutput) ToCommandMapOutput() CommandMapOutput

func (CommandMapOutput) ToCommandMapOutputWithContext

func (o CommandMapOutput) ToCommandMapOutputWithContext(ctx context.Context) CommandMapOutput

type CommandOutput

type CommandOutput struct{ *pulumi.OutputState }

func (CommandOutput) ElementType

func (CommandOutput) ElementType() reflect.Type

func (CommandOutput) ToCommandOutput

func (o CommandOutput) ToCommandOutput() CommandOutput

func (CommandOutput) ToCommandOutputWithContext

func (o CommandOutput) ToCommandOutputWithContext(ctx context.Context) CommandOutput

type CommandState

type CommandState struct {
}

func (CommandState) ElementType

func (CommandState) ElementType() reflect.Type