pulumi/tests/testdata/codegen/output-funcs/docs/funcwithdictparam/_index.md

15 KiB


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

Check codegen of functions with a Dict<str,str> parameter.

Using funcWithDictParam

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 funcWithDictParam(args: FuncWithDictParamArgs, opts?: InvokeOptions): Promise<FuncWithDictParamResult>
function funcWithDictParamOutput(args: FuncWithDictParamOutputArgs, opts?: InvokeOptions): Output<FuncWithDictParamResult>
def func_with_dict_param(a: Optional[Mapping[str, str]] = None,
                         b: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> FuncWithDictParamResult
def func_with_dict_param_output(a: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                         b: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[FuncWithDictParamResult]
func FuncWithDictParam(ctx *Context, args *FuncWithDictParamArgs, opts ...InvokeOption) (*FuncWithDictParamResult, error)
func FuncWithDictParamOutput(ctx *Context, args *FuncWithDictParamOutputArgs, opts ...InvokeOption) FuncWithDictParamResultOutput

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

public static class FuncWithDictParam 
{
    public static Task<FuncWithDictParamResult> InvokeAsync(FuncWithDictParamArgs args, InvokeOptions? opts = null)
    public static Output<FuncWithDictParamResult> Invoke(FuncWithDictParamInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<FuncWithDictParamResult> funcWithDictParam(FuncWithDictParamArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: mypkg:funcWithDictParam
  arguments:
    # arguments dictionary

The following arguments are supported:

A Dictionary<string, string>
B string
A map[string]string
B string
a Map<String,String>
b String
a {[key: string]: string}
b string
a Mapping[str, str]
b str
a Map<String>
b String

funcWithDictParam Result

The following output properties are available:

R string
R string
r String
r string
r str
r String

Package Details

Repository
mypkg
License