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

Template

    Template describes a Pulumi project template.

    Properties

    • name string required
      The unique identifier name of the template.
    • publisher string required
      The organization or user that published the template.
    • source string required
      The source identifier indicating where the template originates from.
    • displayName string required
      The human-readable display name shown in the UI.
    • description string optional
      A free-form text description of the template’s purpose.
    • runtime TemplateRuntimeInfo optional
      The runtime that the template uses with optional configuration.
    • ↳ name string optional
      The runtime language or platform, e.g. ’nodejs’, ‘python’, ‘go’, ‘dotnet’, ‘java’, ‘yaml’.
    • ↳ options map[string]object optional
      Optional configuration options for the runtime.
    • language enum required
      The language that the template is in, inferred from the runtime. This may differ from the runtime (e.g., dotnet runtime with C# language, nodejs runtime with TypeScript language) or be the same (e.g., python).
      Values: unknown, python, go, dotnet, java, javascript, typescript, yaml
    • readmeURL string optional
      ReadmeURL is just a pre-signed URL, derived from the artifact key.
    • downloadURL string required

      An URL, valid for at least 5 minutes that you can retrieve the full download bundle for your template.

      The bundle will be a .tar.gz.

    • repoSlug string optional
      A link to the hosting repository. Non-VCS backed templates do not have a repo slug as of now.
    • visibility enum required
      The visibility of the template (public or private).
      Values: public, private
    • updatedAt string required
      The timestamp when the template was last updated.
    • metadata map[string]string optional
      Key-value metadata associated with the template.
    • config map[string]AppProjectTemplateConfigValue optional
      Configuration values for the template.
    • url string required
      For registry-backed templates, the URL will be a registry:// URL. For VCS-backed templates, this will be the VCS URL (e.g., GitHub, GitLab).