MDAA TS Docs
    Preparing search index...

    Interface SageMakerPipelineL3ConstructProps

    Props for the CfnPipeline-based SageMaker Pipeline construct.

    Unlike SageMakerModelTrainingL3ConstructProps which creates CodeBuild + seed code, this construct creates the SageMaker Pipeline definition directly as a CloudFormation resource (CfnPipeline), with full MDAA compliance.

    interface SageMakerPipelineL3ConstructProps {
        additionalReadBucketNames?: string[];
        baseJobPrefix?: string;
        createModelPackageGroup?: boolean;
        createOutputs?: boolean;
        createParams?: boolean;
        crossAccountStacks?: { [account: string]: { [region: string]: Stack } };
        domainArn?: string;
        domainId?: string;
        modelPackageGroupName?: string;
        naming: IMdaaResourceNaming;
        networkConfig?: PipelineNetworkConfig;
        pipelineBucketName?: string;
        pipelineKmsKeyArn?: string;
        pipelineName?: string;
        pipelineParameters?: PipelineParameter[];
        pipelineSteps: PipelineStep[];
        preProdAccountId?: string;
        prodAccountId?: string;
        projectName: string;
        roleHelper: MdaaRoleHelper;
        tags?: { [key: string]: string };
    }

    Hierarchy

    • MdaaL3ConstructProps
      • SageMakerPipelineL3ConstructProps
    Index

    Properties

    additionalReadBucketNames? baseJobPrefix? createModelPackageGroup? createOutputs? createParams? crossAccountStacks? domainArn? domainId? modelPackageGroupName? naming networkConfig? pipelineBucketName? pipelineKmsKeyArn? pipelineName? pipelineParameters? pipelineSteps preProdAccountId? prodAccountId? projectName roleHelper tags?

    Properties

    additionalReadBucketNames?: string[]

    Additional S3 bucket names the pipeline execution role needs read access to.

    baseJobPrefix?: string

    Prefix used by seed code when naming SageMaker jobs (default: projectName). Used to scope IAM resource ARNs.

    createModelPackageGroup?: boolean

    Whether to create a new SageMaker Model Package Group. Defaults to true. Set to false when the Model Package Group already exists (e.g. created by sagemaker-model-training-l3-construct) and modelPackageGroupName contains a fully-qualified name that must be used as-is.

    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

    crossAccountStacks?: { [account: string]: { [region: string]: Stack } }
    domainArn?: string

    SageMaker domain ARN (from Studio).

    domainId?: string

    SageMaker domain ID (from Studio).

    modelPackageGroupName?: string

    SageMaker Model Package Group name. When provided, IAM permissions are scoped to this group.

    naming: IMdaaResourceNaming

    MDAA naming implementation for consistent resource naming across all MDAA constructs

    networkConfig?: PipelineNetworkConfig

    Default network config applied to steps that don't specify their own.

    pipelineBucketName?: string

    Existing S3 bucket name to reuse for pipeline artifacts instead of creating a new one. When provided, the construct imports this bucket and grants the execution role access. When omitted, a new MdaaBucket is created (standalone mode).

    pipelineKmsKeyArn?: string

    KMS key ARN for the existing pipeline bucket. Required when pipelineBucketName is set.

    pipelineName?: string

    Explicit pipeline name (if not provided, generated from MDAA naming convention).

    pipelineParameters?: PipelineParameter[]

    Pipeline-level parameters (overridable at execution time).

    pipelineSteps: PipelineStep[]

    Pipeline steps (built using the step construct classes).

    preProdAccountId?: string

    Pre-prod account ID for cross-account model registry access.

    prodAccountId?: string

    Prod account ID for cross-account model registry access.

    projectName: string

    SageMaker project name.

    roleHelper: MdaaRoleHelper
    tags?: { [key: string]: string }

    Settings

    Member Visibility

    On This Page

    Properties