pulumi/pkg/codegen/internal/test/testdata/simple-enum-schema/docs/tree/v1/rubbertree/_index.md
2021-11-08 15:43:36 -08:00

40 KiB


title: "RubberTree" title_tag: "plant.tree/v1.RubberTree" meta_desc: "Documentation for the plant.tree/v1.RubberTree resource with examples, input properties, output properties, lookup functions, and supporting types." layout: api no_edit_this_page: true

Create a RubberTree Resource

{{< chooser language "typescript,python,go,csharp" / >}}

{{% choosable language nodejs %}}

new RubberTree(name: string, args: RubberTreeArgs, opts?: CustomResourceOptions);
{{% /choosable %}}

{{% choosable language python %}}

@overload
def RubberTree(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               container: Optional[_root_inputs.ContainerArgs] = None,
               diameter: Optional[Diameter] = None,
               farm: Optional[Union[Farm, str]] = None,
               size: Optional[TreeSize] = None,
               type: Optional[RubberTreeVariety] = None)
@overload
def RubberTree(resource_name: str,
               args: RubberTreeArgs,
               opts: Optional[ResourceOptions] = None)
{{% /choosable %}}

{{% choosable language go %}}

func NewRubberTree(ctx *Context, name string, args RubberTreeArgs, opts ...ResourceOption) (*RubberTree, error)
{{% /choosable %}}

{{% choosable language csharp %}}

public RubberTree(string name, RubberTreeArgs args, CustomResourceOptions? opts = null)
{{% /choosable %}}

{{% choosable language nodejs %}}

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

{{% /choosable %}}

RubberTree Resource 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 RubberTree resource accepts the following [input]({{< relref "/docs/intro/concepts/inputs-outputs" >}}) properties:

{{% choosable language csharp %}}

Type Pulumi.Plant.Tree.V1.RubberTreeVariety
{{% md %}}{{% /md %}}
Container Pulumi.Plant.Inputs.ContainerArgs
{{% md %}}{{% /md %}}
Diameter Pulumi.Plant.Tree.V1.Diameter
{{% md %}}{{% /md %}}
Farm Pulumi.Plant.Tree.V1.Farm | string
{{% md %}}{{% /md %}}
Size Pulumi.Plant.Tree.V1.TreeSize
{{% md %}}{{% /md %}}
{{% /choosable %}}

{{% choosable language go %}}

Type RubberTreeVariety
{{% md %}}{{% /md %}}
Container ContainerArgs
{{% md %}}{{% /md %}}
Diameter Diameter
{{% md %}}{{% /md %}}
Farm Farm | string
{{% md %}}{{% /md %}}
Size TreeSize
{{% md %}}{{% /md %}}
{{% /choosable %}}

{{% choosable language nodejs %}}

type RubberTreeVariety
{{% md %}}{{% /md %}}
container ContainerArgs
{{% md %}}{{% /md %}}
diameter Diameter
{{% md %}}{{% /md %}}
farm Farm | string
{{% md %}}{{% /md %}}
size TreeSize
{{% md %}}{{% /md %}}
{{% /choosable %}}

{{% choosable language python %}}

type RubberTreeVariety
{{% md %}}{{% /md %}}
container ContainerArgs
{{% md %}}{{% /md %}}
diameter Diameter
{{% md %}}{{% /md %}}
farm Farm | str
{{% md %}}{{% /md %}}
size TreeSize
{{% md %}}{{% /md %}}
{{% /choosable %}}

Outputs

All input properties are implicitly available as output properties. Additionally, the RubberTree 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 %}}

Look up an Existing RubberTree Resource

Get an existing RubberTree resource's state with the given name, ID, and optional extra properties used to qualify the lookup. {{< chooser language "typescript,python,go,csharp" / >}}

{{% choosable language nodejs %}}

public static get(name: string, id: Input<ID>, state?: RubberTreeState, opts?: CustomResourceOptions): RubberTree
{{% /choosable %}}

