pulumi/pkg/codegen/internal/test/testdata/env-helper/docs/foo/_index.md

---

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

test new feature with resoruces

Create a Foo Resource

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

{{% choosable language nodejs %}}

new Foo(name: string, args: FooArgs, opts?: CustomResourceOptions);

{{% /choosable %}}

{{% choosable language python %}}

@overload
def Foo(resource_name: str,
        opts: Optional[ResourceOptions] = None,
        argument: Optional[str] = None,
        backup_kube_client_settings: Optional[KubeClientSettingsArgs] = None,
        kube_client_settings: Optional[KubeClientSettingsArgs] = None,
        settings: Optional[LayeredTypeArgs] = None)
@overload
def Foo(resource_name: str,
        args: FooArgs,
        opts: Optional[ResourceOptions] = None)

{{% /choosable %}}

{{% choosable language go %}}

func NewFoo(ctx *Context, name string, args FooArgs, opts ...ResourceOption) (*Foo, error)

{{% /choosable %}}

{{% choosable language csharp %}}

public Foo(string name, FooArgs args, CustomResourceOptions? opts = null)

{{% /choosable %}}

{{% choosable language nodejs %}}

name string

The unique name of the resource.

args FooArgs

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 FooArgs

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 FooArgs

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 FooArgs

The arguments to resource properties.

opts CustomResourceOptions

Bag of options to control resource's behavior.

{{% /choosable %}}

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

{{% choosable language csharp %}}

BackupKubeClientSettings KubeClientSettingsArgs

{{% md %}}Options for tuning the Kubernetes client used by a Provider.{{% /md %}}

Argument string

{{% md %}}{{% /md %}}

KubeClientSettings KubeClientSettingsArgs

{{% md %}}Options for tuning the Kubernetes client used by a Provider.{{% /md %}}

Settings LayeredTypeArgs

{{% md %}}describing things{{% /md %}}

{{% /choosable %}}

{{% choosable language go %}}

BackupKubeClientSettings KubeClientSettingsArgs

{{% md %}}Options for tuning the Kubernetes client used by a Provider.{{% /md %}}

Argument string

{{% md %}}{{% /md %}}

KubeClientSettings KubeClientSettingsArgs

{{% md %}}Options for tuning the Kubernetes client used by a Provider.{{% /md %}}

Settings LayeredTypeArgs

{{% md %}}describing things{{% /md %}}

{{% /choosable %}}

{{% choosable language nodejs %}}

backupKubeClientSettings KubeClientSettingsArgs

{{% md %}}Options for tuning the Kubernetes client used by a Provider.{{% /md %}}

argument string

{{% md %}}{{% /md %}}

kubeClientSettings KubeClientSettingsArgs

{{% md %}}Options for tuning the Kubernetes client used by a Provider.{{% /md %}}

settings LayeredTypeArgs

{{% md %}}describing things{{% /md %}}

{{% /choosable %}}

{{% choosable language python %}}

backup_kube_client_settings KubeClientSettingsArgs

{{% md %}}Options for tuning the Kubernetes client used by a Provider.{{% /md %}}

argument str

{{% md %}}{{% /md %}}

kube_client_settings KubeClientSettingsArgs

{{% md %}}Options for tuning the Kubernetes client used by a Provider.{{% /md %}}

settings LayeredTypeArgs

{{% md %}}describing things{{% /md %}}

{{% /choosable %}}

Outputs

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

{{% choosable language csharp %}}

Id string

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

DefaultKubeClientSettings KubeClientSettings

{{% md %}}A test for plain types{{% /md %}}

{{% /choosable %}}

{{% choosable language go %}}

Id string

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

DefaultKubeClientSettings KubeClientSettings

{{% md %}}A test for plain types{{% /md %}}

{{% /choosable %}}

{{% choosable language nodejs %}}

id string

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

defaultKubeClientSettings KubeClientSettings

{{% md %}}A test for plain types{{% /md %}}

{{% /choosable %}}

{{% choosable language python %}}

id str

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

default_kube_client_settings KubeClientSettings

{{% md %}}A test for plain types{{% /md %}}

{{% /choosable %}}

Supporting Types

HelmReleaseSettings

{{% choosable language csharp %}}

RequiredArg string

{{% md %}}to test required args{{% /md %}}

Driver string

{{% md %}}The backend storage driver for Helm. Values are: configmap, secret, memory, sql.{{% /md %}}

PluginsPath string

{{% md %}}The path to the helm plugins directory.{{% /md %}}

