MDAA TS Docs
    Preparing search index...

    Interface SageMakerProjectProps

    interface SageMakerProjectProps {
        dataSources?: { [name: string]: DataSourceProps };
        domainUnit?: string;
        environmentConfigs?: { [name: string]: ProjectEnvironmentConfiguration };
        groups?: { [id: string]: string };
        metadataForms?: { [formName: string]: MetadataFormProps };
        ownerGroups?: { [id: string]: string };
        ownerUsers?: { [id: string]: string };
        profileName: string;
        users?: { [id: string]: string };
    }
    Index

    Properties

    dataSources? domainUnit? environmentConfigs? groups? metadataForms? ownerGroups? ownerUsers? profileName users?

    Properties

    dataSources?: { [name: string]: DataSourceProps }

    Glue data sources to import into the project. Each data source references a Glue database and creates Lake Formation read permissions for the project's environment user.

    Use cases: Importing existing Glue databases into SageMaker projects; Data asset discovery

    AWS: DataZone data sources with Glue run configuration

    Validation: Optional; map of data source name to DataSourceProps

    domainUnit?: string

    Domain unit path where the project will be created (e.g., /some/domain/unit).

    Use cases: Project organizational placement; Governance scope targeting

    AWS: DataZone domain unit for project placement

    Validation: Optional; slash-delimited domain unit path

    environmentConfigs?: { [name: string]: ProjectEnvironmentConfiguration }

    Per-environment configuration overrides for this project's environments.

    Use cases: Project-specific environment customization

    AWS: DataZone project environment configurations

    Validation: Optional; map of environment name to ProjectEnvironmentConfiguration

    groups?: { [id: string]: string }

    MDAA group configuration names that receive PROJECT_CONTRIBUTOR designation with contributor-level access to the project.

    Use cases: Team-based project contribution; Group standard access

    AWS: DataZone project membership with PROJECT_CONTRIBUTOR role

    Validation: Optional; map of ID to group config name; names must exist in module groups config

    metadataForms?: { [formName: string]: MetadataFormProps }

    Metadata form types to create, owned by this project. Each form is defined by a set of fields; MDAA assembles the Smithy model (setting the namespace to the domain ID and the structure name to the form name). Forms are usable across the domain to attach standardized metadata to assets. The map key is used as the form's stable identifier; renaming a key replaces that form type (delete-then-create).

    Use cases: Data governance metadata standards; Asset metadata enforcement; Searchable custom attributes

    AWS: DataZone metadata form types (AWS::DataZone::FormType) owned by the project

    Validation: Optional; map of form name to MetadataFormProps; form name must be a valid Smithy structure name

    ownerGroups?: { [id: string]: string }

    MDAA group configuration names (from the SageMaker module groups section) that receive PROJECT_OWNER designation with full administrative access to the project. These are not DataZone group names or Identity Center group identifiers.

    Use cases: Team-based project ownership; Group admin access

    AWS: DataZone project membership with PROJECT_OWNER role

    Validation: Optional; map of ID to group config name; names must exist in module groups config

    ownerUsers?: { [id: string]: string }

    MDAA user configuration names (from the SageMaker module users section) that receive PROJECT_OWNER designation with full administrative access to the project. These are not DataZone usernames or Identity Center identifiers.

    Use cases: User-based project ownership; Full project admin access

    AWS: DataZone project membership with PROJECT_OWNER role

    Validation: Optional; map of ID to user config name; names must exist in module users config

    profileName: string

    Name of the project profile to use for this project. The profile must target the same account as the project.

    Use cases: Profile-based project creation; Environment template selection

    AWS: DataZone project profile reference

    Validation: Required; string; must match a key in projectProfiles config

    users?: { [id: string]: string }

    MDAA user configuration names that receive PROJECT_CONTRIBUTOR designation with contributor-level access to the project.

    Use cases: User-based project contribution; Standard project access

    AWS: DataZone project membership with PROJECT_CONTRIBUTOR role

    Validation: Optional; map of ID to user config name; names must exist in module users config

    Settings

    Member Visibility

    On This Page

    Properties