github.com/myhau/pulumi/pkg/v3@v3.70.2-0.20221116134521-f2775972e587/codegen/testing/test/testdata/provider-config-schema/docs/provider/_index.md (about) 1 2 --- 3 title: "Provider" 4 title_tag: "configstation.Provider" 5 meta_desc: "Documentation for the configstation.Provider resource with examples, input properties, output properties, lookup functions, 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 ## Create Provider Resource {#create} 19 <div> 20 <pulumi-chooser type="language" options="typescript,python,go,csharp,java,yaml"></pulumi-chooser> 21 </div> 22 23 24 <div> 25 <pulumi-choosable type="language" values="javascript,typescript"> 26 <div class="highlight"><pre class="chroma"><code class="language-typescript" data-lang="typescript"><span class="k">new </span><span class="nx">Provider</span><span class="p">(</span><span class="nx">name</span><span class="p">:</span> <span class="nx">string</span><span class="p">,</span> <span class="nx">args</span><span class="p">?:</span> <span class="nx"><a href="#inputs">ProviderArgs</a></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/#CustomResourceOptions">CustomResourceOptions</a></span><span class="p">);</span></code></pre></div> 27 </pulumi-choosable> 28 </div> 29 30 <div> 31 <pulumi-choosable type="language" values="python"> 32 <div class="highlight"><pre class="chroma"><code class="language-python" data-lang="python"><span class=nd>@overload</span> 33 <span class="k">def </span><span class="nx">Provider</span><span class="p">(</span><span class="nx">resource_name</span><span class="p">:</span> <span class="nx">str</span><span class="p">,</span> 34 <span class="nx">opts</span><span class="p">:</span> <span class="nx"><a href="/docs/reference/pkg/python/pulumi/#pulumi.ResourceOptions">Optional[ResourceOptions]</a></span> = None<span class="p">,</span> 35 <span class="nx">favorite_color</span><span class="p">:</span> <span class="nx">Optional[Union[str, Color]]</span> = None<span class="p">)</span> 36 <span class=nd>@overload</span> 37 <span class="k">def </span><span class="nx">Provider</span><span class="p">(</span><span class="nx">resource_name</span><span class="p">:</span> <span class="nx">str</span><span class="p">,</span> 38 <span class="nx">args</span><span class="p">:</span> <span class="nx"><a href="#inputs">Optional[ProviderArgs]</a></span> = None<span class="p">,</span> 39 <span class="nx">opts</span><span class="p">:</span> <span class="nx"><a href="/docs/reference/pkg/python/pulumi/#pulumi.ResourceOptions">Optional[ResourceOptions]</a></span> = None<span class="p">)</span></code></pre></div> 40 </pulumi-choosable> 41 </div> 42 43 <div> 44 <pulumi-choosable type="language" values="go"> 45 <div class="highlight"><pre class="chroma"><code class="language-go" data-lang="go"><span class="k">func </span><span class="nx">NewProvider</span><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">name</span><span class="p"> </span><span class="nx">string</span><span class="p">,</span> <span class="nx">args</span><span class="p"> *</span><span class="nx"><a href="#inputs">ProviderArgs</a></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#ResourceOption">ResourceOption</a></span><span class="p">) (*<span class="nx">Provider</span>, error)</span></code></pre></div> 46 </pulumi-choosable> 47 </div> 48 49 <div> 50 <pulumi-choosable type="language" values="csharp"> 51 <div class="highlight"><pre class="chroma"><code class="language-csharp" data-lang="csharp"><span class="k">public </span><span class="nx">Provider</span><span class="p">(</span><span class="nx">string</span><span class="p"> </span><span class="nx">name<span class="p">,</span> <span class="nx"><a href="#inputs">ProviderArgs</a></span><span class="p">? </span><span class="nx">args = null<span class="p">,</span> <span class="nx"><a href="/docs/reference/pkg/dotnet/Pulumi/Pulumi.CustomResourceOptions.html">CustomResourceOptions</a></span><span class="p">? </span><span class="nx">opts = null<span class="p">)</span></code></pre></div> 52 </pulumi-choosable> 53 </div> 54 55 <div> 56 <pulumi-choosable type="language" values="java"> 57 <div class="highlight"><pre class="chroma"> 58 <code class="language-java" data-lang="java"><span class="k">public </span><span class="nx">Provider</span><span class="p">(</span><span class="nx">String</span><span class="p"> </span><span class="nx">name<span class="p">,</span> <span class="nx"><a href="#inputs">ProviderArgs</a></span><span class="p"> </span><span class="nx">args<span class="p">)</span> 59 <span class="k">public </span><span class="nx">Provider</span><span class="p">(</span><span class="nx">String</span><span class="p"> </span><span class="nx">name<span class="p">,</span> <span class="nx"><a href="#inputs">ProviderArgs</a></span><span class="p"> </span><span class="nx">args<span class="p">,</span> <span class="nx">CustomResourceOptions</span><span class="p"> </span><span class="nx">options<span class="p">)</span> 60 </code></pre></div> 61 </pulumi-choosable> 62 </div> 63 64 <div> 65 <pulumi-choosable type="language" values="yaml"> 66 <div class="highlight"><pre class="chroma"><code class="language-yaml" data-lang="yaml">type: <span class="nx">pulumi:providers:configstation</span><span class="p"></span> 67 <span class="p">properties</span><span class="p">: </span><span class="c"># The arguments to resource properties.</span> 68 <span class="p"></span><span class="p">options</span><span class="p">: </span><span class="c"># Bag of options to control resource's behavior.</span> 69 <span class="p"></span> 70 </code></pre></div> 71 </pulumi-choosable> 72 </div> 73 74 <div> 75 <pulumi-choosable type="language" values="javascript,typescript"> 76 77 <dl class="resources-properties"><dt 78 class="property-required" title="Required"> 79 <span>name</span> 80 <span class="property-indicator"></span> 81 <span class="property-type">string</span> 82 </dt> 83 <dd>The unique name of the resource.</dd><dt 84 class="property-optional" title="Optional"> 85 <span>args</span> 86 <span class="property-indicator"></span> 87 <span class="property-type"><a href="#inputs">ProviderArgs</a></span> 88 </dt> 89 <dd>The arguments to resource properties.</dd><dt 90 class="property-optional" title="Optional"> 91 <span>opts</span> 92 <span class="property-indicator"></span> 93 <span class="property-type"><a href="/docs/reference/pkg/nodejs/pulumi/pulumi/#CustomResourceOptions">CustomResourceOptions</a></span> 94 </dt> 95 <dd>Bag of options to control resource's behavior.</dd></dl> 96 97 </pulumi-choosable> 98 </div> 99 100 <div> 101 <pulumi-choosable type="language" values="python"> 102 103 <dl class="resources-properties"><dt 104 class="property-required" title="Required"> 105 <span>resource_name</span> 106 <span class="property-indicator"></span> 107 <span class="property-type">str</span> 108 </dt> 109 <dd>The unique name of the resource.</dd><dt 110 class="property-optional" title="Optional"> 111 <span>args</span> 112 <span class="property-indicator"></span> 113 <span class="property-type"><a href="#inputs">ProviderArgs</a></span> 114 </dt> 115 <dd>The arguments to resource properties.</dd><dt 116 class="property-optional" title="Optional"> 117 <span>opts</span> 118 <span class="property-indicator"></span> 119 <span class="property-type"><a href="/docs/reference/pkg/python/pulumi/#pulumi.ResourceOptions">ResourceOptions</a></span> 120 </dt> 121 <dd>Bag of options to control resource's behavior.</dd></dl> 122 123 </pulumi-choosable> 124 </div> 125 126 <div> 127 <pulumi-choosable type="language" values="go"> 128 129 <dl class="resources-properties"><dt 130 class="property-optional" title="Optional"> 131 <span>ctx</span> 132 <span class="property-indicator"></span> 133 <span class="property-type"><a href="https://pkg.go.dev/github.com/pulumi/pulumi/sdk/v3/go/pulumi?tab=doc#Context">Context</a></span> 134 </dt> 135 <dd>Context object for the current deployment.</dd><dt 136 class="property-required" title="Required"> 137 <span>name</span> 138 <span class="property-indicator"></span> 139 <span class="property-type">string</span> 140 </dt> 141 <dd>The unique name of the resource.</dd><dt 142 class="property-optional" title="Optional"> 143 <span>args</span> 144 <span class="property-indicator"></span> 145 <span class="property-type"><a href="#inputs">ProviderArgs</a></span> 146 </dt> 147 <dd>The arguments to resource properties.</dd><dt 148 class="property-optional" title="Optional"> 149 <span>opts</span> 150 <span class="property-indicator"></span> 151 <span class="property-type"><a href="https://pkg.go.dev/github.com/pulumi/pulumi/sdk/v3/go/pulumi?tab=doc#ResourceOption">ResourceOption</a></span> 152 </dt> 153 <dd>Bag of options to control resource's behavior.</dd></dl> 154 155 </pulumi-choosable> 156 </div> 157 158 <div> 159 <pulumi-choosable type="language" values="csharp"> 160 161 <dl class="resources-properties"><dt 162 class="property-required" title="Required"> 163 <span>name</span> 164 <span class="property-indicator"></span> 165 <span class="property-type">string</span> 166 </dt> 167 <dd>The unique name of the resource.</dd><dt 168 class="property-optional" title="Optional"> 169 <span>args</span> 170 <span class="property-indicator"></span> 171 <span class="property-type"><a href="#inputs">ProviderArgs</a></span> 172 </dt> 173 <dd>The arguments to resource properties.</dd><dt 174 class="property-optional" title="Optional"> 175 <span>opts</span> 176 <span class="property-indicator"></span> 177 <span class="property-type"><a href="/docs/reference/pkg/dotnet/Pulumi/Pulumi.CustomResourceOptions.html">CustomResourceOptions</a></span> 178 </dt> 179 <dd>Bag of options to control resource's behavior.</dd></dl> 180 181 </pulumi-choosable> 182 </div> 183 184 <div> 185 <pulumi-choosable type="language" values="java"> 186 187 <dl class="resources-properties"><dt 188 class="property-required" title="Required"> 189 <span>name</span> 190 <span class="property-indicator"></span> 191 <span class="property-type">String</span> 192 </dt> 193 <dd>The unique name of the resource.</dd><dt 194 class="property-required" title="Required"> 195 <span>args</span> 196 <span class="property-indicator"></span> 197 <span class="property-type"><a href="#inputs">ProviderArgs</a></span> 198 </dt> 199 <dd>The arguments to resource properties.</dd><dt 200 class="property-optional" title="Optional"> 201 <span>options</span> 202 <span class="property-indicator"></span> 203 <span class="property-type">CustomResourceOptions</span> 204 </dt> 205 <dd>Bag of options to control resource's behavior.</dd></dl> 206 207 </pulumi-choosable> 208 </div> 209 210 ## Provider Resource Properties {#properties} 211 212 To learn more about resource properties and how to use them, see [Inputs and Outputs](/docs/intro/concepts/inputs-outputs) in the Architecture and Concepts docs. 213 214 ### Inputs 215 216 The Provider resource accepts the following [input](/docs/intro/concepts/inputs-outputs) properties: 217 218 219 220 <div> 221 <pulumi-choosable type="language" values="csharp"> 222 <dl class="resources-properties"><dt class="property-optional" 223 title="Optional"> 224 <span id="favoritecolor_csharp"> 225 <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#favoritecolor_csharp" style="color: inherit; text-decoration: inherit;">Favorite<wbr>Color</a> 226 </span> 227 <span class="property-indicator"></span> 228 <span class="property-type">string | <a href="#color">Configstation.<wbr>Pulumi.<wbr>Configstation.<wbr>Color</a></span> 229 </dt> 230 <dd><p>this is a relaxed string enum which can also be set via env var It can also be sourced from the following environment variable: <code>FAVE_COLOR</code></p> 231 </dd></dl> 232 </pulumi-choosable> 233 </div> 234 235 <div> 236 <pulumi-choosable type="language" values="go"> 237 <dl class="resources-properties"><dt class="property-optional" 238 title="Optional"> 239 <span id="favoritecolor_go"> 240 <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#favoritecolor_go" style="color: inherit; text-decoration: inherit;">Favorite<wbr>Color</a> 241 </span> 242 <span class="property-indicator"></span> 243 <span class="property-type">string | <a href="#color">Color</a></span> 244 </dt> 245 <dd><p>this is a relaxed string enum which can also be set via env var It can also be sourced from the following environment variable: <code>FAVE_COLOR</code></p> 246 </dd></dl> 247 </pulumi-choosable> 248 </div> 249 250 <div> 251 <pulumi-choosable type="language" values="java"> 252 <dl class="resources-properties"><dt class="property-optional" 253 title="Optional"> 254 <span id="favoritecolor_java"> 255 <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#favoritecolor_java" style="color: inherit; text-decoration: inherit;">favorite<wbr>Color</a> 256 </span> 257 <span class="property-indicator"></span> 258 <span class="property-type">String | <a href="#color">Color</a></span> 259 </dt> 260 <dd><p>this is a relaxed string enum which can also be set via env var It can also be sourced from the following environment variable: <code>FAVE_COLOR</code></p> 261 </dd></dl> 262 </pulumi-choosable> 263 </div> 264 265 <div> 266 <pulumi-choosable type="language" values="javascript,typescript"> 267 <dl class="resources-properties"><dt class="property-optional" 268 title="Optional"> 269 <span id="favoritecolor_nodejs"> 270 <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#favoritecolor_nodejs" style="color: inherit; text-decoration: inherit;">favorite<wbr>Color</a> 271 </span> 272 <span class="property-indicator"></span> 273 <span class="property-type">string | <a href="#color">Color</a></span> 274 </dt> 275 <dd><p>this is a relaxed string enum which can also be set via env var It can also be sourced from the following environment variable: <code>FAVE_COLOR</code></p> 276 </dd></dl> 277 </pulumi-choosable> 278 </div> 279 280 <div> 281 <pulumi-choosable type="language" values="python"> 282 <dl class="resources-properties"><dt class="property-optional" 283 title="Optional"> 284 <span id="favorite_color_python"> 285 <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#favorite_color_python" style="color: inherit; text-decoration: inherit;">favorite_<wbr>color</a> 286 </span> 287 <span class="property-indicator"></span> 288 <span class="property-type">str | <a href="#color">Color</a></span> 289 </dt> 290 <dd><p>this is a relaxed string enum which can also be set via env var It can also be sourced from the following environment variable: <code>FAVE_COLOR</code></p> 291 </dd></dl> 292 </pulumi-choosable> 293 </div> 294 295 <div> 296 <pulumi-choosable type="language" values="yaml"> 297 <dl class="resources-properties"><dt class="property-optional" 298 title="Optional"> 299 <span id="favoritecolor_yaml"> 300 <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#favoritecolor_yaml" style="color: inherit; text-decoration: inherit;">favorite<wbr>Color</a> 301 </span> 302 <span class="property-indicator"></span> 303 <span class="property-type">String | <a href="#color">"blue" | "red"</a></span> 304 </dt> 305 <dd><p>this is a relaxed string enum which can also be set via env var It can also be sourced from the following environment variable: <code>FAVE_COLOR</code></p> 306 </dd></dl> 307 </pulumi-choosable> 308 </div> 309 310 311 ### Outputs 312 313 All [input](#inputs) properties are implicitly available as output properties. Additionally, the Provider resource produces the following output properties: 314 315 316 317 <div> 318 <pulumi-choosable type="language" values="csharp"> 319 <dl class="resources-properties"><dt class="property-" 320 title=""> 321 <span id="id_csharp"> 322 <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#id_csharp" style="color: inherit; text-decoration: inherit;">Id</a> 323 </span> 324 <span class="property-indicator"></span> 325 <span class="property-type">string</span> 326 </dt> 327 <dd><p>The provider-assigned unique ID for this managed resource.</p> 328 </dd></dl> 329 </pulumi-choosable> 330 </div> 331 332 <div> 333 <pulumi-choosable type="language" values="go"> 334 <dl class="resources-properties"><dt class="property-" 335 title=""> 336 <span id="id_go"> 337 <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#id_go" style="color: inherit; text-decoration: inherit;">Id</a> 338 </span> 339 <span class="property-indicator"></span> 340 <span class="property-type">string</span> 341 </dt> 342 <dd><p>The provider-assigned unique ID for this managed resource.</p> 343 </dd></dl> 344 </pulumi-choosable> 345 </div> 346 347 <div> 348 <pulumi-choosable type="language" values="java"> 349 <dl class="resources-properties"><dt class="property-" 350 title=""> 351 <span id="id_java"> 352 <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#id_java" style="color: inherit; text-decoration: inherit;">id</a> 353 </span> 354 <span class="property-indicator"></span> 355 <span class="property-type">String</span> 356 </dt> 357 <dd><p>The provider-assigned unique ID for this managed resource.</p> 358 </dd></dl> 359 </pulumi-choosable> 360 </div> 361 362 <div> 363 <pulumi-choosable type="language" values="javascript,typescript"> 364 <dl class="resources-properties"><dt class="property-" 365 title=""> 366 <span id="id_nodejs"> 367 <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#id_nodejs" style="color: inherit; text-decoration: inherit;">id</a> 368 </span> 369 <span class="property-indicator"></span> 370 <span class="property-type">string</span> 371 </dt> 372 <dd><p>The provider-assigned unique ID for this managed resource.</p> 373 </dd></dl> 374 </pulumi-choosable> 375 </div> 376 377 <div> 378 <pulumi-choosable type="language" values="python"> 379 <dl class="resources-properties"><dt class="property-" 380 title=""> 381 <span id="id_python"> 382 <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#id_python" style="color: inherit; text-decoration: inherit;">id</a> 383 </span> 384 <span class="property-indicator"></span> 385 <span class="property-type">str</span> 386 </dt> 387 <dd><p>The provider-assigned unique ID for this managed resource.</p> 388 </dd></dl> 389 </pulumi-choosable> 390 </div> 391 392 <div> 393 <pulumi-choosable type="language" values="yaml"> 394 <dl class="resources-properties"><dt class="property-" 395 title=""> 396 <span id="id_yaml"> 397 <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#id_yaml" style="color: inherit; text-decoration: inherit;">id</a> 398 </span> 399 <span class="property-indicator"></span> 400 <span class="property-type">String</span> 401 </dt> 402 <dd><p>The provider-assigned unique ID for this managed resource.</p> 403 </dd></dl> 404 </pulumi-choosable> 405 </div> 406 407 408 409 410 411 412 413 ## Supporting Types 414 415 416 417 <h4 id="color">Color</h4> 418 419 <div> 420 <pulumi-choosable type="language" values="csharp"> 421 <dl class="tabular"><dt>Blue</dt> 422 <dd>blue</dd><dt>Red</dt> 423 <dd>red</dd></dl> 424 </pulumi-choosable> 425 </div> 426 427 <div> 428 <pulumi-choosable type="language" values="go"> 429 <dl class="tabular"><dt>Color<wbr>Blue</dt> 430 <dd>blue</dd><dt>Color<wbr>Red</dt> 431 <dd>red</dd></dl> 432 </pulumi-choosable> 433 </div> 434 435 <div> 436 <pulumi-choosable type="language" values="java"> 437 <dl class="tabular"><dt>Blue</dt> 438 <dd>blue</dd><dt>Red</dt> 439 <dd>red</dd></dl> 440 </pulumi-choosable> 441 </div> 442 443 <div> 444 <pulumi-choosable type="language" values="nodejs"> 445 <dl class="tabular"><dt>Blue</dt> 446 <dd>blue</dd><dt>Red</dt> 447 <dd>red</dd></dl> 448 </pulumi-choosable> 449 </div> 450 451 <div> 452 <pulumi-choosable type="language" values="python"> 453 <dl class="tabular"><dt>BLUE</dt> 454 <dd>blue</dd><dt>RED</dt> 455 <dd>red</dd></dl> 456 </pulumi-choosable> 457 </div> 458 459 <div> 460 <pulumi-choosable type="language" values="yaml"> 461 <dl class="tabular"><dt>"blue"</dt> 462 <dd>blue</dd><dt>"red"</dt> 463 <dd>red</dd></dl> 464 </pulumi-choosable> 465 </div> 466 467 468 <h2 id="package-details">Package Details</h2> 469 <dl class="package-details"> 470 <dt>Repository</dt> 471 <dd><a href=""></a></dd> 472 <dt>License</dt> 473 <dd></dd> 474 </dl> 475