Package software.aws.awsprototypingsdk.pipeline

Class PDKPipelinePyProject.Builder

    • Method Detail

      • name

        @Stability(Experimental)
public PDKPipelinePyProject.Builder name​(String name)
        (experimental) This is the name of your project.

        Default: $BASEDIR

        Parameters:
        name - This is the name of your project. This parameter is required.
        Returns:
        this

      • commitGenerated

        @Stability(Experimental)
public PDKPipelinePyProject.Builder commitGenerated​(Boolean commitGenerated)
        (experimental) Whether to commit the managed files by default.

        Default: true

        Parameters:
        commitGenerated - Whether to commit the managed files by default. This parameter is required.
        Returns:
        this

      • gitIgnoreOptions

        @Stability(Experimental)
public PDKPipelinePyProject.Builder gitIgnoreOptions​(io.github.cdklabs.projen.IgnoreFileOptions gitIgnoreOptions)
        (experimental) Configuration options for .gitignore file.

        Parameters:
        gitIgnoreOptions - Configuration options for .gitignore file. This parameter is required.
        Returns:
        this

      • gitOptions

        @Stability(Experimental)
public PDKPipelinePyProject.Builder gitOptions​(io.github.cdklabs.projen.GitOptions gitOptions)
        (experimental) Configuration options for git.

        Parameters:
        gitOptions - Configuration options for git. This parameter is required.
        Returns:
        this

      • logging

        @Stability(Experimental)
public PDKPipelinePyProject.Builder logging​(io.github.cdklabs.projen.LoggerOptions logging)
        (experimental) Configure logging options such as verbosity.

        Default: {}

        Parameters:
        logging - Configure logging options such as verbosity. This parameter is required.
        Returns:
        this

      • outdir

        @Stability(Experimental)
public PDKPipelinePyProject.Builder outdir​(String outdir)
        (experimental) The root directory of the project.

        Relative to this directory, all files are synthesized.

        If this project has a parent, this directory is relative to the parent directory and it cannot be the same as the parent or any of it's other sub-projects.

        Default: "."

        Parameters:
        outdir - The root directory of the project. This parameter is required.
        Returns:
        this

      • parent

        @Stability(Experimental)
public PDKPipelinePyProject.Builder parent​(io.github.cdklabs.projen.Project parent)
        (experimental) The parent project, if this project is part of a bigger project.

        Parameters:
        parent - The parent project, if this project is part of a bigger project. This parameter is required.
        Returns:
        this

      • projenCommand

        @Stability(Experimental)
public PDKPipelinePyProject.Builder projenCommand​(String projenCommand)
        (experimental) The shell command to use in order to run the projen CLI.

        Can be used to customize in special environments.

        Default: "npx projen"

        Parameters:
        projenCommand - The shell command to use in order to run the projen CLI. This parameter is required.
        Returns:
        this

      • projenrcJson

        @Stability(Experimental)
public PDKPipelinePyProject.Builder projenrcJson​(Boolean projenrcJson)
        (experimental) Generate (once) .projenrc.json (in JSON). Set to false in order to disable .projenrc.json generation.

        Default: false

        Parameters:
        projenrcJson - Generate (once) .projenrc.json (in JSON). Set to false in order to disable .projenrc.json generation. This parameter is required.
        Returns:
        this

      • projenrcJsonOptions

        @Stability(Experimental)
public PDKPipelinePyProject.Builder projenrcJsonOptions​(io.github.cdklabs.projen.ProjenrcJsonOptions projenrcJsonOptions)
        (experimental) Options for .projenrc.json.

        Default: - default options

        Parameters:
        projenrcJsonOptions - Options for .projenrc.json. This parameter is required.
        Returns:
        this

      • renovatebot

        @Stability(Experimental)
public PDKPipelinePyProject.Builder renovatebot​(Boolean renovatebot)
        (experimental) Use renovatebot to handle dependency upgrades.

        Default: false

        Parameters:
        renovatebot - Use renovatebot to handle dependency upgrades. This parameter is required.
        Returns:
        this

      • renovatebotOptions

        @Stability(Experimental)
