pulumi/pkg/codegen/internal/test/testdata/external-resource-schema/docs/cat.md

18 KiB


title: "Cat" title_tag: "example.Cat" meta_desc: "Documentation for the example.Cat resource with examples, input properties, output properties, lookup functions, and supporting types."

Create a Cat Resource

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

{{% choosable language nodejs %}}

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

{{% choosable language python %}}

@overload
def Cat(resource_name: str,
        opts: Optional[ResourceOptions] = None,
        age: Optional[int] = None,
        pet: Optional[PetArgs] = None)
@overload
def Cat(resource_name: str,
        args: Optional[CatArgs] = None,
        opts: Optional[ResourceOptions] = None)
{{% /choosable %}}

{{% choosable language go %}}

func NewCat(ctx *Context, name string, args *CatArgs, opts ...ResourceOption) (*Cat, error)
{{% /choosable %}}

{{% choosable language csharp %}}

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

{{% choosable language nodejs %}}

name string
The unique name of the resource.
args CatArgs
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 CatArgs
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 CatArgs
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 CatArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

{{% /choosable %}}

Cat 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 Programming Model docs.

Inputs

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

{{% choosable language csharp %}}

Age int
{{% md %}}{{% /md %}}
Pet PetArgs
{{% md %}}{{% /md %}}
{{% /choosable %}}

{{% choosable language go %}}

Age int
{{% md %}}{{% /md %}}
Pet Pet
{{% md %}}{{% /md %}}
{{% /choosable %}}

{{% choosable language nodejs %}}

age number
{{% md %}}{{% /md %}}
pet PetArgs
{{% md %}}{{% /md %}}
{{% /choosable %}}

{{% choosable language python %}}

age int
{{% md %}}{{% /md %}}
pet PetArgs
{{% md %}}{{% /md %}}
{{% /choosable %}}

Outputs

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

{{% choosable language csharp %}}

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

{{% choosable language go %}}

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

{{% choosable language nodejs %}}

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

{{% choosable language python %}}

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

Supporting Types

Pet

{{% choosable language csharp %}}

Age int
{{% md %}}{{% /md %}}
Name Pulumi.Random.RandomPet
{{% md %}}{{% /md %}}
{{% /choosable %}}

{{% choosable language go %}}

Age int
{{% md %}}{{% /md %}}
Name RandomPet
{{% md %}}{{% /md %}}
{{% /choosable %}}

{{% choosable language nodejs %}}

age number
{{% md %}}{{% /md %}}
name randomRandomPet
{{% md %}}{{% /md %}}
{{% /choosable %}}

{{% choosable language python %}}

age int
{{% md %}}{{% /md %}}
name RandomPet
{{% md %}}{{% /md %}}
{{% /choosable %}}

Package Details

Repository
License