Class Cdk8sPythonApp.Builder
- java.lang.Object
-
- io.github.cdklabs.projen.cdk8s.Cdk8sPythonApp.Builder
-
- All Implemented Interfaces:
software.amazon.jsii.Builder<Cdk8sPythonApp>
- Enclosing class:
- Cdk8sPythonApp
@Stability(Experimental) public static final class Cdk8sPythonApp.Builder extends Object implements software.amazon.jsii.Builder<Cdk8sPythonApp>
(experimental) A fluent builder forCdk8sPythonApp.
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description Cdk8sPythonApp.BuilderappEntrypoint(String appEntrypoint)(experimental) The CDK8s app's entrypoint.Cdk8sPythonApp.BuilderauthorEmail(String authorEmail)(experimental) Author's e-mail.Cdk8sPythonApp.BuilderauthorName(String authorName)(experimental) Author's name.Cdk8sPythonApp.BuilderautoApproveOptions(AutoApproveOptions autoApproveOptions)(experimental) Enable and configure the 'auto approve' workflow.Cdk8sPythonApp.BuilderautoMerge(Boolean autoMerge)(experimental) Enable automatic merging on GitHub.Cdk8sPythonApp.BuilderautoMergeOptions(AutoMergeOptions autoMergeOptions)(experimental) Configure options for automatic merging on GitHub.Cdk8sPythonAppbuild()Cdk8sPythonApp.Buildercdk8SCliVersion(String cdk8SCliVersion)(experimental) Minimum version of the cdk8s-cli to depend on.Cdk8sPythonApp.Buildercdk8SCliVersionPinning(Boolean cdk8SCliVersionPinning)(experimental) Use pinned version instead of caret version for cdk8s-cli.Cdk8sPythonApp.Buildercdk8SImports(List<String> cdk8SImports)(experimental) Import additional specs.Cdk8sPythonApp.Buildercdk8SPlus(Boolean cdk8SPlus)(experimental) Include cdk8s-plus.Cdk8sPythonApp.Buildercdk8SPlusVersion(String cdk8SPlusVersion)(experimental) Minimum version of the cdk8s-plus-XX to depend on.Cdk8sPythonApp.Buildercdk8SPlusVersionPinning(Boolean cdk8SPlusVersionPinning)(experimental) Use pinned version instead of caret version for cdk8s-plus-17.Cdk8sPythonApp.Buildercdk8SVersion(String cdk8SVersion)(experimental) Minimum version of the cdk8s to depend on.Cdk8sPythonApp.Buildercdk8SVersionPinning(Boolean cdk8SVersionPinning)(experimental) Use pinned version instead of caret version for cdk8s.Cdk8sPythonApp.Builderclassifiers(List<String> classifiers)(experimental) A list of PyPI trove classifiers that describe the project.Cdk8sPythonApp.Builderclobber(Boolean clobber)(experimental) Add aclobbertask which resets the repo to origin.Cdk8sPythonApp.BuildercommitGenerated(Boolean commitGenerated)(experimental) Whether to commit the managed files by default.Cdk8sPythonApp.BuilderconstructsVersion(String constructsVersion)(experimental) Minimum version of theconstructslibrary to depend on.Cdk8sPythonApp.BuilderconstructsVersionPinning(Boolean constructsVersionPinning)(experimental) Use pinned version instead of caret version for constructs.static Cdk8sPythonApp.Buildercreate()Cdk8sPythonApp.Builderdeps(List<String> deps)(experimental) List of runtime dependencies for this project.Cdk8sPythonApp.Builderdescription(String description)(experimental) A short description of the package.Cdk8sPythonApp.BuilderdevContainer(Boolean devContainer)(experimental) Add a VSCode development environment (used for GitHub Codespaces).Cdk8sPythonApp.BuilderdevDeps(List<String> devDeps)(experimental) List of dev dependencies for this project.Cdk8sPythonApp.Buildergithub(Boolean github)(experimental) Enable GitHub integration.Cdk8sPythonApp.BuildergithubOptions(GitHubOptions githubOptions)(experimental) Options for GitHub integration.Cdk8sPythonApp.BuildergitIgnoreOptions(IgnoreFileOptions gitIgnoreOptions)(experimental) Configuration options for .gitignore file.Cdk8sPythonApp.BuildergitOptions(GitOptions gitOptions)(experimental) Configuration options for git.Cdk8sPythonApp.Buildergitpod(Boolean gitpod)(experimental) Add a Gitpod development environment.Cdk8sPythonApp.Builderhomepage(String homepage)(experimental) A URL to the website of the project.Cdk8sPythonApp.Builderk8SMinorVersion(Number k8SMinorVersion)(experimental) The cdk8s-plus library depends of Kubernetes minor version For example, cdk8s-plus-22 targets kubernetes version 1.22.0 cdk8s-plus-21 targets kubernetes version 1.21.0.Cdk8sPythonApp.Builderk8SSpecVersion(String k8SSpecVersion)(experimental) Import a specific Kubernetes spec version.Cdk8sPythonApp.Builderlicense(String license)(experimental) License of this package as an SPDX identifier.Cdk8sPythonApp.Builderlogging(LoggerOptions logging)(experimental) Configure logging options such as verbosity.Cdk8sPythonApp.Buildermergify(Boolean mergify)Deprecated.usegithubOptions.mergifyinsteadCdk8sPythonApp.BuildermergifyOptions(MergifyOptions mergifyOptions)Deprecated.usegithubOptions.mergifyOptionsinsteadCdk8sPythonApp.BuildermoduleName(String moduleName)(experimental) Name of the python package as used in imports and filenames.Cdk8sPythonApp.Buildername(String name)(experimental) This is the name of your project.Cdk8sPythonApp.Builderoutdir(String outdir)(experimental) The root directory of the project.Cdk8sPythonApp.BuilderpackageName(String packageName)(experimental) Package name.Cdk8sPythonApp.Builderparent(Project parent)(experimental) The parent project, if this project is part of a bigger project.Cdk8sPythonApp.Builderpip(Boolean pip)(experimental) Use pip with a requirements.txt file to track project dependencies.Cdk8sPythonApp.Builderpoetry(Boolean poetry)(experimental) Use poetry to manage your project dependencies, virtual environment, and (optional) packaging/publishing.Cdk8sPythonApp.BuilderpoetryOptions(PoetryPyprojectOptionsWithoutDeps poetryOptions)(experimental) Additional options to set for poetry if using poetry.Cdk8sPythonApp.BuilderprojectType(ProjectType projectType)Deprecated.no longer supported at the base project levelCdk8sPythonApp.BuilderprojenCommand(String projenCommand)(experimental) The shell command to use in order to run the projen CLI.Cdk8sPythonApp.BuilderprojenCredentials(GithubCredentials projenCredentials)(experimental) Choose a method of providing GitHub API access for projen workflows.Cdk8sPythonApp.BuilderprojenrcJs(Boolean projenrcJs)(experimental) Use projenrc in javascript.Cdk8sPythonApp.BuilderprojenrcJson(Boolean projenrcJson)(experimental) Generate (once) .projenrc.json (in JSON).Cdk8sPythonApp.BuilderprojenrcJsonOptions(ProjenrcJsonOptions projenrcJsonOptions)(experimental) Options for .projenrc.json.Cdk8sPythonApp.BuilderprojenrcJsOptions(ProjenrcOptions projenrcJsOptions)(experimental) Options related to projenrc in JavaScript.Cdk8sPythonApp.BuilderprojenrcPython(Boolean projenrcPython)(experimental) Use projenrc in Python.Cdk8sPythonApp.BuilderprojenrcPythonOptions(ProjenrcOptions projenrcPythonOptions)(experimental) Options related to projenrc in python.Cdk8sPythonApp.BuilderprojenrcTs(Boolean projenrcTs)(experimental) Use projenrc in TypeScript.Cdk8sPythonApp.BuilderprojenrcTsOptions(ProjenrcTsOptions projenrcTsOptions)(experimental) Options related to projenrc in TypeScript.Cdk8sPythonApp.BuilderprojenTokenSecret(String projenTokenSecret)Deprecated.useprojenCredentialsCdk8sPythonApp.Builderpytest(Boolean pytest)(experimental) Include pytest tests.Cdk8sPythonApp.BuilderpytestOptions(PytestOptions pytestOptions)(experimental) pytest options.Cdk8sPythonApp.BuilderpythonExec(String pythonExec)(experimental) Path to the python executable to use.Cdk8sPythonApp.Builderreadme(SampleReadmeProps readme)(experimental) The README setup.Cdk8sPythonApp.Builderrenovatebot(Boolean renovatebot)(experimental) Use renovatebot to handle dependency upgrades.Cdk8sPythonApp.BuilderrenovatebotOptions(RenovatebotOptions renovatebotOptions)(experimental) Options for renovatebot.Cdk8sPythonApp.Buildersample(Boolean sample)(experimental) Include sample code and test if the relevant directories don't exist.Cdk8sPythonApp.BuildersetupConfig(Map<String,? extends Object> setupConfig)(experimental) Additional fields to pass in the setup() function if using setuptools.Cdk8sPythonApp.Buildersetuptools(Boolean setuptools)(experimental) Use setuptools with a setup.py script for packaging and publishing.Cdk8sPythonApp.Builderstale(Boolean stale)(experimental) Auto-close of stale issues and pull request.Cdk8sPythonApp.BuilderstaleOptions(StaleOptions staleOptions)(experimental) Auto-close stale issues and pull requests.Cdk8sPythonApp.Buildervenv(Boolean venv)(experimental) Use venv to manage a virtual environment for installing dependencies inside.Cdk8sPythonApp.BuildervenvOptions(VenvOptions venvOptions)(experimental) Venv options.Cdk8sPythonApp.Builderversion(String version)(experimental) Version of the package.Cdk8sPythonApp.Buildervscode(Boolean vscode)(experimental) Enable VSCode integration.
-
-
-
Method Detail
-
create
@Stability(Experimental) public static Cdk8sPythonApp.Builder create()
- Returns:
- a new instance of
Cdk8sPythonApp.Builder.
-
name
@Stability(Experimental) public Cdk8sPythonApp.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 Cdk8sPythonApp.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 Cdk8sPythonApp.Builder gitIgnoreOptions(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 Cdk8sPythonApp.Builder gitOptions(GitOptions gitOptions)
(experimental) Configuration options for git.- Parameters:
gitOptions- Configuration options for git. This parameter is required.- Returns:
this
-
logging
@Stability(Experimental) public Cdk8sPythonApp.Builder logging(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 Cdk8sPythonApp.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 subprojects.
Default: "."
- Parameters:
outdir- The root directory of the project. This parameter is required.- Returns:
this
-
parent
@Stability(Experimental) public Cdk8sPythonApp.Builder parent(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 Cdk8sPythonApp.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 Cdk8sPythonApp.Builder projenrcJson(Boolean projenrcJson)
(experimental) Generate (once) .projenrc.json (in JSON). Set tofalsein order to disable .projenrc.json generation.Default: false
- Parameters:
projenrcJson- Generate (once) .projenrc.json (in JSON). Set tofalsein order to disable .projenrc.json generation. This parameter is required.- Returns:
this
-
projenrcJsonOptions
@Stability(Experimental) public Cdk8sPythonApp.Builder projenrcJsonOptions(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 Cdk8sPythonApp.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 Cdk8sPythonApp.Builder renovatebotOptions(RenovatebotOptions renovatebotOptions)
(experimental) Options for renovatebot.Default: - default options
- Parameters:
renovatebotOptions- Options for renovatebot. This parameter is required.- Returns:
this
-
autoApproveOptions
@Stability(Experimental) public Cdk8sPythonApp.Builder autoApproveOptions(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 Cdk8sPythonApp.Builder autoMerge(Boolean autoMerge)
(experimental) Enable automatic merging on GitHub.Has no effect if
github.mergifyis set to false.Default: true
- Parameters:
autoMerge- Enable automatic merging on GitHub. This parameter is required.- Returns:
this
-
autoMergeOptions
@Stability(Experimental) public Cdk8sPythonApp.Builder autoMergeOptions(AutoMergeOptions autoMergeOptions)
(experimental) Configure options for automatic merging on GitHub.Has no effect if
github.mergifyorautoMergeis 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 Cdk8sPythonApp.Builder clobber(Boolean clobber)
(experimental) Add aclobbertask which resets the repo to origin.Default: - true, but false for subprojects
- Parameters:
clobber- Add aclobbertask which resets the repo to origin. This parameter is required.- Returns:
this
-
devContainer
@Stability(Experimental) public Cdk8sPythonApp.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 Cdk8sPythonApp.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 Cdk8sPythonApp.Builder githubOptions(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 Cdk8sPythonApp.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 Cdk8sPythonApp.Builder mergify(Boolean mergify)
Deprecated.usegithubOptions.mergifyinstead(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 Cdk8sPythonApp.Builder mergifyOptions(MergifyOptions mergifyOptions)
Deprecated.usegithubOptions.mergifyOptionsinstead(deprecated) Options for mergify.Default: - default options
- Parameters:
mergifyOptions- Options for mergify. This parameter is required.- Returns:
this
-
projectType
@Stability(Deprecated) @Deprecated public Cdk8sPythonApp.Builder projectType(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 Cdk8sPythonApp.Builder projenCredentials(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 Cdk8sPythonApp.Builder projenTokenSecret(String projenTokenSecret)
Deprecated.useprojenCredentials(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,workflowsandpackagesscope.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 Cdk8sPythonApp.Builder readme(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 Cdk8sPythonApp.Builder stale(Boolean stale)
(experimental) Auto-close of stale issues and pull request.See
staleOptionsfor options.Default: false
- Parameters:
stale- Auto-close of stale issues and pull request. This parameter is required.- Returns:
this
-
staleOptions
@Stability(Experimental) public Cdk8sPythonApp.Builder staleOptions(StaleOptions staleOptions)
(experimental) Auto-close stale issues and pull requests.To disable set
staletofalse.Default: - see defaults in `StaleOptions`
- Parameters:
staleOptions- Auto-close stale issues and pull requests. This parameter is required.- Returns:
this
-
vscode
@Stability(Experimental) public Cdk8sPythonApp.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 Cdk8sPythonApp.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 Cdk8sPythonApp.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 Cdk8sPythonApp.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 Cdk8sPythonApp.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 Cdk8sPythonApp.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 Cdk8sPythonApp.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 Cdk8sPythonApp.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 Cdk8sPythonApp.Builder packageName(String packageName)
(experimental) Package name.- Parameters:
packageName- Package name. This parameter is required.- Returns:
this
-
poetryOptions
@Stability(Experimental) public Cdk8sPythonApp.Builder poetryOptions(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 Cdk8sPythonApp.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
-
pythonExec
@Stability(Experimental) public Cdk8sPythonApp.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
-
moduleName
@Stability(Experimental) public Cdk8sPythonApp.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 Cdk8sPythonApp.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 Cdk8sPythonApp.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 Cdk8sPythonApp.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 Cdk8sPythonApp.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 tofalse.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 Cdk8sPythonApp.Builder projenrcJs(Boolean projenrcJs)
(experimental) Use projenrc in javascript.This will install
projenas a JavaScript dependency and add asynthtask which will run.projenrc.js.Default: false
- Parameters:
projenrcJs- Use projenrc in javascript. This parameter is required.- Returns:
this
-
projenrcJsOptions
@Stability(Experimental) public Cdk8sPythonApp.Builder projenrcJsOptions(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 Cdk8sPythonApp.Builder projenrcPython(Boolean projenrcPython)
(experimental) Use projenrc in Python.This will install
projenas a Python dependency and add asynthtask which will run.projenrc.py.Default: true
- Parameters:
projenrcPython- Use projenrc in Python. This parameter is required.- Returns:
this
-
projenrcPythonOptions
@Stability(Experimental) public Cdk8sPythonApp.Builder projenrcPythonOptions(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 Cdk8sPythonApp.Builder projenrcTs(Boolean projenrcTs)
(experimental) Use projenrc in TypeScript.This will create a tsconfig file (default:
tsconfig.projen.json) and usets-nodein 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 Cdk8sPythonApp.Builder projenrcTsOptions(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 Cdk8sPythonApp.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 Cdk8sPythonApp.Builder pytestOptions(PytestOptions pytestOptions)
(experimental) pytest options.Default: - defaults
- Parameters:
pytestOptions- pytest options. This parameter is required.- Returns:
this
-
sample
@Stability(Experimental) public Cdk8sPythonApp.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 Cdk8sPythonApp.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 Cdk8sPythonApp.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 Cdk8sPythonApp.Builder venvOptions(VenvOptions venvOptions)
(experimental) Venv options.Default: - defaults
- Parameters:
venvOptions- Venv options. This parameter is required.- Returns:
this
-
cdk8SVersion
@Stability(Experimental) public Cdk8sPythonApp.Builder cdk8SVersion(String cdk8SVersion)
(experimental) Minimum version of the cdk8s to depend on.Default: "2.3.33"
- Parameters:
cdk8SVersion- Minimum version of the cdk8s to depend on. This parameter is required.- Returns:
this
-
cdk8SCliVersion
@Stability(Experimental) public Cdk8sPythonApp.Builder cdk8SCliVersion(String cdk8SCliVersion)
(experimental) Minimum version of the cdk8s-cli to depend on.Default: "2.0.28"
- Parameters:
cdk8SCliVersion- Minimum version of the cdk8s-cli to depend on. This parameter is required.- Returns:
this
-
cdk8SCliVersionPinning
@Stability(Experimental) public Cdk8sPythonApp.Builder cdk8SCliVersionPinning(Boolean cdk8SCliVersionPinning)
(experimental) Use pinned version instead of caret version for cdk8s-cli.You can use this to prevent yarn to mix versions for your CDK8s package and to prevent auto-updates. If you use experimental features this will let you define the moment you include breaking changes.
Default: false
- Parameters:
cdk8SCliVersionPinning- Use pinned version instead of caret version for cdk8s-cli. This parameter is required.- Returns:
this
-
cdk8SPlus
@Stability(Experimental) public Cdk8sPythonApp.Builder cdk8SPlus(Boolean cdk8SPlus)
(experimental) Include cdk8s-plus.Default: true
- Parameters:
cdk8SPlus- Include cdk8s-plus. This parameter is required.- Returns:
this
-
cdk8SPlusVersion
@Stability(Experimental) public Cdk8sPythonApp.Builder cdk8SPlusVersion(String cdk8SPlusVersion)
(experimental) Minimum version of the cdk8s-plus-XX to depend on.Default: "2.0.0-rc.26"
- Parameters:
cdk8SPlusVersion- Minimum version of the cdk8s-plus-XX to depend on. This parameter is required.- Returns:
this
-
cdk8SPlusVersionPinning
@Stability(Experimental) public Cdk8sPythonApp.Builder cdk8SPlusVersionPinning(Boolean cdk8SPlusVersionPinning)
(experimental) Use pinned version instead of caret version for cdk8s-plus-17.You can use this to prevent yarn to mix versions for your CDK8s package and to prevent auto-updates. If you use experimental features this will let you define the moment you include breaking changes.
Default: false
- Parameters:
cdk8SPlusVersionPinning- Use pinned version instead of caret version for cdk8s-plus-17. This parameter is required.- Returns:
this
-
cdk8SVersionPinning
@Stability(Experimental) public Cdk8sPythonApp.Builder cdk8SVersionPinning(Boolean cdk8SVersionPinning)
(experimental) Use pinned version instead of caret version for cdk8s.You can use this to prevent yarn to mix versions for your CDK8s package and to prevent auto-updates. If you use experimental features this will let you define the moment you include breaking changes.
Default: false
- Parameters:
cdk8SVersionPinning- Use pinned version instead of caret version for cdk8s. This parameter is required.- Returns:
this
-
constructsVersion
@Stability(Experimental) public Cdk8sPythonApp.Builder constructsVersion(String constructsVersion)
(experimental) Minimum version of theconstructslibrary to depend on.Default: "10.1.42"
- Parameters:
constructsVersion- Minimum version of theconstructslibrary to depend on. This parameter is required.- Returns:
this
-
constructsVersionPinning
@Stability(Experimental) public Cdk8sPythonApp.Builder constructsVersionPinning(Boolean constructsVersionPinning)
(experimental) Use pinned version instead of caret version for constructs.You can use this to prevent yarn to mix versions for your consructs package and to prevent auto-updates. If you use experimental features this will let you define the moment you include breaking changes.
Default: false
- Parameters:
constructsVersionPinning- Use pinned version instead of caret version for constructs. This parameter is required.- Returns:
this
-
k8SMinorVersion
@Stability(Experimental) public Cdk8sPythonApp.Builder k8SMinorVersion(Number k8SMinorVersion)
(experimental) The cdk8s-plus library depends of Kubernetes minor version For example, cdk8s-plus-22 targets kubernetes version 1.22.0 cdk8s-plus-21 targets kubernetes version 1.21.0.Default: 22
- Parameters:
k8SMinorVersion- The cdk8s-plus library depends of Kubernetes minor version For example, cdk8s-plus-22 targets kubernetes version 1.22.0 cdk8s-plus-21 targets kubernetes version 1.21.0. This parameter is required.- Returns:
this
-
appEntrypoint
@Stability(Experimental) public Cdk8sPythonApp.Builder appEntrypoint(String appEntrypoint)
(experimental) The CDK8s app's entrypoint.Default: "app.py"
- Parameters:
appEntrypoint- The CDK8s app's entrypoint. This parameter is required.- Returns:
this
-
cdk8SImports
@Stability(Experimental) public Cdk8sPythonApp.Builder cdk8SImports(List<String> cdk8SImports)
(experimental) Import additional specs.Default: - no additional specs imported
- Parameters:
cdk8SImports- Import additional specs. This parameter is required.- Returns:
this
-
k8SSpecVersion
@Stability(Experimental) public Cdk8sPythonApp.Builder k8SSpecVersion(String k8SSpecVersion)
(experimental) Import a specific Kubernetes spec version.Default: - Use the cdk8s default
- Parameters:
k8SSpecVersion- Import a specific Kubernetes spec version. This parameter is required.- Returns:
this
-
build
@Stability(Experimental) public Cdk8sPythonApp build()
- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<Cdk8sPythonApp>- Returns:
- a newly built instance of
Cdk8sPythonApp.
-
-