1. Docs
2. Reference
3. REST API Docs
4. Schema
5. RegistryDocsProperty

A property of a resource or function.

Properties

• name map[string]string required
  Property name, keyed by language.
• type map[string]string required
  Display type, keyed by language.
• required boolean required
  Whether the property is required.
• replaceOnChanges boolean required
  Whether changing this property forces replacement.
• deprecated boolean optional
  Whether this property is deprecated.
• description map[string]string required
  Markdown description, keyed by language.
• typeRef RegistryDocsTypeRef optional
  Reference to a local supporting type or a remote type. Null for primitive types.
• ↳ typeToken string required
  The Pulumi type token of the referenced type.
• ↳ package string optional
  The package identifier for remote types (e.g. ‘pulumi/pulumi/aws’). Absent for local types within the same package.
• ↳ version string optional
  The version of the remote package. Absent for local types.