Documentation
¶
Index ¶
- type Command
- type CommandArgs
- type CommandArray
- type CommandArrayInput
- type CommandArrayOutput
- type CommandInput
- type CommandMap
- type CommandMapInput
- type CommandMapOutput
- type CommandOutput
- func (o CommandOutput) Archive() pulumi.ArchiveOutput
- func (o CommandOutput) ArchivePaths() pulumi.StringArrayOutput
- func (o CommandOutput) AssetPaths() pulumi.StringArrayOutput
- func (o CommandOutput) Assets() pulumi.AssetOrArchiveMapOutput
- func (o CommandOutput) Create() pulumi.StringPtrOutput
- func (o CommandOutput) Delete() pulumi.StringPtrOutput
- func (o CommandOutput) Dir() pulumi.StringPtrOutput
- func (CommandOutput) ElementType() reflect.Type
- func (o CommandOutput) Environment() pulumi.StringMapOutput
- func (o CommandOutput) Interpreter() pulumi.StringArrayOutput
- func (o CommandOutput) Stderr() pulumi.StringOutput
- func (o CommandOutput) Stdin() pulumi.StringPtrOutput
- func (o CommandOutput) Stdout() pulumi.StringOutput
- func (o CommandOutput) ToCommandOutput() CommandOutput
- func (o CommandOutput) ToCommandOutputWithContext(ctx context.Context) CommandOutput
- func (o CommandOutput) Triggers() pulumi.ArrayOutput
- func (o CommandOutput) Update() pulumi.StringPtrOutput
- type CommandState
- type RunArgs
- type RunOutputArgs
- type RunResult
- type RunResultOutput
- func (o RunResultOutput) Archive() pulumi.ArchiveOutput
- func (o RunResultOutput) Assets() pulumi.AssetOrArchiveMapOutput
- func (o RunResultOutput) Command() pulumi.StringOutput
- func (o RunResultOutput) Dir() pulumi.StringPtrOutput
- func (RunResultOutput) ElementType() reflect.Type
- func (o RunResultOutput) Environment() pulumi.StringMapOutput
- func (o RunResultOutput) Interpreter() pulumi.StringArrayOutput
- func (o RunResultOutput) Stderr() pulumi.StringOutput
- func (o RunResultOutput) Stdin() pulumi.StringOutput
- func (o RunResultOutput) Stdout() pulumi.StringPtrOutput
- func (o RunResultOutput) ToRunResultOutput() RunResultOutput
- func (o RunResultOutput) ToRunResultOutputWithContext(ctx context.Context) RunResultOutput
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Command ¶
type Command struct {
pulumi.CustomResourceState
// An archive asset containing files found after running the command.
Archive pulumi.ArchiveOutput `pulumi:"archive"`
// A list of path globs to return as a single archive asset after the command completes.
ArchivePaths pulumi.StringArrayOutput `pulumi:"archivePaths"`
// A list of path globs to read after the command completes.
AssetPaths pulumi.StringArrayOutput `pulumi:"assetPaths"`
// A map of assets found after running the command.
// The key is the relative path from the command dir
Assets pulumi.AssetOrArchiveMapOutput `pulumi:"assets"`
// 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"`
// Pass a string to the command's process as standard in
Stdin pulumi.StringPtrOutput `pulumi:"stdin"`
// The standard output of the command's process
Stdout pulumi.StringOutput `pulumi:"stdout"`
// Trigger replacements on changes to this input.
Triggers pulumi.ArrayOutput `pulumi:"triggers"`
// The command to run on update, if empty, create will run again.
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) ToCommandOutput ¶
func (i *Command) ToCommandOutput() CommandOutput
func (*Command) ToCommandOutputWithContext ¶
func (i *Command) ToCommandOutputWithContext(ctx context.Context) CommandOutput
type CommandArgs ¶
type CommandArgs struct {
// A list of path globs to return as a single archive asset after the command completes.
//
// When specifying glob patterns the following rules apply:
// - We only include files not directories for assets and archives.
// - Path separators are `/` on all platforms - including Windows.
// - Patterns starting with `!` are 'exclude' rules.
// - Rules are evaluated in order, so exclude rules should be after inclusion rules.
// - `*` matches anything except `/`
// - `**` matches anything, _including_ `/`
// - All returned paths are relative to the working directory (without leading `./`) e.g. `file.text` or `subfolder/file.txt`.
// - For full details of the globbing syntax, see [github.com/gobwas/glob](https://github.com/gobwas/glob)
//
// #### Example
//
// Given the rules:
//
// When evaluating against this folder:
//
// The following paths will be returned:
ArchivePaths pulumi.StringArrayInput
// A list of path globs to read after the command completes.
//
// When specifying glob patterns the following rules apply:
// - We only include files not directories for assets and archives.
// - Path separators are `/` on all platforms - including Windows.
// - Patterns starting with `!` are 'exclude' rules.
// - Rules are evaluated in order, so exclude rules should be after inclusion rules.
// - `*` matches anything except `/`
// - `**` matches anything, _including_ `/`
// - All returned paths are relative to the working directory (without leading `./`) e.g. `file.text` or `subfolder/file.txt`.
// - For full details of the globbing syntax, see [github.com/gobwas/glob](https://github.com/gobwas/glob)
//
// #### Example
//
// Given the rules:
//
// When evaluating against this folder:
//
// The following paths will be returned:
AssetPaths pulumi.StringArrayInput
// 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
// Pass a string to the command's process as standard in
Stdin pulumi.StringPtrInput
Triggers pulumi.ArrayInput
// The command to run on update, if empty, create will run again.
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) Archive ¶ added in v0.4.0
func (o CommandOutput) Archive() pulumi.ArchiveOutput
An archive asset containing files found after running the command.
func (CommandOutput) ArchivePaths ¶ added in v0.4.0
func (o CommandOutput) ArchivePaths() pulumi.StringArrayOutput
A list of path globs to return as a single archive asset after the command completes.
func (CommandOutput) AssetPaths ¶ added in v0.4.0
func (o CommandOutput) AssetPaths() pulumi.StringArrayOutput
A list of path globs to read after the command completes.
func (CommandOutput) Assets ¶ added in v0.4.0
func (o CommandOutput) Assets() pulumi.AssetOrArchiveMapOutput
A map of assets found after running the command. The key is the relative path from the command dir
func (CommandOutput) Create ¶ added in v0.2.0
func (o CommandOutput) Create() pulumi.StringPtrOutput
The command to run on create.
func (CommandOutput) Delete ¶ added in v0.2.0
func (o CommandOutput) Delete() pulumi.StringPtrOutput
The command to run on delete.
func (CommandOutput) Dir ¶ added in v0.2.0
func (o CommandOutput) Dir() pulumi.StringPtrOutput
The directory from which to run the command from. If `dir` does not exist, then `Command` will fail.
func (CommandOutput) ElementType ¶
func (CommandOutput) ElementType() reflect.Type
func (CommandOutput) Environment ¶ added in v0.2.0
func (o CommandOutput) Environment() pulumi.StringMapOutput
Additional environment variables available to the command's process.
func (CommandOutput) Interpreter ¶ added in v0.2.0
func (o CommandOutput) Interpreter() pulumi.StringArrayOutput
The program and arguments to run the command. For example: `["/bin/sh", "-c"]`
func (CommandOutput) Stderr ¶ added in v0.2.0
func (o CommandOutput) Stderr() pulumi.StringOutput
The standard error of the command's process
func (CommandOutput) Stdin ¶ added in v0.2.0
func (o CommandOutput) Stdin() pulumi.StringPtrOutput
Pass a string to the command's process as standard in
func (CommandOutput) Stdout ¶ added in v0.2.0
func (o CommandOutput) Stdout() pulumi.StringOutput
The standard output of the command's process
func (CommandOutput) ToCommandOutput ¶
func (o CommandOutput) ToCommandOutput() CommandOutput
func (CommandOutput) ToCommandOutputWithContext ¶
func (o CommandOutput) ToCommandOutputWithContext(ctx context.Context) CommandOutput
func (CommandOutput) Triggers ¶ added in v0.2.0
func (o CommandOutput) Triggers() pulumi.ArrayOutput
Trigger replacements on changes to this input.
func (CommandOutput) Update ¶ added in v0.2.0
func (o CommandOutput) Update() pulumi.StringPtrOutput
The command to run on update, if empty, create will run again.
type CommandState ¶
type CommandState struct {
}
func (CommandState) ElementType ¶
func (CommandState) ElementType() reflect.Type
type RunArgs ¶ added in v0.4.0
type RunArgs struct {
// A list of path globs to return as a single archive asset after the command completes.
//
// When specifying glob patterns the following rules apply:
// - We only include files not directories for assets and archives.
// - Path separators are `/` on all platforms - including Windows.
// - Patterns starting with `!` are 'exclude' rules.
// - Rules are evaluated in order, so exclude rules should be after inclusion rules.
// - `*` matches anything except `/`
// - `**` matches anything, _including_ `/`
// - All returned paths are relative to the working directory (without leading `./`) e.g. `file.text` or `subfolder/file.txt`.
// - For full details of the globbing syntax, see [github.com/gobwas/glob](https://github.com/gobwas/glob)
//
// #### Example
//
// Given the rules:
//
// When evaluating against this folder:
//
// The following paths will be returned:
ArchivePaths []string `pulumi:"archivePaths"`
// A list of path globs to read after the command completes.
//
// When specifying glob patterns the following rules apply:
// - We only include files not directories for assets and archives.
// - Path separators are `/` on all platforms - including Windows.
// - Patterns starting with `!` are 'exclude' rules.
// - Rules are evaluated in order, so exclude rules should be after inclusion rules.
// - `*` matches anything except `/`
// - `**` matches anything, _including_ `/`
// - All returned paths are relative to the working directory (without leading `./`) e.g. `file.text` or `subfolder/file.txt`.
// - For full details of the globbing syntax, see [github.com/gobwas/glob](https://github.com/gobwas/glob)
//
// #### Example
//
// Given the rules:
//
// When evaluating against this folder:
//
// The following paths will be returned:
AssetPaths []string `pulumi:"assetPaths"`
// The command to run.
Command string `pulumi:"command"`
// The working directory in which to run the command from.
Dir *string `pulumi:"dir"`
// Additional environment variables available to the command's process.
Environment map[string]string `pulumi:"environment"`
// The program and arguments to run the command.
// On Linux and macOS, defaults to: `["/bin/sh", "-c"]`. On Windows, defaults to: `["cmd", "/C"]`
Interpreter []string `pulumi:"interpreter"`
// Pass a string to the command's process as standard in
Stdin *string `pulumi:"stdin"`
}
type RunOutputArgs ¶ added in v0.4.0
type RunOutputArgs struct {
// A list of path globs to return as a single archive asset after the command completes.
//
// When specifying glob patterns the following rules apply:
// - We only include files not directories for assets and archives.
// - Path separators are `/` on all platforms - including Windows.
// - Patterns starting with `!` are 'exclude' rules.
// - Rules are evaluated in order, so exclude rules should be after inclusion rules.
// - `*` matches anything except `/`
// - `**` matches anything, _including_ `/`
// - All returned paths are relative to the working directory (without leading `./`) e.g. `file.text` or `subfolder/file.txt`.
// - For full details of the globbing syntax, see [github.com/gobwas/glob](https://github.com/gobwas/glob)
//
// #### Example
//
// Given the rules:
//
// When evaluating against this folder:
//
// The following paths will be returned:
ArchivePaths pulumi.StringArrayInput `pulumi:"archivePaths"`
// A list of path globs to read after the command completes.
//
// When specifying glob patterns the following rules apply:
// - We only include files not directories for assets and archives.
// - Path separators are `/` on all platforms - including Windows.
// - Patterns starting with `!` are 'exclude' rules.
// - Rules are evaluated in order, so exclude rules should be after inclusion rules.
// - `*` matches anything except `/`
// - `**` matches anything, _including_ `/`
// - All returned paths are relative to the working directory (without leading `./`) e.g. `file.text` or `subfolder/file.txt`.
// - For full details of the globbing syntax, see [github.com/gobwas/glob](https://github.com/gobwas/glob)
//
// #### Example
//
// Given the rules:
//
// When evaluating against this folder:
//
// The following paths will be returned:
AssetPaths pulumi.StringArrayInput `pulumi:"assetPaths"`
// The command to run.
Command pulumi.StringInput `pulumi:"command"`
// The working directory in which to run the command from.
Dir pulumi.StringPtrInput `pulumi:"dir"`
// Additional environment variables available to the command's process.
Environment pulumi.StringMapInput `pulumi:"environment"`
// 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 `pulumi:"interpreter"`
// Pass a string to the command's process as standard in
Stdin pulumi.StringPtrInput `pulumi:"stdin"`
}
func (RunOutputArgs) ElementType ¶ added in v0.4.0
func (RunOutputArgs) ElementType() reflect.Type
type RunResult ¶ added in v0.4.0
type RunResult struct {
// An archive asset containing files found after running the command.
Archive pulumi.Archive `pulumi:"archive"`
// A map of assets found after running the command.
// The key is the relative path from the command dir
Assets map[string]pulumi.AssetOrArchive `pulumi:"assets"`
// The command to run.
Command string `pulumi:"command"`
// The directory from which the command was run from.
Dir *string `pulumi:"dir"`
// Additional environment variables available to the command's process.
Environment map[string]string `pulumi:"environment"`
// The program and arguments to run the command.
// For example: `["/bin/sh", "-c"]`
Interpreter []string `pulumi:"interpreter"`
// The standard error of the command's process
Stderr string `pulumi:"stderr"`
// String passed to the command's process as standard in.
Stdin string `pulumi:"stdin"`
// The standard output of the command's process
Stdout *string `pulumi:"stdout"`
}
type RunResultOutput ¶ added in v0.4.0
type RunResultOutput struct{ *pulumi.OutputState }
func RunOutput ¶ added in v0.4.0
func RunOutput(ctx *pulumi.Context, args RunOutputArgs, opts ...pulumi.InvokeOption) RunResultOutput
func (RunResultOutput) Archive ¶ added in v0.4.0
func (o RunResultOutput) Archive() pulumi.ArchiveOutput
An archive asset containing files found after running the command.
func (RunResultOutput) Assets ¶ added in v0.4.0
func (o RunResultOutput) Assets() pulumi.AssetOrArchiveMapOutput
A map of assets found after running the command. The key is the relative path from the command dir
func (RunResultOutput) Command ¶ added in v0.4.0
func (o RunResultOutput) Command() pulumi.StringOutput
The command to run.
func (RunResultOutput) Dir ¶ added in v0.4.0
func (o RunResultOutput) Dir() pulumi.StringPtrOutput
The directory from which the command was run from.
func (RunResultOutput) ElementType ¶ added in v0.4.0
func (RunResultOutput) ElementType() reflect.Type
func (RunResultOutput) Environment ¶ added in v0.4.0
func (o RunResultOutput) Environment() pulumi.StringMapOutput
Additional environment variables available to the command's process.
func (RunResultOutput) Interpreter ¶ added in v0.4.0
func (o RunResultOutput) Interpreter() pulumi.StringArrayOutput
The program and arguments to run the command. For example: `["/bin/sh", "-c"]`
func (RunResultOutput) Stderr ¶ added in v0.4.0
func (o RunResultOutput) Stderr() pulumi.StringOutput
The standard error of the command's process
func (RunResultOutput) Stdin ¶ added in v0.4.0
func (o RunResultOutput) Stdin() pulumi.StringOutput
String passed to the command's process as standard in.
func (RunResultOutput) Stdout ¶ added in v0.4.0
func (o RunResultOutput) Stdout() pulumi.StringPtrOutput
The standard output of the command's process
func (RunResultOutput) ToRunResultOutput ¶ added in v0.4.0
func (o RunResultOutput) ToRunResultOutput() RunResultOutput
func (RunResultOutput) ToRunResultOutputWithContext ¶ added in v0.4.0
func (o RunResultOutput) ToRunResultOutputWithContext(ctx context.Context) RunResultOutput