* 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>
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 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 language go %}}
func NewTypeUses(ctx *Context, name string, args *TypeUsesArgs, opts ...ResourceOption) (*TypeUses, error)
{{% choosable language csharp %}}
public TypeUses(string name, TypeUsesArgs? args = null, CustomResourceOptions? opts = null)
{{% 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
Some
Other Object Args - {{% md %}}{{% /md %}}
-
Baz
Object
With Node Optional Inputs Args - {{% md %}}{{% /md %}}
-
Foo
Object
Args - {{% md %}}{{% /md %}}
{{% choosable language go %}}
-
Bar
Some
Other Object Args - {{% md %}}{{% /md %}}
-
Baz
Object
With Node Optional Inputs Args - {{% md %}}{{% /md %}}
-
Foo
Object
Args - {{% md %}}{{% /md %}}
{{% choosable language nodejs %}}
-
bar
Some
Other Object Args - {{% md %}}{{% /md %}}
-
baz
Object
With Node Optional Inputs Args - {{% md %}}{{% /md %}}
-
foo
Object
Args - {{% md %}}{{% /md %}}
{{% choosable language python %}}
-
bar
Some
Other Object Args - {{% md %}}{{% /md %}}
-
baz
Object
With Node Optional Inputs Args - {{% md %}}{{% /md %}}
-
foo
Object
Args - {{% md %}}{{% /md %}}
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 language go %}}
- Id string
- {{% md %}}The provider-assigned unique ID for this managed resource.{{% /md %}}
{{% choosable language nodejs %}}
- id string
- {{% md %}}The provider-assigned unique ID for this managed resource.{{% /md %}}
{{% choosable language python %}}
- id str
- {{% md %}}The provider-assigned unique ID for this managed resource.{{% /md %}}
Supporting Types
ConfigMap
{{% choosable language csharp %}}
- Config string
- {{% md %}}{{% /md %}}
{{% choosable language go %}}
- Config string
- {{% md %}}{{% /md %}}
{{% choosable language nodejs %}}
- config string
- {{% md %}}{{% /md %}}
{{% choosable language python %}}
- config str
- {{% md %}}{{% /md %}}
Object
{{% choosable language csharp %}}
- Bar string
- {{% md %}}{{% /md %}}
-
Configs
List<Config
Map> - {{% md %}}{{% /md %}}
-
Foo
Pulumi.
Example. Resource - {{% md %}}{{% /md %}}
-
Others
List<Immutable
Array<Some Other Object>> - {{% md %}}List of lists of other objects{{% /md %}}
-
Still
Others Dictionary<string, ImmutableArray<Some Other Object>> - {{% md %}}Mapping from string to list of some other object{{% /md %}}
{{% choosable language go %}}
- Bar string
- {{% md %}}{{% /md %}}
-
Configs
[]Config
Map - {{% md %}}{{% /md %}}
- Foo Resource
- {{% md %}}{{% /md %}}
-
Others
[][]Some
Other Object - {{% md %}}List of lists of other objects{{% /md %}}
-
Still
Others map[string][]SomeOther Object - {{% md %}}Mapping from string to list of some other object{{% /md %}}
{{% choosable language nodejs %}}
- bar string
- {{% md %}}{{% /md %}}
-
configs
Config
Map[] - {{% md %}}{{% /md %}}
- foo Resource
- {{% md %}}{{% /md %}}
-
others
Some
Other Object[][] - {{% md %}}List of lists of other objects{{% /md %}}
-
still
Others {[key: string]: SomeOther Object[]} - {{% md %}}Mapping from string to list of some other object{{% /md %}}
{{% choosable language python %}}
- bar str
- {{% md %}}{{% /md %}}
-
configs
Sequence[Config
Map] - {{% md %}}{{% /md %}}
- foo Resource
- {{% md %}}{{% /md %}}
-
others
Sequence[Sequence[Some
Other Object]] - {{% md %}}List of lists of other objects{{% /md %}}
-
still_
others Mapping[str, Sequence[SomeOther Object]] - {{% md %}}Mapping from string to list of some other object{{% /md %}}
ObjectWithNodeOptionalInputs
{{% choosable language csharp %}}
{{% /choosable %}}{{% choosable language go %}}
{{% /choosable %}}{{% choosable language nodejs %}}
{{% /choosable %}}{{% choosable language python %}}
{{% /choosable %}}SomeOtherObject
{{% choosable language csharp %}}
- Baz string
- {{% md %}}{{% /md %}}
{{% choosable language go %}}
- Baz string
- {{% md %}}{{% /md %}}
{{% choosable language nodejs %}}
- baz string
- {{% md %}}{{% /md %}}
{{% choosable language python %}}
- baz str
- {{% md %}}{{% /md %}}
Package Details
- Repository
- License