@Stability(value=Experimental) public static final class ConstructLibraryAws.Builder extends Object implements software.amazon.jsii.Builder<ConstructLibraryAws>
ConstructLibraryAws.| Modifier and Type | Method and Description |
|---|---|
ConstructLibraryAws.Builder |
allowLibraryDependencies(Boolean allowLibraryDependencies)
(experimental) Allow the project to include `peerDependencies` and `bundledDependencies`.
|
ConstructLibraryAws.Builder |
antitamper(Boolean antitamper)
(experimental) Checks that after build there are no modified files on git.
|
ConstructLibraryAws.Builder |
artifactsDirectory(String artifactsDirectory)
(experimental) A directory which will contain artifacts to be published to npm.
|
ConstructLibraryAws.Builder |
author(String author)
(experimental) The name of the library author.
|
ConstructLibraryAws.Builder |
authorAddress(String authorAddress)
(experimental) Email or URL of the library author.
|
ConstructLibraryAws.Builder |
authorEmail(String authorEmail)
(experimental) Author's e-mail.
|
ConstructLibraryAws.Builder |
authorName(String authorName)
(experimental) Author's name.
|
ConstructLibraryAws.Builder |
authorOrganization(Boolean authorOrganization)
(experimental) Author's Organization.
|
ConstructLibraryAws.Builder |
authorUrl(String authorUrl)
(experimental) Author's URL / Website.
|
ConstructLibraryAws.Builder |
autoApproveOptions(AutoApproveOptions autoApproveOptions)
(experimental) Enable and configure the 'auto approve' workflow.
|
ConstructLibraryAws.Builder |
autoApproveProjenUpgrades(Boolean autoApproveProjenUpgrades)
(experimental) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).
|
ConstructLibraryAws.Builder |
autoApproveUpgrades(Boolean autoApproveUpgrades)
(experimental) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued).
|
ConstructLibraryAws.Builder |
autoDetectBin(Boolean autoDetectBin)
(experimental) Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section.
|
ConstructLibraryAws.Builder |
autoMergeOptions(AutoMergeOptions autoMergeOptions)
(experimental) Configure options for automatic merging on GitHub.
|
ConstructLibraryAws.Builder |
bin(Map<String,String> bin)
(experimental) Binary programs vended with your module.
|
ConstructLibraryAws |
build() |
ConstructLibraryAws.Builder |
buildWorkflow(Boolean buildWorkflow)
(experimental) Define a GitHub workflow for building PRs.
|
ConstructLibraryAws.Builder |
bundledDeps(List<String> bundledDeps)
(experimental) List of dependencies to bundle into this module.
|
ConstructLibraryAws.Builder |
bundlerOptions(BundlerOptions bundlerOptions)
(experimental) Options for `Bundler`.
|
ConstructLibraryAws.Builder |
catalog(Catalog catalog)
(experimental) Libraries will be picked up by the construct catalog when they are published to npm as jsii modules and will be published under:.
|
ConstructLibraryAws.Builder |
cdkAssert(Boolean cdkAssert)
Deprecated.
The
|
ConstructLibraryAws.Builder |
cdkAssertions(Boolean cdkAssertions)
(experimental) Install the @aws-cdk/assertions library?
|
ConstructLibraryAws.Builder |
cdkDependencies(List<String> cdkDependencies)
Deprecated.
For CDK 2.x use 'peerDeps' instead
|
ConstructLibraryAws.Builder |
cdkDependenciesAsDeps(Boolean cdkDependenciesAsDeps)
Deprecated.
Not supported in CDK v2.
|
ConstructLibraryAws.Builder |
cdkTestDependencies(List<String> cdkTestDependencies)
Deprecated.
For CDK 2.x use 'devDeps' instead
|
ConstructLibraryAws.Builder |
cdkVersion(String cdkVersion)
(experimental) Minimum version of the AWS CDK to depend on.
|
ConstructLibraryAws.Builder |
cdkVersionPinning(Boolean cdkVersionPinning)
(experimental) Use pinned version instead of caret version for CDK.
|
ConstructLibraryAws.Builder |
clobber(Boolean clobber)
(experimental) Add a `clobber` task which resets the repo to origin.
|
ConstructLibraryAws.Builder |
codeArtifactOptions(CodeArtifactOptions codeArtifactOptions)
(experimental) Options for publishing npm package to AWS CodeArtifact.
|
ConstructLibraryAws.Builder |
codeCov(Boolean codeCov)
(experimental) Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v1 A secret is required for private repos.
|
ConstructLibraryAws.Builder |
codeCovTokenSecret(String codeCovTokenSecret)
(experimental) Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories.
|
ConstructLibraryAws.Builder |
compat(Boolean compat)
(experimental) Automatically run API compatibility test against the latest version published to npm after compilation.
|
ConstructLibraryAws.Builder |
compatIgnore(String compatIgnore)
(experimental) Name of the ignore file for API compatibility tests.
|
ConstructLibraryAws.Builder |
constructsVersion(String constructsVersion)
(experimental) Minimum version of the `constructs` library to depend on.
|
ConstructLibraryAws.Builder |
copyrightOwner(String copyrightOwner)
(experimental) License copyright owner.
|
ConstructLibraryAws.Builder |
copyrightPeriod(String copyrightPeriod)
(experimental) The copyright years to put in the LICENSE file.
|
static ConstructLibraryAws.Builder |
create() |
ConstructLibraryAws.Builder |
defaultReleaseBranch(String defaultReleaseBranch)
(experimental) The name of the main release branch.
|
ConstructLibraryAws.Builder |
dependabot(Boolean dependabot)
(experimental) Use dependabot to handle dependency upgrades.
|
ConstructLibraryAws.Builder |
dependabotOptions(DependabotOptions dependabotOptions)
(experimental) Options for dependabot.
|
ConstructLibraryAws.Builder |
deps(List<String> deps)
(experimental) Runtime dependencies of this module.
|
ConstructLibraryAws.Builder |
depsUpgrade(Boolean depsUpgrade)
(experimental) Use github workflows to handle dependency upgrades.
|
ConstructLibraryAws.Builder |
depsUpgradeOptions(UpgradeDependenciesOptions depsUpgradeOptions)
(experimental) Options for depsUpgrade.
|
ConstructLibraryAws.Builder |
description(String description)
(experimental) The description is just a string that helps people understand the purpose of the package.
|
ConstructLibraryAws.Builder |
devContainer(Boolean devContainer)
(experimental) Add a VSCode development environment (used for GitHub Codespaces).
|
ConstructLibraryAws.Builder |
devDeps(List<String> devDeps)
(experimental) Build dependencies for this module.
|
ConstructLibraryAws.Builder |
disableTsconfig(Boolean disableTsconfig)
(experimental) Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler).
|
ConstructLibraryAws.Builder |
docgen(Boolean docgen)
(experimental) Docgen by Typedoc.
|
ConstructLibraryAws.Builder |
docsDirectory(String docsDirectory)
(experimental) Docs directory.
|
ConstructLibraryAws.Builder |
dotnet(JsiiDotNetTarget dotnet)
Deprecated.
use `publishToNuget`
|
ConstructLibraryAws.Builder |
entrypoint(String entrypoint)
(experimental) Module entrypoint (`main` in `package.json`).
|
ConstructLibraryAws.Builder |
entrypointTypes(String entrypointTypes)
(experimental) The .d.ts file that includes the type declarations for this module.
|
ConstructLibraryAws.Builder |
eslint(Boolean eslint)
(experimental) Setup eslint.
|
ConstructLibraryAws.Builder |
eslintOptions(EslintOptions eslintOptions)
(experimental) Eslint options.
|
ConstructLibraryAws.Builder |
excludeTypescript(List<String> excludeTypescript)
(experimental) Accepts a list of glob patterns.
|
ConstructLibraryAws.Builder |
github(Boolean github)
(experimental) Enable GitHub integration.
|
ConstructLibraryAws.Builder |
githubOptions(GitHubOptions githubOptions)
(experimental) Options for GitHub integration.
|
ConstructLibraryAws.Builder |
gitignore(List<String> gitignore)
(experimental) Additional entries to .gitignore.
|
ConstructLibraryAws.Builder |
gitpod(Boolean gitpod)
(experimental) Add a Gitpod development environment.
|
ConstructLibraryAws.Builder |
homepage(String homepage)
(experimental) Package's Homepage / Website.
|
ConstructLibraryAws.Builder |
jest(Boolean jest)
(experimental) Setup jest unit tests.
|
ConstructLibraryAws.Builder |
jestOptions(JestOptions jestOptions)
(experimental) Jest options.
|
ConstructLibraryAws.Builder |
jsiiReleaseVersion(String jsiiReleaseVersion)
(experimental) Version requirement of `jsii-release` which is used to publish modules to npm.
|
ConstructLibraryAws.Builder |
keywords(List<String> keywords)
(experimental) Keywords to include in `package.json`.
|
ConstructLibraryAws.Builder |
lambdaAutoDiscover(Boolean lambdaAutoDiscover)
(experimental) Automatically adds an `aws_lambda.Function` for each `.lambda.ts` handler in your source tree.
|
ConstructLibraryAws.Builder |
lambdaOptions(LambdaFunctionCommonOptions lambdaOptions)
(experimental) Common options for all AWS Lambda functions.
|
ConstructLibraryAws.Builder |
libdir(String libdir)
(experimental) Typescript artifacts output directory.
|
ConstructLibraryAws.Builder |
license(String license)
(experimental) License's SPDX identifier.
|
ConstructLibraryAws.Builder |
licensed(Boolean licensed)
(experimental) Indicates if a license should be added.
|
ConstructLibraryAws.Builder |
logging(LoggerOptions logging)
(experimental) Configure logging options such as verbosity.
|
ConstructLibraryAws.Builder |
majorVersion(Number majorVersion)
(experimental) Major version to release from the default branch.
|
ConstructLibraryAws.Builder |
maxNodeVersion(String maxNodeVersion)
(experimental) Minimum node.js version to require via `engines` (inclusive).
|
ConstructLibraryAws.Builder |
mergify(Boolean mergify)
Deprecated.
use `githubOptions.mergify` instead
|
ConstructLibraryAws.Builder |
mergifyOptions(MergifyOptions mergifyOptions)
Deprecated.
use `githubOptions.mergifyOptions` instead
|
ConstructLibraryAws.Builder |
minNodeVersion(String minNodeVersion)
(experimental) Minimum Node.js version to require via package.json `engines` (inclusive).
|
ConstructLibraryAws.Builder |
mutableBuild(Boolean mutableBuild)
(experimental) Automatically update files modified during builds to pull-request branches.
|
ConstructLibraryAws.Builder |
name(String name)
(experimental) This is the name of your project.
|
ConstructLibraryAws.Builder |
npmAccess(NpmAccess npmAccess)
(experimental) Access level of the npm package.
|
ConstructLibraryAws.Builder |
npmDistTag(String npmDistTag)
(experimental) The npmDistTag to use when publishing from the default branch.
|
ConstructLibraryAws.Builder |
npmignore(List<String> npmignore)
Deprecated.
- use `project.addPackageIgnore`
|
ConstructLibraryAws.Builder |
npmignoreEnabled(Boolean npmignoreEnabled)
(experimental) Defines an .npmignore file.
|
ConstructLibraryAws.Builder |
npmRegistry(String npmRegistry)
Deprecated.
use `npmRegistryUrl` instead
|
ConstructLibraryAws.Builder |
npmRegistryUrl(String npmRegistryUrl)
(experimental) The base URL of the npm package registry.
|
ConstructLibraryAws.Builder |
npmTokenSecret(String npmTokenSecret)
(experimental) GitHub secret which contains the NPM token to use when publishing packages.
|
ConstructLibraryAws.Builder |
outdir(String outdir)
(experimental) The root directory of the project.
|
ConstructLibraryAws.Builder |
packageManager(NodePackageManager packageManager)
(experimental) The Node Package Manager used to execute scripts.
|
ConstructLibraryAws.Builder |
packageName(String packageName)
(experimental) The "name" in package.json.
|
ConstructLibraryAws.Builder |
packageValue(Boolean packageValue)
(experimental) Defines a `yarn package` command that will produce a tarball and place it under `dist/js`.
|
ConstructLibraryAws.Builder |
parent(Project parent)
(experimental) The parent project, if this project is part of a bigger project.
|
ConstructLibraryAws.Builder |
peerDependencyOptions(PeerDependencyOptions peerDependencyOptions)
(experimental) Options for `peerDeps`.
|
ConstructLibraryAws.Builder |
peerDeps(List<String> peerDeps)
(experimental) Peer dependencies for this module.
|
ConstructLibraryAws.Builder |
postBuildSteps(List<? extends JobStep> postBuildSteps)
(experimental) Steps to execute after build as part of the release workflow.
|
ConstructLibraryAws.Builder |
prerelease(String prerelease)
(experimental) Bump versions from the default branch as pre-releases (e.g.
|
ConstructLibraryAws.Builder |
projectType(ProjectType projectType)
Deprecated.
no longer supported at the base project level
|
ConstructLibraryAws.Builder |
projenCommand(String projenCommand)
(experimental) The shell command to use in order to run the projen CLI.
|
ConstructLibraryAws.Builder |
projenDevDependency(Boolean projenDevDependency)
(experimental) Indicates of "projen" should be installed as a devDependency.
|
ConstructLibraryAws.Builder |
projenrcJs(Boolean projenrcJs)
(experimental) Generate (once) .projenrc.js (in JavaScript).
|
ConstructLibraryAws.Builder |
projenrcJson(Boolean projenrcJson)
(experimental) Generate (once) .projenrc.json (in JSON).
|
ConstructLibraryAws.Builder |
projenrcJsonOptions(ProjenrcOptions projenrcJsonOptions)
(experimental) Options for .projenrc.json.
|
ConstructLibraryAws.Builder |
projenrcJsOptions(ProjenrcOptions projenrcJsOptions)
(experimental) Options for .projenrc.js.
|
ConstructLibraryAws.Builder |
projenrcTs(Boolean projenrcTs)
(experimental) Use TypeScript for your projenrc file (`.projenrc.ts`).
|
ConstructLibraryAws.Builder |
projenrcTsOptions(ProjenrcOptions projenrcTsOptions)
(experimental) Options for .projenrc.ts.
|
ConstructLibraryAws.Builder |
projenUpgradeAutoMerge(Boolean projenUpgradeAutoMerge)
Deprecated.
use `autoApproveProjenUpgrades`.
|
ConstructLibraryAws.Builder |
projenUpgradeSchedule(List<String> projenUpgradeSchedule)
(experimental) Customize the projenUpgrade schedule in cron expression.
|
ConstructLibraryAws.Builder |
projenUpgradeSecret(String projenUpgradeSecret)
(experimental) Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`).
|
ConstructLibraryAws.Builder |
projenVersion(String projenVersion)
(experimental) Version of projen to install.
|
ConstructLibraryAws.Builder |
publishTasks(Boolean publishTasks)
(experimental) Define publishing tasks that can be executed manually as well as workflows.
|
ConstructLibraryAws.Builder |
publishToGo(JsiiGoTarget publishToGo)
(experimental) Publish Go bindings to a git repository.
|
ConstructLibraryAws.Builder |
publishToMaven(JsiiJavaTarget publishToMaven)
(experimental) Publish to maven.
|
ConstructLibraryAws.Builder |
publishToNuget(JsiiDotNetTarget publishToNuget)
(experimental) Publish to NuGet.
|
ConstructLibraryAws.Builder |
publishToPypi(JsiiPythonTarget publishToPypi)
(experimental) Publish to pypi.
|
ConstructLibraryAws.Builder |
pullRequestTemplate(Boolean pullRequestTemplate)
(experimental) Include a GitHub pull request template.
|
ConstructLibraryAws.Builder |
pullRequestTemplateContents(List<String> pullRequestTemplateContents)
(experimental) The contents of the pull request template.
|
ConstructLibraryAws.Builder |
python(JsiiPythonTarget python)
Deprecated.
use `publishToPyPi`
|
ConstructLibraryAws.Builder |
readme(SampleReadmeProps readme)
(experimental) The README setup.
|
ConstructLibraryAws.Builder |
release(Boolean release)
(experimental) Add release management to this project.
|
ConstructLibraryAws.Builder |
releaseBranches(Map<String,? extends BranchOptions> releaseBranches)
(experimental) Defines additional release branches.
|
ConstructLibraryAws.Builder |
releaseEveryCommit(Boolean releaseEveryCommit)
Deprecated.
Use `releaseTrigger: ReleaseTrigger.continuous()` instead
|
ConstructLibraryAws.Builder |
releaseFailureIssue(Boolean releaseFailureIssue)
(experimental) Create a github issue on every failed publishing task.
|
ConstructLibraryAws.Builder |
releaseFailureIssueLabel(String releaseFailureIssueLabel)
(experimental) The label to apply to issues indicating publish failures.
|
ConstructLibraryAws.Builder |
releaseSchedule(String releaseSchedule)
Deprecated.
Use `releaseTrigger: ReleaseTrigger.scheduled()` instead
|
ConstructLibraryAws.Builder |
releaseTagPrefix(String releaseTagPrefix)
(experimental) Automatically add the given prefix to release tags.
|
ConstructLibraryAws.Builder |
releaseToNpm(Boolean releaseToNpm)
(experimental) Automatically release to npm when new versions are introduced.
|
ConstructLibraryAws.Builder |
releaseTrigger(ReleaseTrigger releaseTrigger)
(experimental) The release trigger to use.
|
ConstructLibraryAws.Builder |
releaseWorkflow(Boolean releaseWorkflow)
Deprecated.
see `release`.
|
ConstructLibraryAws.Builder |
releaseWorkflowName(String releaseWorkflowName)
(experimental) The name of the default release workflow.
|
ConstructLibraryAws.Builder |
releaseWorkflowSetupSteps(List<? extends JobStep> releaseWorkflowSetupSteps)
(experimental) A set of workflow steps to execute in order to setup the workflow container.
|
ConstructLibraryAws.Builder |
repository(String repository)
(experimental) The repository is the location where the actual code for your package lives.
|
ConstructLibraryAws.Builder |
repositoryDirectory(String repositoryDirectory)
(experimental) If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives.
|
ConstructLibraryAws.Builder |
repositoryUrl(String repositoryUrl)
(experimental) Git repository URL.
|
ConstructLibraryAws.Builder |
rootdir(String rootdir)
Default: "."
|
ConstructLibraryAws.Builder |
sampleCode(Boolean sampleCode)
(experimental) Generate one-time sample in `src/` and `test/` if there are no files there.
|
ConstructLibraryAws.Builder |
scripts(Map<String,String> scripts)
(experimental) npm scripts to include.
|
ConstructLibraryAws.Builder |
srcdir(String srcdir)
(experimental) Typescript sources directory.
|
ConstructLibraryAws.Builder |
stability(String stability)
(experimental) Package's Stability.
|
ConstructLibraryAws.Builder |
stale(Boolean stale)
(experimental) Auto-close of stale issues and pull request.
|
ConstructLibraryAws.Builder |
staleOptions(StaleOptions staleOptions)
(experimental) Auto-close stale issues and pull requests.
|
ConstructLibraryAws.Builder |
testdir(String testdir)
(experimental) Jest tests directory.
|
ConstructLibraryAws.Builder |
tsconfig(TypescriptConfigOptions tsconfig)
(experimental) Custom TSConfig.
|
ConstructLibraryAws.Builder |
tsconfigDev(TypescriptConfigOptions tsconfigDev)
(experimental) Custom tsconfig options for the development tsconfig.json file (used for testing).
|
ConstructLibraryAws.Builder |
tsconfigDevFile(String tsconfigDevFile)
(experimental) The name of the development tsconfig.json file.
|
ConstructLibraryAws.Builder |
typescriptVersion(String typescriptVersion)
(experimental) TypeScript version to use.
|
ConstructLibraryAws.Builder |
versionrcOptions(Map<String,? extends Object> versionrcOptions)
(experimental) Custom configuration used when creating changelog with standard-version package.
|
ConstructLibraryAws.Builder |
vscode(Boolean vscode)
(experimental) Enable VSCode integration.
|
ConstructLibraryAws.Builder |
workflowBootstrapSteps(List<? extends Object> workflowBootstrapSteps)
(experimental) Workflow steps to use in order to bootstrap this repo.
|
ConstructLibraryAws.Builder |
workflowContainerImage(String workflowContainerImage)
(experimental) Container image to use for GitHub workflows.
|
ConstructLibraryAws.Builder |
workflowGitIdentity(GitIdentity workflowGitIdentity)
(experimental) The git identity to use in workflows.
|
ConstructLibraryAws.Builder |
workflowNodeVersion(String workflowNodeVersion)
(experimental) The node version to use in GitHub workflows.
|
ConstructLibraryAws.Builder |
workflowRunsOn(List<String> workflowRunsOn)
(experimental) Github Runner selection labels.
|
@Stability(value=Experimental) public static ConstructLibraryAws.Builder create()
ConstructLibraryAws.Builder.@Stability(value=Experimental) public ConstructLibraryAws.Builder name(String name)
Default: $BASEDIR
name - This is the name of your project. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder logging(LoggerOptions logging)
Default: {}
logging - Configure logging options such as verbosity. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder outdir(String outdir)
Relative to this directory, all files are synthesized.
If this project has a parent, this directory is relative to the parent directory and it cannot be the same as the parent or any of it's other sub-projects.
Default: "."
outdir - The root directory of the project. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder parent(Project parent)
parent - The parent project, if this project is part of a bigger project. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder projenCommand(String projenCommand)
Can be used to customize in special environments.
Default: "npx projen"
projenCommand - The shell command to use in order to run the projen CLI. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder projenrcJson(Boolean projenrcJson)
Default: false
projenrcJson - Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder projenrcJsonOptions(ProjenrcOptions projenrcJsonOptions)
Default: - default options
projenrcJsonOptions - Options for .projenrc.json. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder autoApproveOptions(AutoApproveOptions autoApproveOptions)
Default: - auto approve is disabled
autoApproveOptions - Enable and configure the 'auto approve' workflow. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder autoMergeOptions(AutoMergeOptions autoMergeOptions)
Has no effect if
github.mergify is set to false.
Default: - see defaults in `AutoMergeOptions`
autoMergeOptions - Configure options for automatic merging on GitHub. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder clobber(Boolean clobber)
Default: true
clobber - Add a `clobber` task which resets the repo to origin. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder devContainer(Boolean devContainer)
Default: false
devContainer - Add a VSCode development environment (used for GitHub Codespaces). This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder github(Boolean github)
Enabled by default for root projects. Disabled for non-root projects.
Default: true
github - Enable GitHub integration. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder githubOptions(GitHubOptions githubOptions)
Default: - see GitHubOptions
githubOptions - Options for GitHub integration. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder gitpod(Boolean gitpod)
Default: false
gitpod - Add a Gitpod development environment. This parameter is required.this@Stability(value=Deprecated) @Deprecated public ConstructLibraryAws.Builder mergify(Boolean mergify)
Default: true
mergify - Whether mergify should be enabled on this repository or not. This parameter is required.this@Stability(value=Deprecated) @Deprecated public ConstructLibraryAws.Builder mergifyOptions(MergifyOptions mergifyOptions)
Default: - default options
mergifyOptions - Options for mergify. This parameter is required.this@Stability(value=Deprecated) @Deprecated public ConstructLibraryAws.Builder projectType(ProjectType projectType)
Default: ProjectType.UNKNOWN
projectType - Which type of project this is (library/app). This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder readme(SampleReadmeProps readme)
Default: - { filename: 'README.md', contents: '# replace this' }
Example:
// Example automatically generated from non-compiling source. May contain errors.
"{ filename: 'readme.md', contents: '# title' }"
readme - The README setup. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder stale(Boolean stale)
See staleOptions for options.
Default: true
stale - Auto-close of stale issues and pull request. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder staleOptions(StaleOptions staleOptions)
To disable set stale to false.
Default: - see defaults in `StaleOptions`
staleOptions - Auto-close stale issues and pull requests. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder vscode(Boolean vscode)
Enabled by default for root projects. Disabled for non-root projects.
Default: true
vscode - Enable VSCode integration. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder allowLibraryDependencies(Boolean allowLibraryDependencies)
This is normally only allowed for libraries. For apps, there's no meaning for specifying these.
Default: true
allowLibraryDependencies - Allow the project to include `peerDependencies` and `bundledDependencies`. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder authorEmail(String authorEmail)
authorEmail - Author's e-mail. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder authorName(String authorName)
authorName - Author's name. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder authorOrganization(Boolean authorOrganization)
authorOrganization - Author's Organization. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder authorUrl(String authorUrl)
authorUrl - Author's URL / Website. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder autoDetectBin(Boolean autoDetectBin)
Default: true
autoDetectBin - Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder bin(Map<String,String> bin)
You can use this option to add/customize how binaries are represented in
your package.json, but unless autoDetectBin is false, every
executable file under bin will automatically be added to this section.
bin - Binary programs vended with your module. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder bundledDeps(List<String> bundledDeps)
These modules will be
added both to the dependencies section and bundledDependencies section of
your package.json.
The recommendation is to only specify the module name here (e.g.
express). This will behave similar to yarn add or npm install in the
sense that it will add the module as a dependency to your package.json
file with the latest version (^). You can specify semver requirements in
the same syntax passed to npm i or yarn add (e.g. express@^2) and
this will be what you package.json will eventually include.
bundledDeps - List of dependencies to bundle into this module. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder codeArtifactOptions(CodeArtifactOptions codeArtifactOptions)
Default: - undefined
codeArtifactOptions - Options for publishing npm package to AWS CodeArtifact. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder deps(List<String> deps)
The recommendation is to only specify the module name here (e.g.
express). This will behave similar to yarn add or npm install in the
sense that it will add the module as a dependency to your package.json
file with the latest version (^). You can specify semver requirements in
the same syntax passed to npm i or yarn add (e.g. express@^2) and
this will be what you package.json will eventually include.
Default: []
Example:
// Example automatically generated from non-compiling source. May contain errors. [ 'express', 'lodash', 'foo@^2' ]
deps - Runtime dependencies of this module. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder description(String description)
It can be used when searching for packages in a package manager as well. See https://classic.yarnpkg.com/en/docs/package-json/#toc-description
description - The description is just a string that helps people understand the purpose of the package. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder devDeps(List<String> devDeps)
These dependencies will only be available in your build environment but will not be fetched when this module is consumed.
The recommendation is to only specify the module name here (e.g.
express). This will behave similar to yarn add or npm install in the
sense that it will add the module as a dependency to your package.json
file with the latest version (^). You can specify semver requirements in
the same syntax passed to npm i or yarn add (e.g. express@^2) and
this will be what you package.json will eventually include.
Default: []
Example:
// Example automatically generated from non-compiling source. May contain errors. [ 'typescript', '@types/express' ]
devDeps - Build dependencies for this module. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder entrypoint(String entrypoint)
Set to an empty string to not include main in your package.json
Default: "lib/index.js"
entrypoint - Module entrypoint (`main` in `package.json`). This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder homepage(String homepage)
homepage - Package's Homepage / Website. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder keywords(List<String> keywords)
keywords - Keywords to include in `package.json`. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder license(String license)
See https://github.com/projen/projen/tree/main/license-text for a list of supported licenses.
Use the licensed option if you want to no license to be specified.
Default: "Apache-2.0"
license - License's SPDX identifier. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder licensed(Boolean licensed)
Default: true
licensed - Indicates if a license should be added. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder maxNodeVersion(String maxNodeVersion)
Default: - no max
maxNodeVersion - Minimum node.js version to require via `engines` (inclusive). This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder minNodeVersion(String minNodeVersion)
Default: - no "engines" specified
minNodeVersion - Minimum Node.js version to require via package.json `engines` (inclusive). This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder npmAccess(NpmAccess npmAccess)
Default: - for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
npmAccess - Access level of the npm package. This parameter is required.this@Stability(value=Deprecated) @Deprecated public ConstructLibraryAws.Builder npmRegistry(String npmRegistry)
Cannot be set together with npmRegistryUrl.
npmRegistry - The host name of the npm registry to publish to. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder npmRegistryUrl(String npmRegistryUrl)
Must be a URL (e.g. start with "https://" or "http://")
Default: "https://registry.npmjs.org"
npmRegistryUrl - The base URL of the npm package registry. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder npmTokenSecret(String npmTokenSecret)
Default: "NPM_TOKEN"
npmTokenSecret - GitHub secret which contains the NPM token to use when publishing packages. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder packageManager(NodePackageManager packageManager)
Default: NodePackageManager.YARN
packageManager - The Node Package Manager used to execute scripts. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder packageName(String packageName)
Default: - defaults to project name
packageName - The "name" in package.json. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder peerDependencyOptions(PeerDependencyOptions peerDependencyOptions)
peerDependencyOptions - Options for `peerDeps`. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder peerDeps(List<String> peerDeps)
Dependencies listed here are required to
be installed (and satisfied) by the consumer of this library. Using peer
dependencies allows you to ensure that only a single module of a certain
library exists in the node_modules tree of your consumers.
Note that prior to npm@7, peer dependencies are not automatically installed, which means that adding peer dependencies to a library will be a breaking change for your customers.
Unless peerDependencyOptions.pinnedDevDependency is disabled (it is
enabled by default), projen will automatically add a dev dependency with a
pinned version for each peer dependency. This will ensure that you build &
test your module against the lowest peer version required.
Default: []
peerDeps - Peer dependencies for this module. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder repository(String repository)
See https://classic.yarnpkg.com/en/docs/package-json/#toc-repository
repository - The repository is the location where the actual code for your package lives. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder repositoryDirectory(String repositoryDirectory)
repositoryDirectory - If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder scripts(Map<String,String> scripts)
If a script has the same name as a standard script, the standard script will be overwritten.
Default: {}
scripts - npm scripts to include. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder stability(String stability)
stability - Package's Stability. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder antitamper(Boolean antitamper)
Default: true
antitamper - Checks that after build there are no modified files on git. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder artifactsDirectory(String artifactsDirectory)
Default: "dist"
artifactsDirectory - A directory which will contain artifacts to be published to npm. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder jsiiReleaseVersion(String jsiiReleaseVersion)
Default: "latest"
jsiiReleaseVersion - Version requirement of `jsii-release` which is used to publish modules to npm. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder majorVersion(Number majorVersion)
If this is specified, we bump the latest version of this major version line. If not specified, we bump the global latest version.
Default: - Major version is not enforced.
majorVersion - Major version to release from the default branch. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder npmDistTag(String npmDistTag)
To set the npm dist-tag for release branches, set the npmDistTag property
for each branch.
Default: "latest"
npmDistTag - The npmDistTag to use when publishing from the default branch. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder postBuildSteps(List<? extends JobStep> postBuildSteps)
Default: []
postBuildSteps - Steps to execute after build as part of the release workflow. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder prerelease(String prerelease)
Default: - normal semantic versions
prerelease - Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder publishTasks(Boolean publishTasks)
Normally, publishing only happens within automated workflows. Enable this in order to create a publishing task for each publishing activity.
Default: false
publishTasks - Define publishing tasks that can be executed manually as well as workflows. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder releaseBranches(Map<String,? extends BranchOptions> releaseBranches)
A workflow will be created for each
release branch which will publish releases from commits in this branch.
Each release branch must be assigned a major version number which is used
to enforce that versions published from that branch always use that major
version. If multiple branches are used, the majorVersion field must also
be provided for the default branch.
Default: - no additional branches are used for release. you can use `addBranch()` to add additional branches.
releaseBranches - Defines additional release branches. This parameter is required.this@Stability(value=Deprecated) @Deprecated public ConstructLibraryAws.Builder releaseEveryCommit(Boolean releaseEveryCommit)
Default: true
releaseEveryCommit - Automatically release new versions every commit to one of branches in `releaseBranches`. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder releaseFailureIssue(Boolean releaseFailureIssue)
Default: false
releaseFailureIssue - Create a github issue on every failed publishing task. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder releaseFailureIssueLabel(String releaseFailureIssueLabel)
Only applies if releaseFailureIssue is true.
Default: "failed-release"
releaseFailureIssueLabel - The label to apply to issues indicating publish failures. This parameter is required.this@Stability(value=Deprecated) @Deprecated public ConstructLibraryAws.Builder releaseSchedule(String releaseSchedule)
Default: - no scheduled releases
releaseSchedule - CRON schedule to trigger new releases. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder releaseTagPrefix(String releaseTagPrefix)
Note: this prefix is used to detect the latest tagged version when bumping, so if you change this on a project with an existing version history, you may need to manually tag your latest release with the new prefix.
Default: - no prefix
releaseTagPrefix - Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder releaseTrigger(ReleaseTrigger releaseTrigger)
Default: - Continuous releases (`ReleaseTrigger.continuous()`)
releaseTrigger - The release trigger to use. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder releaseWorkflowName(String releaseWorkflowName)
Default: "Release"
releaseWorkflowName - The name of the default release workflow. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder releaseWorkflowSetupSteps(List<? extends JobStep> releaseWorkflowSetupSteps)
releaseWorkflowSetupSteps - A set of workflow steps to execute in order to setup the workflow container. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder versionrcOptions(Map<String,? extends Object> versionrcOptions)
Given values either append to default configuration or overwrite values in it.
Default: - standard configuration applicable for GitHub repositories
versionrcOptions - Custom configuration used when creating changelog with standard-version package. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder workflowContainerImage(String workflowContainerImage)
Default: - default image
workflowContainerImage - Container image to use for GitHub workflows. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder workflowRunsOn(List<String> workflowRunsOn)
Default: ["ubuntu-latest"]
workflowRunsOn - Github Runner selection labels. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder defaultReleaseBranch(String defaultReleaseBranch)
Default: "main"
defaultReleaseBranch - The name of the main release branch. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder autoApproveProjenUpgrades(Boolean autoApproveProjenUpgrades)
Throw if set to true but autoApproveOptions are not defined.
Default: false
autoApproveProjenUpgrades - Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder autoApproveUpgrades(Boolean autoApproveUpgrades)
Throw if set to true but autoApproveOptions are not defined.
Default: - true
autoApproveUpgrades - Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder buildWorkflow(Boolean buildWorkflow)
Default: - true if not a subproject
buildWorkflow - Define a GitHub workflow for building PRs. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder bundlerOptions(BundlerOptions bundlerOptions)
bundlerOptions - Options for `Bundler`. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder codeCov(Boolean codeCov)
Default: false
codeCov - Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v1 A secret is required for private repos. Configured with @codeCovTokenSecret. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder codeCovTokenSecret(String codeCovTokenSecret)
Default: - if this option is not specified, only public repositories are supported
codeCovTokenSecret - Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder copyrightOwner(String copyrightOwner)
Default: - defaults to the value of authorName or "" if `authorName` is undefined.
copyrightOwner - License copyright owner. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder copyrightPeriod(String copyrightPeriod)
Default: - current year
copyrightPeriod - The copyright years to put in the LICENSE file. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder dependabot(Boolean dependabot)
Cannot be used in conjunction with depsUpgrade.
Default: false
dependabot - Use dependabot to handle dependency upgrades. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder dependabotOptions(DependabotOptions dependabotOptions)
Default: - default options
dependabotOptions - Options for dependabot. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder depsUpgrade(Boolean depsUpgrade)
Cannot be used in conjunction with dependabot.
Default: true
depsUpgrade - Use github workflows to handle dependency upgrades. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder depsUpgradeOptions(UpgradeDependenciesOptions depsUpgradeOptions)
Default: - default options
depsUpgradeOptions - Options for depsUpgrade. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder gitignore(List<String> gitignore)
gitignore - Additional entries to .gitignore. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder jest(Boolean jest)
Default: true
jest - Setup jest unit tests. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder jestOptions(JestOptions jestOptions)
Default: - default options
jestOptions - Jest options. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder mutableBuild(Boolean mutableBuild)
This means that any files synthesized by projen or e.g. test snapshots will always be up-to-date before a PR is merged.
Implies that PR builds do not have anti-tamper checks.
Default: true
mutableBuild - Automatically update files modified during builds to pull-request branches. This parameter is required.this@Stability(value=Deprecated) @Deprecated public ConstructLibraryAws.Builder npmignore(List<String> npmignore)
npmignore - Additional entries to .npmignore. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder npmignoreEnabled(Boolean npmignoreEnabled)
Default: true
npmignoreEnabled - Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder projenDevDependency(Boolean projenDevDependency)
Default: true
projenDevDependency - Indicates of "projen" should be installed as a devDependency. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder projenrcJs(Boolean projenrcJs)
Default: - true if projenrcJson is false
projenrcJs - Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder projenrcJsOptions(ProjenrcOptions projenrcJsOptions)
Default: - default options
projenrcJsOptions - Options for .projenrc.js. This parameter is required.this@Stability(value=Deprecated) @Deprecated public ConstructLibraryAws.Builder projenUpgradeAutoMerge(Boolean projenUpgradeAutoMerge)
Throw if set to true but autoApproveOptions are not defined.
Default: false
projenUpgradeAutoMerge - Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder projenUpgradeSchedule(List<String> projenUpgradeSchedule)
Default: [ "0 6 * * *" ]
projenUpgradeSchedule - Customize the projenUpgrade schedule in cron expression. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder projenUpgradeSecret(String projenUpgradeSecret)
This setting is a GitHub secret name which contains a GitHub Access Token
with repo and workflow permissions.
This token is used to submit the upgrade pull request, which will likely include workflow updates.
To create a personal access token see https://github.com/settings/tokens
Default: - no automatic projen upgrade pull requests
projenUpgradeSecret - Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`). This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder projenVersion(String projenVersion)
Default: - Defaults to the latest version.
projenVersion - Version of projen to install. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder pullRequestTemplate(Boolean pullRequestTemplate)
Default: true
pullRequestTemplate - Include a GitHub pull request template. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder pullRequestTemplateContents(List<String> pullRequestTemplateContents)
Default: - default content
pullRequestTemplateContents - The contents of the pull request template. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder release(Boolean release)
Default: - true (false for subprojects)
release - Add release management to this project. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder releaseToNpm(Boolean releaseToNpm)
Default: false
releaseToNpm - Automatically release to npm when new versions are introduced. This parameter is required.this@Stability(value=Deprecated) @Deprecated public ConstructLibraryAws.Builder releaseWorkflow(Boolean releaseWorkflow)
Default: - true if not a subproject
releaseWorkflow - DEPRECATED: renamed to `release`. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder workflowBootstrapSteps(List<? extends Object> workflowBootstrapSteps)
Default: "yarn install --frozen-lockfile && yarn projen"
workflowBootstrapSteps - Workflow steps to use in order to bootstrap this repo. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder workflowGitIdentity(GitIdentity workflowGitIdentity)
Default: - GitHub Actions
workflowGitIdentity - The git identity to use in workflows. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder workflowNodeVersion(String workflowNodeVersion)
Default: - same as `minNodeVersion`
workflowNodeVersion - The node version to use in GitHub workflows. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder disableTsconfig(Boolean disableTsconfig)
Default: false
disableTsconfig - Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder docgen(Boolean docgen)
Default: false
docgen - Docgen by Typedoc. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder docsDirectory(String docsDirectory)
Default: "docs"
docsDirectory - Docs directory. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder entrypointTypes(String entrypointTypes)
Default: - .d.ts file derived from the project's entrypoint (usually lib/index.d.ts)
entrypointTypes - The .d.ts file that includes the type declarations for this module. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder eslint(Boolean eslint)
Default: true
eslint - Setup eslint. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder eslintOptions(EslintOptions eslintOptions)
Default: - opinionated default options
eslintOptions - Eslint options. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder libdir(String libdir)
Default: "lib"
libdir - Typescript artifacts output directory. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder packageValue(Boolean packageValue)
Default: true
packageValue - Defines a `yarn package` command that will produce a tarball and place it under `dist/js`. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder projenrcTs(Boolean projenrcTs)
Default: false
projenrcTs - Use TypeScript for your projenrc file (`.projenrc.ts`). This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder projenrcTsOptions(ProjenrcOptions projenrcTsOptions)
projenrcTsOptions - Options for .projenrc.ts. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder sampleCode(Boolean sampleCode)
Default: true
sampleCode - Generate one-time sample in `src/` and `test/` if there are no files there. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder srcdir(String srcdir)
Default: "src"
srcdir - Typescript sources directory. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder testdir(String testdir)
If this directory is under srcdir (e.g. src/test, src/__tests__),
then tests are going to be compiled into lib/ and executed as javascript.
If the test directory is outside of src, then we configure jest to
compile the code in-memory.
Default: "test"
testdir - Jest tests directory. Tests files should be named `xxx.test.ts`. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder tsconfig(TypescriptConfigOptions tsconfig)
Default: - default options
tsconfig - Custom TSConfig. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder tsconfigDev(TypescriptConfigOptions tsconfigDev)
Default: - use the production tsconfig options
tsconfigDev - Custom tsconfig options for the development tsconfig.json file (used for testing). This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder tsconfigDevFile(String tsconfigDevFile)
Default: "tsconfig.dev.json"
tsconfigDevFile - The name of the development tsconfig.json file. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder typescriptVersion(String typescriptVersion)
NOTE: Typescript is not semantically versioned and should remain on the
same minor, so we recommend using a ~ dependency (e.g. ~1.2.3).
Default: "latest"
typescriptVersion - TypeScript version to use. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder author(String author)
Default: $GIT_USER_NAME
author - The name of the library author. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder authorAddress(String authorAddress)
Default: $GIT_USER_EMAIL
authorAddress - Email or URL of the library author. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder repositoryUrl(String repositoryUrl)
Default: $GIT_REMOTE
repositoryUrl - Git repository URL. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder compat(Boolean compat)
yarn compat if this feature is disabled.Default: false
compat - Automatically run API compatibility test against the latest version published to npm after compilation. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder compatIgnore(String compatIgnore)
Default: ".compatignore"
compatIgnore - Name of the ignore file for API compatibility tests. This parameter is required.this@Stability(value=Deprecated) @Deprecated public ConstructLibraryAws.Builder dotnet(JsiiDotNetTarget dotnet)
dotnet - This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder excludeTypescript(List<String> excludeTypescript)
Files matching any of those patterns will be excluded from the TypeScript compiler input.
By default, jsii will include all *.ts files (except .d.ts files) in the TypeScript compiler input. This can be problematic for example when the package's build or test procedure generates .ts files that cannot be compiled with jsii's compiler settings.
excludeTypescript - Accepts a list of glob patterns. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder publishToGo(JsiiGoTarget publishToGo)
Default: - no publishing
publishToGo - Publish Go bindings to a git repository. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder publishToMaven(JsiiJavaTarget publishToMaven)
Default: - no publishing
publishToMaven - Publish to maven. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder publishToNuget(JsiiDotNetTarget publishToNuget)
Default: - no publishing
publishToNuget - Publish to NuGet. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder publishToPypi(JsiiPythonTarget publishToPypi)
Default: - no publishing
publishToPypi - Publish to pypi. This parameter is required.this@Stability(value=Deprecated) @Deprecated public ConstructLibraryAws.Builder python(JsiiPythonTarget python)
python - This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder rootdir(String rootdir)
rootdir - This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder catalog(Catalog catalog)
https://awscdk.io/packages/[@SCOPE/]PACKAGE@VERSION
The catalog will also post a tweet to https://twitter.com/awscdkio with the
package name, description and the above link. You can disable these tweets
through { announce: false }.
You can also add a Twitter handle through { twitter: 'xx' } which will be
mentioned in the tweet.
Default: - new version will be announced
catalog - Libraries will be picked up by the construct catalog when they are published to npm as jsii modules and will be published under:. This parameter is required.thishttps://github.com/construct-catalog/catalog@Stability(value=Experimental) public ConstructLibraryAws.Builder cdkVersion(String cdkVersion)
Default: "2.1.0"
cdkVersion - Minimum version of the AWS CDK to depend on. This parameter is required.this@Stability(value=Deprecated) @Deprecated public ConstructLibraryAws.Builder cdkAssert(Boolean cdkAssert)
Default: - will be included by default for AWS CDK >= 1.0.0 < 2.0.0
cdkAssert - Install the @aws-cdk/assert library?. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder cdkAssertions(Boolean cdkAssertions)
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
cdkAssertions - Install the @aws-cdk/assertions library?. This parameter is required.this@Stability(value=Deprecated) @Deprecated public ConstructLibraryAws.Builder cdkDependencies(List<String> cdkDependencies)
cdkDependencies - Which AWS CDK modules (those that start with "@aws-cdk/") does this library require when consumed?. This parameter is required.this@Stability(value=Deprecated) @Deprecated public ConstructLibraryAws.Builder cdkDependenciesAsDeps(Boolean cdkDependenciesAsDeps)
This is to ensure that downstream consumers actually have your CDK dependencies installed
when using npm < 7 or yarn, where peer dependencies are not automatically installed.
If this is disabled, cdkDependencies will be added to devDependencies to ensure
they are present during development.
Default: true
cdkDependenciesAsDeps - If this is enabled (default), all modules declared in `cdkDependencies` will be also added as normal `dependencies` (as well as `peerDependencies`). This parameter is required.this@Stability(value=Deprecated) @Deprecated public ConstructLibraryAws.Builder cdkTestDependencies(List<String> cdkTestDependencies)
cdkTestDependencies - AWS CDK modules required for testing. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder cdkVersionPinning(Boolean cdkVersionPinning)
You can use this to prevent yarn to mix 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.
cdkVersionPinning - Use pinned version instead of caret version for CDK. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder constructsVersion(String constructsVersion)
Default: - for CDK 1.x the default is "3.2.27", for CDK 2.x the default is "10.0.5".
constructsVersion - Minimum version of the `constructs` library to depend on. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder lambdaAutoDiscover(Boolean lambdaAutoDiscover)
Default: true
lambdaAutoDiscover - Automatically adds an `aws_lambda.Function` for each `.lambda.ts` handler in your source tree. If this is disabled, you either need to explicitly call `aws_lambda.Function.autoDiscover()` or define a `new aws_lambda.Function()` for each handler. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws.Builder lambdaOptions(LambdaFunctionCommonOptions lambdaOptions)
Default: - default options
lambdaOptions - Common options for all AWS Lambda functions. This parameter is required.this@Stability(value=Experimental) public ConstructLibraryAws build()
build in interface software.amazon.jsii.Builder<ConstructLibraryAws>Copyright © 2021. All rights reserved.