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

A code example extracted from a resource or function description.

Properties

• id string required
  Stable identifier within the package version. Format: ‘#’, where slug is the kebab-case title (e.g. ‘aws:ec2/instance:Instance#account-analyzer’), falling back to ’example-’ when there is no heading. Duplicates within the same type token are suffixed ‘-2’, ‘-3’, etc.
• title string required
  Title derived from the surrounding heading or caption. Capped at 120 chars. Empty when none was available; rely on ‘id’ for addressability.
• code string required
  Example source code in the resolved language.
• typeToken string required
  Pulumi type token this example belongs to.
• kind string required
  Whether ’typeToken’ is a ‘resource’ or ‘function’.