pulumi/tests/testdata/codegen/replace-on-change/docs/dog/_index.md

19 KiB


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

Create Dog Resource

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

Constructor syntax

new Dog(name: string, args?: DogArgs, opts?: CustomResourceOptions);
@overload
def Dog(resource_name: str,
        args: Optional[DogArgs] = None,
        opts: Optional[ResourceOptions] = None)

@overload
def Dog(resource_name: str,
        opts: Optional[ResourceOptions] = None)
func NewDog(ctx *Context, name string, args *DogArgs, opts ...ResourceOption) (*Dog, error)
public Dog(string name, DogArgs? args = null, CustomResourceOptions? opts = null)
public Dog(String name, DogArgs args)
public Dog(String name, DogArgs args, CustomResourceOptions options)
type: example:Dog
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 DogArgs
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 DogArgs
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 DogArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args DogArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args DogArgs
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 dogResource = new Example.Dog("dogResource");
example, err := example.NewDog(ctx, "dogResource", nil)
var dogResource = new Dog("dogResource");
dog_resource = example.Dog("dogResource")
const dogResource = new example.Dog("dogResource", {});
type: example:Dog
properties: {}

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

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Bone string
Id string
The provider-assigned unique ID for this managed resource.
Bone string
id String
The provider-assigned unique ID for this managed resource.
bone String
id string
The provider-assigned unique ID for this managed resource.
bone string
id str
The provider-assigned unique ID for this managed resource.
bone str
id String
The provider-assigned unique ID for this managed resource.
bone String

Package Details

Repository
example
License