MDAA TS Docs
    Preparing search index...

    Interface MdaaDatazoneS3ConnectionProps

    interface MdaaDatazoneS3ConnectionProps {
        bucketName: string;
        createOutputs?: boolean;
        createParams?: boolean;
        domainIdentifier: string;
        environmentIdentifier?: string;
        grantReadRoleArn?: string;
        kmsKeyArn?: string;
        name: string;
        naming: IMdaaResourceNaming;
        prefix?: string;
        projectIdentifier: string;
        registerS3AccessGrantLocation?: boolean;
        s3AccessGrantLocationId?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    bucketName: string

    Name of the S3 bucket to register as the connection's data source. Accepts a literal bucket name or an MDAA ssm-org:/ssm-domain: reference to a bucket created by another module (e.g. ssm-org:/shared/datalake/bucket/research/name).

    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

    domainIdentifier: string

    DataZone domain ID in which the connection is created.

    environmentIdentifier?: string

    DataZone environment ID in which the connection is created. Required for SMUS (SageMaker Unified Studio) projects; omit for DataZone (non-SMUS) projects.

    grantReadRoleArn?: string

    ARN of an IAM role to grant read access (list + get object) on bucketName/prefix. Typically the DataZone/SMUS project's environment user role. Unlike the Glue data source path, DataZone does not grant Lake Formation permissions for a raw S3 connection, so this is MDAA's default access-control mechanism for a raw S3 connection — both L3 callers (sagemaker-project, dataops-project) always pass the project's environment role here, matching the Glue path's always-on Lake Formation grant. registerS3AccessGrantLocation above is an optional, additional layer on top of this, not a substitute for it.

    This grant alone cannot make objects readable on every bucket: it adds no KMS access (see kmsKeyArn below), and it cannot override a bucket policy that denies access by default. A bucket with a default-deny policy, such as an MDAA data lake bucket's accessPolicies, must also list this role on its own policy for reads to actually succeed.

    kmsKeyArn?: string

    ARN of the KMS key used to encrypt bucketName, if SSE-KMS. When set alongside grantReadRoleArn, grants that role kms:Decrypt on this key, scoped to calls made through the S3 service. Without this, grantReadRoleArn cannot decrypt objects in an SSE-KMS bucket even though it can list and get them.

    name: string

    Name used to generate the DataZone connection's resource name.

    naming: IMdaaResourceNaming

    MDAA naming implementation for consistent resource naming across all MDAA constructs

    prefix?: string

    Key prefix within the bucket to register, e.g. raw/. Registers the whole bucket when omitted.

    ''
    
    projectIdentifier: string

    DataZone project ID that will own the connection.

    registerS3AccessGrantLocation?: boolean

    Whether to register an S3 Access Grants location for the connection. This is an additional, optional governance layer on top of grantReadRoleArn (below), which is MDAA's default, unconditional access control for this construct. When enabled, SageMaker Unified Studio registers the S3 Access Grants location itself — creating an S3 Access Grants instance first if none exists in the account/region — which requires s3:CreateAccessGrantsLocation, s3:CreateAccessGrant, and related Access Grants permissions on the caller. MDAA does not grant these permissions to any role, so enabling this flag only works if that caller already has them from outside this construct.

    s3AccessGrantLocationId?: string

    S3 Access Grants location ID to associate with the connection.