software.amazon.awscdk.services.codepipeline

Interface PipelineProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

PipelineProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.72.0 (build 4b8828b)",
           date="2022-12-14T20:30:48.399Z")
 @Stability(value=Stable)
public interface PipelineProps
extends software.amazon.jsii.JsiiSerializable

Example:

 PipelineProject project;
 Repository repository = Repository.Builder.create(this, "MyRepository")
         .repositoryName("MyRepository")
         .build();
 PipelineProject project = new PipelineProject(this, "MyProject");
 Artifact sourceOutput = new Artifact();
 CodeCommitSourceAction sourceAction = CodeCommitSourceAction.Builder.create()
         .actionName("CodeCommit")
         .repository(repository)
         .output(sourceOutput)
         .build();
 CodeBuildAction buildAction = CodeBuildAction.Builder.create()
         .actionName("CodeBuild")
         .project(project)
         .input(sourceOutput)
         .outputs(List.of(new Artifact())) // optional
         .executeBatchBuild(true) // optional, defaults to false
         .combineBatchBuildArtifacts(true)
         .build();
 Pipeline.Builder.create(this, "MyPipeline")
         .stages(List.of(StageProps.builder()
                 .stageName("Source")
                 .actions(List.of(sourceAction))
                 .build(), StageProps.builder()
                 .stageName("Build")
                 .actions(List.of(buildAction))
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PipelineProps.Builder A builder for PipelineProps
static class	PipelineProps.Jsii$Proxy An implementation for PipelineProps

Method Summary

Modifier and Type	Method and Description
static PipelineProps.Builder	builder()
default IBucket	getArtifactBucket() The S3 bucket used by this Pipeline to store artifacts.
default Boolean	getCrossAccountKeys() Create KMS keys for cross-account deployments.
default Map<String,IBucket>	getCrossRegionReplicationBuckets() A map of region to S3 bucket name used for cross-region CodePipeline.
default Boolean	getEnableKeyRotation() Enable KMS key rotation for the generated KMS keys.
default String	getPipelineName() Name of the pipeline.
default Boolean	getRestartExecutionOnUpdate() Indicates whether to rerun the AWS CodePipeline pipeline after you update it.
default Boolean	getReuseCrossRegionSupportStacks() Reuse the same cross region support stack for all pipelines in the App.
default IRole	getRole() The IAM role to be assumed by this Pipeline.
default List<StageProps>	getStages() The list of Stages, in order, to create this Pipeline with.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getArtifactBucket

@Stability(value=Stable)
 @Nullable
default IBucket getArtifactBucket()

The S3 bucket used by this Pipeline to store artifacts.

Default: - A new S3 bucket will be created.

getCrossAccountKeys

@Stability(value=Stable)
 @Nullable
default Boolean getCrossAccountKeys()

Create KMS keys for cross-account deployments.

This controls whether the pipeline is enabled for cross-account deployments.

By default cross-account deployments are enabled, but this feature requires that KMS Customer Master Keys are created which have a cost of $1/month.

If you do not need cross-account deployments, you can set this to false to not create those keys and save on that cost (the artifact bucket will be encrypted with an AWS-managed key). However, cross-account deployments will no longer be possible.

Default: true

getCrossRegionReplicationBuckets

@Stability(value=Stable)
 @Nullable
default Map<String,IBucket> getCrossRegionReplicationBuckets()

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

For every Action that you specify targeting a different region than the Pipeline itself, if you don't provide an explicit Bucket for that region using this property, the construct will automatically create a Stack containing an S3 Bucket in that region.

Default: - None.

getEnableKeyRotation

@Stability(value=Stable)
 @Nullable
default Boolean getEnableKeyRotation()

Enable KMS key rotation for the generated KMS keys.

By default KMS key rotation is disabled, but will add an additional $1/month for each year the key exists when enabled.

Default: - false (key rotation is disabled)

getPipelineName

@Stability(value=Stable)
 @Nullable
default String getPipelineName()

Name of the pipeline.

Default: - AWS CloudFormation generates an ID and uses that for the pipeline name.

getRestartExecutionOnUpdate

@Stability(value=Stable)
 @Nullable
default Boolean getRestartExecutionOnUpdate()

Indicates whether to rerun the AWS CodePipeline pipeline after you update it.

Default: false

getReuseCrossRegionSupportStacks

@Stability(value=Stable)
 @Nullable
default Boolean getReuseCrossRegionSupportStacks()

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

Default: - true (Use the same support stack for all pipelines in App)

getRole

@Stability(value=Stable)
 @Nullable
default IRole getRole()

The IAM role to be assumed by this Pipeline.

Default: a new IAM role will be created.

getStages

@Stability(value=Stable)
 @Nullable
default List<StageProps> getStages()

The list of Stages, in order, to create this Pipeline with.

You can always add more Stages later by calling {@link Pipeline#addStage}.

Default: - None.

builder

@Stability(value=Stable)
static PipelineProps.Builder builder()

Returns:

a PipelineProps.Builder of PipelineProps