github.com/myhau/pulumi/pkg/v3@v3.70.2-0.20221116134521-f2775972e587/codegen/testing/test/testdata/simple-resource-schema-custom-pypackage-name/docs/provider/_index.md (about)

     1  
     2  ---
     3  title: "Provider"
     4  title_tag: "example.Provider"
     5  meta_desc: "Documentation for the example.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=nd>@overload</span>
    36  <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>
    37               <span class="nx">args</span><span class="p">:</span> <span class="nx"><a href="#inputs">Optional[ProviderArgs]</a></span> = None<span class="p">,</span>
    38               <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>
    39  </pulumi-choosable>
    40  </div>
    41  
    42  <div>
    43  <pulumi-choosable type="language" values="go">
    44  <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>
    45  </pulumi-choosable>
    46  </div>
    47  
    48  <div>
    49  <pulumi-choosable type="language" values="csharp">
    50  <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>
    51  </pulumi-choosable>
    52  </div>
    53  
    54  <div>
    55  <pulumi-choosable type="language" values="java">
    56  <div class="highlight"><pre class="chroma">
    57  <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>
    58  <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>
    59  </code></pre></div>
    60  </pulumi-choosable>
    61  </div>
    62  
    63  <div>
    64  <pulumi-choosable type="language" values="yaml">
    65  <div class="highlight"><pre class="chroma"><code class="language-yaml" data-lang="yaml">type: <span class="nx">pulumi:providers:example</span><span class="p"></span>
    66  <span class="p">properties</span><span class="p">: </span><span class="c">#&nbsp;The arguments to resource properties.</span>
    67  <span class="p"></span><span class="p">options</span><span class="p">: </span><span class="c">#&nbsp;Bag of options to control resource&#39;s behavior.</span>
    68  <span class="p"></span>
    69  </code></pre></div>
    70  </pulumi-choosable>
    71  </div>
    72  
    73  <div>
    74  <pulumi-choosable type="language" values="javascript,typescript">
    75  
    76  <dl class="resources-properties"><dt
    77          class="property-required" title="Required">
    78          <span>name</span>
    79          <span class="property-indicator"></span>
    80          <span class="property-type">string</span>
    81      </dt>
    82      <dd>The unique name of the resource.</dd><dt
    83          class="property-optional" title="Optional">
    84          <span>args</span>
    85          <span class="property-indicator"></span>
    86          <span class="property-type"><a href="#inputs">ProviderArgs</a></span>
    87      </dt>
    88      <dd>The arguments to resource properties.</dd><dt
    89          class="property-optional" title="Optional">
    90          <span>opts</span>
    91          <span class="property-indicator"></span>
    92          <span class="property-type"><a href="/docs/reference/pkg/nodejs/pulumi/pulumi/#CustomResourceOptions">CustomResourceOptions</a></span>
    93      </dt>
    94      <dd>Bag of options to control resource&#39;s behavior.</dd></dl>
    95  
    96  </pulumi-choosable>
    97  </div>
    98  
    99  <div>
   100  <pulumi-choosable type="language" values="python">
   101  
   102  <dl class="resources-properties"><dt
   103          class="property-required" title="Required">
   104          <span>resource_name</span>
   105          <span class="property-indicator"></span>
   106          <span class="property-type">str</span>
   107      </dt>
   108      <dd>The unique name of the resource.</dd><dt
   109          class="property-optional" title="Optional">
   110          <span>args</span>
   111          <span class="property-indicator"></span>
   112          <span class="property-type"><a href="#inputs">ProviderArgs</a></span>
   113      </dt>
   114      <dd>The arguments to resource properties.</dd><dt
   115          class="property-optional" title="Optional">
   116          <span>opts</span>
   117          <span class="property-indicator"></span>
   118          <span class="property-type"><a href="/docs/reference/pkg/python/pulumi/#pulumi.ResourceOptions">ResourceOptions</a></span>
   119      </dt>
   120      <dd>Bag of options to control resource&#39;s behavior.</dd></dl>
   121  
   122  </pulumi-choosable>
   123  </div>
   124  
   125  <div>
   126  <pulumi-choosable type="language" values="go">
   127  
   128  <dl class="resources-properties"><dt
   129          class="property-optional" title="Optional">
   130          <span>ctx</span>
   131          <span class="property-indicator"></span>
   132          <span class="property-type"><a href="https://pkg.go.dev/github.com/pulumi/pulumi/sdk/v3/go/pulumi?tab=doc#Context">Context</a></span>
   133      </dt>
   134      <dd>Context object for the current deployment.</dd><dt
   135          class="property-required" title="Required">
   136          <span>name</span>
   137          <span class="property-indicator"></span>
   138          <span class="property-type">string</span>
   139      </dt>
   140      <dd>The unique name of the resource.</dd><dt
   141          class="property-optional" title="Optional">
   142          <span>args</span>
   143          <span class="property-indicator"></span>
   144          <span class="property-type"><a href="#inputs">ProviderArgs</a></span>
   145      </dt>
   146      <dd>The arguments to resource properties.</dd><dt
   147          class="property-optional" title="Optional">
   148          <span>opts</span>
   149          <span class="property-indicator"></span>
   150          <span class="property-type"><a href="https://pkg.go.dev/github.com/pulumi/pulumi/sdk/v3/go/pulumi?tab=doc#ResourceOption">ResourceOption</a></span>
   151      </dt>
   152      <dd>Bag of options to control resource&#39;s behavior.</dd></dl>
   153  
   154  </pulumi-choosable>
   155  </div>
   156  
   157  <div>
   158  <pulumi-choosable type="language" values="csharp">
   159  
   160  <dl class="resources-properties"><dt
   161          class="property-required" title="Required">
   162          <span>name</span>
   163          <span class="property-indicator"></span>
   164          <span class="property-type">string</span>
   165      </dt>
   166      <dd>The unique name of the resource.</dd><dt
   167          class="property-optional" title="Optional">
   168          <span>args</span>
   169          <span class="property-indicator"></span>
   170          <span class="property-type"><a href="#inputs">ProviderArgs</a></span>
   171      </dt>
   172      <dd>The arguments to resource properties.</dd><dt
   173          class="property-optional" title="Optional">
   174          <span>opts</span>
   175          <span class="property-indicator"></span>
   176          <span class="property-type"><a href="/docs/reference/pkg/dotnet/Pulumi/Pulumi.CustomResourceOptions.html">CustomResourceOptions</a></span>
   177      </dt>
   178      <dd>Bag of options to control resource&#39;s behavior.</dd></dl>
   179  
   180  </pulumi-choosable>
   181  </div>
   182  
   183  <div>
   184  <pulumi-choosable type="language" values="java">
   185  
   186  <dl class="resources-properties"><dt
   187          class="property-required" title="Required">
   188          <span>name</span>
   189          <span class="property-indicator"></span>
   190          <span class="property-type">String</span>
   191      </dt>
   192      <dd>The unique name of the resource.</dd><dt
   193          class="property-required" title="Required">
   194          <span>args</span>
   195          <span class="property-indicator"></span>
   196          <span class="property-type"><a href="#inputs">ProviderArgs</a></span>
   197      </dt>
   198      <dd>The arguments to resource properties.</dd><dt
   199          class="property-optional" title="Optional">
   200          <span>options</span>
   201          <span class="property-indicator"></span>
   202          <span class="property-type">CustomResourceOptions</span>
   203      </dt>
   204      <dd>Bag of options to control resource&#39;s behavior.</dd></dl>
   205  
   206  </pulumi-choosable>
   207  </div>
   208  
   209  ## Provider Resource Properties {#properties}
   210  
   211  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.
   212  
   213  ### Inputs
   214  
   215  The Provider resource accepts the following [input](/docs/intro/concepts/inputs-outputs) properties:
   216  
   217  
   218  
   219  <div>
   220  <pulumi-choosable type="language" values="csharp">
   221  <dl class="resources-properties"></dl>
   222  </pulumi-choosable>
   223  </div>
   224  
   225  <div>
   226  <pulumi-choosable type="language" values="go">
   227  <dl class="resources-properties"></dl>
   228  </pulumi-choosable>
   229  </div>
   230  
   231  <div>
   232  <pulumi-choosable type="language" values="java">
   233  <dl class="resources-properties"></dl>
   234  </pulumi-choosable>
   235  </div>
   236  
   237  <div>
   238  <pulumi-choosable type="language" values="javascript,typescript">
   239  <dl class="resources-properties"></dl>
   240  </pulumi-choosable>
   241  </div>
   242  
   243  <div>
   244  <pulumi-choosable type="language" values="python">
   245  <dl class="resources-properties"></dl>
   246  </pulumi-choosable>
   247  </div>
   248  
   249  <div>
   250  <pulumi-choosable type="language" values="yaml">
   251  <dl class="resources-properties"></dl>
   252  </pulumi-choosable>
   253  </div>
   254  
   255  
   256  ### Outputs
   257  
   258  All [input](#inputs) properties are implicitly available as output properties. Additionally, the Provider resource produces the following output properties:
   259  
   260  
   261  
   262  <div>
   263  <pulumi-choosable type="language" values="csharp">
   264  <dl class="resources-properties"><dt class="property-"
   265              title="">
   266          <span id="id_csharp">
   267  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#id_csharp" style="color: inherit; text-decoration: inherit;">Id</a>
   268  </span>
   269          <span class="property-indicator"></span>
   270          <span class="property-type">string</span>
   271      </dt>
   272      <dd><p>The provider-assigned unique ID for this managed resource.</p>
   273  </dd></dl>
   274  </pulumi-choosable>
   275  </div>
   276  
   277  <div>
   278  <pulumi-choosable type="language" values="go">
   279  <dl class="resources-properties"><dt class="property-"
   280              title="">
   281          <span id="id_go">
   282  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#id_go" style="color: inherit; text-decoration: inherit;">Id</a>
   283  </span>
   284          <span class="property-indicator"></span>
   285          <span class="property-type">string</span>
   286      </dt>
   287      <dd><p>The provider-assigned unique ID for this managed resource.</p>
   288  </dd></dl>
   289  </pulumi-choosable>
   290  </div>
   291  
   292  <div>
   293  <pulumi-choosable type="language" values="java">
   294  <dl class="resources-properties"><dt class="property-"
   295              title="">
   296          <span id="id_java">
   297  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#id_java" style="color: inherit; text-decoration: inherit;">id</a>
   298  </span>
   299          <span class="property-indicator"></span>
   300          <span class="property-type">String</span>
   301      </dt>
   302      <dd><p>The provider-assigned unique ID for this managed resource.</p>
   303  </dd></dl>
   304  </pulumi-choosable>
   305  </div>
   306  
   307  <div>
   308  <pulumi-choosable type="language" values="javascript,typescript">
   309  <dl class="resources-properties"><dt class="property-"
   310              title="">
   311          <span id="id_nodejs">
   312  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#id_nodejs" style="color: inherit; text-decoration: inherit;">id</a>
   313  </span>
   314          <span class="property-indicator"></span>
   315          <span class="property-type">string</span>
   316      </dt>
   317      <dd><p>The provider-assigned unique ID for this managed resource.</p>
   318  </dd></dl>
   319  </pulumi-choosable>
   320  </div>
   321  
   322  <div>
   323  <pulumi-choosable type="language" values="python">
   324  <dl class="resources-properties"><dt class="property-"
   325              title="">
   326          <span id="id_python">
   327  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#id_python" style="color: inherit; text-decoration: inherit;">id</a>
   328  </span>
   329          <span class="property-indicator"></span>
   330          <span class="property-type">str</span>
   331      </dt>
   332      <dd><p>The provider-assigned unique ID for this managed resource.</p>
   333  </dd></dl>
   334  </pulumi-choosable>
   335  </div>
   336  
   337  <div>
   338  <pulumi-choosable type="language" values="yaml">
   339  <dl class="resources-properties"><dt class="property-"
   340              title="">
   341          <span id="id_yaml">
   342  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#id_yaml" style="color: inherit; text-decoration: inherit;">id</a>
   343  </span>
   344          <span class="property-indicator"></span>
   345          <span class="property-type">String</span>
   346      </dt>
   347      <dd><p>The provider-assigned unique ID for this managed resource.</p>
   348  </dd></dl>
   349  </pulumi-choosable>
   350  </div>
   351  
   352  
   353  
   354  
   355  
   356  
   357  
   358  
   359  <h2 id="package-details">Package Details</h2>
   360  <dl class="package-details">
   361  	<dt>Repository</dt>
   362  	<dd><a href=""></a></dd>
   363  	<dt>License</dt>
   364  	<dd></dd>
   365  </dl>
   366