public PDKPipelinePyProject.Builder renovatebotOptions​(io.github.cdklabs.projen.RenovatebotOptions renovatebotOptions)
        (experimental) Options for renovatebot.

        Default: - default options

        Parameters:
        renovatebotOptions - Options for renovatebot. This parameter is required.
        Returns:
        this

      • autoApproveOptions

        @Stability(Experimental)
public PDKPipelinePyProject.Builder autoApproveOptions​(io.github.cdklabs.projen.github.AutoApproveOptions autoApproveOptions)
        (experimental) Enable and configure the 'auto approve' workflow.

        Default: - auto approve is disabled

        Parameters:
        autoApproveOptions - Enable and configure the 'auto approve' workflow. This parameter is required.
        Returns:
        this

      • autoMerge

        @Stability(Experimental)
public PDKPipelinePyProject.Builder autoMerge​(Boolean autoMerge)
        (experimental) Enable automatic merging on GitHub.

        Has no effect if github.mergify is set to false.

        Default: true

        Parameters:
        autoMerge - Enable automatic merging on GitHub. This parameter is required.
        Returns:
        this

      • autoMergeOptions

        @Stability(Experimental)
public PDKPipelinePyProject.Builder autoMergeOptions​(io.github.cdklabs.projen.github.AutoMergeOptions autoMergeOptions)
        (experimental) Configure options for automatic merging on GitHub.

        Has no effect if github.mergify or autoMerge is set to false.

        Default: - see defaults in `AutoMergeOptions`

        Parameters:
        autoMergeOptions - Configure options for automatic merging on GitHub. This parameter is required.
        Returns:
        this

      • clobber

        @Stability(Experimental)
public PDKPipelinePyProject.Builder clobber​(Boolean clobber)
        (experimental) Add a clobber task which resets the repo to origin.

        Default: - true, but false for subprojects

        Parameters:
        clobber - Add a clobber task which resets the repo to origin. This parameter is required.
        Returns:
        this

      • devContainer

        @Stability(Experimental)
public PDKPipelinePyProject.Builder devContainer​(Boolean devContainer)
        (experimental) Add a VSCode development environment (used for GitHub Codespaces).

        Default: false

        Parameters:
        devContainer - Add a VSCode development environment (used for GitHub Codespaces). This parameter is required.
        Returns:
        this

      • github

        @Stability(Experimental)
public PDKPipelinePyProject.Builder github​(Boolean github)
        (experimental) Enable GitHub integration.

        Enabled by default for root projects. Disabled for non-root projects.

        Default: true

        Parameters:
        github - Enable GitHub integration. This parameter is required.
        Returns:
        this

      • githubOptions

        @Stability(Experimental)
public PDKPipelinePyProject.Builder githubOptions​(io.github.cdklabs.projen.github.GitHubOptions githubOptions)
        (experimental) Options for GitHub integration.

        Default: - see GitHubOptions

        Parameters:
        githubOptions - Options for GitHub integration. This parameter is required.
        Returns:
        this

      • gitpod

        @Stability(Experimental)
public PDKPipelinePyProject.Builder gitpod​(Boolean gitpod)
        (experimental) Add a Gitpod development environment.

        Default: false

        Parameters:
        gitpod - Add a Gitpod development environment. This parameter is required.
        Returns:
        this

      • mergify

        @Stability(Deprecated)
@Deprecated
public PDKPipelinePyProject.Builder mergify​(Boolean mergify)
        Deprecated.
        use githubOptions.mergify instead
        (deprecated) Whether mergify should be enabled on this repository or not.

        Default: true

        Parameters:
        mergify - Whether mergify should be enabled on this repository or not. This parameter is required.
        Returns:
        this

      • mergifyOptions

        @Stability(Deprecated)
