external

Documentation

Overview

A Pulumi package for creating and managing External cloud resources.

Index

• type GetExternalArgs
• type GetExternalOutputArgs
  • func (GetExternalOutputArgs) ElementType() reflect.Type
• type GetExternalResult
  • func GetExternal(ctx *pulumi.Context, args *GetExternalArgs, opts ...pulumi.InvokeOption) (*GetExternalResult, error)
• type GetExternalResultOutput
  • func GetExternalOutput(ctx *pulumi.Context, args GetExternalOutputArgs, opts ...pulumi.InvokeOption) GetExternalResultOutput
  • func (GetExternalResultOutput) ElementType() reflect.Type
  • func (o GetExternalResultOutput) Id() pulumi.StringOutput
  • func (o GetExternalResultOutput) Programs() pulumi.StringArrayOutput
  • func (o GetExternalResultOutput) Query() pulumi.StringMapOutput
  • func (o GetExternalResultOutput) Result() pulumi.StringMapOutput
  • func (o GetExternalResultOutput) ToGetExternalResultOutput() GetExternalResultOutput
  • func (o GetExternalResultOutput) ToGetExternalResultOutputWithContext(ctx context.Context) GetExternalResultOutput
  • func (o GetExternalResultOutput) WorkingDir() pulumi.StringPtrOutput
• type Provider
  • func NewProvider(ctx *pulumi.Context, name string, args *ProviderArgs, ...) (*Provider, error)
  • func (*Provider) ElementType() reflect.Type
  • func (i *Provider) ToProviderOutput() ProviderOutput
  • func (i *Provider) ToProviderOutputWithContext(ctx context.Context) ProviderOutput
• type ProviderArgs
  • func (ProviderArgs) ElementType() reflect.Type
• type ProviderInput
• type ProviderOutput
  • func (ProviderOutput) ElementType() reflect.Type
  • func (o ProviderOutput) ToProviderOutput() ProviderOutput
  • func (o ProviderOutput) ToProviderOutputWithContext(ctx context.Context) ProviderOutput

Types

type GetExternalArgs

type GetExternalArgs struct {
	Programs []string `pulumi:"programs"`
	// A map of string values to pass to the external program as the query arguments. If not supplied, the program will receive an empty object as its input.
	Query map[string]string `pulumi:"query"`
	// Working directory of the program. If not supplied, the program will run in the current directory.
	WorkingDir *string `pulumi:"workingDir"`
}

A collection of arguments for invoking getExternal.

type GetExternalOutputArgs

type GetExternalOutputArgs struct {
	Programs pulumi.StringArrayInput `pulumi:"programs"`
	// A map of string values to pass to the external program as the query arguments. If not supplied, the program will receive an empty object as its input.
	Query pulumi.StringMapInput `pulumi:"query"`
	// Working directory of the program. If not supplied, the program will run in the current directory.
	WorkingDir pulumi.StringPtrInput `pulumi:"workingDir"`
}

A collection of arguments for invoking getExternal.

func (GetExternalOutputArgs) ElementType

func (GetExternalOutputArgs) ElementType() reflect.Type

type GetExternalResult

type GetExternalResult struct {
	// The id of the data source. This will always be set to `-`
	Id       string   `pulumi:"id"`
	Programs []string `pulumi:"programs"`
	// A map of string values to pass to the external program as the query arguments. If not supplied, the program will receive an empty object as its input.
	Query map[string]string `pulumi:"query"`
	// A map of string values returned from the external program.
	Result map[string]string `pulumi:"result"`
	// Working directory of the program. If not supplied, the program will run in the current directory.
	WorkingDir *string `pulumi:"workingDir"`
}

A collection of values returned by getExternal.

func GetExternal

func GetExternal(ctx *pulumi.Context, args *GetExternalArgs, opts ...pulumi.InvokeOption) (*GetExternalResult, error)

type GetExternalResultOutput

type GetExternalResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getExternal.

func GetExternalOutput

func GetExternalOutput(ctx *pulumi.Context, args GetExternalOutputArgs, opts ...pulumi.InvokeOption) GetExternalResultOutput

func (GetExternalResultOutput) ElementType

func (GetExternalResultOutput) ElementType() reflect.Type

func (GetExternalResultOutput) Id

func (o GetExternalResultOutput) Id() pulumi.StringOutput

The id of the data source. This will always be set to `-`

func (GetExternalResultOutput) Programs

func (o GetExternalResultOutput) Programs() pulumi.StringArrayOutput

func (GetExternalResultOutput) Query

func (o GetExternalResultOutput) Query() pulumi.StringMapOutput

A map of string values to pass to the external program as the query arguments. If not supplied, the program will receive an empty object as its input.

func (GetExternalResultOutput) Result

func (o GetExternalResultOutput) Result() pulumi.StringMapOutput

A map of string values returned from the external program.

func (GetExternalResultOutput) ToGetExternalResultOutput

func (o GetExternalResultOutput) ToGetExternalResultOutput() GetExternalResultOutput

func (GetExternalResultOutput) ToGetExternalResultOutputWithContext

func (o GetExternalResultOutput) ToGetExternalResultOutputWithContext(ctx context.Context) GetExternalResultOutput

func (GetExternalResultOutput) WorkingDir

func (o GetExternalResultOutput) WorkingDir() pulumi.StringPtrOutput

Working directory of the program. If not supplied, the program will run in the current directory.

type Provider

type Provider struct {
	pulumi.ProviderResourceState
}

The provider type for the external package. By default, resources use package-wide configuration settings, however an explicit `Provider` instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the [documentation](https://www.pulumi.com/docs/reference/programming-model/#providers) for more information.

func NewProvider

func NewProvider(ctx *pulumi.Context,
	name string, args *ProviderArgs, opts ...pulumi.ResourceOption) (*Provider, error)

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

func (*Provider) ElementType

func (*Provider) ElementType() reflect.Type

func (*Provider) ToProviderOutput

func (i *Provider) ToProviderOutput() ProviderOutput

func (*Provider) ToProviderOutputWithContext

func (i *Provider) ToProviderOutputWithContext(ctx context.Context) ProviderOutput

type ProviderArgs

type ProviderArgs struct {
}

The set of arguments for constructing a Provider resource.

func (ProviderArgs) ElementType

func (ProviderArgs) ElementType() reflect.Type

type ProviderInput

type ProviderInput interface {
	pulumi.Input

	ToProviderOutput() ProviderOutput
	ToProviderOutputWithContext(ctx context.Context) ProviderOutput
}

type ProviderOutput

type ProviderOutput struct{ *pulumi.OutputState }

func (ProviderOutput) ElementType

func (ProviderOutput) ElementType() reflect.Type

func (ProviderOutput) ToProviderOutput

func (o ProviderOutput) ToProviderOutput() ProviderOutput

func (ProviderOutput) ToProviderOutputWithContext

func (o ProviderOutput) ToProviderOutputWithContext(ctx context.Context) ProviderOutput