{{% choosable language python %}}

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        farm: Optional[Union[Farm, str]] = None) -> RubberTree
{{% /choosable %}}

{{% choosable language go %}}

func GetRubberTree(ctx *Context, name string, id IDInput, state *RubberTreeState, opts ...ResourceOption) (*RubberTree, error)
{{% /choosable %}}

{{% choosable language csharp %}}

public static RubberTree Get(string name, Input<string> id, RubberTreeState? state, CustomResourceOptions? opts = null)
{{% /choosable %}}

{{% choosable language nodejs %}}

name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.

{{% /choosable %}}

{{% choosable language python %}}

resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
{{% /choosable %}}

{{% choosable language go %}}

name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.

{{% /choosable %}}

{{% choosable language csharp %}}

name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.

{{% /choosable %}}

The following state arguments are supported:

{{% choosable language csharp %}}

Farm Pulumi.Plant.Tree.V1.Farm | string
{{% md %}}{{% /md %}}
{{% /choosable %}}

{{% choosable language go %}}

Farm Farm | string
{{% md %}}{{% /md %}}
{{% /choosable %}}

{{% choosable language nodejs %}}

farm Farm | string
{{% md %}}{{% /md %}}
{{% /choosable %}}

{{% choosable language python %}}

farm Farm | str
{{% md %}}{{% /md %}}
{{% /choosable %}}

Supporting Types

Container

{{% choosable language csharp %}}

Size Pulumi.Plant.ContainerSize
{{% md %}}{{% /md %}}
Brightness Pulumi.Plant.ContainerBrightness
{{% md %}}{{% /md %}}
Color Pulumi.Plant.ContainerColor | string
{{% md %}}{{% /md %}}
Material string
{{% md %}}{{% /md %}}
{{% /choosable %}}

{{% choosable language go %}}

Size ContainerSize
{{% md %}}{{% /md %}}
Brightness ContainerBrightness
{{% md %}}{{% /md %}}
Color ContainerColor | string
{{% md %}}{{% /md %}}
Material string
{{% md %}}{{% /md %}}
{{% /choosable %}}

{{% choosable language nodejs %}}

size ContainerSize
{{% md %}}{{% /md %}}
brightness ContainerBrightness
{{% md %}}{{% /md %}}
color ContainerColor | string
{{% md %}}{{% /md %}}
material string
{{% md %}}{{% /md %}}
{{% /choosable %}}

{{% choosable language python %}}

size ContainerSize
{{% md %}}{{% /md %}}
brightness ContainerBrightness
{{% md %}}{{% /md %}}
color ContainerColor | str
{{% md %}}{{% /md %}}
material str
{{% md %}}{{% /md %}}
{{% /choosable %}}

ContainerBrightness

{{% choosable language csharp %}}

ZeroPointOne
0.1
One
1
{{% /choosable %}}

{{% choosable language go %}}

ContainerBrightnessZeroPointOne
0.1
ContainerBrightnessOne
1
{{% /choosable %}}

{{% choosable language nodejs %}}

ZeroPointOne
0.1
One
1
{{% /choosable %}}

{{% choosable language python %}}

ZERO_POINT_ONE
0.1
ONE
1
{{% /choosable %}}

ContainerColor

{{% choosable language csharp %}}

Red
red
Blue
blue
Yellow
yellow
{{% /choosable %}}

{{% choosable language go %}}

ContainerColorRed
red
ContainerColorBlue
blue
ContainerColorYellow
yellow
{{% /choosable %}}

{{% choosable language nodejs %}}

Red
red
Blue
blue
Yellow
yellow
{{% /choosable %}}

{{% choosable language python %}}

RED
red
BLUE
blue
YELLOW
yellow
{{% /choosable %}}

ContainerSize

{{% choosable language csharp %}}

FourInch
4
SixInch
6
EightInch
8

Deprecated: {{% md %}}Eight inch pots are no longer supported.{{% /md %}}

