MDAA TS Docs
    Preparing search index...
    interface MdaaDatazoneGlossaryProps {
        createOutputs?: boolean;
        createParams?: boolean;
        description?: string;
        domainIdentifier: string;
        glossaryName: string;
        handlerRole: IRole;
        naming: IMdaaResourceNaming;
        owningProjectIdentifier: string;
        status?: "DISABLED" | "ENABLED";
        terms?: { [termName: string]: GlossaryTermProps };
    }

    Hierarchy (View Summary)

    Index

    Properties

    createOutputs?: boolean

    Flag controlling CloudFormation output and stack export creation for construct resources

    createParams?: boolean

    Flag controlling SSM parameter creation for construct resource references enabling

    description?: string

    Human-readable description of the glossary.

    - no description
    
    domainIdentifier: string

    The DataZone (SMUS) domain ID in which the glossary is created.

    glossaryName: string

    The glossary name, used verbatim as the CreateGlossary name. Must be unique within the domain (enforced by the DataZone API, not by MDAA at synth time).

    handlerRole: IRole

    IAM role used to create the glossary and its terms via the DataZone API. DataZone requires the CreateGlossary caller to be an owner/member of the owning project, which the default CloudFormation execution role is not. This role must be a PROJECT_OWNER of owningProjectIdentifier; the domain custom-resource role (which MDAA already makes a project owner) satisfies this.

    naming: IMdaaResourceNaming

    MDAA naming implementation for consistent resource naming across all MDAA constructs

    owningProjectIdentifier: string

    The DataZone project ID that owns the glossary.

    status?: "DISABLED" | "ENABLED"

    Glossary status. DISABLED glossaries are retained but not attachable.

    ENABLED
    
    terms?: { [termName: string]: GlossaryTermProps }

    Terms to create under this glossary. The map key is the term name.

    - no terms are created