Package io.github.cdklabs.projen.cdk8s

Class Cdk8sPythonOptions.Builder

java.lang.Object

io.github.cdklabs.projen.cdk8s.Cdk8sPythonOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<Cdk8sPythonOptions>

Enclosing interface:

Cdk8sPythonOptions

@Stability(Experimental)
public static final class Cdk8sPythonOptions.Builder
extends Object
implements software.amazon.jsii.Builder<Cdk8sPythonOptions>

A builder for Cdk8sPythonOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
Cdk8sPythonOptions.Builder	appEntrypoint(String appEntrypoint)	Sets the value of Cdk8sPythonOptions.getAppEntrypoint()
Cdk8sPythonOptions.Builder	authorEmail(String authorEmail)	Sets the value of PythonPackagingOptions.getAuthorEmail()
Cdk8sPythonOptions.Builder	authorName(String authorName)	Sets the value of PythonPackagingOptions.getAuthorName()
Cdk8sPythonOptions.Builder	autoApproveOptions(AutoApproveOptions autoApproveOptions)	Sets the value of GitHubProjectOptions.getAutoApproveOptions()
Cdk8sPythonOptions.Builder	autoMerge(Boolean autoMerge)	Sets the value of GitHubProjectOptions.getAutoMerge()
Cdk8sPythonOptions.Builder	autoMergeOptions(AutoMergeOptions autoMergeOptions)	Sets the value of GitHubProjectOptions.getAutoMergeOptions()
Cdk8sPythonOptions	build()	Builds the configured instance.
Cdk8sPythonOptions.Builder	cdk8SCliVersion(String cdk8SCliVersion)	Sets the value of Cdk8sPythonOptions#getCdk8SCliVersion
Cdk8sPythonOptions.Builder	cdk8SCliVersionPinning(Boolean cdk8SCliVersionPinning)	Sets the value of Cdk8sPythonOptions#getCdk8SCliVersionPinning
Cdk8sPythonOptions.Builder	cdk8SImports(List<String> cdk8SImports)	Sets the value of Cdk8sPythonOptions#getCdk8SImports
Cdk8sPythonOptions.Builder	cdk8SPlus(Boolean cdk8SPlus)	Sets the value of Cdk8sPythonOptions#getCdk8SPlus
Cdk8sPythonOptions.Builder	cdk8SPlusVersion(String cdk8SPlusVersion)	Sets the value of Cdk8sPythonOptions#getCdk8SPlusVersion
Cdk8sPythonOptions.Builder	cdk8SPlusVersionPinning(Boolean cdk8SPlusVersionPinning)	Sets the value of Cdk8sPythonOptions#getCdk8SPlusVersionPinning
Cdk8sPythonOptions.Builder	cdk8SVersion(String cdk8SVersion)	Sets the value of Cdk8sPythonOptions#getCdk8SVersion
Cdk8sPythonOptions.Builder	cdk8SVersionPinning(Boolean cdk8SVersionPinning)	Sets the value of Cdk8sPythonOptions#getCdk8SVersionPinning
Cdk8sPythonOptions.Builder	classifiers(List<String> classifiers)	Sets the value of PythonPackagingOptions.getClassifiers()
Cdk8sPythonOptions.Builder	clobber(Boolean clobber)	Sets the value of GitHubProjectOptions.getClobber()
Cdk8sPythonOptions.Builder	commitGenerated(Boolean commitGenerated)	Sets the value of ProjectOptions.getCommitGenerated()
Cdk8sPythonOptions.Builder	constructsVersion(String constructsVersion)	Sets the value of Cdk8sDepsCommonOptions.getConstructsVersion()
Cdk8sPythonOptions.Builder	constructsVersionPinning(Boolean constructsVersionPinning)	Sets the value of Cdk8sDepsCommonOptions.getConstructsVersionPinning()
Cdk8sPythonOptions.Builder	deps(List<String> deps)	Sets the value of PythonProjectOptions.getDeps()
Cdk8sPythonOptions.Builder	description(String description)	Sets the value of PythonPackagingOptions.getDescription()
Cdk8sPythonOptions.Builder	devContainer(Boolean devContainer)	Sets the value of GitHubProjectOptions.getDevContainer()
Cdk8sPythonOptions.Builder	devDeps(List<String> devDeps)	Sets the value of PythonProjectOptions.getDevDeps()
Cdk8sPythonOptions.Builder	github(Boolean github)	Sets the value of GitHubProjectOptions.getGithub()
Cdk8sPythonOptions.Builder	githubOptions(GitHubOptions githubOptions)	Sets the value of GitHubProjectOptions.getGithubOptions()
Cdk8sPythonOptions.Builder	gitIgnoreOptions(IgnoreFileOptions gitIgnoreOptions)	Sets the value of ProjectOptions.getGitIgnoreOptions()
Cdk8sPythonOptions.Builder	gitOptions(GitOptions gitOptions)	Sets the value of ProjectOptions.getGitOptions()
Cdk8sPythonOptions.Builder	gitpod(Boolean gitpod)	Sets the value of GitHubProjectOptions.getGitpod()
Cdk8sPythonOptions.Builder	homepage(String homepage)	Sets the value of PythonPackagingOptions.getHomepage()
Cdk8sPythonOptions.Builder	k8SMinorVersion(Number k8SMinorVersion)	Sets the value of Cdk8sPythonOptions#getK8SMinorVersion
Cdk8sPythonOptions.Builder	k8SSpecVersion(String k8SSpecVersion)	Sets the value of Cdk8sPythonOptions#getK8SSpecVersion
Cdk8sPythonOptions.Builder	license(String license)	Sets the value of PythonPackagingOptions.getLicense()
Cdk8sPythonOptions.Builder	logging(LoggerOptions logging)	Sets the value of ProjectOptions.getLogging()
Cdk8sPythonOptions.Builder	mergify(Boolean mergify)	Deprecated. use `githubOptions.mergify` instead
Cdk8sPythonOptions.Builder	mergifyOptions(MergifyOptions mergifyOptions)	Deprecated. use `githubOptions.mergifyOptions` instead
Cdk8sPythonOptions.Builder	moduleName(String moduleName)	Sets the value of PythonProjectOptions.getModuleName()
Cdk8sPythonOptions.Builder	name(String name)	Sets the value of ProjectOptions.getName()
Cdk8sPythonOptions.Builder	outdir(String outdir)	Sets the value of ProjectOptions.getOutdir()
Cdk8sPythonOptions.Builder	packageName(String packageName)	Sets the value of PythonPackagingOptions.getPackageName()
Cdk8sPythonOptions.Builder	parent(Project parent)	Sets the value of ProjectOptions.getParent()
Cdk8sPythonOptions.Builder	pip(Boolean pip)	Sets the value of PythonProjectOptions.getPip()
Cdk8sPythonOptions.Builder	poetry(Boolean poetry)	Sets the value of PythonProjectOptions.getPoetry()
Cdk8sPythonOptions.Builder	poetryOptions(PoetryPyprojectOptionsWithoutDeps poetryOptions)	Sets the value of PythonPackagingOptions.getPoetryOptions()
Cdk8sPythonOptions.Builder	projectType(ProjectType projectType)	Deprecated. no longer supported at the base project level
Cdk8sPythonOptions.Builder	projenCommand(String projenCommand)	Sets the value of ProjectOptions.getProjenCommand()
Cdk8sPythonOptions.Builder	projenCredentials(GithubCredentials projenCredentials)	Sets the value of GitHubProjectOptions.getProjenCredentials()
Cdk8sPythonOptions.Builder	projenrcJs(Boolean projenrcJs)	Sets the value of PythonProjectOptions.getProjenrcJs()
Cdk8sPythonOptions.Builder	projenrcJson(Boolean projenrcJson)	Sets the value of ProjectOptions.getProjenrcJson()
Cdk8sPythonOptions.Builder	projenrcJsonOptions(ProjenrcJsonOptions projenrcJsonOptions)	Sets the value of ProjectOptions.getProjenrcJsonOptions()
Cdk8sPythonOptions.Builder	projenrcJsOptions(ProjenrcOptions projenrcJsOptions)	Sets the value of PythonProjectOptions.getProjenrcJsOptions()
Cdk8sPythonOptions.Builder	projenrcPython(Boolean projenrcPython)	Sets the value of PythonProjectOptions.getProjenrcPython()
Cdk8sPythonOptions.Builder	projenrcPythonOptions(ProjenrcOptions projenrcPythonOptions)	Sets the value of PythonProjectOptions.getProjenrcPythonOptions()
Cdk8sPythonOptions.Builder	projenrcTs(Boolean projenrcTs)	Sets the value of PythonProjectOptions.getProjenrcTs()
Cdk8sPythonOptions.Builder	projenrcTsOptions(ProjenrcTsOptions projenrcTsOptions)	Sets the value of PythonProjectOptions.getProjenrcTsOptions()
Cdk8sPythonOptions.Builder	projenTokenSecret(String projenTokenSecret)	Deprecated. use `projenCredentials`
Cdk8sPythonOptions.Builder	pytest(Boolean pytest)	Sets the value of PythonProjectOptions.getPytest()
Cdk8sPythonOptions.Builder	pytestOptions(PytestOptions pytestOptions)	Sets the value of PythonProjectOptions.getPytestOptions()
Cdk8sPythonOptions.Builder	pythonExec(String pythonExec)	Sets the value of PythonExecutableOptions.getPythonExec()
Cdk8sPythonOptions.Builder	readme(SampleReadmeProps readme)	Sets the value of GitHubProjectOptions.getReadme()
Cdk8sPythonOptions.Builder	renovatebot(Boolean renovatebot)	Sets the value of ProjectOptions.getRenovatebot()
Cdk8sPythonOptions.Builder	renovatebotOptions(RenovatebotOptions renovatebotOptions)	Sets the value of ProjectOptions.getRenovatebotOptions()
Cdk8sPythonOptions.Builder	sample(Boolean sample)	Sets the value of PythonProjectOptions.getSample()
Cdk8sPythonOptions.Builder	setupConfig(Map<String,? extends Object> setupConfig)	Sets the value of PythonPackagingOptions.getSetupConfig()
Cdk8sPythonOptions.Builder	setuptools(Boolean setuptools)	Sets the value of PythonProjectOptions.getSetuptools()
Cdk8sPythonOptions.Builder	stale(Boolean stale)	Sets the value of GitHubProjectOptions.getStale()
Cdk8sPythonOptions.Builder	staleOptions(StaleOptions staleOptions)	Sets the value of GitHubProjectOptions.getStaleOptions()
Cdk8sPythonOptions.Builder	venv(Boolean venv)	Sets the value of PythonProjectOptions.getVenv()
Cdk8sPythonOptions.Builder	venvOptions(VenvOptions venvOptions)	Sets the value of PythonProjectOptions.getVenvOptions()
Cdk8sPythonOptions.Builder	version(String version)	Sets the value of PythonPackagingOptions.getVersion()
Cdk8sPythonOptions.Builder	vscode(Boolean vscode)	Sets the value of GitHubProjectOptions.getVscode()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

