PipelineProps

All Known Implementing Classes:: PipelineProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.60.0 (build ebcefe6)",
           date="2022-06-22T23:27:54.371Z")
public interface PipelineProps

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

All Methods Static Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`static PipelineProps.Builder`	`builder()`
`default IBucket`	`getArtifactBucket()` The S3 bucket used by this Pipeline to store artifacts.
`default java.lang.Boolean`	`getCrossAccountKeys()` Create KMS keys for cross-account deployments.
`default java.util.Map<java.lang.String,IBucket>`	`getCrossRegionReplicationBuckets()` A map of region to S3 bucket name used for cross-region CodePipeline.
`default java.lang.Boolean`	`getEnableKeyRotation()` Enable KMS key rotation for the generated KMS keys.
`default java.lang.String`	`getPipelineName()` Name of the pipeline.
`default java.lang.Boolean`	`getRestartExecutionOnUpdate()` Indicates whether to rerun the AWS CodePipeline pipeline after you update it.
`default java.lang.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 java.util.List<StageProps>`	`getStages()` The list of Stages, in order, to create this Pipeline with.

- Method Detail
  - getArtifactBucket
```
default IBucket getArtifactBucket()
```
    The S3 bucket used by this Pipeline to store artifacts.
    Default: - A new S3 bucket will be created.
  - getCrossAccountKeys
```
default java.lang.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
```
default java.util.Map<java.lang.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
```
default java.lang.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
```
default java.lang.String getPipelineName()
```
    Name of the pipeline.
    Default: - AWS CloudFormation generates an ID and uses that for the pipeline name.
  - getRestartExecutionOnUpdate
```
default java.lang.Boolean getRestartExecutionOnUpdate()
```
    Indicates whether to rerun the AWS CodePipeline pipeline after you update it.
    Default: false
  - getReuseCrossRegionSupportStacks
```
default java.lang.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
```
default IRole getRole()
```
    The IAM role to be assumed by this Pipeline.
    Default: a new IAM role will be created.
  - getStages
```
default java.util.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
```
static PipelineProps.Builder builder()
```
    Returns:
    
    a PipelineProps.Builder of PipelineProps

Interface PipelineProps

Nested Class Summary

Method Summary

Method Detail

getArtifactBucket

getCrossAccountKeys

getCrossRegionReplicationBuckets

getEnableKeyRotation

getPipelineName

getRestartExecutionOnUpdate

getReuseCrossRegionSupportStacks

getRole

getStages

builder