Class CodePipeline
A CDK Pipeline that uses CodePipeline to deploy CDK apps.
Inherited Members
Namespace: Amazon.CDK.Pipelines
Assembly: Amazon.CDK.Pipelines.dll
Syntax (csharp)
public class CodePipeline : PipelineBase, IConstruct, IDependable
Syntax (vb)
Public Class CodePipeline
Inherits PipelineBase
Implements IConstruct, IDependable
Remarks
This is a Pipeline
with its engine
property set to
CodePipelineEngine
, and exists for nicer ergonomics for
users that don't need to switch out engines.
ExampleMetadata: infused
Examples
// Modern API
var modernPipeline = new CodePipeline(this, "Pipeline", new CodePipelineProps {
SelfMutation = false,
Synth = new ShellStep("Synth", new ShellStepProps {
Input = CodePipelineSource.Connection("my-org/my-app", "main", new ConnectionSourceOptions {
ConnectionArn = "arn:aws:codestar-connections:us-east-1:222222222222:connection/7d2469ff-514a-4e4f-9003-5ca4a43cdc41"
}),
Commands = new [] { "npm ci", "npm run build", "npx cdk synth" }
})
});
// Original API
var cloudAssemblyArtifact = new Artifact();
var originalPipeline = new CdkPipeline(this, "Pipeline", new CdkPipelineProps {
SelfMutating = false,
CloudAssemblyArtifact = cloudAssemblyArtifact
});
Synopsis
Constructors
CodePipeline(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CodePipeline(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CodePipeline(Construct, String, ICodePipelineProps) |
Properties
Pipeline | The CodePipeline pipeline that deploys the CDK app. |
SynthProject | The CodeBuild project that performs the Synth. |
Methods
DoBuildPipeline() | Implemented by subclasses to do the actual pipeline construction. |
Constructors
CodePipeline(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CodePipeline(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CodePipeline(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CodePipeline(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CodePipeline(Construct, String, ICodePipelineProps)
public CodePipeline(Construct scope, string id, ICodePipelineProps props)
Parameters
- scope Constructs.Construct
- id System.String
- props ICodePipelineProps
Properties
Pipeline
The CodePipeline pipeline that deploys the CDK app.
public virtual Pipeline Pipeline { get; }
Property Value
Remarks
Only available after the pipeline has been built.
SynthProject
The CodeBuild project that performs the Synth.
public virtual IProject SynthProject { get; }
Property Value
Remarks
Only available after the pipeline has been built.
Methods
DoBuildPipeline()
Implemented by subclasses to do the actual pipeline construction.
protected override void DoBuildPipeline()