appEntrypoint

@Stability(Experimental)
public Cdk8sPythonOptions.Builder appEntrypoint(String appEntrypoint)

Sets the value of Cdk8sPythonOptions.getAppEntrypoint()

Parameters:

appEntrypoint - The CDK8s app's entrypoint.

Returns:

this

cdk8SImports

@Stability(Experimental)
public Cdk8sPythonOptions.Builder cdk8SImports(List<String> cdk8SImports)

Sets the value of Cdk8sPythonOptions#getCdk8SImports

Parameters:

cdk8SImports - Import additional specs.

Returns:

this

k8SSpecVersion

@Stability(Experimental)
public Cdk8sPythonOptions.Builder k8SSpecVersion(String k8SSpecVersion)

Sets the value of Cdk8sPythonOptions#getK8SSpecVersion

Parameters:

k8SSpecVersion - Import a specific Kubernetes spec version.

Returns:

this

moduleName

@Stability(Experimental)
public Cdk8sPythonOptions.Builder moduleName(String moduleName)

Sets the value of PythonProjectOptions.getModuleName()

Parameters:

moduleName - Name of the python package as used in imports and filenames. This parameter is required. Must only consist of alphanumeric characters and underscores.

Returns:

this

deps

@Stability(Experimental)
public Cdk8sPythonOptions.Builder deps(List<String> deps)