{{% /choosable %}}

{{% choosable language go %}}

RequiredArg string

{{% md %}}to test required args{{% /md %}}

Driver string

{{% md %}}The backend storage driver for Helm. Values are: configmap, secret, memory, sql.{{% /md %}}

PluginsPath string

{{% md %}}The path to the helm plugins directory.{{% /md %}}

{{% /choosable %}}

{{% choosable language nodejs %}}

requiredArg string

{{% md %}}to test required args{{% /md %}}

driver string

{{% md %}}The backend storage driver for Helm. Values are: configmap, secret, memory, sql.{{% /md %}}

pluginsPath string

{{% md %}}The path to the helm plugins directory.{{% /md %}}

{{% /choosable %}}

{{% choosable language python %}}

required_arg str

{{% md %}}to test required args{{% /md %}}

driver str

{{% md %}}The backend storage driver for Helm. Values are: configmap, secret, memory, sql.{{% /md %}}

plugins_path str

{{% md %}}The path to the helm plugins directory.{{% /md %}}

{{% /choosable %}}

KubeClientSettings

{{% choosable language csharp %}}

Burst int

{{% md %}}Maximum burst for throttle. Default value is 10.{{% /md %}}

Qps double

{{% md %}}Maximum queries per second (QPS) to the API server from this client. Default value is 5.{{% /md %}}

RecTest KubeClientSettings

{{% md %}}{{% /md %}}

{{% /choosable %}}

{{% choosable language go %}}

Burst int

{{% md %}}Maximum burst for throttle. Default value is 10.{{% /md %}}

Qps float64

{{% md %}}Maximum queries per second (QPS) to the API server from this client. Default value is 5.{{% /md %}}

RecTest KubeClientSettings

{{% md %}}{{% /md %}}

{{% /choosable %}}

{{% choosable language nodejs %}}

burst number

{{% md %}}Maximum burst for throttle. Default value is 10.{{% /md %}}

qps number

{{% md %}}Maximum queries per second (QPS) to the API server from this client. Default value is 5.{{% /md %}}

recTest KubeClientSettings

{{% md %}}{{% /md %}}

{{% /choosable %}}

{{% choosable language python %}}

burst int

{{% md %}}Maximum burst for throttle. Default value is 10.{{% /md %}}

qps float

{{% md %}}Maximum queries per second (QPS) to the API server from this client. Default value is 5.{{% /md %}}

rec_test KubeClientSettings

{{% md %}}{{% /md %}}

{{% /choosable %}}

LayeredType

{{% choosable language csharp %}}

Other HelmReleaseSettings

{{% md %}}{{% /md %}}

Thinker string

{{% md %}}To ask and answer{{% /md %}}

Answer double

{{% md %}}The answer to the question{{% /md %}}

PlainOther HelmReleaseSettings

{{% md %}}Test how plain types interact{{% /md %}}

Question string

{{% md %}}The question already answered{{% /md %}}

Recursive LayeredType

{{% md %}}{{% /md %}}

{{% /choosable %}}

{{% choosable language go %}}

Other HelmReleaseSettings

{{% md %}}{{% /md %}}

Thinker string

{{% md %}}To ask and answer{{% /md %}}

Answer float64

{{% md %}}The answer to the question{{% /md %}}

PlainOther HelmReleaseSettings

{{% md %}}Test how plain types interact{{% /md %}}

Question string

{{% md %}}The question already answered{{% /md %}}

Recursive LayeredType

{{% md %}}{{% /md %}}

{{% /choosable %}}

{{% choosable language nodejs %}}

other HelmReleaseSettings

{{% md %}}{{% /md %}}

thinker string

{{% md %}}To ask and answer{{% /md %}}

answer number

{{% md %}}The answer to the question{{% /md %}}

plainOther HelmReleaseSettings

{{% md %}}Test how plain types interact{{% /md %}}

question string

{{% md %}}The question already answered{{% /md %}}

recursive LayeredType

{{% md %}}{{% /md %}}

{{% /choosable %}}

{{% choosable language python %}}

other HelmReleaseSettings

{{% md %}}{{% /md %}}

thinker str

{{% md %}}To ask and answer{{% /md %}}

answer float

{{% md %}}The answer to the question{{% /md %}}

plain_other HelmReleaseSettings

{{% md %}}Test how plain types interact{{% /md %}}

question str

{{% md %}}The question already answered{{% /md %}}

recursive LayeredType

{{% md %}}{{% /md %}}

{{% /choosable %}}

Package Details

Repository

License