MDAA TS Docs
    Preparing search index...

    A project data source: either a Glue database or a raw S3 location, plus optional run/publish behavior. Exactly one of databaseName or s3 is required; this is enforced at synth time (not via the JSON schema, since the mutually-exclusive pair sits alongside other, non-exclusive optional fields here). The inherited DataSourceDefaultsProps fields (and metadataForms) only apply to databaseName entries; setting any of them directly on an s3 entry is a synth-time error, since an AWS::DataZone::Connection has no equivalent properties. Values an s3 entry inherits from the project's dataSourceDefaults are silently not applied instead, since a project-level default is not a misconfiguration of the entry itself.

    interface DataSourceProps {
        autoImportDataQualityResult?: boolean;
        databaseName?: string;
        enableSetting?: "ENABLED" | "DISABLED";
        filterExpressions?: DataSourceFilterExpressionProps[];
        metadataForms?: { [formName: string]: DataSourceMetadataFormProps };
        publishOnImport?: boolean;
        recommendation?: DataSourceRecommendationProps;
        s3?: S3DataSourceProps;
        schedule?: DataSourceScheduleProps;
    }

    Hierarchy (View Summary)

    Index

    Properties

    autoImportDataQualityResult?: boolean

    Whether to automatically import AWS Glue Data Quality results as part of the data source run.

    AWS: AWS::DataZone::DataSource Configuration.GlueRunConfiguration.AutoImportDataQualityResult

    Validation: Optional; boolean

    true
    
    databaseName?: string

    Glue database name to use as the data source. The project's environment user will be granted Lake Formation read permissions on this database and its tables. Mutually exclusive with s3.

    Use cases: Glue database import; Data asset registration

    AWS: Glue database referenced as a DataZone data source

    Validation: Exactly one of databaseName or s3 is required; valid Glue database name

    enableSetting?: "ENABLED" | "DISABLED"

    Whether the data source is enabled to run.

    AWS: AWS::DataZone::DataSource EnableSetting

    Validation: Optional; 'ENABLED' | 'DISABLED'

    ENABLED (DataZone default)
    
    filterExpressions?: DataSourceFilterExpressionProps[]

    Filter expressions limiting which tables in the Glue database are imported. When omitted, every table in the database is imported.

    Use cases: Importing a subset of tables from a large shared database

    AWS: AWS::DataZone::DataSource Configuration.GlueRunConfiguration.RelationalFilterConfigurations[].FilterExpressions

    Validation: Optional; array of DataSourceFilterExpressionProps

    - every table in the database is imported
    
    metadataForms?: { [formName: string]: DataSourceMetadataFormProps }

    Metadata forms, declared under this project's metadataForms, to attach to every asset this data source imports. Map key must match a key declared under metadataForms, must reference an ENABLED form, and content must satisfy that form's required fields; only applies to Glue database data sources (a synth-time error on an s3 entry).

    Use cases: Pre-populating governance metadata on imported assets

    AWS: AWS::DataZone::DataSource AssetFormsInput

    Validation: Optional; map of declared metadataForms key to DataSourceMetadataFormProps; max 10 entries; each key must exist in this project's metadataForms

    10

    - no metadata forms are attached
    
    publishOnImport?: boolean

    Whether assets imported by the data source are automatically published to the project's catalog. When false, imported assets remain in the project inventory and must be published by hand.

    Use cases: Publish-and-subscribe data mesh models; Automated asset catalog population

    AWS: AWS::DataZone::DataSource PublishOnImport

    Validation: Optional; boolean

    false (DataZone default; assets are not auto-published)
    

    Business name generation recommendation configuration for assets this data source imports.

    AWS: AWS::DataZone::DataSource Recommendation (AWS::DataZone::DataSource RecommendationConfiguration)

    Validation: Optional; DataSourceRecommendationProps

    - business name generation is not enabled
    

    S3 location to register as a data source. Mutually exclusive with databaseName.

    Use cases: Onboarding raw S3 data lake locations into a SMUS project's data catalog

    AWS: DataZone connection with S3 properties (AWS::DataZone::Connection)

    Validation: Exactly one of databaseName or s3 is required

    Schedule on which the data source runs automatically. When omitted, the data source never runs on its own and must be run manually or via another trigger.

    Use cases: Automated, recurring metadata import

    AWS: AWS::DataZone::DataSource Schedule (AWS::DataZone::DataSource ScheduleConfiguration)

    Validation: Optional; DataSourceScheduleProps

    - data source does not run on a schedule