Sets the value of PythonProjectOptions.getDeps()

Parameters:

deps - List of runtime dependencies for this project. Dependencies use the format: <module>@<semver>

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

Returns:

this

devDeps

@Stability(Experimental)
public Cdk8sPythonOptions.Builder devDeps(List<String> devDeps)

Sets the value of PythonProjectOptions.getDevDeps()

Parameters:

devDeps - List of dev dependencies for this project. Dependencies use the format: <module>@<semver>

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

Returns:

this

pip

@Stability(Experimental)
public Cdk8sPythonOptions.Builder pip(Boolean pip)

Sets the value of PythonProjectOptions.getPip()

Parameters:

pip - Use pip with a requirements.txt file to track project dependencies.

Returns:

this

poetry

@Stability(Experimental)
public Cdk8sPythonOptions.Builder poetry(Boolean poetry)

Sets the value of PythonProjectOptions.getPoetry()

Parameters:

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

Returns:

this

projenrcJs

@Stability(Experimental)
public Cdk8sPythonOptions.Builder projenrcJs(Boolean projenrcJs)

Sets the value of PythonProjectOptions.getProjenrcJs()

Parameters:

projenrcJs - Use projenrc in javascript. This will install projen as a JavaScript dependency and add a synth task which will run .projenrc.js.

