--- title: "Resource" title_tag: "example.Resource" meta_desc: "Documentation for the example.Resource resource with examples, input properties, output properties, lookup functions, and supporting types." layout: api no_edit_this_page: true --- <!-- WARNING: this file was generated by test. --> <!-- Do not edit by hand unless you're certain you know what you are doing! --> ## Create Resource Resource {#create} Resources are created with functions called constructors. To learn more about declaring and configuring resources, see [Resources](/docs/concepts/resources/). ### Constructor syntax <div> <pulumi-chooser type="language" options="csharp,go,typescript,python,yaml,java"></pulumi-chooser> </div> <div> <pulumi-choosable type="language" values="javascript,typescript"> <div class="no-copy"><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> </div></pulumi-choosable> </div> <div> <pulumi-choosable type="language" values="python"> <div class="no-copy"><div class="highlight"><pre class="chroma"><code class="language-python" data-lang="python"><span class=nd>@overload</span> <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> <span class="nx">args</span><span class="p">:</span> <span class="nx"><a href="#inputs">Optional[ResourceArgs]</a></span> = None<span class="p">,</span> <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> <span></span> <span class=nd>@overload</span> <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> <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> <span class="nx">bar</span><span class="p">:</span> <span class="nx">Optional[str]</span> = None<span class="p">)</span></code></pre></div> </div></pulumi-choosable> </div> <div> <pulumi-choosable type="language" values="go"> <div class="no-copy"><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> </div></pulumi-choosable> </div> <div> <pulumi-choosable type="language" values="csharp"> <div class="no-copy"><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> </div></pulumi-choosable> </div> <div> <pulumi-choosable type="language" values="java"> <div class="no-copy"><div class="highlight"><pre class="chroma"> <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> <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> </code></pre></div></div> </pulumi-choosable> </div> <div> <pulumi-choosable type="language" values="yaml"> <div class="no-copy"><div class="highlight"><pre class="chroma"><code class="language-yaml" data-lang="yaml">type: <span class="nx">example:Resource</span><span class="p"></span> <span class="p">properties</span><span class="p">: </span><span class="c"># The arguments to resource properties.</span> <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> <span class="p"></span> </code></pre></div></div> </pulumi-choosable> </div> #### Parameters <div> <pulumi-choosable type="language" values="javascript,typescript"> <dl class="resources-properties"><dt class="property-required" title="Required"> <span>name</span> <span class="property-indicator"></span> <span class="property-type">string</span> </dt> <dd>The unique name of the resource.</dd><dt class="property-optional" title="Optional"> <span>args</span> <span class="property-indicator"></span> <span class="property-type"><a href="#inputs">ResourceArgs</a></span> </dt> <dd>The arguments to resource properties.</dd><dt class="property-optional" title="Optional"> <span>opts</span> <span class="property-indicator"></span> <span class="property-type"><a href="/docs/reference/pkg/nodejs/pulumi/pulumi/#CustomResourceOptions">CustomResourceOptions</a></span> </dt> <dd>Bag of options to control resource's behavior.</dd></dl> </pulumi-choosable> </div> <div> <pulumi-choosable type="language" values="python"> <dl class="resources-properties"><dt class="property-required" title="Required"> <span>resource_name</span> <span class="property-indicator"></span> <span class="property-type">str</span> </dt> <dd>The unique name of the resource.</dd><dt class="property-optional" title="Optional"> <span>args</span> <span class="property-indicator"></span> <span class="property-type"><a href="#inputs">ResourceArgs</a></span> </dt> <dd>The arguments to resource properties.</dd><dt class="property-optional" title="Optional"> <span>opts</span> <span class="property-indicator"></span> <span class="property-type"><a href="/docs/reference/pkg/python/pulumi/#pulumi.ResourceOptions">ResourceOptions</a></span> </dt> <dd>Bag of options to control resource's behavior.</dd></dl> </pulumi-choosable> </div> <div> <pulumi-choosable type="language" values="go"> <dl class="resources-properties"><dt class="property-optional" title="Optional"> <span>ctx</span> <span class="property-indicator"></span> <span class="property-type"><a href="https://pkg.go.dev/github.com/pulumi/pulumi/sdk/v3/go/pulumi?tab=doc#Context">Context</a></span> </dt> <dd>Context object for the current deployment.</dd><dt class="property-required" title="Required"> <span>name</span> <span class="property-indicator"></span> <span class="property-type">string</span> </dt> <dd>The unique name of the resource.</dd><dt class="property-optional" title="Optional"> <span>args</span> <span class="property-indicator"></span> <span class="property-type"><a href="#inputs">ResourceArgs</a></span> </dt> <dd>The arguments to resource properties.</dd><dt class="property-optional" title="Optional"> <span>opts</span> <span class="property-indicator"></span> <span class="property-type"><a href="https://pkg.go.dev/github.com/pulumi/pulumi/sdk/v3/go/pulumi?tab=doc#ResourceOption">ResourceOption</a></span> </dt> <dd>Bag of options to control resource's behavior.</dd></dl> </pulumi-choosable> </div> <div> <pulumi-choosable type="language" values="csharp"> <dl class="resources-properties"><dt class="property-required" title="Required"> <span>name</span> <span class="property-indicator"></span> <span class="property-type">string</span> </dt> <dd>The unique name of the resource.</dd><dt class="property-optional" title="Optional"> <span>args</span> <span class="property-indicator"></span> <span class="property-type"><a href="#inputs">ResourceArgs</a></span> </dt> <dd>The arguments to resource properties.</dd><dt class="property-optional" title="Optional"> <span>opts</span> <span class="property-indicator"></span> <span class="property-type"><a href="/docs/reference/pkg/dotnet/Pulumi/Pulumi.CustomResourceOptions.html">CustomResourceOptions</a></span> </dt> <dd>Bag of options to control resource's behavior.</dd></dl> </pulumi-choosable> </div> <div> <pulumi-choosable type="language" values="java"> <dl class="resources-properties"><dt class="property-required" title="Required"> <span>name</span> <span class="property-indicator"></span> <span class="property-type">String</span> </dt> <dd>The unique name of the resource.</dd><dt class="property-required" title="Required"> <span>args</span> <span class="property-indicator"></span> <span class="property-type"><a href="#inputs">ResourceArgs</a></span> </dt> <dd>The arguments to resource properties.</dd><dt class="property-optional" title="Optional"> <span>options</span> <span class="property-indicator"></span> <span class="property-type">CustomResourceOptions</span> </dt> <dd>Bag of options to control resource's behavior.</dd></dl> </pulumi-choosable> </div> ### Constructor example The following reference example uses placeholder values for all [input properties](#inputs). <div> <pulumi-chooser type="language" options="csharp,go,typescript,python,yaml,java"></pulumi-chooser> </div> <div> <pulumi-choosable type="language" values="csharp"> ```csharp var resourceResource = new Example.Resource("resourceResource", new() { Bar = "string", }); ``` </pulumi-choosable> </div> <div> <pulumi-choosable type="language" values="go"> ```go example, err := example.NewResource(ctx, "resourceResource", &example.ResourceArgs{ Bar: pulumi.String("string"), }) ``` </pulumi-choosable> </div> <div> <pulumi-choosable type="language" values="java"> ```java var resourceResource = new Resource("resourceResource", ResourceArgs.builder() .bar("string") .build()); ``` </pulumi-choosable> </div> <div> <pulumi-choosable type="language" values="python"> ```python resource_resource = example.Resource("resourceResource", bar="string") ``` </pulumi-choosable> </div> <div> <pulumi-choosable type="language" values="typescript"> ```typescript const resourceResource = new example.Resource("resourceResource", {bar: "string"}); ``` </pulumi-choosable> </div> <div> <pulumi-choosable type="language" values="yaml"> ```yaml type: example:Resource properties: bar: string ``` </pulumi-choosable> </div> ## Resource Resource Properties {#properties} 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. ### Inputs <pulumi-choosable type="language" values="python"> <p> In Python, inputs that are objects can be passed either as <a href="/docs/languages-sdks/python/#inputs-and-outputs">argument classes or as dictionary literals</a>. </p> </pulumi-choosable> The Resource resource accepts the following [input](/docs/intro/concepts/inputs-outputs) properties: <div> <pulumi-choosable type="language" values="csharp"> <dl class="resources-properties"><dt class="property-optional property-replacement" title="Optional"> <span id="bar_csharp"> <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#bar_csharp" style="color: inherit; text-decoration: inherit;">Bar</a> </span> <span class="property-indicator"></span> <span class="property-type">string</span> </dt> <dd></dd></dl> </pulumi-choosable> </div> <div> <pulumi-choosable type="language" values="go"> <dl class="resources-properties"><dt class="property-optional property-replacement" title="Optional"> <span id="bar_go"> <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#bar_go" style="color: inherit; text-decoration: inherit;">Bar</a> </span> <span class="property-indicator"></span> <span class="property-type">string</span> </dt> <dd></dd></dl> </pulumi-choosable> </div> <div> <pulumi-choosable type="language" values="java"> <dl class="resources-properties"><dt class="property-optional property-replacement" title="Optional"> <span id="bar_java"> <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#bar_java" style="color: inherit; text-decoration: inherit;">bar</a> </span> <span class="property-indicator"></span> <span class="property-type">String</span> </dt> <dd></dd></dl> </pulumi-choosable> </div> <div> <pulumi-choosable type="language" values="javascript,typescript"> <dl class="resources-properties"><dt class="property-optional property-replacement" title="Optional"> <span id="bar_nodejs"> <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#bar_nodejs" style="color: inherit; text-decoration: inherit;">bar</a> </span> <span class="property-indicator"></span> <span class="property-type">string</span> </dt> <dd></dd></dl> </pulumi-choosable> </div> <div> <pulumi-choosable type="language" values="python"> <dl class="resources-properties"><dt class="property-optional property-replacement" title="Optional"> <span id="bar_python"> <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#bar_python" style="color: inherit; text-decoration: inherit;">bar</a> </span> <span class="property-indicator"></span> <span class="property-type">str</span> </dt> <dd></dd></dl> </pulumi-choosable> </div> <div> <pulumi-choosable type="language" values="yaml"> <dl class="resources-properties"><dt class="property-optional property-replacement" title="Optional"> <span id="bar_yaml"> <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#bar_yaml" style="color: inherit; text-decoration: inherit;">bar</a> </span> <span class="property-indicator"></span> <span class="property-type">String</span> </dt> <dd></dd></dl> </pulumi-choosable> </div> ### Outputs All [input](#inputs) properties are implicitly available as output properties. Additionally, the Resource resource produces the following output properties: <div> <pulumi-choosable type="language" values="csharp"> <dl class="resources-properties"><dt class="property-" title=""> <span id="id_csharp"> <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#id_csharp" style="color: inherit; text-decoration: inherit;">Id</a> </span> <span class="property-indicator"></span> <span class="property-type">string</span> </dt> <dd>The provider-assigned unique ID for this managed resource.</dd><dt class="property-" title=""> <span id="baz_csharp"> <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#baz_csharp" style="color: inherit; text-decoration: inherit;">Baz</a> </span> <span class="property-indicator"></span> <span class="property-type">string</span> </dt> <dd></dd></dl> </pulumi-choosable> </div> <div> <pulumi-choosable type="language" values="go"> <dl class="resources-properties"><dt class="property-" title=""> <span id="id_go"> <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#id_go" style="color: inherit; text-decoration: inherit;">Id</a> </span> <span class="property-indicator"></span> <span class="property-type">string</span> </dt> <dd>The provider-assigned unique ID for this managed resource.</dd><dt class="property-" title=""> <span id="baz_go"> <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#baz_go" style="color: inherit; text-decoration: inherit;">Baz</a> </span> <span class="property-indicator"></span> <span class="property-type">string</span> </dt> <dd></dd></dl> </pulumi-choosable> </div> <div> <pulumi-choosable type="language" values="java"> <dl class="resources-properties"><dt class="property-" title=""> <span id="id_java"> <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#id_java" style="color: inherit; text-decoration: inherit;">id</a> </span> <span class="property-indicator"></span> <span class="property-type">String</span> </dt> <dd>The provider-assigned unique ID for this managed resource.</dd><dt class="property-" title=""> <span id="baz_java"> <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#baz_java" style="color: inherit; text-decoration: inherit;">baz</a> </span> <span class="property-indicator"></span> <span class="property-type">String</span> </dt> <dd></dd></dl> </pulumi-choosable> </div> <div> <pulumi-choosable type="language" values="javascript,typescript"> <dl class="resources-properties"><dt class="property-" title=""> <span id="id_nodejs"> <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#id_nodejs" style="color: inherit; text-decoration: inherit;">id</a> </span> <span class="property-indicator"></span> <span class="property-type">string</span> </dt> <dd>The provider-assigned unique ID for this managed resource.</dd><dt class="property-" title=""> <span id="baz_nodejs"> <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#baz_nodejs" style="color: inherit; text-decoration: inherit;">baz</a> </span> <span class="property-indicator"></span> <span class="property-type">string</span> </dt> <dd></dd></dl> </pulumi-choosable> </div> <div> <pulumi-choosable type="language" values="python"> <dl class="resources-properties"><dt class="property-" title=""> <span id="id_python"> <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#id_python" style="color: inherit; text-decoration: inherit;">id</a> </span> <span class="property-indicator"></span> <span class="property-type">str</span> </dt> <dd>The provider-assigned unique ID for this managed resource.</dd><dt class="property-" title=""> <span id="baz_python"> <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#baz_python" style="color: inherit; text-decoration: inherit;">baz</a> </span> <span class="property-indicator"></span> <span class="property-type">str</span> </dt> <dd></dd></dl> </pulumi-choosable> </div> <div> <pulumi-choosable type="language" values="yaml"> <dl class="resources-properties"><dt class="property-" title=""> <span id="id_yaml"> <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#id_yaml" style="color: inherit; text-decoration: inherit;">id</a> </span> <span class="property-indicator"></span> <span class="property-type">String</span> </dt> <dd>The provider-assigned unique ID for this managed resource.</dd><dt class="property-" title=""> <span id="baz_yaml"> <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#baz_yaml" style="color: inherit; text-decoration: inherit;">baz</a> </span> <span class="property-indicator"></span> <span class="property-type">String</span> </dt> <dd></dd></dl> </pulumi-choosable> </div> <h2 id="package-details">Package Details</h2> <dl class="package-details"> <dt>Repository</dt> <dd><a href="">example </a></dd> <dt>License</dt> <dd></dd> </dl>