Skip to main content
  1. Docs
  2. Reference
  3. REST API Docs
  4. Schema
  5. RegistryDocsSupportingType

RegistryDocsSupportingType

    A supporting type (object or enum) referenced by properties. Inlined, not referenced by index.

    Properties

    • typeToken string required
      Pulumi type token of this type.
    • name map[string]string required
      Display name keyed by language.
    • kind string required
      ‘object’ or ’enum’.
    • properties array[RegistryDocsProperty] optional
      Properties (when kind is ‘object’).
    • 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.
    • values array[RegistryDocsEnumValue] optional
      Enum values (when kind is ’enum’).
    • name map[string]string required
      Enum value name keyed by language.
    • value string required
      Wire value of this enum variant.
    • description map[string]string optional
      Description keyed by language.