Returns:

this

projenrcJsOptions

@Stability(Experimental)
public Cdk8sPythonOptions.Builder projenrcJsOptions(ProjenrcOptions projenrcJsOptions)

Sets the value of PythonProjectOptions.getProjenrcJsOptions()

Parameters:

projenrcJsOptions - Options related to projenrc in JavaScript.

Returns:

this

projenrcPython

@Stability(Experimental)
public Cdk8sPythonOptions.Builder projenrcPython(Boolean projenrcPython)

Sets the value of PythonProjectOptions.getProjenrcPython()

Parameters:

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

Returns:

this

projenrcPythonOptions

@Stability(Experimental)
public Cdk8sPythonOptions.Builder projenrcPythonOptions(ProjenrcOptions projenrcPythonOptions)

Sets the value of PythonProjectOptions.getProjenrcPythonOptions()

Parameters:

projenrcPythonOptions - Options related to projenrc in python.

Returns:

this

projenrcTs

@Stability(Experimental)
public Cdk8sPythonOptions.Builder projenrcTs(Boolean projenrcTs)

Sets the value of PythonProjectOptions.getProjenrcTs()

Parameters:

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

Returns:

this

projenrcTsOptions

@Stability(Experimental)
public Cdk8sPythonOptions.Builder projenrcTsOptions(ProjenrcTsOptions projenrcTsOptions)

Sets the value of PythonProjectOptions.getProjenrcTsOptions()

Parameters:

projenrcTsOptions - Options related to projenrc in TypeScript.

Returns:

this

pytest

@Stability(Experimental)
public Cdk8sPythonOptions.Builder pytest(Boolean pytest)

Sets the value of PythonProjectOptions.getPytest()

Parameters:

pytest - Include pytest tests.

Returns:

this

pytestOptions

@Stability(Experimental)
public Cdk8sPythonOptions.Builder pytestOptions(PytestOptions pytestOptions)

Sets the value of PythonProjectOptions.getPytestOptions()

