pulumi/tests/testdata/codegen/simple-resource-schema/docs/overlayfunction/_index.md

---

title: "overlayFunction" title_tag: "example.overlayFunction" meta_desc: "Documentation for the example.overlayFunction function with examples, input properties, output properties, and supporting types." layout: api no_edit_this_page: true

Using overlayFunction

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function overlayFunction(args: OverlayFunctionArgs, opts?: InvokeOptions): Promise<OverlayFunctionResult>
function overlayFunctionOutput(args: OverlayFunctionOutputArgs, opts?: InvokeOptions): Output<OverlayFunctionResult>

def overlay_function(arg1: Optional[Resource] = None,
                     opts: Optional[InvokeOptions] = None) -> OverlayFunctionResult
def overlay_function_output(arg1: Optional[pulumi.Input[Resource]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[OverlayFunctionResult]

func OverlayFunction(ctx *Context, args *OverlayFunctionArgs, opts ...InvokeOption) (*OverlayFunctionResult, error)
func OverlayFunctionOutput(ctx *Context, args *OverlayFunctionOutputArgs, opts ...InvokeOption) OverlayFunctionResultOutput

> Note: This function is named OverlayFunction in the Go SDK.

public static class OverlayFunction 
{
    public static Task<OverlayFunctionResult> InvokeAsync(OverlayFunctionArgs args, InvokeOptions? opts = null)
    public static Output<OverlayFunctionResult> Invoke(OverlayFunctionInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<OverlayFunctionResult> overlayFunction(OverlayFunctionArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: example:overlayFunction
  arguments:
    # arguments dictionary

The following arguments are supported:

Arg1 Pulumi.Example.Resource

Arg1 Resource

arg1 Resource

arg1 Resource

arg1 Resource

arg1 example:Resource

overlayFunction Result

The following output properties are available:

Result Pulumi.Example.Resource

Result Resource

result Resource

result Resource

result Resource

result example:Resource

Package Details

Repository

example

License