pulumi/tests/testdata/codegen/simple-resource-schema/docs/barresource/_index.md

17 KiB


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

Create BarResource Resource

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

Constructor syntax

new BarResource(name: string, args?: BarResourceArgs, opts?: ComponentResourceOptions);
@overload
def BarResource(resource_name: str,
                args: Optional[BarResourceArgs] = None,
                opts: Optional[ResourceOptions] = None)

@overload
def BarResource(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                foo: Optional[Resource] = None)
func NewBarResource(ctx *Context, name string, args *BarResourceArgs, opts ...ResourceOption) (*BarResource, error)
public BarResource(string name, BarResourceArgs? args = null, ComponentResourceOptions? opts = null)
public BarResource(String name, BarResourceArgs args)
public BarResource(String name, BarResourceArgs args, ComponentResourceOptions options)
type: bar:BarResource
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 BarResourceArgs
The arguments to resource properties.
opts ComponentResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args BarResourceArgs
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 BarResourceArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args BarResourceArgs
The arguments to resource properties.
opts ComponentResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args BarResourceArgs
The arguments to resource properties.
options ComponentResourceOptions
Bag of options to control resource's behavior.

Constructor example

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

var barResourceResource = new Bar.BarResource("barResourceResource", new()
{
    Foo = resource,
});
example, err := bar.NewBarResource(ctx, "barResourceResource", &bar.BarResourceArgs{
	Foo: resource,
})
var barResourceResource = new BarResource("barResourceResource", BarResourceArgs.builder()
    .foo(resource)
    .build());
bar_resource_resource = bar.BarResource("barResourceResource", foo=resource)
const barResourceResource = new bar.BarResource("barResourceResource", {foo: resource});
type: bar:BarResource
properties:
    foo: ${resource}

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

Foo Pulumi.Example.Resource
Foo Resource
foo Resource
foo Resource
foo Resource
foo example:Resource

Outputs

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

Package Details

Repository
example
License