Parameters:

pytestOptions - pytest options.

Returns:

this

sample

@Stability(Experimental)
public Cdk8sPythonOptions.Builder sample(Boolean sample)

Sets the value of PythonProjectOptions.getSample()

Parameters:

sample - Include sample code and test if the relevant directories don't exist.

Returns:

this

setuptools

@Stability(Experimental)
public Cdk8sPythonOptions.Builder setuptools(Boolean setuptools)

Sets the value of PythonProjectOptions.getSetuptools()

Parameters:

setuptools - Use setuptools with a setup.py script for packaging and publishing.

Returns:

this

venv

@Stability(Experimental)
public Cdk8sPythonOptions.Builder venv(Boolean venv)

Sets the value of PythonProjectOptions.getVenv()

Parameters:

venv - Use venv to manage a virtual environment for installing dependencies inside.

Returns:

this

venvOptions

@Stability(Experimental)
public Cdk8sPythonOptions.Builder venvOptions(VenvOptions venvOptions)

Sets the value of PythonProjectOptions.getVenvOptions()

Parameters:

venvOptions - Venv options.

Returns:

this

autoApproveOptions

@Stability(Experimental)
public Cdk8sPythonOptions.Builder autoApproveOptions(AutoApproveOptions autoApproveOptions)

Sets the value of GitHubProjectOptions.getAutoApproveOptions()

Parameters:

autoApproveOptions - Enable and configure the 'auto approve' workflow.

Returns:

this

autoMerge

@Stability(Experimental)
public Cdk8sPythonOptions.Builder autoMerge(Boolean autoMerge)

Sets the value of GitHubProjectOptions.getAutoMerge()

Parameters:

autoMerge - Enable automatic merging on GitHub. Has no effect if github.mergify is set to false.

Returns:

this

autoMergeOptions

@Stability(Experimental)
public Cdk8sPythonOptions.Builder autoMergeOptions(AutoMergeOptions autoMergeOptions)

Sets the value of GitHubProjectOptions.getAutoMergeOptions()

Parameters:

autoMergeOptions - Configure options for automatic merging on GitHub. Has no effect if github.mergify or autoMerge is set to false.

Returns:

this

clobber

@Stability(Experimental)
public Cdk8sPythonOptions.Builder clobber(Boolean clobber)

Sets the value of GitHubProjectOptions.getClobber()

Parameters:

clobber - Add a clobber task which resets the repo to origin.

Returns:

this

devContainer

@Stability(Experimental)
public Cdk8sPythonOptions.Builder devContainer(Boolean devContainer)

Sets the value of GitHubProjectOptions.getDevContainer()

Parameters:

devContainer - Add a VSCode development environment (used for GitHub Codespaces).

Returns:

this

github

@Stability(Experimental)
public Cdk8sPythonOptions.Builder github(Boolean github)

Sets the value of GitHubProjectOptions.getGithub()

Parameters:

github - Enable GitHub integration. Enabled by default for root projects. Disabled for non-root projects.

Returns:

this

githubOptions

@Stability(Experimental)
public Cdk8sPythonOptions.Builder githubOptions(GitHubOptions githubOptions)

Sets the value of GitHubProjectOptions.getGithubOptions()

Parameters:

githubOptions - Options for GitHub integration.

Returns:

this

gitpod

@Stability(Experimental)
public Cdk8sPythonOptions.Builder gitpod(Boolean gitpod)

Sets the value of GitHubProjectOptions.getGitpod()

Parameters:

gitpod - Add a Gitpod development environment.

Returns:

this

mergify

@Stability(Deprecated)
@Deprecated
public Cdk8sPythonOptions.Builder mergify(Boolean mergify)

Deprecated.

use `githubOptions.mergify` instead

Sets the value of GitHubProjectOptions.getMergify()

Parameters:

mergify - Whether mergify should be enabled on this repository or not.

Returns:

this

mergifyOptions

