---
title: "OverlayResource"
title_tag: "example.OverlayResource"
meta_desc: "Documentation for the example.OverlayResource resource with examples, input properties, output properties, lookup functions, and supporting types."
layout: api
no_edit_this_page: true
---
## Create a OverlayResource Resource {#create}
{{< chooser language "typescript,python,go,csharp" / >}}
{{% choosable language nodejs %}}
{{% /choosable %}}
{{% choosable language python %}}
{{% /choosable %}}
{{% choosable language go %}}
{{% /choosable %}}
{{% choosable language csharp %}}
{{% /choosable %}}
{{% choosable language nodejs %}}
-
name
string
- The unique name of the resource.
-
args
OverlayResourceArgs
- 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
OverlayResourceArgs
- 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
OverlayResourceArgs
- 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
OverlayResourceArgs
- The arguments to resource properties.
-
opts
CustomResourceOptions
- Bag of options to control resource's behavior.
{{% /choosable %}}
## OverlayResource Resource Properties {#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 OverlayResource resource accepts the following [input]({{< relref "/docs/intro/concepts/inputs-outputs" >}}) properties:
{{% choosable language csharp %}}
-
Bar
Pulumi.Example.EnumOverlay
- {{% md %}}{{% /md %}}
-
Foo
ConfigMapOverlayArgs
- {{% md %}}{{% /md %}}
{{% /choosable %}}
{{% choosable language go %}}
-
Bar
EnumOverlay
- {{% md %}}{{% /md %}}
-
Foo
ConfigMapOverlayArgs
- {{% md %}}{{% /md %}}
{{% /choosable %}}
{{% choosable language nodejs %}}
-
bar
EnumOverlay
- {{% md %}}{{% /md %}}
-
foo
ConfigMapOverlayArgs
- {{% md %}}{{% /md %}}
{{% /choosable %}}
{{% choosable language python %}}
-
bar
EnumOverlay
- {{% md %}}{{% /md %}}
-
foo
ConfigMapOverlayArgs
- {{% md %}}{{% /md %}}
{{% /choosable %}}
### Outputs
All [input](#inputs) properties are implicitly available as output properties. Additionally, the OverlayResource 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
ConfigMapOverlay
{{% choosable language csharp %}}
-
Config
string
- {{% md %}}{{% /md %}}
{{% /choosable %}}
{{% choosable language go %}}
-
Config
string
- {{% md %}}{{% /md %}}
{{% /choosable %}}
{{% choosable language nodejs %}}
-
config
string
- {{% md %}}{{% /md %}}
{{% /choosable %}}
{{% choosable language python %}}
-
config
str
- {{% md %}}{{% /md %}}
{{% /choosable %}}
EnumOverlay
{{% choosable language csharp %}}
- SomeEnumValue
- SOME_ENUM_VALUE
{{% /choosable %}}
{{% choosable language go %}}
- EnumOverlaySomeEnumValue
- SOME_ENUM_VALUE
{{% /choosable %}}
{{% choosable language nodejs %}}
- SomeEnumValue
- SOME_ENUM_VALUE
{{% /choosable %}}
{{% choosable language python %}}
- SOME_ENUM_VALUE
- SOME_ENUM_VALUE
{{% /choosable %}}
Package Details
- Repository
- License