2023-11-19 13:47:45 +00:00
---
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
---
<!-- WARNING: this file was generated by test. -->
<!-- Do not edit by hand unless you're certain you know what you are doing! -->
## Create Provider Resource {#create}
2024-04-02 15:47:32 +00:00
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see [Resources ](/docs/concepts/resources/ ).
### Constructor syntax
2023-11-19 13:47:45 +00:00
< div >
2024-07-09 14:54:50 +00:00
< pulumi-chooser type = "language" options = "csharp,go,typescript,python,yaml,java" > < / pulumi-chooser >
2023-11-19 13:47:45 +00:00
< / div >
< div >
< pulumi-choosable type = "language" values = "javascript,typescript" >
2024-04-02 15:47:32 +00:00
< div class = "no-copy" > < div class = "highlight" > < pre class = "chroma" > < code class = "language-typescript" data-lang = "typescript" > < span class = "k" > new < / span > < span class = "nx" > Provider< / span > < span class = "p" > (< / span > < span class = "nx" > name< / span > < span class = "p" > :< / span > < span class = "nx" > string< / span > < span class = "p" > ,< / span > < span class = "nx" > args< / span > < span class = "p" > ?:< / span > < span class = "nx" > < a href = "#inputs" > ProviderArgs< / a > < / span > < span class = "p" > ,< / span > < span class = "nx" > opts< / span > < span class = "p" > ?:< / span > < span class = "nx" > < a href = "/docs/reference/pkg/nodejs/pulumi/pulumi/#CustomResourceOptions" > CustomResourceOptions< / a > < / span > < span class = "p" > );< / span > < / code > < / pre > < / div >
< / div > < / pulumi-choosable >
2023-11-19 13:47:45 +00:00
< / div >
< div >
< pulumi-choosable type = "language" values = "python" >
2024-04-02 15:47:32 +00:00
< div class = "no-copy" > < div class = "highlight" > < pre class = "chroma" > < code class = "language-python" data-lang = "python" > < span class = nd > @overload< / span >
2023-11-19 13:47:45 +00:00
< span class = "k" > def < / span > < span class = "nx" > Provider< / span > < span class = "p" > (< / span > < span class = "nx" > resource_name< / span > < span class = "p" > :< / span > < span class = "nx" > str< / span > < span class = "p" > ,< / span >
2024-04-02 15:47:32 +00:00
< span class = "nx" > args< / span > < span class = "p" > :< / span > < span class = "nx" > < a href = "#inputs" > Optional[ProviderArgs]< / a > < / span > = None< span class = "p" > ,< / span >
2023-11-19 13:47:45 +00:00
< span class = "nx" > opts< / span > < span class = "p" > :< / span > < span class = "nx" > < a href = "/docs/reference/pkg/python/pulumi/#pulumi.ResourceOptions" > Optional[ResourceOptions]< / a > < / span > = None< span class = "p" > )< / span >
2024-04-02 15:47:32 +00:00
< span > < / span >
2023-11-19 13:47:45 +00:00
< span class = nd > @overload< / span >
< span class = "k" > def < / span > < span class = "nx" > Provider< / span > < span class = "p" > (< / span > < span class = "nx" > resource_name< / span > < span class = "p" > :< / span > < span class = "nx" > str< / span > < span class = "p" > ,< / span >
< span class = "nx" > opts< / span > < span class = "p" > :< / span > < span class = "nx" > < a href = "/docs/reference/pkg/python/pulumi/#pulumi.ResourceOptions" > Optional[ResourceOptions]< / a > < / span > = None< span class = "p" > )< / span > < / code > < / pre > < / div >
2024-04-02 15:47:32 +00:00
< / div > < / pulumi-choosable >
2023-11-19 13:47:45 +00:00
< / div >
< div >
< pulumi-choosable type = "language" values = "go" >
2024-04-02 15:47:32 +00:00
< div class = "no-copy" >< div class = "highlight" >< pre class = "chroma" >< code class = "language-go" data-lang = "go" >< span class = "k" > func </ span >< span class = "nx" > NewProvider</ span >< span class = "p" > (</ span >< span class = "nx" > ctx</ span >< span class = "p" > *</span><span class="nx"><a href="https://pkg.go.dev/github.com/pulumi/pulumi/sdk/v3/go/pulumi?tab=doc#Context">Context</a></span><span class="p">,</span> <span class="nx">name</span><span class="p"> </span><span class="nx">string</span><span class="p">,</span> <span class="nx">args</span><span class="p"> * </ span >< span class = "nx" >< a href = "#inputs" > ProviderArgs</ a ></ span >< span class = "p" > ,</ span > < span class = "nx" > opts</ span >< span class = "p" > ...</ span >< span class = "nx" >< a href = "https://pkg.go.dev/github.com/pulumi/pulumi/sdk/v3/go/pulumi?tab=doc#ResourceOption" > ResourceOption</ a ></ span >< span class = "p" > ) (*< span class = "nx" > Provider</ span > , error)</ span ></ code ></ pre ></ div >
< / div > < / pulumi-choosable >
2023-11-19 13:47:45 +00:00
< / div >
< div >
< pulumi-choosable type = "language" values = "csharp" >
2024-04-02 15:47:32 +00:00
< div class = "no-copy" > < div class = "highlight" > < pre class = "chroma" > < code class = "language-csharp" data-lang = "csharp" > < span class = "k" > public < / span > < span class = "nx" > Provider< / span > < span class = "p" > (< / span > < span class = "nx" > string< / span > < span class = "p" > < / span > < span class = "nx" > name< span class = "p" > ,< / span > < span class = "nx" > < a href = "#inputs" > ProviderArgs< / a > < / span > < span class = "p" > ? < / span > < span class = "nx" > args = null< span class = "p" > ,< / span > < span class = "nx" > < a href = "/docs/reference/pkg/dotnet/Pulumi/Pulumi.CustomResourceOptions.html" > CustomResourceOptions< / a > < / span > < span class = "p" > ? < / span > < span class = "nx" > opts = null< span class = "p" > )< / span > < / code > < / pre > < / div >
< / div > < / pulumi-choosable >
2023-11-19 13:47:45 +00:00
< / div >
< div >
< pulumi-choosable type = "language" values = "java" >
2024-04-02 15:47:32 +00:00
< div class = "no-copy" > < div class = "highlight" > < pre class = "chroma" >
2023-11-19 13:47:45 +00:00
< code class = "language-java" data-lang = "java" > < span class = "k" > public < / span > < span class = "nx" > Provider< / span > < span class = "p" > (< / span > < span class = "nx" > String< / span > < span class = "p" > < / span > < span class = "nx" > name< span class = "p" > ,< / span > < span class = "nx" > < a href = "#inputs" > ProviderArgs< / a > < / span > < span class = "p" > < / span > < span class = "nx" > args< span class = "p" > )< / span >
< span class = "k" > public < / span > < span class = "nx" > Provider< / span > < span class = "p" > (< / span > < span class = "nx" > String< / span > < span class = "p" > < / span > < span class = "nx" > name< span class = "p" > ,< / span > < span class = "nx" > < a href = "#inputs" > ProviderArgs< / a > < / span > < span class = "p" > < / span > < span class = "nx" > args< span class = "p" > ,< / span > < span class = "nx" > CustomResourceOptions< / span > < span class = "p" > < / span > < span class = "nx" > options< span class = "p" > )< / span >
2024-04-02 15:47:32 +00:00
< / code > < / pre > < / div > < / div >
2023-11-19 13:47:45 +00:00
< / pulumi-choosable >
< / div >
< div >
< pulumi-choosable type = "language" values = "yaml" >
2024-04-02 15:47:32 +00:00
< div class = "no-copy" > < div class = "highlight" > < pre class = "chroma" > < code class = "language-yaml" data-lang = "yaml" > type: < span class = "nx" > pulumi:providers:example< / span > < span class = "p" > < / span >
2023-11-19 13:47:45 +00:00
< span class = "p" > properties< / span > < span class = "p" > : < / span > < span class = "c" > # The arguments to resource properties.< / span >
< span class = "p" > < / span > < span class = "p" > options< / span > < span class = "p" > : < / span > < span class = "c" > # Bag of options to control resource' s behavior.< / span >
< span class = "p" > < / span >
2024-04-02 15:47:32 +00:00
< / code > < / pre > < / div > < / div >
2023-11-19 13:47:45 +00:00
< / pulumi-choosable >
< / div >
2024-04-02 15:47:32 +00:00
#### Parameters
2023-11-19 13:47:45 +00:00
< div >
< pulumi-choosable type = "language" values = "javascript,typescript" >
< dl class = "resources-properties" > < dt
class="property-required" title="Required">
< span > name< / span >
< span class = "property-indicator" > < / span >
< span class = "property-type" > string< / span >
< / dt >
< dd > The unique name of the resource.< / dd > < dt
class="property-optional" title="Optional">
< span > args< / span >
< span class = "property-indicator" > < / span >
< span class = "property-type" > < a href = "#inputs" > ProviderArgs< / a > < / span >
< / dt >
< dd > The arguments to resource properties.< / dd > < dt
class="property-optional" title="Optional">
< span > opts< / span >
< span class = "property-indicator" > < / span >
< span class = "property-type" > < a href = "/docs/reference/pkg/nodejs/pulumi/pulumi/#CustomResourceOptions" > CustomResourceOptions< / a > < / span >
< / dt >
< dd > Bag of options to control resource' s behavior.< / dd > < / dl >
< / pulumi-choosable >
< / div >
< div >
< pulumi-choosable type = "language" values = "python" >
< dl class = "resources-properties" > < dt
class="property-required" title="Required">
< span > resource_name< / span >
< span class = "property-indicator" > < / span >
< span class = "property-type" > str< / span >
< / dt >
< dd > The unique name of the resource.< / dd > < dt
class="property-optional" title="Optional">
< span > args< / span >
< span class = "property-indicator" > < / span >
< span class = "property-type" > < a href = "#inputs" > ProviderArgs< / a > < / span >
< / dt >
< dd > The arguments to resource properties.< / dd > < dt
class="property-optional" title="Optional">
< span > opts< / span >
< span class = "property-indicator" > < / span >
< span class = "property-type" > < a href = "/docs/reference/pkg/python/pulumi/#pulumi.ResourceOptions" > ResourceOptions< / a > < / span >
< / dt >
< dd > Bag of options to control resource' s behavior.< / dd > < / dl >
< / pulumi-choosable >
< / div >
< div >
< pulumi-choosable type = "language" values = "go" >
< dl class = "resources-properties" > < dt
class="property-optional" title="Optional">
< span > ctx< / span >
< span class = "property-indicator" > < / span >
< span class = "property-type" > < a href = "https://pkg.go.dev/github.com/pulumi/pulumi/sdk/v3/go/pulumi?tab=doc#Context" > Context< / a > < / span >
< / dt >
< dd > Context object for the current deployment.< / dd > < dt
class="property-required" title="Required">
< span > name< / span >
< span class = "property-indicator" > < / span >
< span class = "property-type" > string< / span >
< / dt >
< dd > The unique name of the resource.< / dd > < dt
class="property-optional" title="Optional">
< span > args< / span >
< span class = "property-indicator" > < / span >
< span class = "property-type" > < a href = "#inputs" > ProviderArgs< / a > < / span >
< / dt >
< dd > The arguments to resource properties.< / dd > < dt
class="property-optional" title="Optional">
< span > opts< / span >
< span class = "property-indicator" > < / span >
< span class = "property-type" > < a href = "https://pkg.go.dev/github.com/pulumi/pulumi/sdk/v3/go/pulumi?tab=doc#ResourceOption" > ResourceOption< / a > < / span >
< / dt >
< dd > Bag of options to control resource' s behavior.< / dd > < / dl >
< / pulumi-choosable >
< / div >
< div >
< pulumi-choosable type = "language" values = "csharp" >
< dl class = "resources-properties" > < dt
class="property-required" title="Required">
< span > name< / span >
< span class = "property-indicator" > < / span >
< span class = "property-type" > string< / span >
< / dt >
< dd > The unique name of the resource.< / dd > < dt
class="property-optional" title="Optional">
< span > args< / span >
< span class = "property-indicator" > < / span >
< span class = "property-type" > < a href = "#inputs" > ProviderArgs< / a > < / span >
< / dt >
< dd > The arguments to resource properties.< / dd > < dt
class="property-optional" title="Optional">
< span > opts< / span >
< span class = "property-indicator" > < / span >
< span class = "property-type" > < a href = "/docs/reference/pkg/dotnet/Pulumi/Pulumi.CustomResourceOptions.html" > CustomResourceOptions< / a > < / span >
< / dt >
< dd > Bag of options to control resource' s behavior.< / dd > < / dl >
< / pulumi-choosable >
< / div >
< div >
< pulumi-choosable type = "language" values = "java" >
< dl class = "resources-properties" > < dt
class="property-required" title="Required">
< span > name< / span >
< span class = "property-indicator" > < / span >
< span class = "property-type" > String< / span >
< / dt >
< dd > The unique name of the resource.< / dd > < dt
class="property-required" title="Required">
< span > args< / span >
< span class = "property-indicator" > < / span >
< span class = "property-type" > < a href = "#inputs" > ProviderArgs< / a > < / span >
< / dt >
< dd > The arguments to resource properties.< / dd > < dt
class="property-optional" title="Optional">
< span > options< / span >
< span class = "property-indicator" > < / span >
< span class = "property-type" > CustomResourceOptions< / span >
< / dt >
< dd > Bag of options to control resource' s behavior.< / dd > < / dl >
< / pulumi-choosable >
< / div >
2024-04-02 15:47:32 +00:00
2023-11-19 13:47:45 +00:00
## Provider Resource Properties {#properties}
To learn more about resource properties and how to use them, see [Inputs and Outputs ](/docs/intro/concepts/inputs-outputs ) in the Architecture and Concepts docs.
### Inputs
2024-07-31 08:46:04 +00:00
< pulumi-choosable type = "language" values = "python" >
< p >
In Python, inputs that are objects can be passed either as < a href = "/docs/languages-sdks/python/#inputs-and-outputs" > argument classes or as dictionary literals< / a > .
< / p >
< / pulumi-choosable >
2023-11-19 13:47:45 +00:00
The Provider resource accepts the following [input ](/docs/intro/concepts/inputs-outputs ) properties:
< div >
< pulumi-choosable type = "language" values = "csharp" >
< dl class = "resources-properties" > < / dl >
< / pulumi-choosable >
< / div >
< div >
< pulumi-choosable type = "language" values = "go" >
< dl class = "resources-properties" > < / dl >
< / pulumi-choosable >
< / div >
< div >
< pulumi-choosable type = "language" values = "java" >
< dl class = "resources-properties" > < / dl >
< / pulumi-choosable >
< / div >
< div >
< pulumi-choosable type = "language" values = "javascript,typescript" >
< dl class = "resources-properties" > < / dl >
< / pulumi-choosable >
< / div >
< div >
< pulumi-choosable type = "language" values = "python" >
< dl class = "resources-properties" > < / dl >
< / pulumi-choosable >
< / div >
< div >
< pulumi-choosable type = "language" values = "yaml" >
< dl class = "resources-properties" > < / dl >
< / pulumi-choosable >
< / div >
### Outputs
All [input ](#inputs ) properties are implicitly available as output properties. Additionally, the Provider resource produces the following output properties:
< div >
< pulumi-choosable type = "language" values = "csharp" >
< dl class = "resources-properties" > < dt class = "property-"
title="">
< span id = "id_csharp" >
< a data-swiftype-name = "resource-property" data-swiftype-type = "text" href = "#id_csharp" style = "color: inherit; text-decoration: inherit;" > Id< / a >
< / span >
< span class = "property-indicator" > < / span >
< span class = "property-type" > string< / span >
< / dt >
< dd > The provider-assigned unique ID for this managed resource.< / dd > < / dl >
< / pulumi-choosable >
< / div >
< div >
< pulumi-choosable type = "language" values = "go" >
< dl class = "resources-properties" > < dt class = "property-"
title="">
< span id = "id_go" >
< a data-swiftype-name = "resource-property" data-swiftype-type = "text" href = "#id_go" style = "color: inherit; text-decoration: inherit;" > Id< / a >
< / span >
< span class = "property-indicator" > < / span >
< span class = "property-type" > string< / span >
< / dt >
< dd > The provider-assigned unique ID for this managed resource.< / dd > < / dl >
< / pulumi-choosable >
< / div >
< div >
< pulumi-choosable type = "language" values = "java" >
< dl class = "resources-properties" > < dt class = "property-"
title="">
< span id = "id_java" >
< a data-swiftype-name = "resource-property" data-swiftype-type = "text" href = "#id_java" style = "color: inherit; text-decoration: inherit;" > id< / a >
< / span >
< span class = "property-indicator" > < / span >
< span class = "property-type" > String< / span >
< / dt >
< dd > The provider-assigned unique ID for this managed resource.< / dd > < / dl >
< / pulumi-choosable >
< / div >
< div >
< pulumi-choosable type = "language" values = "javascript,typescript" >
< dl class = "resources-properties" > < dt class = "property-"
title="">
< span id = "id_nodejs" >
< a data-swiftype-name = "resource-property" data-swiftype-type = "text" href = "#id_nodejs" style = "color: inherit; text-decoration: inherit;" > id< / a >
< / span >
< span class = "property-indicator" > < / span >
< span class = "property-type" > string< / span >
< / dt >
< dd > The provider-assigned unique ID for this managed resource.< / dd > < / dl >
< / pulumi-choosable >
< / div >
< div >
< pulumi-choosable type = "language" values = "python" >
< dl class = "resources-properties" > < dt class = "property-"
title="">
< span id = "id_python" >
< a data-swiftype-name = "resource-property" data-swiftype-type = "text" href = "#id_python" style = "color: inherit; text-decoration: inherit;" > id< / a >
< / span >
< span class = "property-indicator" > < / span >
< span class = "property-type" > str< / span >
< / dt >
< dd > The provider-assigned unique ID for this managed resource.< / dd > < / dl >
< / pulumi-choosable >
< / div >
< div >
< pulumi-choosable type = "language" values = "yaml" >
< dl class = "resources-properties" > < dt class = "property-"
title="">
< span id = "id_yaml" >
< a data-swiftype-name = "resource-property" data-swiftype-type = "text" href = "#id_yaml" style = "color: inherit; text-decoration: inherit;" > id< / a >
< / span >
< span class = "property-indicator" > < / span >
< span class = "property-type" > String< / span >
< / dt >
< dd > The provider-assigned unique ID for this managed resource.< / dd > < / dl >
< / pulumi-choosable >
< / div >
< h2 id = "package-details" > Package Details< / h2 >
< dl class = "package-details" >
< dt > Repository< / dt >
< dd > < a href = "" > example < / a > < / dd >
< dt > License< / dt >
< dd > < / dd >
< / dl >