@Stability(Deprecated)
@Deprecated
public Cdk8sPythonOptions.Builder mergifyOptions(MergifyOptions mergifyOptions)

Deprecated.

use `githubOptions.mergifyOptions` instead

Sets the value of GitHubProjectOptions.getMergifyOptions()

Parameters:

mergifyOptions - Options for mergify.

Returns:

this

projectType

@Stability(Deprecated)
@Deprecated
public Cdk8sPythonOptions.Builder projectType(ProjectType projectType)

Deprecated.

no longer supported at the base project level

Sets the value of GitHubProjectOptions.getProjectType()

Parameters:

projectType - Which type of project this is (library/app).

Returns:

this

projenCredentials

@Stability(Experimental)
public Cdk8sPythonOptions.Builder projenCredentials(GithubCredentials projenCredentials)

Sets the value of GitHubProjectOptions.getProjenCredentials()

Parameters:

projenCredentials - Choose a method of providing GitHub API access for projen workflows.

Returns:

this

projenTokenSecret

@Stability(Deprecated)
@Deprecated
public Cdk8sPythonOptions.Builder projenTokenSecret(String projenTokenSecret)

Deprecated.

use `projenCredentials`

Sets the value of GitHubProjectOptions.getProjenTokenSecret()

Parameters:

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

Returns:

this

readme

@Stability(Experimental)
public Cdk8sPythonOptions.Builder readme(SampleReadmeProps readme)

Sets the value of GitHubProjectOptions.getReadme()

Parameters:

readme - The README setup.

Returns:

this

stale

@Stability(Experimental)
public Cdk8sPythonOptions.Builder stale(Boolean stale)

Sets the value of GitHubProjectOptions.getStale()

Parameters:

stale - Auto-close of stale issues and pull request. See staleOptions for options.

Returns:

this

staleOptions

@Stability(Experimental)
public Cdk8sPythonOptions.Builder staleOptions(StaleOptions staleOptions)

Sets the value of GitHubProjectOptions.getStaleOptions()

Parameters:

staleOptions - Auto-close stale issues and pull requests. To disable set stale to false.

Returns:

this

vscode

@Stability(Experimental)
public Cdk8sPythonOptions.Builder vscode(Boolean vscode)

Sets the value of GitHubProjectOptions.getVscode()

Parameters:

vscode - Enable VSCode integration. Enabled by default for root projects. Disabled for non-root projects.

Returns:

this

name

@Stability(Experimental)
public Cdk8sPythonOptions.Builder name(String name)

Sets the value of ProjectOptions.getName()

Parameters:

name - This is the name of your project. This parameter is required.

Returns:

this

commitGenerated

@Stability(Experimental)
public Cdk8sPythonOptions.Builder commitGenerated(Boolean commitGenerated)

Sets the value of ProjectOptions.getCommitGenerated()

Parameters:

commitGenerated - Whether to commit the managed files by default.

Returns:

this

gitIgnoreOptions

@Stability(Experimental)
public Cdk8sPythonOptions.Builder gitIgnoreOptions(IgnoreFileOptions gitIgnoreOptions)

Sets the value of ProjectOptions.getGitIgnoreOptions()

Parameters:

gitIgnoreOptions - Configuration options for .gitignore file.

Returns:

this

gitOptions

@Stability(Experimental)
public Cdk8sPythonOptions.Builder gitOptions(GitOptions gitOptions)

Sets the value of ProjectOptions.getGitOptions()

Parameters:

gitOptions - Configuration options for git.

Returns:

this

logging

@Stability(Experimental)
public Cdk8sPythonOptions.Builder logging(LoggerOptions logging)

Sets the value of ProjectOptions.getLogging()

Parameters:

logging - Configure logging options such as verbosity.

Returns:

this

outdir

@Stability(Experimental)
public Cdk8sPythonOptions.Builder outdir(String outdir)

Sets the value of ProjectOptions.getOutdir()

Parameters:

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

Returns:

this

parent

@Stability(Experimental)
public Cdk8sPythonOptions.Builder parent(Project parent)

