Environment Definition Reference

This is a reference for the various constructs defined by ESC.

Reference summary

The ESC Environment reference is divided into the following sections:

• Top-level keys: These are the different top-level document keys defined by the ESC language. Each key has its own well-defined semantics. For more information, see the top-level key reference.
• Interpolations and references: Interpolations and references are additional syntactical constructs ESC layers on top of YAML to enable users to reuse property values. For more information, see the interpolation and references syntax reference.
• Built-in functions: These are the different built-in functions defined by the ESC language. These functions allow you to perform common tasks such as encoding and decoding values and manipulating strings. For more information, see the built-in functions reference.
• Built-in properties: These are the different predefined properties available to interpolations and references. For more information, see the built-in values reference.
• Providers: These are the different providers that allow dynamic access to credentials, configuration, and secrets stored outside of ESC. Each provider has its own set of inputs that affect its behavior. For more information, see the providers reference.
• Rotators: These are the different rotators that allow ESC to rotate credentials, configuration, and secrets stored outside of ESC. Each rotator has its own set of inputs that affect its behavior. For more information, see the rotators reference.
• Reserved properties: These are the different environment properties that are interpreted by the esc CLI and other ESC consumers (e.g. the pulumi CLI). The semantics of these properties are defined by conventions amongst consumers of ESC environments. For more information, see the reserved property reference.
• Sample environment definition: This is a sample environment definition that demonstrates many of the constructs described in the other reference sections. For more information, see the sample environment definition reference.

Each ESC environment is a YAML document that defines the structure and values produced when the environment is evaluated (also referred to as opened). For more information see the high-level Environments documentation.