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

12 KiB


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

Create a Resource Resource

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

{{% choosable language nodejs %}}

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

{{% choosable language python %}}

@overload
def Resource(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             bar: Optional[str] = None)
@overload
def Resource(resource_name: str,
             args: Optional[ResourceArgs] = None,
             opts: Optional[ResourceOptions] = None)
{{% /choosable %}}

{{% choosable language go %}}

func NewResource(ctx *Context, name string, args *ResourceArgs, opts ...ResourceOption) (*Resource, error)
{{% /choosable %}}

{{% choosable language csharp %}}

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

{{% choosable language nodejs %}}

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

{{% /choosable %}}

Resource 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 Resource resource accepts the following [input]({{< relref "/docs/intro/concepts/inputs-outputs" >}}) properties:

{{% choosable language csharp %}}

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

{{% choosable language go %}}

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

{{% choosable language nodejs %}}

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

{{% choosable language python %}}

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

Outputs

All input properties are implicitly available as output properties. Additionally, the Resource 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 %}}

Package Details

Repository
License