PropertyDefinition

besom.codegen.metaschema.PropertyDefinition
See thePropertyDefinition companion object

Describes an object or resource property

Value parameters

const

The constant value for the property, if any. The type of the value must be assignable to the type of the property.

default

The default value for the property, if any. The type of the value must be assignable to the type of the property.

defaultInfo

"Additional information about the property's default value, if any."

deprecationMessage

Indicates whether the property is deprecated

description

The description of the property, if any. Interpreted as Markdown.

replaceOnChanges

Specifies whether a change to the property causes its containing resource to be replaced instead of updated (default false).

secret

Specifies whether the property is secret (default false).

typeReference

A reference to a type that describes the property's type

willReplaceOnChanges

Indicates that the provider will replace the resource when this property is changed.

Attributes

See also
Companion
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Members list

Value members

Inherited methods

Attributes

Inherited from:
Product

Attributes

Inherited from:
Product