{{% /choosable %}}

{{% choosable language go %}}

ContainerSizeFourInch
4
ContainerSizeSixInch
6
ContainerSizeEightInch
8

Deprecated: {{% md %}}Eight inch pots are no longer supported.{{% /md %}}

{{% /choosable %}}

{{% choosable language nodejs %}}

FourInch
4
SixInch
6
EightInch
8

Deprecated: {{% md %}}Eight inch pots are no longer supported.{{% /md %}}

{{% /choosable %}}

{{% choosable language python %}}

FOUR_INCH
4
SIX_INCH
6
EIGHT_INCH
8

Deprecated: {{% md %}}Eight inch pots are no longer supported.{{% /md %}}

{{% /choosable %}}

Diameter

{{% choosable language csharp %}}

Sixinch
6
Twelveinch
12
{{% /choosable %}}

{{% choosable language go %}}

DiameterSixinch
6
DiameterTwelveinch
12
{{% /choosable %}}

{{% choosable language nodejs %}}

Sixinch
6
Twelveinch
12
{{% /choosable %}}

{{% choosable language python %}}

SIXINCH
6
TWELVEINCH
12
{{% /choosable %}}

Farm

{{% choosable language csharp %}}

Pulumi_Planters_Inc_
Pulumi Planters Inc.
Plants_R_Us
Plants'R'Us
{{% /choosable %}}

{{% choosable language go %}}

Farm_Pulumi_Planters_Inc_
Pulumi Planters Inc.
Farm_Plants_R_Us
Plants'R'Us
{{% /choosable %}}

{{% choosable language nodejs %}}

Pulumi_Planters_Inc_
Pulumi Planters Inc.
Plants_R_Us
Plants'R'Us
{{% /choosable %}}

{{% choosable language python %}}

PULUMI_PLANTERS_INC_
Pulumi Planters Inc.
PLANTS_R_US
Plants'R'Us
{{% /choosable %}}

RubberTreeVariety

{{% choosable language csharp %}}

Burgundy
Burgundy{{% md %}}A burgundy rubber tree.{{% /md %}}
Ruby
Ruby{{% md %}}A ruby rubber tree.{{% /md %}}
Tineke
Tineke{{% md %}}A tineke rubber tree.{{% /md %}}
{{% /choosable %}}

{{% choosable language go %}}

RubberTreeVarietyBurgundy
Burgundy{{% md %}}A burgundy rubber tree.{{% /md %}}
RubberTreeVarietyRuby
Ruby{{% md %}}A ruby rubber tree.{{% /md %}}
RubberTreeVarietyTineke
Tineke{{% md %}}A tineke rubber tree.{{% /md %}}
{{% /choosable %}}

{{% choosable language nodejs %}}

Burgundy
Burgundy{{% md %}}A burgundy rubber tree.{{% /md %}}
Ruby
Ruby{{% md %}}A ruby rubber tree.{{% /md %}}
Tineke
Tineke{{% md %}}A tineke rubber tree.{{% /md %}}
{{% /choosable %}}

{{% choosable language python %}}

BURGUNDY
Burgundy{{% md %}}A burgundy rubber tree.{{% /md %}}
RUBY
Ruby{{% md %}}A ruby rubber tree.{{% /md %}}
TINEKE
Tineke{{% md %}}A tineke rubber tree.{{% /md %}}
{{% /choosable %}}

TreeSize

{{% choosable language csharp %}}

Small
small
Medium
medium
Large
large
{{% /choosable %}}

{{% choosable language go %}}

TreeSizeSmall
small
TreeSizeMedium
medium
TreeSizeLarge
large
{{% /choosable %}}

{{% choosable language nodejs %}}

Small
small
Medium
medium
Large
large
{{% /choosable %}}

{{% choosable language python %}}

SMALL
small
MEDIUM
medium
LARGE
large
{{% /choosable %}}

Package Details

Repository
License