Package software.aws.awsprototypingsdk.pipeline

Interface PDKPipelineProps

All Superinterfaces:

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

All Known Implementing Classes:

PDKPipelineProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.82.0 (build 2d2ddd7)",
           date="2023-08-02T01:26:24.021Z")
@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

Modifier and Type	Method	Description
static PDKPipelineProps.Builder	builder()
default List<String>	getBranchNamePrefixes()	Branch name prefixes Any branches created matching this list of prefixes will create a new pipeline and stack.
default String	getCdkCommand()	CDK command.
default software.amazon.awscdk.RemovalPolicy	getCodeCommitRemovalPolicy()	Possible values for a resource's Removal Policy The removal policy controls what happens to the resource if it stops being managed by CloudFormation.
default String	getDefaultBranchName()	Branch to trigger the pipeline execution.
String	getPrimarySynthDirectory()	Output directory for cdk synthesized artifacts i.e: packages/infra/cdk.out.
String	getRepositoryName()	Name of the CodeCommit repository to create.
default SonarCodeScannerConfig	getSonarCodeScannerConfig()	Configuration for enabling Sonarqube code scanning on a successful synth.
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

getArtifactBucket, getAssetPublishingCodeBuildDefaults, getCliVersion, getCodeBuildDefaults, getCodePipeline, getCrossAccountKeys, getDockerCredentials, getDockerEnabledForSelfMutation, getDockerEnabledForSynth, getEnableKeyRotation, getPipelineName, getPublishAssetsInParallel, getReuseCrossRegionSupportStacks, getRole, getSelfMutation, getSelfMutationCodeBuildDefaults, getSynth, getSynthCodeBuildDefaults, getUseChangeSets

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.

getBranchNamePrefixes

@Stability(Stable)
@Nullable
default List<String> getBranchNamePrefixes()

Branch name prefixes Any branches created matching this list of prefixes will create a new pipeline and stack.

Default: undefined

Example:

 // Disables feature branches (default)
 new PDKPipeline(this, 'PDKPipeline', {
   repositoryName: 'my-repo',
   branchNamePrefixes: [], // or simply exclude this line
 }
 

getCdkCommand

@Stability(Stable)
@Nullable
default String getCdkCommand()

CDK command.

Override the command used to call cdk for synth and deploy.

Default: 'npx cdk'

getCodeCommitRemovalPolicy

@Stability(Stable)
@Nullable
default software.amazon.awscdk.RemovalPolicy getCodeCommitRemovalPolicy()

Possible values for a resource's Removal Policy The removal policy controls what happens to the resource if it stops being managed by CloudFormation.

getDefaultBranchName

@Stability(Stable)
@Nullable
default String getDefaultBranchName()

Branch to trigger the pipeline execution.

Default: mainline

getSonarCodeScannerConfig

@Stability(Stable)
@Nullable
default SonarCodeScannerConfig getSonarCodeScannerConfig()

Configuration for enabling Sonarqube code scanning on a successful synth.

Default: undefined

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