codepipeline: construct should allow 'disableInboundStageTransitions' to be set

[jesterhazy]

The codepipeline construct doesn't allow the disableInboundStageTransitions property to be set. This is useful for pipelines you want to run on a schedule or some other event rather than for every source change.

There is a workaround via the CfnPipeline, but it would be great if we could do this through the construct, either in the Pipeline construct, the individual Stage constructs, or both.

Workaround code is:

const cfnPipeline = pipeline.node.findChild('Resource') as codepipeline.CfnPipeline
cfnPipeline.propertyOverrides.disableInboundStageTransitions = [{
    reason: 'Pipeline is triggered by schedule not source changes',
    stageName: 'Source'
}]

[skinny85]

Still relevant.

[berenddeboer]

The current way to add this override is:

    cfnPipeline.addPropertyOverride("DisableInboundStageTransitions", [{
      Reason: 'Pipeline is triggered by schedule not source changes',
      StageName: 'Source'
    }])

[paulrichards-provar]

Do you have a more complete example? When I try to use that code snippet it can't find a child called Resource on the pipeline construct.

const pipeline = new CdkPipeline(this, "SomePipeline", {...})
pipeline.node.findChild('Resource')

When running cdk synth I get a "No child with id: 'Resource'" error.

[berenddeboer]

@paulrichards-provar that's exactly how it works for me. I'm assuming you are on the latest CDK. Perhaps you can come up with a small example that gives that error?

[paulrichards-provar]

I'm using cdk version 1.109.0 (build c647e38)

`import { Repository } from '@aws-cdk/aws-codecommit';
import { CodeCommitSourceAction } from "@aws-cdk/aws-codepipeline-actions";
import { Artifact, CfnPipeline } from '@aws-cdk/aws-codepipeline';
import { Construct, Stack, StackProps } from '@aws-cdk/core';
import { CdkPipeline, SimpleSynthAction } from '@aws-cdk/pipelines';

interface PipelineStackProps extends StackProps {
env: any
}

export class PipelineStack extends Stack {
constructor(scope: Construct, id: string, props: PipelineStackProps) {
super(scope, id, props);

const cloudAssemblyArtifact = new Artifact();
const sourceArtifact = new Artifact();
const repoArn = `arn:aws:codecommit:${props.env.region}:${props.env.account}:SomeRepo`;


const pipeline = new CdkPipeline(this, "TestPipeline", {
  pipelineName: "TestPipeline",
  cloudAssemblyArtifact,
  sourceAction: new CodeCommitSourceAction({
    actionName: "PipelineSource",
    repository: Repository.fromRepositoryArn(
      this,
      "TestRepo",
      repoArn,
    ),
    branch: "main",
    output: sourceArtifact
  }),
  synthAction: SimpleSynthAction.standardNpmSynth({
    sourceArtifact,
    cloudAssemblyArtifact,
    buildCommand: "npm run build && npm test",
  }),
});

pipeline.node.findChild('Resource') as CfnPipeline;

}
}
`

[github-actions]

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.