PDKPipelineProps (software.aws.awsprototypingsdk:aws-prototyping-sdk 0.0.34 API)

All Superinterfaces:

software.amazon.awscdk.pipelines.CodePipelineProps, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

PDKPipelineProps.Jsii$Proxy
```
@Generated(value="jsii-pacmak/1.54.0 (build b1b977a)",
           date="2022-03-05T05:44:07.556Z")
@Stability(Stable)
public interface PDKPipelineProps
extends software.amazon.jsii.JsiiSerializable, software.amazon.awscdk.pipelines.CodePipelineProps
```
Properties to configure the PDKPipeline.
Note: Due to limitations with JSII and generic support it should be noted that the synth, synthShellStepPartialProps.input and synthShellStepPartialProps.primaryOutputDirectory properties will be ignored if passed in to this construct.
synthShellStepPartialProps.commands is marked as a required field, however if you pass in [] the default commands of this construct will be retained.

Nested Class Summary

Nested Classes
Modifier and Type	Interface	Description
`static class`	`PDKPipelineProps.Builder`	A builder for `PDKPipelineProps`
`static class`	`PDKPipelineProps.Jsii$Proxy`	An implementation for `PDKPipelineProps`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`static PDKPipelineProps.Builder`	`builder()`
`default String`	`getDefaultBranchName()`	Branch to trigger the pipeline execution.
`default Boolean`	`getPrBuildChecker()`	Enables a build job to trigger on PR merges to the defaultBranchName.
`String`	`getPrimarySynthDirectory()`	Output directory for cdk synthesized artifacts i.e: packages/infra/cdk.out.
`String`	`getRepositoryName()`	Name of the CodeCommit repository to create.
`default software.amazon.awscdk.pipelines.ShellStepProps`	`getSynthShellStepPartialProps()`	PDKPipeline by default assumes a NX Monorepo structure for it's codebase and uses sane defaults for the install and run commands.

Methods inherited from interface software.amazon.awscdk.pipelines.CodePipelineProps
getAssetPublishingCodeBuildDefaults, getCliVersion, getCodeBuildDefaults, getCodePipeline, getCrossAccountKeys, getDockerCredentials, getDockerEnabledForSelfMutation, getDockerEnabledForSynth, getPipelineName, getPublishAssetsInParallel, getReuseCrossRegionSupportStacks, getSelfMutation, getSelfMutationCodeBuildDefaults, getSynth, getSynthCodeBuildDefaults

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

- Method Detail
  - getPrimarySynthDirectory
```
@Stability(Stable)
@NotNull
String getPrimarySynthDirectory()
```
    Output directory for cdk synthesized artifacts i.e: packages/infra/cdk.out.
  - getRepositoryName
```
@Stability(Stable)
@NotNull
String getRepositoryName()
```
    Name of the CodeCommit repository to create.
  - getDefaultBranchName
```
@Stability(Stable)
@Nullable
default String getDefaultBranchName()
```
    Branch to trigger the pipeline execution.
    Default: mainline
  - getPrBuildChecker
```
@Stability(Stable)
@Nullable
default Boolean getPrBuildChecker()
```
    Enables a build job to trigger on PR merges to the defaultBranchName.
    This will automatically build the codebase and add an Approval to the PR on successful build.
    Default: true
  - getSynthShellStepPartialProps
```
@Stability(Stable)
@Nullable
default software.amazon.awscdk.pipelines.ShellStepProps getSynthShellStepPartialProps()
```
    PDKPipeline by default assumes a NX Monorepo structure for it's codebase and uses sane defaults for the install and run commands.
    To override these defaults and/or provide additional inputs, specify env settings, etc you can provide a partial ShellStepProps.
  - builder
```
@Stability(Stable)
static PDKPipelineProps.Builder builder()
```
    Returns:
    
    a PDKPipelineProps.Builder of PDKPipelineProps