Interface ICodePipelineProps

Properties for a CodePipeline.

Namespace: Amazon.CDK.Pipelines

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICodePipelineProps

Syntax (vb)

Public Interface ICodePipelineProps

Examples

Pipeline codePipeline;


            var sourceArtifact = new Artifact("MySourceArtifact");

            var pipeline = new CodePipeline(this, "Pipeline", new CodePipelineProps {
                CodePipeline = codePipeline,
                Synth = new ShellStep("Synth", new ShellStepProps {
                    Input = CodePipelineFileSet.FromArtifact(sourceArtifact),
                    Commands = new [] { "npm ci", "npm run build", "npx cdk synth" }
                })
            });

Synopsis

Properties

ArtifactBucket	An existing S3 Bucket to use for storing the pipeline's artifact.
AssetPublishingCodeBuildDefaults	Additional customizations to apply to the asset publishing CodeBuild projects.
CdkAssetsCliVersion	CDK CLI version to use in asset publishing steps.
CliVersion	CDK CLI version to use in self-mutation step.
CodeBuildDefaults	Customize the CodeBuild projects created for this pipeline.
CodePipeline	An existing Pipeline to be reused and built upon.
CrossAccountKeys	Create KMS keys for the artifact buckets, allowing cross-account deployments.
CrossRegionReplicationBuckets	A map of region to S3 bucket name used for cross-region CodePipeline.
DockerCredentials	A list of credentials used to authenticate to Docker registries.
DockerEnabledForSelfMutation	Enable Docker for the self-mutate step.
DockerEnabledForSynth	Enable Docker for the 'synth' step.
EnableKeyRotation	Enable KMS key rotation for the generated KMS keys.
PipelineName	The name of the CodePipeline pipeline.
PipelineType	Type of the pipeline.
PublishAssetsInParallel	Publish assets in multiple CodeBuild projects.
ReuseCrossRegionSupportStacks	Reuse the same cross region support stack for all pipelines in the App.
Role	The IAM role to be assumed by this Pipeline.
SelfMutation	Whether the pipeline will update itself.
SelfMutationCodeBuildDefaults	Additional customizations to apply to the self mutation CodeBuild projects.
Synth	The build step that produces the CDK Cloud Assembly.
SynthCodeBuildDefaults	Additional customizations to apply to the synthesize CodeBuild projects.
UseChangeSets	Deploy every stack by creating a change set and executing it.
UsePipelineRoleForActions	Use pipeline service role for actions if no action role configured.

Properties

ArtifactBucket

An existing S3 Bucket to use for storing the pipeline's artifact.

IBucket? ArtifactBucket { get; }

Property Value

IBucket

AssetPublishingCodeBuildDefaults

Additional customizations to apply to the asset publishing CodeBuild projects.

ICodeBuildOptions? AssetPublishingCodeBuildDefaults { get; }

Property Value

ICodeBuildOptions

CdkAssetsCliVersion

CDK CLI version to use in asset publishing steps.

string? CdkAssetsCliVersion { get; }

Property Value

string

CliVersion

CDK CLI version to use in self-mutation step.

string? CliVersion { get; }

Property Value

string

CodeBuildDefaults

Customize the CodeBuild projects created for this pipeline.

ICodeBuildOptions? CodeBuildDefaults { get; }

Property Value

ICodeBuildOptions

CodePipeline

An existing Pipeline to be reused and built upon.

Pipeline? CodePipeline { get; }

Property Value

Pipeline

CrossAccountKeys

Create KMS keys for the artifact buckets, allowing cross-account deployments.

bool? CrossAccountKeys { get; }

Property Value

bool?

CrossRegionReplicationBuckets

A map of region to S3 bucket name used for cross-region CodePipeline.

IDictionary<string, IBucket>? CrossRegionReplicationBuckets { get; }

Property Value

IDictionary<string, IBucket>

DockerCredentials

A list of credentials used to authenticate to Docker registries.

DockerCredential[]? DockerCredentials { get; }

Property Value

DockerCredential[]

DockerEnabledForSelfMutation

Enable Docker for the self-mutate step.

bool? DockerEnabledForSelfMutation { get; }

Property Value

bool?

DockerEnabledForSynth

Enable Docker for the 'synth' step.

bool? DockerEnabledForSynth { get; }

Property Value

bool?

EnableKeyRotation

Enable KMS key rotation for the generated KMS keys.

bool? EnableKeyRotation { get; }

Property Value

bool?

PipelineName

The name of the CodePipeline pipeline.

string? PipelineName { get; }

Property Value

string

PipelineType

Type of the pipeline.

PipelineType? PipelineType { get; }

Property Value

PipelineType?

PublishAssetsInParallel

Publish assets in multiple CodeBuild projects.

bool? PublishAssetsInParallel { get; }

Property Value

bool?

ReuseCrossRegionSupportStacks

Reuse the same cross region support stack for all pipelines in the App.

bool? ReuseCrossRegionSupportStacks { get; }

Property Value

bool?

Role

The IAM role to be assumed by this Pipeline.

Property Value

IRole

SelfMutation

Whether the pipeline will update itself.

bool? SelfMutation { get; }

Property Value

bool?

SelfMutationCodeBuildDefaults

Additional customizations to apply to the self mutation CodeBuild projects.

ICodeBuildOptions? SelfMutationCodeBuildDefaults { get; }

Property Value

ICodeBuildOptions

Synth

The build step that produces the CDK Cloud Assembly.

IFileSetProducer Synth { get; }

Property Value

IFileSetProducer

SynthCodeBuildDefaults

Additional customizations to apply to the synthesize CodeBuild projects.

ICodeBuildOptions? SynthCodeBuildDefaults { get; }

Property Value

ICodeBuildOptions

UseChangeSets

Deploy every stack by creating a change set and executing it.

bool? UseChangeSets { get; }

Property Value

bool?

UsePipelineRoleForActions

Use pipeline service role for actions if no action role configured.

bool? UsePipelineRoleForActions { get; }

Property Value

bool?