pulumi/tests/testdata/codegen/docs-collision/docs/fn-overlay/_index.md

13 KiB


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

Using overlay

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 overlay(args: OverlayArgs, opts?: InvokeOptions): Promise<OverlayResult>
function overlayOutput(args: OverlayOutputArgs, opts?: InvokeOptions): Output<OverlayResult>
def overlay(arg1: Optional[Overlay] = None,
            opts: Optional[InvokeOptions] = None) -> OverlayResult
def overlay_output(arg1: Optional[pulumi.Input[Overlay]] = None,
            opts: Optional[InvokeOptions] = None) -> Output[OverlayResult]
func Overlay(ctx *Context, args *OverlayArgs, opts ...InvokeOption) (*OverlayResult, error)
func OverlayOutput(ctx *Context, args *OverlayOutputArgs, opts ...InvokeOption) OverlayResultOutput

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

public static class Overlay 
{
    public static Task<OverlayResult> InvokeAsync(OverlayArgs args, InvokeOptions? opts = null)
    public static Output<OverlayResult> Invoke(OverlayInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<OverlayResult> overlay(OverlayArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: example:overlay
  arguments:
    # arguments dictionary

The following arguments are supported:

Arg1 Pulumi.Example.Overlay
Arg1 Overlay
arg1 Overlay
arg1 Overlay
arg1 Overlay
arg1 example:Overlay

overlay Result

The following output properties are available:

Result Pulumi.Example.Overlay
Result Overlay
result Overlay
result Overlay
result Overlay
result example:Overlay

Package Details

Repository
example
License