pulumi/tests/testdata/codegen/resource-property-overlap/docs/rec/_index.md

500 lines
19 KiB
Markdown
Raw Permalink Normal View History

---
title: "Rec"
title_tag: "example.Rec"
meta_desc: "Documentation for the example.Rec 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 Rec Resource {#create}
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see [Resources](/docs/concepts/resources/).
### Constructor syntax
2022-05-04 07:05:39 +00:00
<div>
Add ability to constrain supported languages of resource and function overlays (#16579) The existing overlays (e.g. Chart v3 in Kubernetes, or CallbackFunction in AWS) are not available in every language Pulumi supports. This often confuses users because the generated docs include all languages Pulumi supports (e.g. see https://github.com/pulumi/pulumi-kubernetes/issues/2181). To solve that problem, this change adds a new optional parameter to the schema that allows configuring the languages an overlay (resource or function) supports. To support this in docsgen the existing Language Chooser (`LangChooserLanguages`) of resources is made configurable and extended to functions. Note: This doesn't support resource methods right now. They'll need extra handling because and overlay resource method might not support all of the languages its resource supports. I'll tackle this in a follow up PR. Here's a screenshot of how this will look like for the Helm v3 chart for example: <img width="1046" alt="Screenshot 2024-07-01 at 16 11 23" src="https://github.com/pulumi/pulumi/assets/2453580/b1a1365a-6dee-4099-829a-2859639a4c8c"> The PR contains the following commits. I'd recommend to look at the first three ones and then check the regenerated golden files in the last one: - **Add schema parameter to constrain supported languages for overlays** - **Update developer docs and changelog** - **Refactor LanguageChooser and always pass supported languages** - **Regenerate testdata** relates to #13231
2024-07-09 14:54:50 +00:00
<pulumi-chooser type="language" options="csharp,go,typescript,python,yaml,java"></pulumi-chooser>
2022-05-04 07:05:39 +00:00
</div>
2022-04-29 22:04:15 +00:00
<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">Rec</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">RecArgs</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>
2022-04-29 22:04:15 +00:00
</div>
2022-04-29 22:04:15 +00:00
<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">Rec</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[RecArgs]</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">Rec</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></code></pre></div>
</div></pulumi-choosable>
2022-04-29 22:04:15 +00:00
</div>
2022-04-29 22:04:15 +00:00
<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">NewRec</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">RecArgs</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">Rec</span>, error)</span></code></pre></div>
</div></pulumi-choosable>
2022-04-29 22:04:15 +00:00
</div>
2022-04-29 22:04:15 +00:00
<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">Rec</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">RecArgs</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>
2022-04-29 22:04:15 +00:00
</div>
2022-05-04 07:05:39 +00:00
<div>
<pulumi-choosable type="language" values="java">
<div class="no-copy"><div class="highlight"><pre class="chroma">
2022-05-04 07:05:39 +00:00
<code class="language-java" data-lang="java"><span class="k">public </span><span class="nx">Rec</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">RecArgs</a></span><span class="p"> </span><span class="nx">args<span class="p">)</span>
<span class="k">public </span><span class="nx">Rec</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">RecArgs</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>
2022-05-04 07:05:39 +00:00
</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:Rec</span><span class="p"></span>
2022-05-04 07:05:39 +00:00
<span class="p">properties</span><span class="p">: </span><span class="c">#&nbsp;The arguments to resource properties.</span>
<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>
<span class="p"></span>
</code></pre></div></div>
2022-05-04 07:05:39 +00:00
</pulumi-choosable>
</div>
#### Parameters
2022-04-29 22:04:15 +00:00
<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">RecArgs</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&#39;s behavior.</dd></dl>
2022-04-29 22:04:15 +00:00
</pulumi-choosable>
</div>
2022-04-29 22:04:15 +00:00
<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">RecArgs</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&#39;s behavior.</dd></dl>
2022-04-29 22:04:15 +00:00
</pulumi-choosable>
</div>
2022-04-29 22:04:15 +00:00
<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">RecArgs</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&#39;s behavior.</dd></dl>
2022-04-29 22:04:15 +00:00
</pulumi-choosable>
</div>
2022-04-29 22:04:15 +00:00
<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">RecArgs</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&#39;s behavior.</dd></dl>
2022-04-29 22:04:15 +00:00
</pulumi-choosable>
</div>
2022-05-04 07:05:39 +00:00
<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">RecArgs</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&#39;s behavior.</dd></dl>
</pulumi-choosable>
</div>
### Constructor example
The following reference example uses placeholder values for all [input properties](#inputs).
<div>
Add ability to constrain supported languages of resource and function overlays (#16579) The existing overlays (e.g. Chart v3 in Kubernetes, or CallbackFunction in AWS) are not available in every language Pulumi supports. This often confuses users because the generated docs include all languages Pulumi supports (e.g. see https://github.com/pulumi/pulumi-kubernetes/issues/2181). To solve that problem, this change adds a new optional parameter to the schema that allows configuring the languages an overlay (resource or function) supports. To support this in docsgen the existing Language Chooser (`LangChooserLanguages`) of resources is made configurable and extended to functions. Note: This doesn't support resource methods right now. They'll need extra handling because and overlay resource method might not support all of the languages its resource supports. I'll tackle this in a follow up PR. Here's a screenshot of how this will look like for the Helm v3 chart for example: <img width="1046" alt="Screenshot 2024-07-01 at 16 11 23" src="https://github.com/pulumi/pulumi/assets/2453580/b1a1365a-6dee-4099-829a-2859639a4c8c"> The PR contains the following commits. I'd recommend to look at the first three ones and then check the regenerated golden files in the last one: - **Add schema parameter to constrain supported languages for overlays** - **Update developer docs and changelog** - **Refactor LanguageChooser and always pass supported languages** - **Regenerate testdata** relates to #13231
2024-07-09 14:54:50 +00:00
<pulumi-chooser type="language" options="csharp,go,typescript,python,yaml,java"></pulumi-chooser>
</div>
<div>
<pulumi-choosable type="language" values="csharp">
```csharp
var recResource = new Example.Rec("recResource");
```
</pulumi-choosable>
</div>
<div>
<pulumi-choosable type="language" values="go">
```go
example, err := example.NewRec(ctx, "recResource", nil)
```
</pulumi-choosable>
</div>
<div>
<pulumi-choosable type="language" values="java">
```java
var recResource = new Rec("recResource");
```
</pulumi-choosable>
</div>
<div>
<pulumi-choosable type="language" values="python">
```python
rec_resource = example.Rec("recResource")
```
</pulumi-choosable>
</div>
<div>
<pulumi-choosable type="language" values="typescript">
```typescript
const recResource = new example.Rec("recResource", {});
```
</pulumi-choosable>
</div>
<div>
<pulumi-choosable type="language" values="yaml">
```yaml
type: example:Rec
properties: {}
```
</pulumi-choosable>
</div>
## Rec Resource Properties {#properties}
2022-05-04 07:05:39 +00:00
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>
2022-05-04 07:05:39 +00:00
The Rec resource accepts the following [input](/docs/intro/concepts/inputs-outputs) properties:
2022-04-29 22:04:15 +00:00
<div>
<pulumi-choosable type="language" values="csharp">
<dl class="resources-properties"></dl>
2022-04-29 22:04:15 +00:00
</pulumi-choosable>
</div>
2022-04-29 22:04:15 +00:00
<div>
<pulumi-choosable type="language" values="go">
<dl class="resources-properties"></dl>
2022-04-29 22:04:15 +00:00
</pulumi-choosable>
</div>
2022-05-04 07:05:39 +00:00
<div>
<pulumi-choosable type="language" values="java">
<dl class="resources-properties"></dl>
</pulumi-choosable>
</div>
2022-04-29 22:04:15 +00:00
<div>
<pulumi-choosable type="language" values="javascript,typescript">
<dl class="resources-properties"></dl>
2022-04-29 22:04:15 +00:00
</pulumi-choosable>
</div>
2022-04-29 22:04:15 +00:00
<div>
<pulumi-choosable type="language" values="python">
<dl class="resources-properties"></dl>
2022-04-29 22:04:15 +00:00
</pulumi-choosable>
</div>
2022-05-04 07:05:39 +00:00
<div>
<pulumi-choosable type="language" values="yaml">
<dl class="resources-properties"></dl>
</pulumi-choosable>
</div>
### Outputs
All [input](#inputs) properties are implicitly available as output properties. Additionally, the Rec resource produces the following output properties:
2022-04-29 22:04:15 +00:00
<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>
[docsgen] Fix rendering of deprecated messages and text in description lists (#13773) A change was made a while back to remove the use of shortcodes. As part of that, the shortcode used to render markdown was replaced by a function call that used goldmark to render markdown. The resulting HTML from that wraps the text in paragraph tags. This causes some problems for rendering the docs. For deprecations, the deprecation message now shows up outside of the "Deprecated" box. This happens because the rendered markdown was being wrapped in `<p></p>` tags, leading to `<p class="resource-deprecated">Deprecated: <p>message</p></p>`, which does not render correctly because paragraph tags cannot be nested. Also, in description lists, rendered markdown text was being wrapped in paragraph tags (e.g. `<dd><p>text</p></dd>`), causing it to render differently from text not wrapped in paragraph tags (e.g. `<dd>text</dd>`). This change addresses these issues. - First, `<div class="resource-deprecated">` is used rather than `<p>` to contain the deprecation information. - Second, the `markdownify` function will now trim unnecessary paragraph tags. Fixes https://github.com/pulumi/pulumi-hugo/issues/2832 Fixes https://github.com/pulumi/registry/issues/3008 --- ## Before <img width="713" alt="Screen Shot 2023-08-24 at 5 21 44 PM" src="https://github.com/pulumi/pulumi/assets/710598/1358cc74-dd8a-4bc0-bed8-603b1439b2aa"> ## After <img width="721" alt="Screen Shot 2023-08-24 at 5 21 58 PM" src="https://github.com/pulumi/pulumi/assets/710598/ad501e68-1bac-486c-a723-7db2b3442c8a"> ## Before <img width="719" alt="Screen Shot 2023-08-24 at 5 22 28 PM" src="https://github.com/pulumi/pulumi/assets/710598/6ca40b85-9008-429b-83c3-2f0d681752f3"> ## After <img width="714" alt="Screen Shot 2023-08-24 at 5 24 02 PM" src="https://github.com/pulumi/pulumi/assets/710598/eec1dacf-8c24-470e-b1e3-da843b4aeaee">
2023-08-26 17:36:28 +00:00
<dd>The provider-assigned unique ID for this managed resource.</dd><dt class="property-"
title="">
<span id="rec_csharp">
<a data-swiftype-name="resource-property" data-swiftype-type="text" href="#rec_csharp" style="color: inherit; text-decoration: inherit;">Rec</a>
</span>
<span class="property-indicator"></span>
[codegen/go] Remove ResourcePtr input/output types (#8449) These changes remove the `Ptr` variants of input/ouptut types for resources. A `TPtr` input or output is normally generated for `T` if `T` is present in an `optional(input(T))` or `optional(output(T))` and if the Go representation for `T` is not nilable. The generation of `Ptr` variants for resource types breaks the latter rule: the canonical representation of a resource type named `Foo` is a pointer to a struct type named `Foo` (i.e. `*Foo`). `Foo` itself is not a resource, as it does not implement the Go `Resource` interface. Because this representation already accommodates `nil` to indicate the lack of a value, we need not generate `FooPtr{Input,Output}` types. Besides being unnecessary, the implementation of `Ptr` types for resources was incorrect. Rather than using `**Foo` as their element type, these types use `*Foo`--identical to the element type used for the normal input/output types. Furthermore, the generated code for at least `FooOutput.ToFooPtrOutputWithContext` and `FooPtrOutput.Elem` was incorrect, making these types virtually unusable in practice. Finally, these `Ptr` types should never appear on input/output properties in practice, as the logic we use to generate input and output type references never generates them for `optional({input,output}(T)). Instead, it generates references to the standard input/output types. Though this is _technically_ a breaking change--it changes the set of exported types for any package that defines resources--I believe that in practice it will be invisible to users for the reasons stated above. These types are not usable, and were never referenced. This is preparatory work for #7943.
2021-11-23 18:24:56 +00:00
<span class="property-type">Pulumi.<wbr>Example.<wbr>Rec</span>
</dt>
2022-04-29 22:04:15 +00:00
<dd></dd></dl>
</pulumi-choosable>
</div>
2022-04-29 22:04:15 +00:00
<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>
[docsgen] Fix rendering of deprecated messages and text in description lists (#13773) A change was made a while back to remove the use of shortcodes. As part of that, the shortcode used to render markdown was replaced by a function call that used goldmark to render markdown. The resulting HTML from that wraps the text in paragraph tags. This causes some problems for rendering the docs. For deprecations, the deprecation message now shows up outside of the "Deprecated" box. This happens because the rendered markdown was being wrapped in `<p></p>` tags, leading to `<p class="resource-deprecated">Deprecated: <p>message</p></p>`, which does not render correctly because paragraph tags cannot be nested. Also, in description lists, rendered markdown text was being wrapped in paragraph tags (e.g. `<dd><p>text</p></dd>`), causing it to render differently from text not wrapped in paragraph tags (e.g. `<dd>text</dd>`). This change addresses these issues. - First, `<div class="resource-deprecated">` is used rather than `<p>` to contain the deprecation information. - Second, the `markdownify` function will now trim unnecessary paragraph tags. Fixes https://github.com/pulumi/pulumi-hugo/issues/2832 Fixes https://github.com/pulumi/registry/issues/3008 --- ## Before <img width="713" alt="Screen Shot 2023-08-24 at 5 21 44 PM" src="https://github.com/pulumi/pulumi/assets/710598/1358cc74-dd8a-4bc0-bed8-603b1439b2aa"> ## After <img width="721" alt="Screen Shot 2023-08-24 at 5 21 58 PM" src="https://github.com/pulumi/pulumi/assets/710598/ad501e68-1bac-486c-a723-7db2b3442c8a"> ## Before <img width="719" alt="Screen Shot 2023-08-24 at 5 22 28 PM" src="https://github.com/pulumi/pulumi/assets/710598/6ca40b85-9008-429b-83c3-2f0d681752f3"> ## After <img width="714" alt="Screen Shot 2023-08-24 at 5 24 02 PM" src="https://github.com/pulumi/pulumi/assets/710598/eec1dacf-8c24-470e-b1e3-da843b4aeaee">
2023-08-26 17:36:28 +00:00
<dd>The provider-assigned unique ID for this managed resource.</dd><dt class="property-"
title="">
<span id="rec_go">
<a data-swiftype-name="resource-property" data-swiftype-type="text" href="#rec_go" style="color: inherit; text-decoration: inherit;">Rec</a>
</span>
<span class="property-indicator"></span>
<span class="property-type">Rec</span>
</dt>
2022-04-29 22:04:15 +00:00
<dd></dd></dl>
</pulumi-choosable>
</div>
2022-05-04 07:05:39 +00:00
<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>
[docsgen] Fix rendering of deprecated messages and text in description lists (#13773) A change was made a while back to remove the use of shortcodes. As part of that, the shortcode used to render markdown was replaced by a function call that used goldmark to render markdown. The resulting HTML from that wraps the text in paragraph tags. This causes some problems for rendering the docs. For deprecations, the deprecation message now shows up outside of the "Deprecated" box. This happens because the rendered markdown was being wrapped in `<p></p>` tags, leading to `<p class="resource-deprecated">Deprecated: <p>message</p></p>`, which does not render correctly because paragraph tags cannot be nested. Also, in description lists, rendered markdown text was being wrapped in paragraph tags (e.g. `<dd><p>text</p></dd>`), causing it to render differently from text not wrapped in paragraph tags (e.g. `<dd>text</dd>`). This change addresses these issues. - First, `<div class="resource-deprecated">` is used rather than `<p>` to contain the deprecation information. - Second, the `markdownify` function will now trim unnecessary paragraph tags. Fixes https://github.com/pulumi/pulumi-hugo/issues/2832 Fixes https://github.com/pulumi/registry/issues/3008 --- ## Before <img width="713" alt="Screen Shot 2023-08-24 at 5 21 44 PM" src="https://github.com/pulumi/pulumi/assets/710598/1358cc74-dd8a-4bc0-bed8-603b1439b2aa"> ## After <img width="721" alt="Screen Shot 2023-08-24 at 5 21 58 PM" src="https://github.com/pulumi/pulumi/assets/710598/ad501e68-1bac-486c-a723-7db2b3442c8a"> ## Before <img width="719" alt="Screen Shot 2023-08-24 at 5 22 28 PM" src="https://github.com/pulumi/pulumi/assets/710598/6ca40b85-9008-429b-83c3-2f0d681752f3"> ## After <img width="714" alt="Screen Shot 2023-08-24 at 5 24 02 PM" src="https://github.com/pulumi/pulumi/assets/710598/eec1dacf-8c24-470e-b1e3-da843b4aeaee">
2023-08-26 17:36:28 +00:00
<dd>The provider-assigned unique ID for this managed resource.</dd><dt class="property-"
2022-05-04 07:05:39 +00:00
title="">
<span id="rec_java">
<a data-swiftype-name="resource-property" data-swiftype-type="text" href="#rec_java" style="color: inherit; text-decoration: inherit;">rec</a>
</span>
<span class="property-indicator"></span>
<span class="property-type">Rec</span>
</dt>
<dd></dd></dl>
</pulumi-choosable>
</div>
2022-04-29 22:04:15 +00:00
<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>
[docsgen] Fix rendering of deprecated messages and text in description lists (#13773) A change was made a while back to remove the use of shortcodes. As part of that, the shortcode used to render markdown was replaced by a function call that used goldmark to render markdown. The resulting HTML from that wraps the text in paragraph tags. This causes some problems for rendering the docs. For deprecations, the deprecation message now shows up outside of the "Deprecated" box. This happens because the rendered markdown was being wrapped in `<p></p>` tags, leading to `<p class="resource-deprecated">Deprecated: <p>message</p></p>`, which does not render correctly because paragraph tags cannot be nested. Also, in description lists, rendered markdown text was being wrapped in paragraph tags (e.g. `<dd><p>text</p></dd>`), causing it to render differently from text not wrapped in paragraph tags (e.g. `<dd>text</dd>`). This change addresses these issues. - First, `<div class="resource-deprecated">` is used rather than `<p>` to contain the deprecation information. - Second, the `markdownify` function will now trim unnecessary paragraph tags. Fixes https://github.com/pulumi/pulumi-hugo/issues/2832 Fixes https://github.com/pulumi/registry/issues/3008 --- ## Before <img width="713" alt="Screen Shot 2023-08-24 at 5 21 44 PM" src="https://github.com/pulumi/pulumi/assets/710598/1358cc74-dd8a-4bc0-bed8-603b1439b2aa"> ## After <img width="721" alt="Screen Shot 2023-08-24 at 5 21 58 PM" src="https://github.com/pulumi/pulumi/assets/710598/ad501e68-1bac-486c-a723-7db2b3442c8a"> ## Before <img width="719" alt="Screen Shot 2023-08-24 at 5 22 28 PM" src="https://github.com/pulumi/pulumi/assets/710598/6ca40b85-9008-429b-83c3-2f0d681752f3"> ## After <img width="714" alt="Screen Shot 2023-08-24 at 5 24 02 PM" src="https://github.com/pulumi/pulumi/assets/710598/eec1dacf-8c24-470e-b1e3-da843b4aeaee">
2023-08-26 17:36:28 +00:00
<dd>The provider-assigned unique ID for this managed resource.</dd><dt class="property-"
title="">
<span id="rec_nodejs">
<a data-swiftype-name="resource-property" data-swiftype-type="text" href="#rec_nodejs" style="color: inherit; text-decoration: inherit;">rec</a>
</span>
<span class="property-indicator"></span>
<span class="property-type">Rec</span>
</dt>
2022-04-29 22:04:15 +00:00
<dd></dd></dl>
</pulumi-choosable>
</div>
2022-04-29 22:04:15 +00:00
<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>
[docsgen] Fix rendering of deprecated messages and text in description lists (#13773) A change was made a while back to remove the use of shortcodes. As part of that, the shortcode used to render markdown was replaced by a function call that used goldmark to render markdown. The resulting HTML from that wraps the text in paragraph tags. This causes some problems for rendering the docs. For deprecations, the deprecation message now shows up outside of the "Deprecated" box. This happens because the rendered markdown was being wrapped in `<p></p>` tags, leading to `<p class="resource-deprecated">Deprecated: <p>message</p></p>`, which does not render correctly because paragraph tags cannot be nested. Also, in description lists, rendered markdown text was being wrapped in paragraph tags (e.g. `<dd><p>text</p></dd>`), causing it to render differently from text not wrapped in paragraph tags (e.g. `<dd>text</dd>`). This change addresses these issues. - First, `<div class="resource-deprecated">` is used rather than `<p>` to contain the deprecation information. - Second, the `markdownify` function will now trim unnecessary paragraph tags. Fixes https://github.com/pulumi/pulumi-hugo/issues/2832 Fixes https://github.com/pulumi/registry/issues/3008 --- ## Before <img width="713" alt="Screen Shot 2023-08-24 at 5 21 44 PM" src="https://github.com/pulumi/pulumi/assets/710598/1358cc74-dd8a-4bc0-bed8-603b1439b2aa"> ## After <img width="721" alt="Screen Shot 2023-08-24 at 5 21 58 PM" src="https://github.com/pulumi/pulumi/assets/710598/ad501e68-1bac-486c-a723-7db2b3442c8a"> ## Before <img width="719" alt="Screen Shot 2023-08-24 at 5 22 28 PM" src="https://github.com/pulumi/pulumi/assets/710598/6ca40b85-9008-429b-83c3-2f0d681752f3"> ## After <img width="714" alt="Screen Shot 2023-08-24 at 5 24 02 PM" src="https://github.com/pulumi/pulumi/assets/710598/eec1dacf-8c24-470e-b1e3-da843b4aeaee">
2023-08-26 17:36:28 +00:00
<dd>The provider-assigned unique ID for this managed resource.</dd><dt class="property-"
title="">
<span id="rec_python">
<a data-swiftype-name="resource-property" data-swiftype-type="text" href="#rec_python" style="color: inherit; text-decoration: inherit;">rec</a>
</span>
<span class="property-indicator"></span>
[codegen/go] Remove ResourcePtr input/output types (#8449) These changes remove the `Ptr` variants of input/ouptut types for resources. A `TPtr` input or output is normally generated for `T` if `T` is present in an `optional(input(T))` or `optional(output(T))` and if the Go representation for `T` is not nilable. The generation of `Ptr` variants for resource types breaks the latter rule: the canonical representation of a resource type named `Foo` is a pointer to a struct type named `Foo` (i.e. `*Foo`). `Foo` itself is not a resource, as it does not implement the Go `Resource` interface. Because this representation already accommodates `nil` to indicate the lack of a value, we need not generate `FooPtr{Input,Output}` types. Besides being unnecessary, the implementation of `Ptr` types for resources was incorrect. Rather than using `**Foo` as their element type, these types use `*Foo`--identical to the element type used for the normal input/output types. Furthermore, the generated code for at least `FooOutput.ToFooPtrOutputWithContext` and `FooPtrOutput.Elem` was incorrect, making these types virtually unusable in practice. Finally, these `Ptr` types should never appear on input/output properties in practice, as the logic we use to generate input and output type references never generates them for `optional({input,output}(T)). Instead, it generates references to the standard input/output types. Though this is _technically_ a breaking change--it changes the set of exported types for any package that defines resources--I believe that in practice it will be invisible to users for the reasons stated above. These types are not usable, and were never referenced. This is preparatory work for #7943.
2021-11-23 18:24:56 +00:00
<span class="property-type">Rec</span>
</dt>
2022-04-29 22:04:15 +00:00
<dd></dd></dl>
</pulumi-choosable>
</div>
2022-05-04 07:05:39 +00:00
<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>
[docsgen] Fix rendering of deprecated messages and text in description lists (#13773) A change was made a while back to remove the use of shortcodes. As part of that, the shortcode used to render markdown was replaced by a function call that used goldmark to render markdown. The resulting HTML from that wraps the text in paragraph tags. This causes some problems for rendering the docs. For deprecations, the deprecation message now shows up outside of the "Deprecated" box. This happens because the rendered markdown was being wrapped in `<p></p>` tags, leading to `<p class="resource-deprecated">Deprecated: <p>message</p></p>`, which does not render correctly because paragraph tags cannot be nested. Also, in description lists, rendered markdown text was being wrapped in paragraph tags (e.g. `<dd><p>text</p></dd>`), causing it to render differently from text not wrapped in paragraph tags (e.g. `<dd>text</dd>`). This change addresses these issues. - First, `<div class="resource-deprecated">` is used rather than `<p>` to contain the deprecation information. - Second, the `markdownify` function will now trim unnecessary paragraph tags. Fixes https://github.com/pulumi/pulumi-hugo/issues/2832 Fixes https://github.com/pulumi/registry/issues/3008 --- ## Before <img width="713" alt="Screen Shot 2023-08-24 at 5 21 44 PM" src="https://github.com/pulumi/pulumi/assets/710598/1358cc74-dd8a-4bc0-bed8-603b1439b2aa"> ## After <img width="721" alt="Screen Shot 2023-08-24 at 5 21 58 PM" src="https://github.com/pulumi/pulumi/assets/710598/ad501e68-1bac-486c-a723-7db2b3442c8a"> ## Before <img width="719" alt="Screen Shot 2023-08-24 at 5 22 28 PM" src="https://github.com/pulumi/pulumi/assets/710598/6ca40b85-9008-429b-83c3-2f0d681752f3"> ## After <img width="714" alt="Screen Shot 2023-08-24 at 5 24 02 PM" src="https://github.com/pulumi/pulumi/assets/710598/eec1dacf-8c24-470e-b1e3-da843b4aeaee">
2023-08-26 17:36:28 +00:00
<dd>The provider-assigned unique ID for this managed resource.</dd><dt class="property-"
2022-05-04 07:05:39 +00:00
title="">
<span id="rec_yaml">
<a data-swiftype-name="resource-property" data-swiftype-type="text" href="#rec_yaml" style="color: inherit; text-decoration: inherit;">rec</a>
</span>
<span class="property-indicator"></span>
<span class="property-type">example:Rec</span>
</dt>
<dd></dd></dl>
</pulumi-choosable>
</div>
<h2 id="package-details">Package Details</h2>
<dl class="package-details">
<dt>Repository</dt>
2023-01-17 18:22:12 +00:00
<dd><a href="">example </a></dd>
<dt>License</dt>
<dd></dd>
</dl>