Sets the value of ProjectOptions.getParent()

Parameters:

parent - The parent project, if this project is part of a bigger project.

Returns:

this

projenCommand

@Stability(Experimental)
public Cdk8sPythonOptions.Builder projenCommand(String projenCommand)

Sets the value of ProjectOptions.getProjenCommand()

Parameters:

projenCommand - The shell command to use in order to run the projen CLI. Can be used to customize in special environments.

Returns:

this

projenrcJson

@Stability(Experimental)
public Cdk8sPythonOptions.Builder projenrcJson(Boolean projenrcJson)

Sets the value of ProjectOptions.getProjenrcJson()

Parameters:

projenrcJson - Generate (once) .projenrc.json (in JSON). Set to false in order to disable .projenrc.json generation.

Returns:

this

projenrcJsonOptions

@Stability(Experimental)
public Cdk8sPythonOptions.Builder projenrcJsonOptions(ProjenrcJsonOptions projenrcJsonOptions)

Sets the value of ProjectOptions.getProjenrcJsonOptions()

Parameters:

projenrcJsonOptions - Options for .projenrc.json.

Returns:

this

renovatebot

@Stability(Experimental)
public Cdk8sPythonOptions.Builder renovatebot(Boolean renovatebot)

Sets the value of ProjectOptions.getRenovatebot()

Parameters:

renovatebot - Use renovatebot to handle dependency upgrades.

Returns:

this

renovatebotOptions

@Stability(Experimental)
public Cdk8sPythonOptions.Builder renovatebotOptions(RenovatebotOptions renovatebotOptions)

Sets the value of ProjectOptions.getRenovatebotOptions()

Parameters:

renovatebotOptions - Options for renovatebot.

Returns:

this

authorEmail

@Stability(Experimental)
public Cdk8sPythonOptions.Builder authorEmail(String authorEmail)

Sets the value of PythonPackagingOptions.getAuthorEmail()

Parameters:

authorEmail - Author's e-mail. This parameter is required.

Returns:

this

authorName

@Stability(Experimental)
public Cdk8sPythonOptions.Builder authorName(String authorName)

Sets the value of PythonPackagingOptions.getAuthorName()

Parameters:

authorName - Author's name. This parameter is required.

Returns:

this

version

@Stability(Experimental)
public Cdk8sPythonOptions.Builder version(String version)

Sets the value of PythonPackagingOptions.getVersion()

Parameters:

version - Version of the package. This parameter is required.

Returns:

this

classifiers

@Stability(Experimental)
public Cdk8sPythonOptions.Builder classifiers(List<String> classifiers)

Sets the value of PythonPackagingOptions.getClassifiers()

Parameters:

classifiers - A list of PyPI trove classifiers that describe the project.

Returns:

this

description

@Stability(Experimental)
public Cdk8sPythonOptions.Builder description(String description)

Sets the value of PythonPackagingOptions.getDescription()

Parameters:

description - A short description of the package.

Returns:

this

homepage

@Stability(Experimental)
public Cdk8sPythonOptions.Builder homepage(String homepage)

Sets the value of PythonPackagingOptions.getHomepage()

Parameters:

homepage - A URL to the website of the project.

Returns:

this

license

@Stability(Experimental)
public Cdk8sPythonOptions.Builder license(String license)

Sets the value of PythonPackagingOptions.getLicense()

Parameters:

license - License of this package as an SPDX identifier.

Returns:

this

packageName

@Stability(Experimental)
public Cdk8sPythonOptions.Builder packageName(String packageName)

Sets the value of PythonPackagingOptions.getPackageName()

Parameters:

packageName - Package name.

Returns:

this

poetryOptions

@Stability(Experimental)
public Cdk8sPythonOptions.Builder poetryOptions(PoetryPyprojectOptionsWithoutDeps poetryOptions)

Sets the value of PythonPackagingOptions.getPoetryOptions()

Parameters:

poetryOptions - Additional options to set for poetry if using poetry.