@Deprecated
public PDKPipelinePyProject.Builder mergifyOptions​(io.github.cdklabs.projen.github.MergifyOptions mergifyOptions)
        Deprecated.
        use githubOptions.mergifyOptions instead
        (deprecated) Options for mergify.

        Default: - default options

        Parameters:
        mergifyOptions - Options for mergify. This parameter is required.
        Returns:
        this

      • projectType

        @Stability(Deprecated)
@Deprecated
public PDKPipelinePyProject.Builder projectType​(io.github.cdklabs.projen.ProjectType projectType)
        Deprecated.
        no longer supported at the base project level
        (deprecated) Which type of project this is (library/app).

        Default: ProjectType.UNKNOWN

        Parameters:
        projectType - Which type of project this is (library/app). This parameter is required.
        Returns:
        this

      • projenCredentials

        @Stability(Experimental)
public PDKPipelinePyProject.Builder projenCredentials​(io.github.cdklabs.projen.github.GithubCredentials projenCredentials)
        (experimental) Choose a method of providing GitHub API access for projen workflows.

        Default: - use a personal access token named PROJEN_GITHUB_TOKEN

        Parameters:
        projenCredentials - Choose a method of providing GitHub API access for projen workflows. This parameter is required.
        Returns:
        this

      • projenTokenSecret

        @Stability(Deprecated)
@Deprecated
public PDKPipelinePyProject.Builder projenTokenSecret​(String projenTokenSecret)
        Deprecated.
        use projenCredentials
        (deprecated) The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.

        This token needs to have the repo, workflows and packages scope.

        Default: "PROJEN_GITHUB_TOKEN"

        Parameters:
        projenTokenSecret - The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. This parameter is required.
        Returns:
        this

      • readme

        @Stability(Experimental)
public PDKPipelinePyProject.Builder readme​(io.github.cdklabs.projen.SampleReadmeProps readme)
        (experimental) The README setup.

        Default: - { filename: 'README.md', contents: '# replace this' }

        Example: 

         "{ filename: 'readme.md', contents: '# title' }"

        Parameters:
        readme - The README setup. This parameter is required.
        Returns:
        this

      • stale

        @Stability(Experimental)
public PDKPipelinePyProject.Builder stale​(Boolean stale)
        (experimental) Auto-close of stale issues and pull request.

        See staleOptions for options.

        Default: false

        Parameters:
        stale - Auto-close of stale issues and pull request. This parameter is required.
        Returns:
        this

      • staleOptions

        @Stability(Experimental)
public PDKPipelinePyProject.Builder staleOptions​(io.github.cdklabs.projen.github.StaleOptions staleOptions)
        (experimental) Auto-close stale issues and pull requests.

        To disable set stale to false.

        Default: - see defaults in `StaleOptions`

        Parameters:
        staleOptions - Auto-close stale issues and pull requests. This parameter is required.
        Returns:
        this

      • vscode

        @Stability(Experimental)
public PDKPipelinePyProject.Builder vscode​(Boolean vscode)
        (experimental) Enable VSCode integration.

        Enabled by default for root projects. Disabled for non-root projects.

        Default: true

        Parameters:
        vscode - Enable VSCode integration. This parameter is required.
        Returns:
        this

      • authorEmail

        @Stability(Experimental)
public PDKPipelinePyProject.Builder authorEmail​(String authorEmail)
        (experimental) Author's e-mail.

        Default: $GIT_USER_EMAIL

        Parameters:
        authorEmail - Author's e-mail. This parameter is required.
        Returns:
        this

      • authorName

        @Stability(Experimental)
public PDKPipelinePyProject.Builder authorName​(String authorName)
        (experimental) Author's name.

        Default: $GIT_USER_NAME

        Parameters:
        authorName - Author's name. This parameter is required.
        Returns:
        this

      • version

        @Stability(Experimental)
public PDKPipelinePyProject.Builder version​(String version)
        (experimental) Version of the package.

        Default: "0.1.0"

        Parameters:
        version - Version of the package. This parameter is required.
        Returns:
        this

      • classifiers

        @Stability(Experimental)
