Amplify Toolbox
    Preparing search index...

    Interface BranchConfig<TConfig>

    Configuration for a single branch pipeline.

    Each branch entry creates its own independent CodePipeline that triggers on pushes to the specified branch and deploys through its own ordered stages.

    interface BranchConfig<TConfig = Record<string, unknown>> {
        branch: string;
        stages: PipelineStageConfig<TConfig>[];
        triggerOnPush?: boolean;
    }

    Type Parameters

    • TConfig = Record<string, unknown>
    Index

    Properties

    branch stages triggerOnPush?

    Properties

    branch: string

    Git branch that triggers this pipeline.

    'main'
    stages: PipelineStageConfig<TConfig>[]

    Ordered list of deployment stages for this branch's pipeline.

    triggerOnPush?: boolean

    Whether to trigger this branch's pipeline on push.

    Overrides the top-level source.triggerOnPush for this specific branch. Useful when you want most branches to auto-trigger but disable it for specific branches (e.g., a release branch that deploys on manual trigger only).

    inherits from source.triggerOnPush (which defaults to true)

    Settings

    Member Visibility

    On This Page

    Properties