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

ContextSchema describes the shape of the Pulumi ESC built-in context object available for interpolation in environments.

Properties

• schema EscSchemaSchema required
  The schema of the built-in context object. Every field is a string.
• ↳ always boolean optional
  Set when the schema is ’true'.
• ↳ never boolean optional
  Set when the schema is ‘false’.
• ↳ $defs map[string]EscSchemaSchema optional
  Schema definitions that can be referenced by $ref.
• ↳ $ref string optional
  A JSON reference to a schema definition.
• ↳ anyOf array[EscSchemaSchema] optional
  A list of schemas, any of which the value must match.
• ↳ oneOf array[EscSchemaSchema] optional
  A list of schemas, exactly one of which the value must match.
• ↳ prefixItems array[EscSchemaSchema] optional
  Schemas for the leading items in an array.
• ↳ items EscSchemaSchema optional
  The schema for array items.
• ↳ additionalProperties EscSchemaSchema optional
  The schema for additional object properties.
• ↳ properties map[string]EscSchemaSchema optional
  Schemas for named object properties.
• ↳ type string optional
  The type of the schema (e.g. string, number, object, array, boolean).
• ↳ const object optional
  A constant value the instance must equal.
• ↳ enum array[object] optional
  A list of allowed values.
• ↳ multipleOf string optional
  The value must be a multiple of this number.
• ↳ maximum string optional
  The maximum allowed value (inclusive).
• ↳ exclusiveMaximum string optional
  The maximum allowed value (exclusive).
• ↳ minimum string optional
  The minimum allowed value (inclusive).
• ↳ exclusiveMinimum string optional
  The minimum allowed value (exclusive).
• ↳ maxLength string optional
  The maximum allowed string length.
• ↳ minLength string optional
  The minimum allowed string length.
• ↳ pattern string optional
  A regular expression pattern the string must match.
• ↳ maxItems string optional
  The maximum number of items in an array.
• ↳ minItems string optional
  The minimum number of items in an array.
• ↳ uniqueItems boolean optional
  Whether array items must be unique.
• ↳ maxProperties string optional
  The maximum number of properties in an object.
• ↳ minProperties string optional
  The minimum number of properties in an object.
• ↳ required array[string] optional
  The list of required property names.
• ↳ dependentRequired map[string]array optional
  A map of property names to lists of properties they depend on.
• ↳ title string optional
  A short human-readable label for the schema (JSON Schema annotation).
• ↳ description string optional
  A human-readable explanation of the schema’s purpose (JSON Schema annotation).
• ↳ default object optional
  The default value for the schema.
• ↳ deprecated boolean optional
  Whether the schema is deprecated.
• ↳ examples array[object] optional
  Example values for the schema.
• ↳ secret boolean optional
  Pulumi ESC extension: if true, the value should be treated as sensitive and masked in output.
• ↳ rotateOnly array[string] optional
  Pulumi ESC extension: property paths within this schema that support rotation-only updates.