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