Class AwsCdkPythonAppOptions.Jsii$Proxy
- java.lang.Object
-
- software.amazon.jsii.JsiiObject
-
- io.github.cdklabs.projen.awscdk.AwsCdkPythonAppOptions.Jsii$Proxy
-
- All Implemented Interfaces:
AwsCdkDepsCommonOptions,AwsCdkPythonAppOptions,CdkConfigCommonOptions,GitHubProjectOptions,ProjectOptions,PythonExecutableOptions,PythonPackagingOptions,PythonProjectOptions,software.amazon.jsii.JsiiSerializable
- Enclosing interface:
- AwsCdkPythonAppOptions
@Stability(Experimental) @Internal public static final class AwsCdkPythonAppOptions.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements AwsCdkPythonAppOptions
An implementation forAwsCdkPythonAppOptions
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
-
Nested classes/interfaces inherited from interface io.github.cdklabs.projen.awscdk.AwsCdkPythonAppOptions
AwsCdkPythonAppOptions.Builder, AwsCdkPythonAppOptions.Jsii$Proxy
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedJsii$Proxy(AwsCdkPythonAppOptions.Builder builder)Constructor that initializes the object based on literal property values passed by theAwsCdkPythonAppOptions.Builder.protectedJsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)Constructor that initializes the object based on values retrieved from the JsiiObject.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description com.fasterxml.jackson.databind.JsonNode$jsii$toJson()booleanequals(Object o)StringgetAppEntrypoint()(experimental) The CDK app's entrypoint (relative to the source directory, which is "src" by default).StringgetAuthorEmail()(experimental) Author's e-mail.StringgetAuthorName()(experimental) Author's name.AutoApproveOptionsgetAutoApproveOptions()(experimental) Enable and configure the 'auto approve' workflow.BooleangetAutoMerge()(experimental) Enable automatic merging on GitHub.AutoMergeOptionsgetAutoMergeOptions()(experimental) Configure options for automatic merging on GitHub.StringgetBuildCommand()(experimental) A command to execute before synthesis.BooleangetCdkAssert()(deprecated) Warning: NodeJS only.BooleangetCdkAssertions()(experimental) Install the assertions library?List<String>getCdkDependencies()(deprecated) Which AWS CDKv1 modules this project requires.BooleangetCdkDependenciesAsDeps()(deprecated) If this is enabled (default), all modules declared incdkDependencieswill be also added as normaldependencies(as well aspeerDependencies).StringgetCdkout()(experimental) cdk.out directory.List<String>getCdkTestDependencies()(deprecated) AWS CDK modules required for testing.StringgetCdkVersion()(experimental) Minimum version of the AWS CDK to depend on.BooleangetCdkVersionPinning()(experimental) Use pinned version instead of caret version for CDK.List<String>getClassifiers()(experimental) A list of PyPI trove classifiers that describe the project.BooleangetClobber()(experimental) Add aclobbertask which resets the repo to origin.BooleangetCommitGenerated()(experimental) Whether to commit the managed files by default.StringgetConstructsVersion()(experimental) Minimum version of theconstructslibrary to depend on.Map<String,Object>getContext()(experimental) Additional context to include incdk.json.List<String>getDeps()(experimental) List of runtime dependencies for this project.StringgetDescription()(experimental) A short description of the package.BooleangetDevContainer()(experimental) Add a VSCode development environment (used for GitHub Codespaces).List<String>getDevDeps()(experimental) List of dev dependencies for this project.BooleangetFeatureFlags()(experimental) Include all feature flags in cdk.json.BooleangetGithub()(experimental) Enable GitHub integration.GitHubOptionsgetGithubOptions()(experimental) Options for GitHub integration.IgnoreFileOptionsgetGitIgnoreOptions()(experimental) Configuration options for .gitignore file.GitOptionsgetGitOptions()(experimental) Configuration options for git.BooleangetGitpod()(experimental) Add a Gitpod development environment.StringgetHomepage()(experimental) A URL to the website of the project.StringgetLicense()(experimental) License of this package as an SPDX identifier.LoggerOptionsgetLogging()(experimental) Configure logging options such as verbosity.BooleangetMergify()(deprecated) Whether mergify should be enabled on this repository or not.MergifyOptionsgetMergifyOptions()(deprecated) Options for mergify.StringgetModuleName()(experimental) Name of the python package as used in imports and filenames.StringgetName()(experimental) This is the name of your project.StringgetOutdir()(experimental) The root directory of the project.StringgetPackageName()(experimental) Package name.ProjectgetParent()(experimental) The parent project, if this project is part of a bigger project.BooleangetPip()(experimental) Use pip with a requirements.txt file to track project dependencies.BooleangetPoetry()(experimental) Use poetry to manage your project dependencies, virtual environment, and (optional) packaging/publishing.PoetryPyprojectOptionsWithoutDepsgetPoetryOptions()(experimental) Additional options to set for poetry if using poetry.ProjectTypegetProjectType()(deprecated) Which type of project this is (library/app).StringgetProjenCommand()(experimental) The shell command to use in order to run the projen CLI.GithubCredentialsgetProjenCredentials()(experimental) Choose a method of providing GitHub API access for projen workflows.BooleangetProjenrcJs()(experimental) Use projenrc in javascript.BooleangetProjenrcJson()(experimental) Generate (once) .projenrc.json (in JSON).ProjenrcJsonOptionsgetProjenrcJsonOptions()(experimental) Options for .projenrc.json.ProjenrcOptionsgetProjenrcJsOptions()(experimental) Options related to projenrc in JavaScript.BooleangetProjenrcPython()(experimental) Use projenrc in Python.ProjenrcOptionsgetProjenrcPythonOptions()(experimental) Options related to projenrc in python.BooleangetProjenrcTs()(experimental) Use projenrc in TypeScript.ProjenrcTsOptionsgetProjenrcTsOptions()(experimental) Options related to projenrc in TypeScript.StringgetProjenTokenSecret()(deprecated) The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.BooleangetPytest()(experimental) Include pytest tests.PytestOptionsgetPytestOptions()(experimental) pytest options.StringgetPythonExec()(experimental) Path to the python executable to use.SampleReadmePropsgetReadme()(experimental) The README setup.BooleangetRenovatebot()(experimental) Use renovatebot to handle dependency upgrades.RenovatebotOptionsgetRenovatebotOptions()(experimental) Options for renovatebot.ApprovalLevelgetRequireApproval()(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.BooleangetSample()(experimental) Include sample code and test if the relevant directories don't exist.Map<String,Object>getSetupConfig()(experimental) Additional fields to pass in the setup() function if using setuptools.BooleangetSetuptools()(experimental) Use setuptools with a setup.py script for packaging and publishing.BooleangetStale()(experimental) Auto-close of stale issues and pull request.StaleOptionsgetStaleOptions()(experimental) Auto-close stale issues and pull requests.StringgetTestdir()(experimental) Python sources directory.BooleangetVenv()(experimental) Use venv to manage a virtual environment for installing dependencies inside.VenvOptionsgetVenvOptions()(experimental) Venv options.StringgetVersion()(experimental) Version of the package.BooleangetVscode()(experimental) Enable VSCode integration.List<String>getWatchExcludes()(experimental) Glob patterns to exclude fromcdk watch.List<String>getWatchIncludes()(experimental) Glob patterns to include incdk watch.inthashCode()
-
-
-
Constructor Detail
-
Jsii$Proxy
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
Constructor that initializes the object based on values retrieved from the JsiiObject.- Parameters:
objRef- Reference to the JSII managed object.
-
Jsii$Proxy
protected Jsii$Proxy(AwsCdkPythonAppOptions.Builder builder)
Constructor that initializes the object based on literal property values passed by theAwsCdkPythonAppOptions.Builder.
-
-
Method Detail
-
getAppEntrypoint
public final String getAppEntrypoint()
Description copied from interface:AwsCdkPythonAppOptions(experimental) The CDK app's entrypoint (relative to the source directory, which is "src" by default).Default: "app.py"
- Specified by:
getAppEntrypointin interfaceAwsCdkPythonAppOptions
-
getTestdir
public final String getTestdir()
Description copied from interface:AwsCdkPythonAppOptions(experimental) Python sources directory.Default: "tests"
- Specified by:
getTestdirin interfaceAwsCdkPythonAppOptions
-
getModuleName
public final String getModuleName()
Description copied from interface:PythonProjectOptions(experimental) Name of the python package as used in imports and filenames.Must only consist of alphanumeric characters and underscores.
Default: $PYTHON_MODULE_NAME
- Specified by:
getModuleNamein interfacePythonProjectOptions
-
getDeps
public final List<String> getDeps()
Description copied from interface:PythonProjectOptions(experimental) List of runtime dependencies for this project.Dependencies use the format:
<module>@<semver>Additional dependencies can be added via
project.addDependency().Default: []
- Specified by:
getDepsin interfacePythonProjectOptions
-
getDevDeps
public final List<String> getDevDeps()
Description copied from interface:PythonProjectOptions(experimental) List of dev dependencies for this project.Dependencies use the format:
<module>@<semver>Additional dependencies can be added via
project.addDevDependency().Default: []
- Specified by:
getDevDepsin interfacePythonProjectOptions
-
getPip
public final Boolean getPip()
Description copied from interface:PythonProjectOptions(experimental) Use pip with a requirements.txt file to track project dependencies.Default: - true, unless poetry is true, then false
- Specified by:
getPipin interfacePythonProjectOptions
-
getPoetry
public final Boolean getPoetry()
Description copied from interface:PythonProjectOptions(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
- Specified by:
getPoetryin interfacePythonProjectOptions
-
getProjenrcJs
public final Boolean getProjenrcJs()
Description copied from interface:PythonProjectOptions(experimental) Use projenrc in javascript.This will install
projenas a JavaScript dependency and add asynthtask which will run.projenrc.js.Default: false
- Specified by:
getProjenrcJsin interfacePythonProjectOptions
-
getProjenrcJsOptions
public final ProjenrcOptions getProjenrcJsOptions()
Description copied from interface:PythonProjectOptions(experimental) Options related to projenrc in JavaScript.Default: - default options
- Specified by:
getProjenrcJsOptionsin interfacePythonProjectOptions
-
getProjenrcPython
public final Boolean getProjenrcPython()
Description copied from interface:PythonProjectOptions(experimental) Use projenrc in Python.This will install
projenas a Python dependency and add asynthtask which will run.projenrc.py.Default: true
- Specified by:
getProjenrcPythonin interfacePythonProjectOptions
-
getProjenrcPythonOptions
public final ProjenrcOptions getProjenrcPythonOptions()
Description copied from interface:PythonProjectOptions(experimental) Options related to projenrc in python.Default: - default options
- Specified by:
getProjenrcPythonOptionsin interfacePythonProjectOptions
-
getProjenrcTs
public final Boolean getProjenrcTs()
Description copied from interface:PythonProjectOptions(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
- Specified by:
getProjenrcTsin interfacePythonProjectOptions
-
getProjenrcTsOptions
public final ProjenrcTsOptions getProjenrcTsOptions()
Description copied from interface:PythonProjectOptions(experimental) Options related to projenrc in TypeScript.Default: - default options
- Specified by:
getProjenrcTsOptionsin interfacePythonProjectOptions
-
getPytest
public final Boolean getPytest()
Description copied from interface:PythonProjectOptions(experimental) Include pytest tests.Default: true
- Specified by:
getPytestin interfacePythonProjectOptions
-
getPytestOptions
public final PytestOptions getPytestOptions()
Description copied from interface:PythonProjectOptions(experimental) pytest options.Default: - defaults
- Specified by:
getPytestOptionsin interfacePythonProjectOptions
-
getSample
public final Boolean getSample()
Description copied from interface:PythonProjectOptions(experimental) Include sample code and test if the relevant directories don't exist.Default: true
- Specified by:
getSamplein interfacePythonProjectOptions
-
getSetuptools
public final Boolean getSetuptools()
Description copied from interface:PythonProjectOptions(experimental) Use setuptools with a setup.py script for packaging and publishing.Default: - true, unless poetry is true, then false
- Specified by:
getSetuptoolsin interfacePythonProjectOptions
-
getVenv
public final Boolean getVenv()
Description copied from interface:PythonProjectOptions(experimental) Use venv to manage a virtual environment for installing dependencies inside.Default: - true, unless poetry is true, then false
- Specified by:
getVenvin interfacePythonProjectOptions
-
getVenvOptions
public final VenvOptions getVenvOptions()
Description copied from interface:PythonProjectOptions(experimental) Venv options.Default: - defaults
- Specified by:
getVenvOptionsin interfacePythonProjectOptions
-
getAutoApproveOptions
public final AutoApproveOptions getAutoApproveOptions()
Description copied from interface:GitHubProjectOptions(experimental) Enable and configure the 'auto approve' workflow.Default: - auto approve is disabled
- Specified by:
getAutoApproveOptionsin interfaceGitHubProjectOptions
-
getAutoMerge
public final Boolean getAutoMerge()
Description copied from interface:GitHubProjectOptions(experimental) Enable automatic merging on GitHub.Has no effect if
github.mergifyis set to false.Default: true
- Specified by:
getAutoMergein interfaceGitHubProjectOptions
-
getAutoMergeOptions
public final AutoMergeOptions getAutoMergeOptions()
Description copied from interface:GitHubProjectOptions(experimental) Configure options for automatic merging on GitHub.Has no effect if
github.mergifyorautoMergeis set to false.Default: - see defaults in `AutoMergeOptions`
- Specified by:
getAutoMergeOptionsin interfaceGitHubProjectOptions
-
getClobber
public final Boolean getClobber()
Description copied from interface:GitHubProjectOptions(experimental) Add aclobbertask which resets the repo to origin.Default: - true, but false for subprojects
- Specified by:
getClobberin interfaceGitHubProjectOptions
-
getDevContainer
public final Boolean getDevContainer()
Description copied from interface:GitHubProjectOptions(experimental) Add a VSCode development environment (used for GitHub Codespaces).Default: false
- Specified by:
getDevContainerin interfaceGitHubProjectOptions
-
getGithub
public final Boolean getGithub()
Description copied from interface:GitHubProjectOptions(experimental) Enable GitHub integration.Enabled by default for root projects. Disabled for non-root projects.
Default: true
- Specified by:
getGithubin interfaceGitHubProjectOptions
-
getGithubOptions
public final GitHubOptions getGithubOptions()
Description copied from interface:GitHubProjectOptions(experimental) Options for GitHub integration.Default: - see GitHubOptions
- Specified by:
getGithubOptionsin interfaceGitHubProjectOptions
-
getGitpod
public final Boolean getGitpod()
Description copied from interface:GitHubProjectOptions(experimental) Add a Gitpod development environment.Default: false
- Specified by:
getGitpodin interfaceGitHubProjectOptions
-
getMergify
public final Boolean getMergify()
Description copied from interface:GitHubProjectOptions(deprecated) Whether mergify should be enabled on this repository or not.Default: true
- Specified by:
getMergifyin interfaceGitHubProjectOptions
-
getMergifyOptions
public final MergifyOptions getMergifyOptions()
Description copied from interface:GitHubProjectOptions(deprecated) Options for mergify.Default: - default options
- Specified by:
getMergifyOptionsin interfaceGitHubProjectOptions
-
getProjectType
public final ProjectType getProjectType()
Description copied from interface:GitHubProjectOptions(deprecated) Which type of project this is (library/app).Default: ProjectType.UNKNOWN
- Specified by:
getProjectTypein interfaceGitHubProjectOptions
-
getProjenCredentials
public final GithubCredentials getProjenCredentials()
Description copied from interface:GitHubProjectOptions(experimental) Choose a method of providing GitHub API access for projen workflows.Default: - use a personal access token named PROJEN_GITHUB_TOKEN
- Specified by:
getProjenCredentialsin interfaceGitHubProjectOptions
-
getProjenTokenSecret
public final String getProjenTokenSecret()
Description copied from interface:GitHubProjectOptions(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"
- Specified by:
getProjenTokenSecretin interfaceGitHubProjectOptions
-
getReadme
public final SampleReadmeProps getReadme()
Description copied from interface:GitHubProjectOptions(experimental) The README setup.Default: - { filename: 'README.md', contents: '# replace this' }
Example:
"{ filename: 'readme.md', contents: '# title' }"- Specified by:
getReadmein interfaceGitHubProjectOptions
-
getStale
public final Boolean getStale()
Description copied from interface:GitHubProjectOptions(experimental) Auto-close of stale issues and pull request.See
staleOptionsfor options.Default: false
- Specified by:
getStalein interfaceGitHubProjectOptions
-
getStaleOptions
public final StaleOptions getStaleOptions()
Description copied from interface:GitHubProjectOptions(experimental) Auto-close stale issues and pull requests.To disable set
staletofalse.Default: - see defaults in `StaleOptions`
- Specified by:
getStaleOptionsin interfaceGitHubProjectOptions
-
getVscode
public final Boolean getVscode()
Description copied from interface:GitHubProjectOptions(experimental) Enable VSCode integration.Enabled by default for root projects. Disabled for non-root projects.
Default: true
- Specified by:
getVscodein interfaceGitHubProjectOptions
-
getName
public final String getName()
Description copied from interface:ProjectOptions(experimental) This is the name of your project.Default: $BASEDIR
- Specified by:
getNamein interfaceProjectOptions
-
getCommitGenerated
public final Boolean getCommitGenerated()
Description copied from interface:ProjectOptions(experimental) Whether to commit the managed files by default.Default: true
- Specified by:
getCommitGeneratedin interfaceProjectOptions
-
getGitIgnoreOptions
public final IgnoreFileOptions getGitIgnoreOptions()
Description copied from interface:ProjectOptions(experimental) Configuration options for .gitignore file.- Specified by:
getGitIgnoreOptionsin interfaceProjectOptions
-
getGitOptions
public final GitOptions getGitOptions()
Description copied from interface:ProjectOptions(experimental) Configuration options for git.- Specified by:
getGitOptionsin interfaceProjectOptions
-
getLogging
public final LoggerOptions getLogging()
Description copied from interface:ProjectOptions(experimental) Configure logging options such as verbosity.Default: {}
- Specified by:
getLoggingin interfaceProjectOptions
-
getOutdir
public final String getOutdir()
Description copied from interface:ProjectOptions(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: "."
- Specified by:
getOutdirin interfaceProjectOptions
-
getParent
public final Project getParent()
Description copied from interface:ProjectOptions(experimental) The parent project, if this project is part of a bigger project.- Specified by:
getParentin interfaceProjectOptions
-
getProjenCommand
public final String getProjenCommand()
Description copied from interface:ProjectOptions(experimental) The shell command to use in order to run the projen CLI.Can be used to customize in special environments.
Default: "npx projen"
- Specified by:
getProjenCommandin interfaceProjectOptions
-
getProjenrcJson
public final Boolean getProjenrcJson()
Description copied from interface:ProjectOptions(experimental) Generate (once) .projenrc.json (in JSON). Set tofalsein order to disable .projenrc.json generation.Default: false
- Specified by:
getProjenrcJsonin interfaceProjectOptions
-
getProjenrcJsonOptions
public final ProjenrcJsonOptions getProjenrcJsonOptions()
Description copied from interface:ProjectOptions(experimental) Options for .projenrc.json.Default: - default options
- Specified by:
getProjenrcJsonOptionsin interfaceProjectOptions
-
getRenovatebot
public final Boolean getRenovatebot()
Description copied from interface:ProjectOptions(experimental) Use renovatebot to handle dependency upgrades.Default: false
- Specified by:
getRenovatebotin interfaceProjectOptions
-
getRenovatebotOptions
public final RenovatebotOptions getRenovatebotOptions()
Description copied from interface:ProjectOptions(experimental) Options for renovatebot.Default: - default options
- Specified by:
getRenovatebotOptionsin interfaceProjectOptions
-
getAuthorEmail
public final String getAuthorEmail()
Description copied from interface:PythonPackagingOptions(experimental) Author's e-mail.Default: $GIT_USER_EMAIL
- Specified by:
getAuthorEmailin interfacePythonPackagingOptions
-
getAuthorName
public final String getAuthorName()
Description copied from interface:PythonPackagingOptions(experimental) Author's name.Default: $GIT_USER_NAME
- Specified by:
getAuthorNamein interfacePythonPackagingOptions
-
getVersion
public final String getVersion()
Description copied from interface:PythonPackagingOptions(experimental) Version of the package.Default: "0.1.0"
- Specified by:
getVersionin interfacePythonPackagingOptions
-
getClassifiers
public final List<String> getClassifiers()
Description copied from interface:PythonPackagingOptions(experimental) A list of PyPI trove classifiers that describe the project.- Specified by:
getClassifiersin interfacePythonPackagingOptions- See Also:
- https://pypi.org/classifiers/
-
getDescription
public final String getDescription()
Description copied from interface:PythonPackagingOptions(experimental) A short description of the package.- Specified by:
getDescriptionin interfacePythonPackagingOptions
-
getHomepage
public final String getHomepage()
Description copied from interface:PythonPackagingOptions(experimental) A URL to the website of the project.- Specified by:
getHomepagein interfacePythonPackagingOptions
-
getLicense
public final String getLicense()
Description copied from interface:PythonPackagingOptions(experimental) License of this package as an SPDX identifier.- Specified by:
getLicensein interfacePythonPackagingOptions
-
getPackageName
public final String getPackageName()
Description copied from interface:PythonPackagingOptions(experimental) Package name.- Specified by:
getPackageNamein interfacePythonPackagingOptions
-
getPoetryOptions
public final PoetryPyprojectOptionsWithoutDeps getPoetryOptions()
Description copied from interface:PythonPackagingOptions(experimental) Additional options to set for poetry if using poetry.- Specified by:
getPoetryOptionsin interfacePythonPackagingOptions
-
getSetupConfig
public final Map<String,Object> getSetupConfig()
Description copied from interface:PythonPackagingOptions(experimental) Additional fields to pass in the setup() function if using setuptools.- Specified by:
getSetupConfigin interfacePythonPackagingOptions
-
getPythonExec
public final String getPythonExec()
Description copied from interface:PythonExecutableOptions(experimental) Path to the python executable to use.Default: "python"
- Specified by:
getPythonExecin interfacePythonExecutableOptions
-
getBuildCommand
public final String getBuildCommand()
Description copied from interface:CdkConfigCommonOptions(experimental) A command to execute before synthesis.This command will be called when running
cdk synthor whencdk watchidentifies a change in your source code before redeployment.Default: - no build command
- Specified by:
getBuildCommandin interfaceCdkConfigCommonOptions
-
getCdkout
public final String getCdkout()
Description copied from interface:CdkConfigCommonOptions(experimental) cdk.out directory.Default: "cdk.out"
- Specified by:
getCdkoutin interfaceCdkConfigCommonOptions
-
getContext
public final Map<String,Object> getContext()
Description copied from interface:CdkConfigCommonOptions(experimental) Additional context to include incdk.json.Default: - no additional context
- Specified by:
getContextin interfaceCdkConfigCommonOptions
-
getFeatureFlags
public final Boolean getFeatureFlags()
Description copied from interface:CdkConfigCommonOptions(experimental) Include all feature flags in cdk.json.Default: true
- Specified by:
getFeatureFlagsin interfaceCdkConfigCommonOptions
-
getRequireApproval
public final ApprovalLevel getRequireApproval()
Description copied from interface:CdkConfigCommonOptions(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
- Specified by:
getRequireApprovalin interfaceCdkConfigCommonOptions
-
getWatchExcludes
public final List<String> getWatchExcludes()
Description copied from interface:CdkConfigCommonOptions(experimental) Glob patterns to exclude fromcdk watch.Default: []
- Specified by:
getWatchExcludesin interfaceCdkConfigCommonOptions
-
getWatchIncludes
public final List<String> getWatchIncludes()
Description copied from interface:CdkConfigCommonOptions(experimental) Glob patterns to include incdk watch.Default: []
- Specified by:
getWatchIncludesin interfaceCdkConfigCommonOptions
-
getCdkVersion
public final String getCdkVersion()
Description copied from interface:AwsCdkDepsCommonOptions(experimental) Minimum version of the AWS CDK to depend on.Default: "2.1.0"
- Specified by:
getCdkVersionin interfaceAwsCdkDepsCommonOptions
-
getCdkAssert
public final Boolean getCdkAssert()
Description copied from interface:AwsCdkDepsCommonOptions(deprecated) Warning: NodeJS only.Install the
Default: - will be included by default for AWS CDK >= 1.0.0 < 2.0.0
- Specified by:
getCdkAssertin interfaceAwsCdkDepsCommonOptions
-
getCdkAssertions
public final Boolean getCdkAssertions()
Description copied from interface:AwsCdkDepsCommonOptions(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
- Specified by:
getCdkAssertionsin interfaceAwsCdkDepsCommonOptions
-
getCdkDependencies
public final List<String> getCdkDependencies()
Description copied from interface:AwsCdkDepsCommonOptions(deprecated) Which AWS CDKv1 modules this project requires.- Specified by:
getCdkDependenciesin interfaceAwsCdkDepsCommonOptions
-
getCdkDependenciesAsDeps
public final Boolean getCdkDependenciesAsDeps()
Description copied from interface:AwsCdkDepsCommonOptions(deprecated) If this is enabled (default), all modules declared incdkDependencieswill be also added as normaldependencies(as well aspeerDependencies).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,
cdkDependencieswill be added todevDependenciesto ensure they are present during development.Note: this setting only applies to construct library projects
Default: true
- Specified by:
getCdkDependenciesAsDepsin interfaceAwsCdkDepsCommonOptions
-
getCdkTestDependencies
public final List<String> getCdkTestDependencies()
Description copied from interface:AwsCdkDepsCommonOptions(deprecated) AWS CDK modules required for testing.- Specified by:
getCdkTestDependenciesin interfaceAwsCdkDepsCommonOptions
-
getCdkVersionPinning
public final Boolean getCdkVersionPinning()
Description copied from interface:AwsCdkDepsCommonOptions(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.
- Specified by:
getCdkVersionPinningin interfaceAwsCdkDepsCommonOptions
-
getConstructsVersion
public final String getConstructsVersion()
Description copied from interface:AwsCdkDepsCommonOptions(experimental) Minimum version of theconstructslibrary to depend on.Default: - for CDK 1.x the default is "3.2.27", for CDK 2.x the default is "10.0.5".
- Specified by:
getConstructsVersionin interfaceAwsCdkDepsCommonOptions
-
$jsii$toJson
@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
- Specified by:
$jsii$toJsonin interfacesoftware.amazon.jsii.JsiiSerializable
-
-