github.com/myhau/pulumi/pkg/v3@v3.70.2-0.20221116134521-f2775972e587/codegen/docs/templates/resource.tmpl (about) 1 {{ template "header" .Header }} 2 3 {{ htmlSafe "<!-- WARNING: this file was generated by" }} {{ .Tool }}. {{ htmlSafe "-->" }} 4 {{ htmlSafe "<!-- Do not edit by hand unless you're certain you know what you are doing! -->" }} 5 6 {{- if .DeprecationMessage }} 7 <p class="resource-deprecated">Deprecated: {{- markdownify .DeprecationMessage -}}</p> 8 {{- end }} 9 10 {{ htmlSafe .Comment }} 11 {{- if ne (len .ExamplesSection) 0 }} 12 {{ template "examples" .ExamplesSection }} 13 {{- end }} 14 15 <!-- Create resource --> 16 ## Create {{ .Header.Title }} Resource {#create} 17 18 {{- if eq .LangChooserLanguages "" }} 19 <div> 20 <pulumi-chooser type="language" options="typescript,python,go,csharp,java,yaml"></pulumi-chooser> 21 </div> 22 {{- else }} 23 <div> 24 <pulumi-chooser type="language" options="{{ .LangChooserLanguages }}"></pulumi-chooser> 25 </div> 26 {{- end }} 27 28 {{/* 29 Render the specific snippet to construct the resource, e.g. 30 "new Bucket(name: string, args?: BucketArgs, opts?: pulumi.ResourceOptions);" 31 "def Bucket(resource_name, opts=None, acceleration_status=None, ..." 32 */}} 33 <div> 34 <pulumi-choosable type="language" values="javascript,typescript"> 35 <div class="highlight"><pre class="chroma"><code class="language-typescript" data-lang="typescript"><span class="k">new </span>{{ template "linkify_param" .ConstructorResource.nodejs }}<span class="p">(</span>{{ htmlSafe .ConstructorParams.nodejs }}<span class="p">);</span></code></pre></div> 36 </pulumi-choosable> 37 </div> 38 39 <div> 40 <pulumi-choosable type="language" values="python"> 41 <div class="highlight"><pre class="chroma"><code class="language-python" data-lang="python"><span class=nd>@overload</span> 42 <span class="k">def </span>{{ template "linkify_param" .ConstructorResource.python }}<span class="p">(</span>{{ htmlSafe .ConstructorParams.python }}<span class="p">)</span> 43 <span class=nd>@overload</span> 44 <span class="k">def </span>{{ template "linkify_param" .ConstructorResource.python }}<span class="p">(</span>{{ htmlSafe .ConstructorParams.pythonargs }}<span class="p">)</span></code></pre></div> 45 </pulumi-choosable> 46 </div> 47 48 <div> 49 <pulumi-choosable type="language" values="go"> 50 <div class="highlight"><pre class="chroma"><code class="language-go" data-lang="go"><span class="k">func </span>{{ template "linkify_go_param" .ConstructorResource.go }}<span class="p">(</span>{{ htmlSafe .ConstructorParams.go }}<span class="p">) (*{{ template "linkify_param" .ConstructorResource.go }}, error)</span></code></pre></div> 51 </pulumi-choosable> 52 </div> 53 54 <div> 55 <pulumi-choosable type="language" values="csharp"> 56 <div class="highlight"><pre class="chroma"><code class="language-csharp" data-lang="csharp"><span class="k">public </span>{{ template "linkify_param" .ConstructorResource.csharp }}<span class="p">(</span>{{ htmlSafe .ConstructorParams.csharp }}<span class="p">)</span></code></pre></div> 57 </pulumi-choosable> 58 </div> 59 60 <div> 61 <pulumi-choosable type="language" values="java"> 62 <div class="highlight"><pre class="chroma"> 63 <code class="language-java" data-lang="java"><span class="k">public </span>{{ template "linkify_param" .ConstructorResource.java }}<span class="p">(</span>{{ htmlSafe .ConstructorParams.javaargs }}<span class="p">)</span> 64 <span class="k">public </span>{{ template "linkify_param" .ConstructorResource.java }}<span class="p">(</span>{{ htmlSafe .ConstructorParams.java }}<span class="p">)</span> 65 </code></pre></div> 66 </pulumi-choosable> 67 </div> 68 69 <div> 70 <pulumi-choosable type="language" values="yaml"> 71 <div class="highlight"><pre class="chroma"><code class="language-yaml" data-lang="yaml">type: {{ template "linkify_param" .ConstructorResource.yaml }}<span class="p"></span> 72 {{ template "yaml_constructor" .ConstructorParamsTyped.yaml }} 73 </code></pre></div> 74 </pulumi-choosable> 75 </div> 76 77 <div> 78 <pulumi-choosable type="language" values="javascript,typescript"> 79 {{ template "constructor_args" .ConstructorParamsTyped.nodejs }} 80 </pulumi-choosable> 81 </div> 82 83 <div> 84 <pulumi-choosable type="language" values="python"> 85 {{ template "constructor_args" .ConstructorParamsTyped.pythonargs }} 86 </pulumi-choosable> 87 </div> 88 89 <div> 90 <pulumi-choosable type="language" values="go"> 91 {{ template "constructor_args" .ConstructorParamsTyped.go }} 92 </pulumi-choosable> 93 </div> 94 95 <div> 96 <pulumi-choosable type="language" values="csharp"> 97 {{ template "constructor_args" .ConstructorParamsTyped.csharp }} 98 </pulumi-choosable> 99 </div> 100 101 <div> 102 <pulumi-choosable type="language" values="java"> 103 {{ template "constructor_args" .ConstructorParamsTyped.java }} 104 </pulumi-choosable> 105 </div> 106 107 ## {{ .Header.Title }} Resource Properties {#properties} 108 109 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. 110 111 ### Inputs 112 113 The {{ .Header.Title }} resource accepts the following [input](/docs/intro/concepts/inputs-outputs) properties: 114 115 {{ template "properties" .InputProperties }} 116 117 <!-- Output properties --> 118 ### Outputs 119 120 All [input](#inputs) properties are implicitly available as output properties. Additionally, the {{ .Header.Title }} resource produces the following output properties: 121 122 {{ template "properties" .OutputProperties }} 123 124 <!-- Methods --> 125 {{- if ne (len .Methods) 0 }} 126 ## {{ .Header.Title }} Resource Methods {#methods} 127 128 {{ range .Methods }} 129 ### {{ .Title }} Method {#method_{{ .Title }}} 130 131 {{- if .DeprecationMessage }} 132 <p class="resource-deprecated">Deprecated: {{- markdownify .DeprecationMessage -}}</p> 133 {{- end }} 134 135 {{ htmlSafe .Comment }} 136 {{- if ne (len .ExamplesSection) 0 }} 137 {{ template "examples" .ExamplesSection }} 138 {{- end }} 139 140 #### Using {{ .Title }} 141 142 <div> 143 <pulumi-chooser type="language" options="typescript,python,go,csharp,java,yaml"></pulumi-chooser> 144 </div> 145 146 <!-- TS/JS --> 147 <div> 148 <pulumi-choosable type="language" values="javascript,typescript"> 149 <div class="highlight"><pre class="chroma"><code class="language-typescript" data-lang="typescript">{{ .MethodName.nodejs }}<span class="p">(</span>{{ if ne .MethodArgs.nodejs "" }}{{ htmlSafe .MethodArgs.nodejs }}{{ end }}<span class="p">): {{ if ne .MethodResult.nodejs.Name "" }}Output<{{ template "linkify_param" .MethodResult.nodejs }}>{{ else }}void{{ end }}</span></code></pre></div> 150 </pulumi-choosable> 151 </div> 152 153 <!-- Python --> 154 <div> 155 <pulumi-choosable type="language" values="python"> 156 <div class="highlight"><pre class="chroma"><code class="language-python" data-lang="python"><span class="k">def </span>{{ .MethodName.python }}(</span>{{ if ne .MethodArgs.python "" }}{{ htmlSafe .MethodArgs.python }}{{ end }}<span class="p">) -></span> {{ if ne .MethodResult.python.Name "" }}Output[{{ template "linkify_param" .MethodResult.python }}]{{ else }}None{{ end }}</code></pre></div> 157 </pulumi-choosable> 158 </div> 159 160 <!-- Go --> 161 <div> 162 <pulumi-choosable type="language" values="go"> 163 <div class="highlight"><pre class="chroma"><code class="language-go" data-lang="go"><span class="k">func</span> <span class="p">(r *{{ .ResourceName }})</span> {{ .MethodName.go }}<span class="p">(</span>{{ if ne .MethodArgs.go "" }}{{ htmlSafe .MethodArgs.go }}{{ end }}<span class="p">) {{ if ne .MethodResult.go.Name "" }}({{ template "linkify_param" .MethodResult.go }}, error){{ else }}error{{ end }}</span></code></pre></div> 164 </pulumi-choosable> 165 </div> 166 167 <!-- C# --> 168 <div> 169 <pulumi-choosable type="language" values="csharp"> 170 <div class="highlight"><pre class="chroma"><code class="language-csharp" data-lang="csharp"><span class="k">public </span>{{ if ne .MethodResult.csharp.Name "" }}Output<{{ template "linkify_param" .MethodResult.csharp }}>{{ else }}void{{ end }} <span class="nx">{{ .MethodName.csharp }}</span><span class="p">({{ if ne .MethodArgs.csharp "" }}{{ htmlSafe .MethodArgs.csharp }}{{ end }})</span></code></pre></div> 171 </pulumi-choosable> 172 </div> 173 174 {{ if ne (len .InputProperties) 0 }} 175 176 The following arguments are supported: 177 {{ template "properties" .InputProperties }} 178 {{ end }} 179 180 {{ if ne (len .OutputProperties) 0 }} 181 #### {{ .Title }} Result {#method_{{ .Title }}_result} 182 {{ template "properties" .OutputProperties }} 183 {{ end }} 184 185 {{ end }} 186 {{- end -}} 187 188 <!-- Read resource --> 189 {{ if ne (len .StateInputs) 0 }} 190 ## Look up Existing {{.Header.Title}} Resource {#look-up} 191 192 Get an existing {{.Header.Title}} resource's state with the given name, ID, and optional extra properties used to qualify the lookup. 193 194 {{- if eq .LangChooserLanguages "" }} 195 <div> 196 <pulumi-chooser type="language" options="typescript,python,go,csharp,java,yaml"></pulumi-chooser> 197 </div> 198 {{- else }} 199 <div> 200 <pulumi-chooser type="language" options="{{ .LangChooserLanguages }}"></pulumi-chooser> 201 </div> 202 {{- end }} 203 204 <div> 205 <pulumi-choosable type="language" values="javascript,typescript"> 206 <div class="highlight"><pre class="chroma"><code class="language-typescript" data-lang="typescript"><span class="k">public static </span><span class="nf">get</span><span class="p">(</span>{{ htmlSafe .LookupParams.nodejs }}<span class="p">): </span>{{ template "linkify_param" .ConstructorResource.nodejs }}</code></pre></div> 207 </pulumi-choosable> 208 </div> 209 210 <div> 211 <pulumi-choosable type="language" values="python"> 212 <div class="highlight"><pre class="chroma"><code class="language-python" data-lang="python"><span class=nd>@staticmethod</span> 213 <span class="k">def </span><span class="nf">get</span><span class="p">(</span><span class="nx">resource_name</span><span class="p">:</span> <span class="nx">str</span><span class="p">,</span> 214 <span class="nx">id</span><span class="p">:</span> <span class="nx">str</span><span class="p">,</span> 215 <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> 216 {{ htmlSafe .LookupParams.python }}<span class="p">) -></span> {{ .ConstructorResource.python.Name }}</code></pre></div> 217 </pulumi-choosable> 218 </div> 219 220 <div> 221 <pulumi-choosable type="language" values="go"> 222 <div class="highlight"><pre class="chroma"><code class="language-go" data-lang="go"><span class="k">func </span>Get{{ .Header.Title }}<span class="p">(</span>{{ htmlSafe .LookupParams.go }}<span class="p">) (*{{ template "linkify_param" .ConstructorResource.go }}, error)</span></code></pre></div> 223 </pulumi-choosable> 224 </div> 225 226 <div> 227 <pulumi-choosable type="language" values="csharp"> 228 <div class="highlight"><pre class="chroma"><code class="language-csharp" data-lang="csharp"><span class="k">public static </span>{{ template "linkify_param" .ConstructorResource.csharp }}<span class="nf"> Get</span><span class="p">(</span>{{ htmlSafe .LookupParams.csharp }}<span class="p">)</span></code></pre></div> 229 </pulumi-choosable> 230 </div> 231 232 <div> 233 <pulumi-choosable type="language" values="java"> 234 <div class="highlight"><pre class="chroma"><code class="language-java" data-lang="java"><span class="k">public static </span>{{ template "linkify_param" .ConstructorResource.java }}<span class="nf"> get</span><span class="p">(</span>{{ htmlSafe .LookupParams.java }}<span class="p">)</span></code></pre></div> 235 </pulumi-choosable> 236 </div> 237 238 <div> 239 <pulumi-choosable type="language" values="yaml"> 240 <div class="highlight"><pre class="chroma"><code class="language-yaml" data-lang="yaml">Resource lookup is not supported in YAML</code></pre></div> 241 </pulumi-choosable> 242 </div> 243 244 <div> 245 <pulumi-choosable type="language" values="javascript,typescript"> 246 {{ template "read_inputs" }} 247 </pulumi-choosable> 248 </div> 249 250 <div> 251 <pulumi-choosable type="language" values="python"> 252 <dl class="resources-properties"> 253 <dt class="property-required" title="Required"> 254 <span>resource_name</span> 255 <span class="property-indicator"></span> 256 </dt> 257 <dd>The unique name of the resulting resource.</dd> 258 <dt class="property-required" title="Optional"> 259 <span>id</span> 260 <span class="property-indicator"></span> 261 </dt> 262 <dd>The <em>unique</em> provider ID of the resource to lookup.</dd> 263 </dl> 264 </pulumi-choosable> 265 </div> 266 267 <div> 268 <pulumi-choosable type="language" values="go"> 269 {{ template "read_inputs" }} 270 </pulumi-choosable> 271 </div> 272 273 <div> 274 <pulumi-choosable type="language" values="csharp"> 275 {{ template "read_inputs" }} 276 </pulumi-choosable> 277 </div> 278 279 <div> 280 <pulumi-choosable type="language" values="java"> 281 {{ template "read_inputs" }} 282 </pulumi-choosable> 283 </div> 284 285 <div> 286 <pulumi-choosable type="language" values="typescript,javascript,python,go,csharp,java"> 287 The following state arguments are supported: 288 {{ template "properties" .StateInputs }} 289 </pulumi-choosable> 290 </div> 291 292 {{ end }} 293 294 <!-- Supporting types --> 295 {{ if ne (len .NestedTypes) 0 }} 296 297 ## Supporting Types 298 299 {{ range .NestedTypes }} 300 301 <h4 id="{{ .AnchorID }}">{{ htmlSafe .Name }}</h4> 302 303 {{- if .Properties }}{{template "properties" .Properties -}}{{ end -}} 304 {{- if .EnumValues }}{{- template "enums" .EnumValues -}}{{ end -}} 305 {{- end -}} 306 307 {{- end -}} 308 309 {{ if .ImportDocs }} 310 311 ## Import 312 313 {{ htmlSafe .ImportDocs }} 314 315 {{ end }} 316 317 {{ template "package_details" .PackageDetails }}