Index — Pulumi Registry

Create OverlayResource Resource {#create}#

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax#

new OverlayResource(name: string, args?: OverlayResourceArgs, opts?: CustomResourceOptions);

@overload
def OverlayResource(resource_name: str,
                    args: Optional[OverlayResourceArgs] = None,
                    opts: Optional[ResourceOptions] = None)

@overload
def OverlayResource(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    bar: Optional[EnumOverlay] = None,
                    foo: Optional[ConfigMapOverlayArgs] = None)

func NewOverlayResource(ctx *Context, name string, args *OverlayResourceArgs, opts ...ResourceOption) (*OverlayResource, error)

public OverlayResource(string name, OverlayResourceArgs? args = null, CustomResourceOptions? opts = null)

public OverlayResource(String name, OverlayResourceArgs args)
public OverlayResource(String name, OverlayResourceArgs args, CustomResourceOptions options)

type: example:OverlayResource
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

resource "example_overlay_resource" "name" {
    # resource properties
}

Parameters#

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.

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.

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.

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.

name String: The unique name of the resource.
args OverlayResourceArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example#

The following reference example uses placeholder values for all input properties.

var overlayResourceResource = new Example.OverlayResource("overlayResourceResource", new()
{
    Bar = Example.EnumOverlay.SomeEnumValue,
    Foo = new Example.Inputs.ConfigMapOverlayArgs
    {
        Config = "string",
    },
});

example, err := example.NewOverlayResource(ctx, "overlayResourceResource", &example.OverlayResourceArgs{
	Bar: example.EnumOverlaySomeEnumValue,
	Foo: &example.ConfigMapOverlayArgs{
		Config: pulumi.String("string"),
	},
})

resource "example_overlay_resource" "overlayResourceResource" {
  lifecycle {
    create_before_destroy = true
  }
  bar = "SOME_ENUM_VALUE"
  foo = {
    config = "string"
  }
}

var overlayResourceResource = new OverlayResource("overlayResourceResource", OverlayResourceArgs.builder()
    .bar("SOME_ENUM_VALUE")
    .foo(ConfigMapOverlayArgs.builder()
        .config("string")
        .build())
    .build());

overlay_resource_resource = example.OverlayResource("overlayResourceResource",
    bar=example.EnumOverlay.SOME_ENUM_VALUE,
    foo={
        "config": "string",
    })

const overlayResourceResource = new example.OverlayResource("overlayResourceResource", {
    bar: example.EnumOverlay.SomeEnumValue,
    foo: {
        config: "string",
    },
});

type: example:OverlayResource
properties:
    bar: SOME_ENUM_VALUE
    foo:
        config: string

OverlayResource Resource Properties {#properties}#

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs#

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The OverlayResource resource accepts the following input properties:

Bar Pulumi.Example.EnumOverlay
Foo ConfigMapOverlay

Bar EnumOverlay
Foo ConfigMapOverlayArgs

bar "SOME_ENUM_VALUE"
foo object

bar EnumOverlay
foo ConfigMapOverlay

bar EnumOverlay
foo ConfigMapOverlay

bar EnumOverlay
foo ConfigMapOverlayArgs

bar "SOME_ENUM_VALUE"
foo Property Map

Outputs#

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

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Supporting Types#

ConfigMapOverlay, ConfigMapOverlayArgs

Config string

Config string

config string

config String

config string

config str

config String

EnumOverlay, EnumOverlayArgs

SomeEnumValue: SOME_ENUM_VALUE

EnumOverlaySomeEnumValue: SOME_ENUM_VALUE

"SOME_ENUM_VALUE": SOME_ENUM_VALUE

SomeEnumValue: SOME_ENUM_VALUE

SomeEnumValue: SOME_ENUM_VALUE

SOME_ENUM_VALUE: SOME_ENUM_VALUE

"SOME_ENUM_VALUE": SOME_ENUM_VALUE

Package Details

Repository: example
License