pulumi/pkg/codegen/internal/test/testdata/simple-resource-schema/docs/typeuses/_index.md
Praneet Loke 0f5b7c765b
[codegen/docs] Update API docs templates to include layout front-matter param (#8242)
* Update generation templates

* Updated templates for codegen

* Rm api-doc-resource template

* Update templates to use layout:api and no alias

* Set no_edit_this_page to true in the header and index templates used by docs gen.

* Update docs generation baseline test files with template updates

* Remove the notion of menu from resource templates (#8200)

* Update the title lookup map entry for aws-api-gateway

* Updated CSS classes for icons in API docs template

* Updated tests:

* Additional test file updates

* Fixup package names

Co-authored-by: Devon Grove <devon@pulumi.com>
Co-authored-by: Christian Nunciato <c@nunciato.org>
Co-authored-by: stack72 <public@paulstack.co.uk>
2021-10-17 22:36:31 -07:00

30 KiB


title: "TypeUses" title_tag: "example.TypeUses" meta_desc: "Documentation for the example.TypeUses resource with examples, input properties, output properties, lookup functions, and supporting types." layout: api no_edit_this_page: true

Create a TypeUses Resource

{{< chooser language "typescript,python,go,csharp" / >}}

{{% choosable language nodejs %}}

new TypeUses(name: string, args?: TypeUsesArgs, opts?: CustomResourceOptions);
{{% /choosable %}}

{{% choosable language python %}}

@overload
def TypeUses(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             bar: Optional[SomeOtherObjectArgs] = None,
             baz: Optional[ObjectWithNodeOptionalInputsArgs] = None,
             foo: Optional[ObjectArgs] = None)
@overload
def TypeUses(resource_name: str,
             args: Optional[TypeUsesArgs] = None,
             opts: Optional[ResourceOptions] = None)
{{% /choosable %}}

{{% choosable language go %}}

func NewTypeUses(ctx *Context, name string, args *TypeUsesArgs, opts ...ResourceOption) (*TypeUses, error)
{{% /choosable %}}

{{% choosable language csharp %}}

public TypeUses(string name, TypeUsesArgs? args = null, CustomResourceOptions? opts = null)
{{% /choosable %}}

{{% choosable language nodejs %}}

name string
The unique name of the resource.
args TypeUsesArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

{{% /choosable %}}

{{% choosable language python %}}

resource_name str
The unique name of the resource.
args TypeUsesArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.

{{% /choosable %}}

{{% choosable language go %}}

ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args TypeUsesArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.

{{% /choosable %}}

{{% choosable language csharp %}}

name string
The unique name of the resource.
args TypeUsesArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

{{% /choosable %}}

TypeUses Resource Properties

To learn more about resource properties and how to use them, see [Inputs and Outputs]({{< relref "/docs/intro/concepts/inputs-outputs" >}}) in the Architecture and Concepts docs.

Inputs

The TypeUses resource accepts the following [input]({{< relref "/docs/intro/concepts/inputs-outputs" >}}) properties:

{{% choosable language csharp %}}

Bar SomeOtherObjectArgs
{{% md %}}{{% /md %}}
Baz ObjectWithNodeOptionalInputsArgs
{{% md %}}{{% /md %}}
Foo ObjectArgs
{{% md %}}{{% /md %}}
{{% /choosable %}}

{{% choosable language go %}}

Bar SomeOtherObjectArgs
{{% md %}}{{% /md %}}
Baz ObjectWithNodeOptionalInputsArgs
{{% md %}}{{% /md %}}
Foo ObjectArgs
{{% md %}}{{% /md %}}
{{% /choosable %}}

{{% choosable language nodejs %}}

bar SomeOtherObjectArgs
{{% md %}}{{% /md %}}
baz ObjectWithNodeOptionalInputsArgs
{{% md %}}{{% /md %}}
foo ObjectArgs
{{% md %}}{{% /md %}}
{{% /choosable %}}

{{% choosable language python %}}

bar SomeOtherObjectArgs
{{% md %}}{{% /md %}}
baz ObjectWithNodeOptionalInputsArgs
{{% md %}}{{% /md %}}
foo ObjectArgs
{{% md %}}{{% /md %}}
{{% /choosable %}}

Outputs

All input properties are implicitly available as output properties. Additionally, the TypeUses resource produces the following output properties:

{{% choosable language csharp %}}

Id string
{{% md %}}The provider-assigned unique ID for this managed resource.{{% /md %}}
{{% /choosable %}}

{{% choosable language go %}}

Id string
{{% md %}}The provider-assigned unique ID for this managed resource.{{% /md %}}
{{% /choosable %}}

{{% choosable language nodejs %}}

id string
{{% md %}}The provider-assigned unique ID for this managed resource.{{% /md %}}
{{% /choosable %}}

{{% choosable language python %}}

id str
{{% md %}}The provider-assigned unique ID for this managed resource.{{% /md %}}
{{% /choosable %}}

Supporting Types

ConfigMap

{{% choosable language csharp %}}

Config string
{{% md %}}{{% /md %}}
{{% /choosable %}}

{{% choosable language go %}}

Config string
{{% md %}}{{% /md %}}
{{% /choosable %}}

{{% choosable language nodejs %}}

config string
{{% md %}}{{% /md %}}
{{% /choosable %}}

{{% choosable language python %}}

config str
{{% md %}}{{% /md %}}
{{% /choosable %}}

Object

{{% choosable language csharp %}}

Bar string
{{% md %}}{{% /md %}}
Configs List<ConfigMap>
{{% md %}}{{% /md %}}
Foo Pulumi.Example.Resource
{{% md %}}{{% /md %}}
Others List<ImmutableArray<SomeOtherObject>>
{{% md %}}List of lists of other objects{{% /md %}}
StillOthers Dictionary<string, ImmutableArray<SomeOtherObject>>
{{% md %}}Mapping from string to list of some other object{{% /md %}}
{{% /choosable %}}

{{% choosable language go %}}

Bar string
{{% md %}}{{% /md %}}
Configs []ConfigMap
{{% md %}}{{% /md %}}
Foo Resource
{{% md %}}{{% /md %}}
Others [][]SomeOtherObject
{{% md %}}List of lists of other objects{{% /md %}}
StillOthers map[string][]SomeOtherObject
{{% md %}}Mapping from string to list of some other object{{% /md %}}
{{% /choosable %}}

{{% choosable language nodejs %}}

bar string
{{% md %}}{{% /md %}}
configs ConfigMap[]
{{% md %}}{{% /md %}}
foo Resource
{{% md %}}{{% /md %}}
others SomeOtherObject[][]
{{% md %}}List of lists of other objects{{% /md %}}
stillOthers {[key: string]: SomeOtherObject[]}
{{% md %}}Mapping from string to list of some other object{{% /md %}}
{{% /choosable %}}

{{% choosable language python %}}

bar str
{{% md %}}{{% /md %}}
configs Sequence[ConfigMap]
{{% md %}}{{% /md %}}
foo Resource
{{% md %}}{{% /md %}}
others Sequence[Sequence[SomeOtherObject]]
{{% md %}}List of lists of other objects{{% /md %}}
still_others Mapping[str, Sequence[SomeOtherObject]]
{{% md %}}Mapping from string to list of some other object{{% /md %}}
{{% /choosable %}}

ObjectWithNodeOptionalInputs

{{% choosable language csharp %}}

Foo string
{{% md %}}{{% /md %}}
Bar int
{{% md %}}{{% /md %}}
{{% /choosable %}}

{{% choosable language go %}}

Foo string
{{% md %}}{{% /md %}}
Bar int
{{% md %}}{{% /md %}}
{{% /choosable %}}

{{% choosable language nodejs %}}

foo string
{{% md %}}{{% /md %}}
bar number
{{% md %}}{{% /md %}}
{{% /choosable %}}

{{% choosable language python %}}

foo str
{{% md %}}{{% /md %}}
bar int
{{% md %}}{{% /md %}}
{{% /choosable %}}

SomeOtherObject

{{% choosable language csharp %}}

Baz string
{{% md %}}{{% /md %}}
{{% /choosable %}}

{{% choosable language go %}}

Baz string
{{% md %}}{{% /md %}}
{{% /choosable %}}

{{% choosable language nodejs %}}

baz string
{{% md %}}{{% /md %}}
{{% /choosable %}}

{{% choosable language python %}}

baz str
{{% md %}}{{% /md %}}
{{% /choosable %}}

Package Details

Repository
License