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

     1  
     2  ---
     3  title: "Resource"
     4  title_tag: "example.Resource"
     5  meta_desc: "Documentation for the example.Resource 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 Resource 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">Resource</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">ResourceArgs</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">Resource</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">bar</span><span class="p">:</span> <span class="nx">Optional[str]</span> = None<span class="p">)</span>
    36  <span class=nd>@overload</span>
    37  <span class="k">def </span><span class="nx">Resource</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[ResourceArgs]</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">NewResource</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">ResourceArgs</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">Resource</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">Resource</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">ResourceArgs</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">Resource</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">ResourceArgs</a></span><span class="p"> </span><span class="nx">args<span class="p">)</span>
    59  <span class="k">public </span><span class="nx">Resource</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">ResourceArgs</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">example:Resource</span><span class="p"></span>
    67  <span class="p">properties</span><span class="p">: </span><span class="c">#&nbsp;The arguments to resource properties.</span>
    68  <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>
    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">ResourceArgs</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&#39;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">ResourceArgs</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&#39;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">ResourceArgs</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&#39;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">ResourceArgs</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&#39;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">ResourceArgs</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&#39;s behavior.</dd></dl>
   206  
   207  </pulumi-choosable>
   208  </div>
   209  
   210  ## Resource 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 Resource 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 property-replacement"
   223              title="Optional">
   224          <span id="bar_csharp">
   225  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#bar_csharp" style="color: inherit; text-decoration: inherit;">Bar</a>
   226  </span>
   227          <span class="property-indicator"></span>
   228          <span class="property-type">string</span>
   229      </dt>
   230      <dd></dd></dl>
   231  </pulumi-choosable>
   232  </div>
   233  
   234  <div>
   235  <pulumi-choosable type="language" values="go">
   236  <dl class="resources-properties"><dt class="property-optional property-replacement"
   237              title="Optional">
   238          <span id="bar_go">
   239  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#bar_go" style="color: inherit; text-decoration: inherit;">Bar</a>
   240  </span>
   241          <span class="property-indicator"></span>
   242          <span class="property-type">string</span>
   243      </dt>
   244      <dd></dd></dl>
   245  </pulumi-choosable>
   246  </div>
   247  
   248  <div>
   249  <pulumi-choosable type="language" values="java">
   250  <dl class="resources-properties"><dt class="property-optional property-replacement"
   251              title="Optional">
   252          <span id="bar_java">
   253  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#bar_java" style="color: inherit; text-decoration: inherit;">bar</a>
   254  </span>
   255          <span class="property-indicator"></span>
   256          <span class="property-type">String</span>
   257      </dt>
   258      <dd></dd></dl>
   259  </pulumi-choosable>
   260  </div>
   261  
   262  <div>
   263  <pulumi-choosable type="language" values="javascript,typescript">
   264  <dl class="resources-properties"><dt class="property-optional property-replacement"
   265              title="Optional">
   266          <span id="bar_nodejs">
   267  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#bar_nodejs" style="color: inherit; text-decoration: inherit;">bar</a>
   268  </span>
   269          <span class="property-indicator"></span>
   270          <span class="property-type">string</span>
   271      </dt>
   272      <dd></dd></dl>
   273  </pulumi-choosable>
   274  </div>
   275  
   276  <div>
   277  <pulumi-choosable type="language" values="python">
   278  <dl class="resources-properties"><dt class="property-optional property-replacement"
   279              title="Optional">
   280          <span id="bar_python">
   281  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#bar_python" style="color: inherit; text-decoration: inherit;">bar</a>
   282  </span>
   283          <span class="property-indicator"></span>
   284          <span class="property-type">str</span>
   285      </dt>
   286      <dd></dd></dl>
   287  </pulumi-choosable>
   288  </div>
   289  
   290  <div>
   291  <pulumi-choosable type="language" values="yaml">
   292  <dl class="resources-properties"><dt class="property-optional property-replacement"
   293              title="Optional">
   294          <span id="bar_yaml">
   295  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#bar_yaml" style="color: inherit; text-decoration: inherit;">bar</a>
   296  </span>
   297          <span class="property-indicator"></span>
   298          <span class="property-type">String</span>
   299      </dt>
   300      <dd></dd></dl>
   301  </pulumi-choosable>
   302  </div>
   303  
   304  
   305  ### Outputs
   306  
   307  All [input](#inputs) properties are implicitly available as output properties. Additionally, the Resource resource produces the following output properties:
   308  
   309  
   310  
   311  <div>
   312  <pulumi-choosable type="language" values="csharp">
   313  <dl class="resources-properties"><dt class="property-"
   314              title="">
   315          <span id="id_csharp">
   316  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#id_csharp" style="color: inherit; text-decoration: inherit;">Id</a>
   317  </span>
   318          <span class="property-indicator"></span>
   319          <span class="property-type">string</span>
   320      </dt>
   321      <dd><p>The provider-assigned unique ID for this managed resource.</p>
   322  </dd><dt class="property-"
   323              title="">
   324          <span id="baz_csharp">
   325  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#baz_csharp" style="color: inherit; text-decoration: inherit;">Baz</a>
   326  </span>
   327          <span class="property-indicator"></span>
   328          <span class="property-type">string</span>
   329      </dt>
   330      <dd></dd></dl>
   331  </pulumi-choosable>
   332  </div>
   333  
   334  <div>
   335  <pulumi-choosable type="language" values="go">
   336  <dl class="resources-properties"><dt class="property-"
   337              title="">
   338          <span id="id_go">
   339  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#id_go" style="color: inherit; text-decoration: inherit;">Id</a>
   340  </span>
   341          <span class="property-indicator"></span>
   342          <span class="property-type">string</span>
   343      </dt>
   344      <dd><p>The provider-assigned unique ID for this managed resource.</p>
   345  </dd><dt class="property-"
   346              title="">
   347          <span id="baz_go">
   348  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#baz_go" style="color: inherit; text-decoration: inherit;">Baz</a>
   349  </span>
   350          <span class="property-indicator"></span>
   351          <span class="property-type">string</span>
   352      </dt>
   353      <dd></dd></dl>
   354  </pulumi-choosable>
   355  </div>
   356  
   357  <div>
   358  <pulumi-choosable type="language" values="java">
   359  <dl class="resources-properties"><dt class="property-"
   360              title="">
   361          <span id="id_java">
   362  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#id_java" style="color: inherit; text-decoration: inherit;">id</a>
   363  </span>
   364          <span class="property-indicator"></span>
   365          <span class="property-type">String</span>
   366      </dt>
   367      <dd><p>The provider-assigned unique ID for this managed resource.</p>
   368  </dd><dt class="property-"
   369              title="">
   370          <span id="baz_java">
   371  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#baz_java" style="color: inherit; text-decoration: inherit;">baz</a>
   372  </span>
   373          <span class="property-indicator"></span>
   374          <span class="property-type">String</span>
   375      </dt>
   376      <dd></dd></dl>
   377  </pulumi-choosable>
   378  </div>
   379  
   380  <div>
   381  <pulumi-choosable type="language" values="javascript,typescript">
   382  <dl class="resources-properties"><dt class="property-"
   383              title="">
   384          <span id="id_nodejs">
   385  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#id_nodejs" style="color: inherit; text-decoration: inherit;">id</a>
   386  </span>
   387          <span class="property-indicator"></span>
   388          <span class="property-type">string</span>
   389      </dt>
   390      <dd><p>The provider-assigned unique ID for this managed resource.</p>
   391  </dd><dt class="property-"
   392              title="">
   393          <span id="baz_nodejs">
   394  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#baz_nodejs" style="color: inherit; text-decoration: inherit;">baz</a>
   395  </span>
   396          <span class="property-indicator"></span>
   397          <span class="property-type">string</span>
   398      </dt>
   399      <dd></dd></dl>
   400  </pulumi-choosable>
   401  </div>
   402  
   403  <div>
   404  <pulumi-choosable type="language" values="python">
   405  <dl class="resources-properties"><dt class="property-"
   406              title="">
   407          <span id="id_python">
   408  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#id_python" style="color: inherit; text-decoration: inherit;">id</a>
   409  </span>
   410          <span class="property-indicator"></span>
   411          <span class="property-type">str</span>
   412      </dt>
   413      <dd><p>The provider-assigned unique ID for this managed resource.</p>
   414  </dd><dt class="property-"
   415              title="">
   416          <span id="baz_python">
   417  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#baz_python" style="color: inherit; text-decoration: inherit;">baz</a>
   418  </span>
   419          <span class="property-indicator"></span>
   420          <span class="property-type">str</span>
   421      </dt>
   422      <dd></dd></dl>
   423  </pulumi-choosable>
   424  </div>
   425  
   426  <div>
   427  <pulumi-choosable type="language" values="yaml">
   428  <dl class="resources-properties"><dt class="property-"
   429              title="">
   430          <span id="id_yaml">
   431  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#id_yaml" style="color: inherit; text-decoration: inherit;">id</a>
   432  </span>
   433          <span class="property-indicator"></span>
   434          <span class="property-type">String</span>
   435      </dt>
   436      <dd><p>The provider-assigned unique ID for this managed resource.</p>
   437  </dd><dt class="property-"
   438              title="">
   439          <span id="baz_yaml">
   440  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#baz_yaml" style="color: inherit; text-decoration: inherit;">baz</a>
   441  </span>
   442          <span class="property-indicator"></span>
   443          <span class="property-type">String</span>
   444      </dt>
   445      <dd></dd></dl>
   446  </pulumi-choosable>
   447  </div>
   448  
   449  
   450  
   451  
   452  
   453  
   454  
   455  
   456  <h2 id="package-details">Package Details</h2>
   457  <dl class="package-details">
   458  	<dt>Repository</dt>
   459  	<dd><a href=""></a></dd>
   460  	<dt>License</dt>
   461  	<dd></dd>
   462  </dl>
   463