github.com/myhau/pulumi/pkg/v3@v3.70.2-0.20221116134521-f2775972e587/codegen/testing/test/testdata/simple-yaml-schema/docs/argfunction/_index.md (about) 1 2 --- 3 title: "argFunction" 4 title_tag: "example.argFunction" 5 meta_desc: "Documentation for the example.argFunction 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 16 17 18 ## Using argFunction {#using} 19 20 Two invocation forms are available. The direct form accepts plain 21 arguments and either blocks until the result value is available, or 22 returns a Promise-wrapped result. The output form accepts 23 Input-wrapped arguments and returns an Output-wrapped result. 24 25 <div> 26 <pulumi-chooser type="language" options="typescript,python,go,csharp,java,yaml"></pulumi-chooser> 27 </div> 28 29 30 <div> 31 <pulumi-choosable type="language" values="javascript,typescript"> 32 <div class="highlight" 33 ><pre class="chroma"><code class="language-typescript" data-lang="typescript" 34 ><span class="k">function </span>argFunction<span class="p">(</span><span class="nx">args</span><span class="p">:</span> <span class="nx">ArgFunctionArgs</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">ArgFunctionResult</a></span>></span 35 ><span class="k"> 36 function </span>argFunctionOutput<span class="p">(</span><span class="nx">args</span><span class="p">:</span> <span class="nx">ArgFunctionOutputArgs</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">): Output<<span class="nx"><a href="#result">ArgFunctionResult</a></span>></span 37 ></code></pre></div> 38 </pulumi-choosable> 39 </div> 40 41 42 <div> 43 <pulumi-choosable type="language" values="python"> 44 <div class="highlight"><pre class="chroma"><code class="language-python" data-lang="python" 45 ><span class="k">def </span>arg_function<span class="p">(</span><span class="nx">arg1</span><span class="p">:</span> <span class="nx">Optional[Resource]</span> = None<span class="p">,</span> 46 <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>ArgFunctionResult</span 47 ><span class="k"> 48 def </span>arg_function_output<span class="p">(</span><span class="nx">arg1</span><span class="p">:</span> <span class="nx">Optional[pulumi.Input[Resource]]</span> = None<span class="p">,</span> 49 <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>Output[ArgFunctionResult]</span 50 ></code></pre></div> 51 </pulumi-choosable> 52 </div> 53 54 55 <div> 56 <pulumi-choosable type="language" values="go"> 57 <div class="highlight"><pre class="chroma"><code class="language-go" data-lang="go" 58 ><span class="k">func </span>ArgFunction<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">ArgFunctionArgs</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">ArgFunctionResult</a></span>, error)</span 59 ></code></pre></div> 60 61 > Note: This function is named `ArgFunction` in the Go SDK. 62 63 </pulumi-choosable> 64 </div> 65 66 67 <div> 68 <pulumi-choosable type="language" values="csharp"> 69 <div class="highlight"><pre class="chroma"><code class="language-csharp" data-lang="csharp"><span class="k">public static class </span><span class="nx">ArgFunction </span><span class="p"> 70 {</span><span class="k"> 71 public static </span>Task<<span class="nx"><a href="#result">ArgFunctionResult</a></span>> <span class="p">InvokeAsync(</span><span class="nx">ArgFunctionArgs</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="k"> 72 public static </span>Output<<span class="nx"><a href="#result">ArgFunctionResult</a></span>> <span class="p">Invoke(</span><span class="nx">ArgFunctionInvokeArgs</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"> 73 }</span></code></pre></div> 74 </pulumi-choosable> 75 </div> 76 77 78 <div> 79 <pulumi-choosable type="language" values="java"> 80 <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">ArgFunctionResult</a></span>> </span>argFunction<span class="p">(</span><span class="nx">ArgFunctionArgs</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> 81 <span class="c">// Output-based functions aren't available in Java yet</span> 82 </code></pre></div> 83 </pulumi-choosable> 84 </div> 85 86 87 <div> 88 <pulumi-choosable type="language" values="yaml"> 89 <div class="highlight"><pre class="chroma"><code class="language-yaml" data-lang="yaml"><span class="k">fn::invoke:</span> 90 <span class="k"> function:</span> example:argFunction 91 <span class="k"> arguments:</span> 92 <span class="c"> # arguments dictionary</span></code></pre></div> 93 </pulumi-choosable> 94 </div> 95 96 97 98 The following arguments are supported: 99 100 101 <div> 102 <pulumi-choosable type="language" values="csharp"> 103 <dl class="resources-properties"><dt class="property-optional" 104 title="Optional"> 105 <span id="arg1_csharp"> 106 <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#arg1_csharp" style="color: inherit; text-decoration: inherit;">Arg1</a> 107 </span> 108 <span class="property-indicator"></span> 109 <span class="property-type">Pulumi.<wbr>Example.<wbr>Resource</span> 110 </dt> 111 <dd></dd></dl> 112 </pulumi-choosable> 113 </div> 114 115 <div> 116 <pulumi-choosable type="language" values="go"> 117 <dl class="resources-properties"><dt class="property-optional" 118 title="Optional"> 119 <span id="arg1_go"> 120 <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#arg1_go" style="color: inherit; text-decoration: inherit;">Arg1</a> 121 </span> 122 <span class="property-indicator"></span> 123 <span class="property-type">Resource</span> 124 </dt> 125 <dd></dd></dl> 126 </pulumi-choosable> 127 </div> 128 129 <div> 130 <pulumi-choosable type="language" values="java"> 131 <dl class="resources-properties"><dt class="property-optional" 132 title="Optional"> 133 <span id="arg1_java"> 134 <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#arg1_java" style="color: inherit; text-decoration: inherit;">arg1</a> 135 </span> 136 <span class="property-indicator"></span> 137 <span class="property-type">Resource</span> 138 </dt> 139 <dd></dd></dl> 140 </pulumi-choosable> 141 </div> 142 143 <div> 144 <pulumi-choosable type="language" values="javascript,typescript"> 145 <dl class="resources-properties"><dt class="property-optional" 146 title="Optional"> 147 <span id="arg1_nodejs"> 148 <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#arg1_nodejs" style="color: inherit; text-decoration: inherit;">arg1</a> 149 </span> 150 <span class="property-indicator"></span> 151 <span class="property-type">Resource</span> 152 </dt> 153 <dd></dd></dl> 154 </pulumi-choosable> 155 </div> 156 157 <div> 158 <pulumi-choosable type="language" values="python"> 159 <dl class="resources-properties"><dt class="property-optional" 160 title="Optional"> 161 <span id="arg1_python"> 162 <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#arg1_python" style="color: inherit; text-decoration: inherit;">arg1</a> 163 </span> 164 <span class="property-indicator"></span> 165 <span class="property-type">Resource</span> 166 </dt> 167 <dd></dd></dl> 168 </pulumi-choosable> 169 </div> 170 171 <div> 172 <pulumi-choosable type="language" values="yaml"> 173 <dl class="resources-properties"><dt class="property-optional" 174 title="Optional"> 175 <span id="arg1_yaml"> 176 <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#arg1_yaml" style="color: inherit; text-decoration: inherit;">arg1</a> 177 </span> 178 <span class="property-indicator"></span> 179 <span class="property-type">example:Resource</span> 180 </dt> 181 <dd></dd></dl> 182 </pulumi-choosable> 183 </div> 184 185 186 187 188 ## argFunction Result {#result} 189 190 The following output properties are available: 191 192 193 194 <div> 195 <pulumi-choosable type="language" values="csharp"> 196 <dl class="resources-properties"><dt class="property-" 197 title=""> 198 <span id="result_csharp"> 199 <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#result_csharp" style="color: inherit; text-decoration: inherit;">Result</a> 200 </span> 201 <span class="property-indicator"></span> 202 <span class="property-type">Pulumi.<wbr>Example.<wbr>Resource</span> 203 </dt> 204 <dd></dd></dl> 205 </pulumi-choosable> 206 </div> 207 208 <div> 209 <pulumi-choosable type="language" values="go"> 210 <dl class="resources-properties"><dt class="property-" 211 title=""> 212 <span id="result_go"> 213 <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#result_go" style="color: inherit; text-decoration: inherit;">Result</a> 214 </span> 215 <span class="property-indicator"></span> 216 <span class="property-type">Resource</span> 217 </dt> 218 <dd></dd></dl> 219 </pulumi-choosable> 220 </div> 221 222 <div> 223 <pulumi-choosable type="language" values="java"> 224 <dl class="resources-properties"><dt class="property-" 225 title=""> 226 <span id="result_java"> 227 <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#result_java" style="color: inherit; text-decoration: inherit;">result</a> 228 </span> 229 <span class="property-indicator"></span> 230 <span class="property-type">Resource</span> 231 </dt> 232 <dd></dd></dl> 233 </pulumi-choosable> 234 </div> 235 236 <div> 237 <pulumi-choosable type="language" values="javascript,typescript"> 238 <dl class="resources-properties"><dt class="property-" 239 title=""> 240 <span id="result_nodejs"> 241 <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#result_nodejs" style="color: inherit; text-decoration: inherit;">result</a> 242 </span> 243 <span class="property-indicator"></span> 244 <span class="property-type">Resource</span> 245 </dt> 246 <dd></dd></dl> 247 </pulumi-choosable> 248 </div> 249 250 <div> 251 <pulumi-choosable type="language" values="python"> 252 <dl class="resources-properties"><dt class="property-" 253 title=""> 254 <span id="result_python"> 255 <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#result_python" style="color: inherit; text-decoration: inherit;">result</a> 256 </span> 257 <span class="property-indicator"></span> 258 <span class="property-type">Resource</span> 259 </dt> 260 <dd></dd></dl> 261 </pulumi-choosable> 262 </div> 263 264 <div> 265 <pulumi-choosable type="language" values="yaml"> 266 <dl class="resources-properties"><dt class="property-" 267 title=""> 268 <span id="result_yaml"> 269 <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#result_yaml" style="color: inherit; text-decoration: inherit;">result</a> 270 </span> 271 <span class="property-indicator"></span> 272 <span class="property-type">example:Resource</span> 273 </dt> 274 <dd></dd></dl> 275 </pulumi-choosable> 276 </div> 277 278 279 280 281 282 <h2 id="package-details">Package Details</h2> 283 <dl class="package-details"> 284 <dt>Repository</dt> 285 <dd><a href=""></a></dd> 286 <dt>License</dt> 287 <dd></dd> 288 </dl> 289