public PDKPipelinePyProject.Builder classifiers​(List<String> classifiers)
        (experimental) A list of PyPI trove classifiers that describe the project.

        Parameters:
        classifiers - A list of PyPI trove classifiers that describe the project. This parameter is required.
        Returns:
        this
        See Also:
        https://pypi.org/classifiers/

      • description

        @Stability(Experimental)
public PDKPipelinePyProject.Builder description​(String description)
        (experimental) A short description of the package.

        Parameters:
        description - A short description of the package. This parameter is required.
        Returns:
        this

      • homepage

        @Stability(Experimental)
public PDKPipelinePyProject.Builder homepage​(String homepage)
        (experimental) A URL to the website of the project.

        Parameters:
        homepage - A URL to the website of the project. This parameter is required.
        Returns:
        this

      • license

        @Stability(Experimental)
public PDKPipelinePyProject.Builder license​(String license)
        (experimental) License of this package as an SPDX identifier.

        Parameters:
        license - License of this package as an SPDX identifier. This parameter is required.
        Returns:
        this

      • packageName

        @Stability(Experimental)
public PDKPipelinePyProject.Builder packageName​(String packageName)
        (experimental) Package name.

        Parameters:
        packageName - Package name. This parameter is required.
        Returns:
        this

      • poetryOptions

        @Stability(Experimental)
public PDKPipelinePyProject.Builder poetryOptions​(io.github.cdklabs.projen.python.PoetryPyprojectOptionsWithoutDeps poetryOptions)
        (experimental) Additional options to set for poetry if using poetry.

        Parameters:
        poetryOptions - Additional options to set for poetry if using poetry. This parameter is required.
        Returns:
        this

      • setupConfig

        @Stability(Experimental)
public PDKPipelinePyProject.Builder setupConfig​(Map<String,​? extends Object> setupConfig)
        (experimental) Additional fields to pass in the setup() function if using setuptools.

        Parameters:
        setupConfig - Additional fields to pass in the setup() function if using setuptools. This parameter is required.
        Returns:
        this

      • moduleName

        @Stability(Experimental)
public PDKPipelinePyProject.Builder moduleName​(String moduleName)
        (experimental) Name of the python package as used in imports and filenames.

        Must only consist of alphanumeric characters and underscores.

        Default: $PYTHON_MODULE_NAME

        Parameters:
        moduleName - Name of the python package as used in imports and filenames. This parameter is required.
        Returns:
        this

      • deps

        @Stability(Experimental)
public PDKPipelinePyProject.Builder deps​(List<String> deps)
        (experimental) List of runtime dependencies for this project.

        Dependencies use the format: <module>@<semver>

        Additional dependencies can be added via project.addDependency().

        Default: []

        Parameters:
        deps - List of runtime dependencies for this project. This parameter is required.
        Returns:
        this

      • devDeps

        @Stability(Experimental)
public PDKPipelinePyProject.Builder devDeps​(List<String> devDeps)
        (experimental) List of dev dependencies for this project.

        Dependencies use the format: <module>@<semver>

        Additional dependencies can be added via project.addDevDependency().

        Default: []

        Parameters:
        devDeps - List of dev dependencies for this project. This parameter is required.
        Returns:
        this

      • pip

        @Stability(Experimental)
public PDKPipelinePyProject.Builder pip​(Boolean pip)
        (experimental) Use pip with a requirements.txt file to track project dependencies.

        Default: - true, unless poetry is true, then false

        Parameters:
        pip - Use pip with a requirements.txt file to track project dependencies. This parameter is required.
        Returns:
        this

      • poetry

        @Stability(Experimental)
public PDKPipelinePyProject.Builder poetry​(Boolean poetry)
        (experimental) Use poetry to manage your project dependencies, virtual environment, and (optional) packaging/publishing.

        This feature is incompatible with pip, setuptools, or venv. If you set this option to true, then pip, setuptools, and venv must be set to false.

        Default: false

        Parameters:
        poetry - Use poetry to manage your project dependencies, virtual environment, and (optional) packaging/publishing. This parameter is required.
        Returns:
        this

      • projenrcJs

        @Stability(Experimental)
