pulumi/_index.md at rebase-node-params

19 KiB

Raw Permalink Blame History

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

Create Overlay Resource

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

Constructor syntax

new Overlay(name: string, args?: OverlayArgs, opts?: CustomResourceOptions);

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

@overload
def Overlay(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            bar: Optional[str] = None)

func NewOverlay(ctx *Context, name string, args *OverlayArgs, opts ...ResourceOption) (*Overlay, error)

public Overlay(string name, OverlayArgs? args = null, CustomResourceOptions? opts = null)

public Overlay(String name, OverlayArgs args)
public Overlay(String name, OverlayArgs args, CustomResourceOptions options)

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

Parameters

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

name string: The unique name of the resource.
args OverlayArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args OverlayArgs: 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 overlayResource = new Example.Overlay("overlayResource", new()
{
    Bar = "string",
});

example, err := example.NewOverlay(ctx, "overlayResource", &example.OverlayArgs{
	Bar: pulumi.String("string"),
})

var overlayResource = new Overlay("overlayResource", OverlayArgs.builder()
    .bar("string")
    .build());

overlay_resource = example.Overlay("overlayResource", bar="string")

const overlayResource = new example.Overlay("overlayResource", {bar: "string"});

type: example:Overlay
properties:
    bar: string

Overlay Resource 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 Overlay resource accepts the following input properties:

Bar string

Bar string

bar String

bar string

bar str

bar String

Outputs

All input properties are implicitly available as output properties. Additionally, the Overlay 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 str: The provider-assigned unique ID for this managed resource.

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

Package Details

Repository: example
License

19 KiB Raw Permalink Blame History