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

PackageMetadata describes a Pulumi package and its associated metadata in the registry.

Properties

• name string required
  The name of the package.
• publisher string required
  The publisher of the package.
• publisherDisplayName string optional
  The display name of the publisher.
• source string required
  The source of the package.
• version string required
  The version of the package in semver format.
• title string optional
  The title/display name of the package.
• description string optional
  The description of the package.
• logoUrl string optional
  The URL of the logo for the package.
• repoUrl string optional
  The URL of the repository the package is hosted in.
• category string optional
  The category of the package.
• isFeatured boolean required
  Whether the package is featured.
• packageTypes array[string] optional
  The package types, e.g. “native”, “component”, “bridged”
• packageStatus enum required
  The maturity level of the package, e.g. “ga”, “public_preview”
  Values:

  ga — GA

  public_preview — PublicPreview

• readmeURL string required
  The URL of the readme for the package.
• schemaURL string required
  The URL of the schema for the package.
• pluginDownloadURL string optional
  The URL to download the plugin at, as found in the schema.
• createdAt string required
  The date and time the package version was created.
• visibility enum required
  The visibility of the package.
  Values: public, private
• parameterization PackageParameterization optional
  The parameterization of the provider, if any.
• ↳ baseProvider ArtifactVersionNameSpec required
  The base provider that this package is parameterized from.
• ↳ parameter array[string] required
  The opaque parameterization data passed to the base provider, base64-encoded.
• usageStats PackageUsageStats optional
  Usage statistics for this package within the requesting org. Only populated when the caller is authenticated.
• ↳ totalStacks integer optional
  Total number of stacks using this package.
• ↳ onLatest integer optional
  Number of stacks on the latest version of this package.
• ↳ onOlder integer optional
  Number of stacks on an older version of this package.
• ↳ versionUnresolved integer optional
  Number of stacks where the version could not be resolved.
• packageConversion TerraformModulePackageConversion optional
  The package-conversion status, for packages produced by converting a Terraform module. Absent for packages that are not backed by a Terraform module conversion.
• ↳ status string required
  The conversion status: converting, converted, failed, or unsupported. A failed conversion may succeed on a retry; an unsupported one cannot, because the module uses Terraform features the bridge cannot express.
• ↳ failureReason string optional
  A fault code classifying why the conversion produced no package, not prose: unknown, transient, misconfigured, timed_out, missing_provider, unsupported_feature, invalid_version or module_error. Every code other than unknown is a positive classification; unknown means the conversion failed and nothing recognised why, so a retry has no established reason to succeed. Clients render their own wording from it. Present when the status is failed or unsupported.
• ↳ failureDetail string optional
  The conversion bridge’s own description of the module’s problem, safe to show verbatim. Present only when the module itself is at fault.
• ↳ packageVersionId string optional
  The Pulumi package version this conversion produced. Present when the status is converted.