pulumi/pkg/codegen/internal/test/testdata/env-helper/docs/provider/_index.md
Ian Wahbe 3e2f36548e
[codegen/typescript] Call site defaults for plain Pulumi Object types (#8400)
* Add test case

* Fix tests

* Add test dependencies correctly

* Feed through error handling

* Include test output

* Get types to line up

* Add remaining test files

* Update changelog

* Correctly find type paths

* Handle transitive objects

* Handle required fields

* Add required+default test case

* Don't `<any>` cast known types.

* Add plain object to env-helper test

This test fails right now. My next problem is fixing it.

* Handle plain types

* Handle function inputs

* Fix the indentation

* Handle output types correctly

* Remove unnecessary `!`

* Add missing change to fix test

* Run tests with merge

* Merge in next _index.md diff

* Another attempt at _index.md

* Make module generation deterministic

* Fix docs generation

Credit to @praneetloke
2021-11-18 12:23:30 -08:00

18 KiB


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

The provider type for the kubernetes package.

Create a Provider Resource

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

{{% choosable language nodejs %}}

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

{{% choosable language python %}}

@overload
def Provider(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             helm_release_settings: Optional[HelmReleaseSettingsArgs] = None)
@overload
def Provider(resource_name: str,
             args: Optional[ProviderArgs] = None,
             opts: Optional[ResourceOptions] = None)
{{% /choosable %}}

{{% choosable language go %}}

func NewProvider(ctx *Context, name string, args *ProviderArgs, opts ...ResourceOption) (*Provider, error)
{{% /choosable %}}

{{% choosable language csharp %}}

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

{{% choosable language nodejs %}}

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

{{% /choosable %}}

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

{{% choosable language csharp %}}

HelmReleaseSettings HelmReleaseSettingsArgs
{{% md %}}BETA FEATURE - Options to configure the Helm Release resource.{{% /md %}}
{{% /choosable %}}

{{% choosable language go %}}

HelmReleaseSettings HelmReleaseSettingsArgs
{{% md %}}BETA FEATURE - Options to configure the Helm Release resource.{{% /md %}}
{{% /choosable %}}

{{% choosable language nodejs %}}

helmReleaseSettings HelmReleaseSettingsArgs
{{% md %}}BETA FEATURE - Options to configure the Helm Release resource.{{% /md %}}
{{% /choosable %}}

{{% choosable language python %}}

helm_release_settings HelmReleaseSettingsArgs
{{% md %}}BETA FEATURE - Options to configure the Helm Release resource.{{% /md %}}
{{% /choosable %}}

Outputs

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

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 %}}

Package Details

Repository
License