Amplify Toolbox
    Preparing search index...

    Class AmplifyPipelineConstruct<TConfig>

    CDK Pipelines-based CI/CD pipeline construct (L3).

    A named re-export of @aws-blocks/pipeline's Pipeline, kept for API stability. It behaves identically to the upstream construct — one self-mutating CodePipeline V2 per branch, deploying to ordered stages with optional approval and bake time. Per-stage post-deploy steps (e.g. the Amplify hosting deploy) are supplied through the upstream postStage prop rather than any Amplify-specific wrapping.

    new AmplifyPipelineConstruct(stack, 'Pipeline', {
      source: {
        repo: 'my-org/my-app',
        connectionArn: 'arn:aws:codeconnections:us-east-1:123456789:connection/aaaaaaaa-1111-2222-3333-bbbbbbbbbbbb',
      },
      branches: [{ branch: 'main', stages: [{ name: 'prod' }] }],
      stageFactory: (scope, stageConfig) => {
        new MyAppStack(scope, 'App', { env: stageConfig.env });
      },
    });

    Type Parameters

    • TConfig = Record<string, unknown>

      Type of the user-defined config object passed to each stage.

    Hierarchy

    • Pipeline<TConfig>
      • AmplifyPipelineConstruct
    Index

    Constructors

    constructor

    Properties

    codePipelines node

    Methods

    toString with create isConstruct

    Constructors

    Properties

    codePipelines: ReadonlyMap<string, CodePipeline>

    The underlying CDK Pipelines CodePipeline instances, keyed by branch name.

    node: Node

    The tree node.

    Methods

    • Returns a string representation of this construct.

      Returns string

    • Applies one or more mixins to this construct.

      Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

      Parameters

      • ...mixins: IMixin[]

        The mixins to apply

      Returns IConstruct

      This construct for chaining

    • Checks if x is a construct.

      Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

      Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

      Parameters

      • x: any

        Any object

      Returns x is Construct

      true if x is an object created from a class which extends Construct.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods