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.74.0 (build 6d08790)",
           date="2023-02-01T23:43:16.148Z")
@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.

    • Method Summary

      All Methods Static Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      static PDKPipelineProps.Builder builder()  
      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

        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.

      • 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.