public PDKPipelinePyProject.Builder projenrcJs​(Boolean projenrcJs)
        (experimental) Use projenrc in javascript.

        This will install projen as a JavaScript dependency and add a synth task which will run .projenrc.js.

        Default: false

        Parameters:
        projenrcJs - Use projenrc in javascript. This parameter is required.
        Returns:
        this

      • projenrcJsOptions

        @Stability(Experimental)
public PDKPipelinePyProject.Builder projenrcJsOptions​(io.github.cdklabs.projen.javascript.ProjenrcOptions projenrcJsOptions)
        (experimental) Options related to projenrc in JavaScript.

        Default: - default options

        Parameters:
        projenrcJsOptions - Options related to projenrc in JavaScript. This parameter is required.
        Returns:
        this

      • projenrcPython

        @Stability(Experimental)
public PDKPipelinePyProject.Builder projenrcPython​(Boolean projenrcPython)
        (experimental) Use projenrc in Python.

        This will install projen as a Python dependency and add a synth task which will run .projenrc.py.

        Default: true

        Parameters:
        projenrcPython - Use projenrc in Python. This parameter is required.
        Returns:
        this

      • projenrcPythonOptions

        @Stability(Experimental)
public PDKPipelinePyProject.Builder projenrcPythonOptions​(io.github.cdklabs.projen.python.ProjenrcOptions projenrcPythonOptions)
        (experimental) Options related to projenrc in python.

        Default: - default options

        Parameters:
        projenrcPythonOptions - Options related to projenrc in python. This parameter is required.
        Returns:
        this

      • projenrcTs

        @Stability(Experimental)
public PDKPipelinePyProject.Builder projenrcTs​(Boolean projenrcTs)
        (experimental) Use projenrc in TypeScript.

        This will create a tsconfig file (default: tsconfig.projen.json) and use ts-node in the default task to parse the project source files.

        Default: false

        Parameters:
        projenrcTs - Use projenrc in TypeScript. This parameter is required.
        Returns:
        this

      • projenrcTsOptions

        @Stability(Experimental)
public PDKPipelinePyProject.Builder projenrcTsOptions​(io.github.cdklabs.projen.typescript.ProjenrcTsOptions projenrcTsOptions)
        (experimental) Options related to projenrc in TypeScript.

        Default: - default options

        Parameters:
        projenrcTsOptions - Options related to projenrc in TypeScript. This parameter is required.
        Returns:
        this

      • pytest

        @Stability(Experimental)
public PDKPipelinePyProject.Builder pytest​(Boolean pytest)
        (experimental) Include pytest tests.

        Default: true

        Parameters:
        pytest - Include pytest tests. This parameter is required.
        Returns:
        this

      • pytestOptions

        @Stability(Experimental)
public PDKPipelinePyProject.Builder pytestOptions​(io.github.cdklabs.projen.python.PytestOptions pytestOptions)
        (experimental) pytest options.

        Default: - defaults

        Parameters:
        pytestOptions - pytest options. This parameter is required.
        Returns:
        this

      • pythonExec

        @Stability(Experimental)
public PDKPipelinePyProject.Builder pythonExec​(String pythonExec)
        (experimental) Path to the python executable to use.

        Default: "python"

        Parameters:
        pythonExec - Path to the python executable to use. This parameter is required.
        Returns:
        this

      • sample

        @Stability(Experimental)
public PDKPipelinePyProject.Builder sample​(Boolean sample)
        (experimental) Include sample code and test if the relevant directories don't exist.

        Default: true

        Parameters:
        sample - Include sample code and test if the relevant directories don't exist. This parameter is required.
        Returns:
        this

      • setuptools

        @Stability(Experimental)
public PDKPipelinePyProject.Builder setuptools​(Boolean setuptools)
        (experimental) Use setuptools with a setup.py script for packaging and publishing.

        Default: - true, unless poetry is true, then false

        Parameters:
        setuptools - Use setuptools with a setup.py script for packaging and publishing. This parameter is required.
        Returns:
        this

      • venv

        @Stability(Experimental)