Returns:

this

setupConfig

@Stability(Experimental)
public Cdk8sPythonOptions.Builder setupConfig(Map<String,? extends Object> setupConfig)

Sets the value of PythonPackagingOptions.getSetupConfig()

Parameters:

setupConfig - Additional fields to pass in the setup() function if using setuptools.

Returns:

this

pythonExec

@Stability(Experimental)
public Cdk8sPythonOptions.Builder pythonExec(String pythonExec)

Sets the value of PythonExecutableOptions.getPythonExec()

Parameters:

pythonExec - Path to the python executable to use.

Returns:

this

cdk8SVersion

@Stability(Experimental)
public Cdk8sPythonOptions.Builder cdk8SVersion(String cdk8SVersion)

Sets the value of Cdk8sPythonOptions#getCdk8SVersion

Parameters:

cdk8SVersion - Minimum version of the cdk8s to depend on. This parameter is required.

Returns:

this

cdk8SCliVersion

@Stability(Experimental)
public Cdk8sPythonOptions.Builder cdk8SCliVersion(String cdk8SCliVersion)

Sets the value of Cdk8sPythonOptions#getCdk8SCliVersion

Parameters:

cdk8SCliVersion - Minimum version of the cdk8s-cli to depend on.

Returns:

this

cdk8SCliVersionPinning

@Stability(Experimental)
public Cdk8sPythonOptions.Builder cdk8SCliVersionPinning(Boolean cdk8SCliVersionPinning)

Sets the value of Cdk8sPythonOptions#getCdk8SCliVersionPinning

Parameters:

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

Returns:

this

cdk8SPlus

@Stability(Experimental)
public Cdk8sPythonOptions.Builder cdk8SPlus(Boolean cdk8SPlus)

Sets the value of Cdk8sPythonOptions#getCdk8SPlus

Parameters:

cdk8SPlus - Include cdk8s-plus.

Returns:

this

cdk8SPlusVersion

@Stability(Experimental)
public Cdk8sPythonOptions.Builder cdk8SPlusVersion(String cdk8SPlusVersion)

Sets the value of Cdk8sPythonOptions#getCdk8SPlusVersion

Parameters:

cdk8SPlusVersion - Minimum version of the cdk8s-plus-XX to depend on.

Returns:

this

cdk8SPlusVersionPinning

@Stability(Experimental)
public Cdk8sPythonOptions.Builder cdk8SPlusVersionPinning(Boolean cdk8SPlusVersionPinning)

Sets the value of Cdk8sPythonOptions#getCdk8SPlusVersionPinning

Parameters:

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

Returns:

this

cdk8SVersionPinning

@Stability(Experimental)
public Cdk8sPythonOptions.Builder cdk8SVersionPinning(Boolean cdk8SVersionPinning)

Sets the value of Cdk8sPythonOptions#getCdk8SVersionPinning

Parameters:

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

Returns:

this

constructsVersion

@Stability(Experimental)
public Cdk8sPythonOptions.Builder constructsVersion(String constructsVersion)

Sets the value of Cdk8sDepsCommonOptions.getConstructsVersion()

Parameters:

constructsVersion - Minimum version of the constructs library to depend on.

Returns:

this

constructsVersionPinning

@Stability(Experimental)
public Cdk8sPythonOptions.Builder constructsVersionPinning(Boolean constructsVersionPinning)

Sets the value of Cdk8sDepsCommonOptions.getConstructsVersionPinning()

Parameters:

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

Returns:

this

k8SMinorVersion

@Stability(Experimental)
public Cdk8sPythonOptions.Builder k8SMinorVersion(Number k8SMinorVersion)

Sets the value of Cdk8sPythonOptions#getK8SMinorVersion

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.

Returns:

this

build

@Stability(Experimental)
public Cdk8sPythonOptions build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<Cdk8sPythonOptions>

Returns:

a new instance of Cdk8sPythonOptions

Throws:

NullPointerException - if any required attribute was not provided