github.com/myhau/pulumi/pkg/v3@v3.70.2-0.20221116134521-f2775972e587/codegen/testing/test/testdata/output-funcs/docs/funcwithconstinput/_index.md (about) 1 2 --- 3 title: "funcWithConstInput" 4 title_tag: "mypkg.funcWithConstInput" 5 meta_desc: "Documentation for the mypkg.funcWithConstInput function with examples, input properties, output properties, and supporting types." 6 layout: api 7 no_edit_this_page: true 8 --- 9 10 11 12 <!-- WARNING: this file was generated by test. --> 13 <!-- Do not edit by hand unless you're certain you know what you are doing! --> 14 15 Codegen demo with const inputs 16 17 18 19 20 ## Using funcWithConstInput {#using} 21 22 <div> 23 <pulumi-chooser type="language" options="typescript,python,go,csharp,java,yaml"></pulumi-chooser> 24 </div> 25 26 27 <div> 28 <pulumi-choosable type="language" values="javascript,typescript"> 29 <div class="highlight" 30 ><pre class="chroma"><code class="language-typescript" data-lang="typescript" 31 ><span class="k">function </span>funcWithConstInput<span class="p">(</span><span class="nx">args</span><span class="p">:</span> <span class="nx">FuncWithConstInputArgs</span><span class="p">,</span> <span class="nx">opts</span><span class="p">?:</span> <span class="nx"><a href="/docs/reference/pkg/nodejs/pulumi/pulumi/#InvokeOptions">InvokeOptions</a></span><span class="p">): Promise<<span class="nx"><a href="#result">FuncWithConstInputResult</a></span>></span 32 ></code></pre></div> 33 </pulumi-choosable> 34 </div> 35 36 37 <div> 38 <pulumi-choosable type="language" values="python"> 39 <div class="highlight"><pre class="chroma"><code class="language-python" data-lang="python" 40 ><span class="k">def </span>func_with_const_input<span class="p">(</span><span class="nx">plain_input</span><span class="p">:</span> <span class="nx">Optional[str]</span> = None<span class="p">,</span> 41 <span class="nx">opts</span><span class="p">:</span> <span class="nx"><a href="/docs/reference/pkg/python/pulumi/#pulumi.InvokeOptions">Optional[InvokeOptions]</a></span> = None<span class="p">) -></span> <span>FuncWithConstInputResult</span 42 ></code></pre></div> 43 </pulumi-choosable> 44 </div> 45 46 47 <div> 48 <pulumi-choosable type="language" values="go"> 49 <div class="highlight"><pre class="chroma"><code class="language-go" data-lang="go" 50 ><span class="k">func </span>FuncWithConstInput<span class="p">(</span><span class="nx">ctx</span><span class="p"> *</span><span class="nx"><a href="https://pkg.go.dev/github.com/pulumi/pulumi/sdk/v3/go/pulumi?tab=doc#Context">Context</a></span><span class="p">,</span> <span class="nx">args</span><span class="p"> *</span><span class="nx">FuncWithConstInputArgs</span><span class="p">,</span> <span class="nx">opts</span><span class="p"> ...</span><span class="nx"><a href="https://pkg.go.dev/github.com/pulumi/pulumi/sdk/v3/go/pulumi?tab=doc#InvokeOption">InvokeOption</a></span><span class="p">) (*<span class="nx"><a href="#result">FuncWithConstInputResult</a></span>, error)</span 51 ></code></pre></div> 52 53 > Note: This function is named `FuncWithConstInput` in the Go SDK. 54 55 </pulumi-choosable> 56 </div> 57 58 59 <div> 60 <pulumi-choosable type="language" values="csharp"> 61 <div class="highlight"><pre class="chroma"><code class="language-csharp" data-lang="csharp"><span class="k">public static class </span><span class="nx">FuncWithConstInput </span><span class="p"> 62 {</span><span class="k"> 63 public static </span>Task<<span class="nx"><a href="#result">FuncWithConstInputResult</a></span>> <span class="p">InvokeAsync(</span><span class="nx">FuncWithConstInputArgs</span><span class="p"> </span><span class="nx">args<span class="p">,</span> <span class="nx"><a href="/docs/reference/pkg/dotnet/Pulumi/Pulumi.InvokeOptions.html">InvokeOptions</a></span><span class="p">? </span><span class="nx">opts = null<span class="p">)</span><span class="p"> 64 }</span></code></pre></div> 65 </pulumi-choosable> 66 </div> 67 68 69 <div> 70 <pulumi-choosable type="language" values="java"> 71 <div class="highlight"><pre class="chroma"><code class="language-java" data-lang="java"><span class="k">public static CompletableFuture<<span class="nx"><a href="#result">FuncWithConstInputResult</a></span>> </span>funcWithConstInput<span class="p">(</span><span class="nx">FuncWithConstInputArgs</span><span class="p"> </span><span class="nx">args<span class="p">,</span> <span class="nx">InvokeOptions</span><span class="p"> </span><span class="nx">options<span class="p">)</span> 72 <span class="c">// Output-based functions aren't available in Java yet</span> 73 </code></pre></div> 74 </pulumi-choosable> 75 </div> 76 77 78 <div> 79 <pulumi-choosable type="language" values="yaml"> 80 <div class="highlight"><pre class="chroma"><code class="language-yaml" data-lang="yaml"><span class="k">fn::invoke:</span> 81 <span class="k"> function:</span> mypkg:funcWithConstInput 82 <span class="k"> arguments:</span> 83 <span class="c"> # arguments dictionary</span></code></pre></div> 84 </pulumi-choosable> 85 </div> 86 87 88 89 The following arguments are supported: 90 91 92 <div> 93 <pulumi-choosable type="language" values="csharp"> 94 <dl class="resources-properties"></dl> 95 </pulumi-choosable> 96 </div> 97 98 <div> 99 <pulumi-choosable type="language" values="go"> 100 <dl class="resources-properties"></dl> 101 </pulumi-choosable> 102 </div> 103 104 <div> 105 <pulumi-choosable type="language" values="java"> 106 <dl class="resources-properties"></dl> 107 </pulumi-choosable> 108 </div> 109 110 <div> 111 <pulumi-choosable type="language" values="javascript,typescript"> 112 <dl class="resources-properties"></dl> 113 </pulumi-choosable> 114 </div> 115 116 <div> 117 <pulumi-choosable type="language" values="python"> 118 <dl class="resources-properties"></dl> 119 </pulumi-choosable> 120 </div> 121 122 <div> 123 <pulumi-choosable type="language" values="yaml"> 124 <dl class="resources-properties"></dl> 125 </pulumi-choosable> 126 </div> 127 128 129 130 131 ## funcWithConstInput Result {#result} 132 133 The following output properties are available: 134 135 136 137 138 139 140 141 <h2 id="package-details">Package Details</h2> 142 <dl class="package-details"> 143 <dt>Repository</dt> 144 <dd><a href=""></a></dd> 145 <dt>License</dt> 146 <dd></dd> 147 </dl> 148