public PDKPipelinePyProject.Builder venv​(Boolean venv)
        (experimental) Use venv to manage a virtual environment for installing dependencies inside.

        Default: - true, unless poetry is true, then false

        Parameters:
        venv - Use venv to manage a virtual environment for installing dependencies inside. This parameter is required.
        Returns:
        this

      • venvOptions

        @Stability(Experimental)
public PDKPipelinePyProject.Builder venvOptions​(io.github.cdklabs.projen.python.VenvOptions venvOptions)
        (experimental) Venv options.

        Default: - defaults

        Parameters:
        venvOptions - Venv options. This parameter is required.
        Returns:
        this

      • buildCommand

        @Stability(Experimental)
public PDKPipelinePyProject.Builder buildCommand​(String buildCommand)
        (experimental) A command to execute before synthesis.

        This command will be called when running cdk synth or when cdk watch identifies a change in your source code before redeployment.

        Default: - no build command

        Parameters:
        buildCommand - A command to execute before synthesis. This parameter is required.
        Returns:
        this

      • cdkout

        @Stability(Experimental)
public PDKPipelinePyProject.Builder cdkout​(String cdkout)
        (experimental) cdk.out directory.

        Default: "cdk.out"

        Parameters:
        cdkout - cdk.out directory. This parameter is required.
        Returns:
        this

      • context

        @Stability(Experimental)
public PDKPipelinePyProject.Builder context​(Map<String,​? extends Object> context)
        (experimental) Additional context to include in cdk.json.

        Default: - no additional context

        Parameters:
        context - Additional context to include in cdk.json. This parameter is required.
        Returns:
        this

      • featureFlags

        @Stability(Experimental)
public PDKPipelinePyProject.Builder featureFlags​(Boolean featureFlags)
        (experimental) Include all feature flags in cdk.json.

        Default: true

        Parameters:
        featureFlags - Include all feature flags in cdk.json. This parameter is required.
        Returns:
        this

      • requireApproval

        @Stability(Experimental)
public PDKPipelinePyProject.Builder requireApproval​(io.github.cdklabs.projen.awscdk.ApprovalLevel requireApproval)
        (experimental) To protect you against unintended changes that affect your security posture, the AWS CDK Toolkit prompts you to approve security-related changes before deploying them.

        Default: ApprovalLevel.BROADENING

        Parameters:
        requireApproval - To protect you against unintended changes that affect your security posture, the AWS CDK Toolkit prompts you to approve security-related changes before deploying them. This parameter is required.
        Returns:
        this

      • watchExcludes

        @Stability(Experimental)
public PDKPipelinePyProject.Builder watchExcludes​(List<String> watchExcludes)
        (experimental) Glob patterns to exclude from cdk watch.

        Default: []

        Parameters:
        watchExcludes - Glob patterns to exclude from cdk watch. This parameter is required.
        Returns:
        this

      • watchIncludes

        @Stability(Experimental)
public PDKPipelinePyProject.Builder watchIncludes​(List<String> watchIncludes)
        (experimental) Glob patterns to include in cdk watch.

        Default: []

        Parameters:
        watchIncludes - Glob patterns to include in cdk watch. This parameter is required.
        Returns:
        this

      • cdkVersion

        @Stability(Experimental)
public PDKPipelinePyProject.Builder cdkVersion​(String cdkVersion)
        (experimental) Minimum version of the AWS CDK to depend on.

        Default: "2.1.0"

        Parameters:
        cdkVersion - Minimum version of the AWS CDK to depend on. This parameter is required.
        Returns:
        this

      • cdkAssert

        @Stability(Deprecated)
@Deprecated
public PDKPipelinePyProject.Builder cdkAssert​(Boolean cdkAssert)
        Deprecated.
        The
        (deprecated) Warning: NodeJS only.

        Install the

        Default: - will be included by default for AWS CDK >= 1.0.0 < 2.0.0

        Parameters:
        cdkAssert - Warning: NodeJS only. This parameter is required.
        Returns:
        this

      • cdkAssertions

        @Stability(Experimental)
