MDAA TS Docs
    Preparing search index...
    interface GlossaryTermProps {
        description?: string;
        readme?: string;
        relatesTo?: string[];
        status?: "DISABLED" | "ENABLED";
    }
    Index

    Properties

    description?: string

    Short, business-facing definition of the term. Maps to the DataZone API's shortDescription field.

    Validation: Optional; string; max 1024 chars

    1024

    readme?: string

    Longer-form Markdown documentation for the term (calculation methodology, data sources, usage guidelines, etc.), shown as the term's README in SageMaker Unified Studio. Maps to the DataZone API's longDescription field.

    Validation: Optional; string; max 4096 chars

    4096

    relatesTo?: string[]

    Other declared terms this term "is a type of" (DataZone's termRelations.isA). Each entry is a bare "<termName>" for a term in this same glossary, or "<glossaryName>.<termName>" for a term in another glossary declared by the same project; a bare entry matching no declared term is passed through as a literal, pre-existing term ID. SageMaker Unified Studio shows the inverse relationship ("Has Types") on the related term automatically.

    This MdaaDatazoneGlossary construct only validates this field (count, self-reference) - it never resolves a reference or creates the DataZone relationship itself. Resolving names and creating the relationship (via a follow-up MdaaDatazoneGlossaryTermRelations, since a related term may belong to a different, independently-constructed glossary) is done by the L3 layer (SagemakerProjectL3Construct); a plain MdaaDatazoneGlossary consumer that sets relatesTo directly gets no relationship in DataZone unless it also builds that wiring itself.

    Validation: Optional; array of string; max 10 entries; no self-reference; rejects cycles across declared terms (enforced by the L3 layer)

    10

    status?: "DISABLED" | "ENABLED"

    Term status. DISABLED terms are retained but not attachable to assets or fields.

    Validation: Optional; 'ENABLED' | 'DISABLED'

    ENABLED