pulumi/_index.md at master

35 KiB

Raw Permalink Blame History

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

Create Cat Resource

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

Constructor syntax

new Cat(name: string, args?: CatArgs, opts?: CustomResourceOptions);

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

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

func NewCat(ctx *Context, name string, args *CatArgs, opts ...ResourceOption) (*Cat, error)

public Cat(string name, CatArgs? args = null, CustomResourceOptions? opts = null)

public Cat(String name, CatArgs args)
public Cat(String name, CatArgs args, CustomResourceOptions options)

type: example:Cat
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 CatArgs: 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 CatArgs: 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 CatArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

name String: The unique name of the resource.
args CatArgs: 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 catResource = new Example.Cat("catResource");

example, err := example.NewCat(ctx, "catResource", nil)

var catResource = new Cat("catResource");

cat_resource = example.Cat("catResource")

const catResource = new example.Cat("catResource", {});

type: example:Cat
properties: {}

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

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.
Foes Dictionary<string, Toy>
Friends List<Toy>
Name string
Other Pulumi.Example.God
Toy Toy

Id string: The provider-assigned unique ID for this managed resource.
Foes map[string]Toy
Friends []Toy
Name string
Other God
Toy Toy

id String: The provider-assigned unique ID for this managed resource.
foes Map<String,Toy>
friends List<Toy>
name String
other God
toy Toy

id string: The provider-assigned unique ID for this managed resource.
foes {[key: string]: Toy}
friends Toy[]
name string
other God
toy Toy

id str: The provider-assigned unique ID for this managed resource.
foes Mapping[str, Toy]
friends Sequence[Toy]
name str
other God
toy Toy

id String: The provider-assigned unique ID for this managed resource.
foes Map<Property Map>
friends List<Property Map>
name String
other example:God
toy Property Map

Supporting Types

Toy, ToyArgs

Associated Toy
Color string
Wear double

Associated Toy
Color string
Wear float64

associated Toy
color String
wear Double

associated Toy
color string
wear number

associated Toy
color str
wear float

associated Property Map
color String
wear Number

Package Details

Repository: example
License

35 KiB Raw Permalink Blame History