public PDKPipelinePyProject.Builder cdkAssertions​(Boolean cdkAssertions)
        (experimental) Install the assertions library?

        Only needed for CDK 1.x. If using CDK 2.x then assertions is already included in 'aws-cdk-lib'

        Default: - will be included by default for AWS CDK >= 1.111.0 < 2.0.0

        Parameters:
        cdkAssertions - Install the assertions library?. This parameter is required.
        Returns:
        this

      • cdkDependencies

        @Stability(Deprecated)
@Deprecated
public PDKPipelinePyProject.Builder cdkDependencies​(List<String> cdkDependencies)
        Deprecated.
        For CDK 2.x use "deps" instead. (or "peerDeps" if you're building a library)
        (deprecated) Which AWS CDKv1 modules this project requires.

        Parameters:
        cdkDependencies - Which AWS CDKv1 modules this project requires. This parameter is required.
        Returns:
        this

      • cdkDependenciesAsDeps

        @Stability(Deprecated)
@Deprecated
public PDKPipelinePyProject.Builder cdkDependenciesAsDeps​(Boolean cdkDependenciesAsDeps)
        Deprecated.
        Not supported in CDK v2.
        (deprecated) If this is enabled (default), all modules declared in cdkDependencies will be also added as normal dependencies (as well as peerDependencies).

        This is to ensure that downstream consumers actually have your CDK dependencies installed when using npm < 7 or yarn, where peer dependencies are not automatically installed. If this is disabled, cdkDependencies will be added to devDependencies to ensure they are present during development.

        Note: this setting only applies to construct library projects

        Default: true

        Parameters:
        cdkDependenciesAsDeps - If this is enabled (default), all modules declared in cdkDependencies will be also added as normal dependencies (as well as peerDependencies). This parameter is required.
        Returns:
        this

      • cdkTestDependencies

        @Stability(Deprecated)
@Deprecated
public PDKPipelinePyProject.Builder cdkTestDependencies​(List<String> cdkTestDependencies)
        Deprecated.
        For CDK 2.x use 'devDeps' (in node.js projects) or 'testDeps' (in java projects) instead
        (deprecated) AWS CDK modules required for testing.

        Parameters:
        cdkTestDependencies - AWS CDK modules required for testing. This parameter is required.
        Returns:
        this

      • cdkVersionPinning

        @Stability(Experimental)
public PDKPipelinePyProject.Builder cdkVersionPinning​(Boolean cdkVersionPinning)
        (experimental) Use pinned version instead of caret version for CDK.

        You can use this to prevent mixed versions for your CDK dependencies and to prevent auto-updates. If you use experimental features this will let you define the moment you include breaking changes.

        Parameters:
        cdkVersionPinning - Use pinned version instead of caret version for CDK. This parameter is required.
        Returns:
        this

      • constructsVersion

        @Stability(Experimental)
public PDKPipelinePyProject.Builder constructsVersion​(String constructsVersion)
        (experimental) Minimum version of the constructs library to depend on.

        Default: - for CDK 1.x the default is "3.2.27", for CDK 2.x the default is "10.0.5".

        Parameters:
        constructsVersion - Minimum version of the constructs library to depend on. This parameter is required.
        Returns:
        this

      • appEntrypoint

        @Stability(Experimental)
public PDKPipelinePyProject.Builder appEntrypoint​(String appEntrypoint)
        (experimental) The CDK app's entrypoint (relative to the source directory, which is "src" by default).

        Default: "app.py"

        Parameters:
        appEntrypoint - The CDK app's entrypoint (relative to the source directory, which is "src" by default). This parameter is required.
        Returns:
        this

      • testdir

        @Stability(Experimental)
public PDKPipelinePyProject.Builder testdir​(String testdir)
        (experimental) Python sources directory.

        Default: "tests"

        Parameters:
        testdir - Python sources directory. This parameter is required.
        Returns:
        this