Variable AwsCdkTsAppBaseBuilder`Const`

AwsCdkTsAppBaseBuilder: ProjectBuilder<typeof AwsCdkTypeScriptApp, {
    allowLibraryDependencies?: boolean;
    appEntrypoint?: string;
    artifactsDirectory?: string;
    authorEmail?: string;
    authorName?: string;
    authorOrganization?: true;
    authorUrl?: string;
    autoApproveOptions?: AutoApproveOptions;
    autoApproveUpgrades?: boolean;
    autoDetectBin?: boolean;
    autoMerge?: boolean;
    autoMergeOptions?: AutoMergeOptions;
    bin?: Record<string, string>;
    bugsEmail?: string;
    bugsUrl?: string;
    buildCommand?: string;
    buildWorkflow?: boolean;
    buildWorkflowOptions?: BuildWorkflowOptions;
    buildWorkflowTriggers?: Triggers;
    bundledDeps?: string[];
    bundlerOptions?: BundlerOptions;
    cdkAssert?: boolean;
    cdkAssertions?: boolean;
    cdkDependencies?: string[];
    cdkDependenciesAsDeps?: boolean;
    cdkTestDependencies?: string[];
    cdkVersion: string;
    cdkVersionPinning?: boolean;
    cdkout?: string;
    checkLicenses?: LicenseCheckerOptions;
    clobber?: boolean;
    codeArtifactOptions?: CodeArtifactOptions;
    codeCov?: boolean;
    codeCovTokenSecret?: string;
    commitGenerated?: boolean;
    constructsVersion?: string;
    context?: {
        [key: string]: any;
    };
    copyrightOwner?: string;
    copyrightPeriod?: string;
    defaultReleaseBranch?: string;
    dependabot?: boolean;
    dependabotOptions?: DependabotOptions;
    deps?: string[];
    depsUpgrade?: boolean;
    depsUpgradeOptions?: UpgradeDependenciesOptions;
    description?: string;
    devContainer?: boolean;
    devDeps?: string[];
    disableTsconfig?: boolean;
    disableTsconfigDev?: boolean;
    docgen?: boolean;
    docsDirectory?: string;
    edgeLambdaAutoDiscover?: boolean;
    entrypoint?: string;
    entrypointTypes?: string;
    eslint?: boolean;
    eslintOptions?: EslintOptions;
    experimentalIntegRunner?: boolean;
    featureFlags?: boolean;
    gitIgnoreOptions?: IgnoreFileOptions;
    gitOptions?: GitOptions;
    github?: boolean;
    githubOptions?: GitHubOptions;
    gitignore?: string[];
    gitpod?: boolean;
    homepage?: string;
    integrationTestAutoDiscover?: boolean;
    jest?: false;
    jestOptions?: JestOptions;
    jsiiReleaseVersion?: string;
    keywords?: string[];
    lambdaAutoDiscover?: boolean;
    lambdaExtensionAutoDiscover?: boolean;
    lambdaOptions?: LambdaFunctionCommonOptions;
    libdir?: string;
    license?: string;
    licensed?: boolean;
    logging?: {
        level: INFO;
        usePrefix: true;
    };
    majorVersion?: number;
    maxNodeVersion?: string;
    mergify?: boolean;
    mergifyOptions?: MergifyOptions;
    minMajorVersion?: number;
    minNodeVersion?: string;
    mutableBuild?: boolean;
    name: string;
    npmAccess?: PUBLIC;
    npmDistTag?: string;
    npmIgnoreOptions?: IgnoreFileOptions;
    npmProvenance?: boolean;
    npmRegistry?: string;
    npmRegistryUrl?: string;
    npmTokenSecret?: string;
    npmignore?: string[];
    npmignoreEnabled?: boolean;
    outdir?: string;
    package?: boolean;
    packageManager?: PNPM;
    packageName?: string;
    parent?: Project;
    peerDependencyOptions?: PeerDependencyOptions;
    peerDeps?: string[];
    pnpmVersion?: string;
    postBuildSteps?: JobStep[];
    prerelease?: string;
    prettier?: true;
    prettierOptions?: PrettierOptions;
    projectType?: ProjectType;
    projenCommand?: string;
    projenCredentials?: GithubCredentials;
    projenDevDependency?: false;
    projenTokenSecret?: string;
    projenVersion?: string;
    projenrcJs?: boolean;
    projenrcJsOptions?: ProjenrcOptions;
    projenrcJson?: boolean;
    projenrcJsonOptions?: ProjenrcJsonOptions;
    projenrcTs?: true;
    projenrcTsOptions?: ProjenrcOptions;
    publishDryRun?: boolean;
    publishTasks?: boolean;
    pullRequestTemplate?: boolean;
    pullRequestTemplateContents?: string[];
    readme?: SampleReadmeProps;
    releasableCommits?: ReleasableCommits;
    release?: true;
    releaseBranches?: {
        [name: string]: BranchOptions;
    };
    releaseEveryCommit?: boolean;
    releaseFailureIssue?: boolean;
    releaseFailureIssueLabel?: string;
    releaseSchedule?: string;
    releaseTagPrefix?: string;
    releaseToNpm?: true;
    releaseTrigger?: ReleaseTrigger;
    releaseWorkflow?: boolean;
    releaseWorkflowName?: string;
    releaseWorkflowSetupSteps?: JobStep[];
    renovatebot?: boolean;
    renovatebotOptions?: RenovatebotOptions;
    repository?: string;
    repositoryDirectory?: string;
    requireApproval?: ApprovalLevel;
    sampleCode?: boolean;
    scopedPackagesOptions?: ScopedPackagesOptions[];
    scripts?: {
        [name: string]: string;
    };
    srcdir?: string;
    stability?: string;
    stale?: boolean;
    staleOptions?: StaleOptions;
    testdir?: string;
    tsJestOptions?: TsJestOptions;
    tsconfig?: TypescriptConfigOptions;
    tsconfigBase?: TypescriptConfigExtends;
    tsconfigDev?: TypescriptConfigOptions;
    tsconfigDevFile?: string;
    typescriptVersion?: string;
    unbuild?: boolean;
    unbuildCompositePreset?: boolean;
    versionrcOptions?: Record<string, any>;
    vscode?: boolean;
    watchExcludes?: string[];
    watchIncludes?: string[];
    workflowBootstrapSteps?: JobStep[];
    workflowContainerImage?: string;
    workflowGitIdentity?: GitIdentity;
    workflowNodeVersion?: string;
    workflowPackageCache?: boolean;
    workflowRunsOn?: string[];
    workflowRunsOnGroup?: GroupRunnerOptions;
    workspaceDeps?: (string | NodeProject)[];
    yarnBerryOptions?: YarnBerryOptions;
}, object & TypescriptConfigBuilderProps & {
    lintConfig: LintConfig;
} & {
    pnpm: PnpmWorkspace;
    addWorkspaceDeps(...dependency: [options: string | NodeProject | {
        addTsPath: boolean;
        depType: DependencyType;
    }, ...deps: (string | NodeProject)[]]): void;
    formatExecCommand(...args: string[]): string;
} & {
    unbuild?: UnBuild;
}> = ...

Base awscdk builder with most commonly used steps.

Type declaration

Optional ReadonlyallowLibraryDependencies?: boolean
Allow the project to include peerDependencies and bundledDependencies. This is normally only allowed for libraries. For apps, there's no meaning for specifying these.
Default
```
true
```
Optional ReadonlyappEntrypoint?: string
The CDK app's entrypoint (relative to the source directory, which is "src" by default).
Default
```
"main.ts"
```
Optional ReadonlyartifactsDirectory?: string
A directory which will contain build artifacts.
Default
```
"dist"
```
OptionalauthorEmail?: string
OptionalauthorName?: string
OptionalauthorOrganization?: true
OptionalauthorUrl?: string
Optional ReadonlyautoApproveOptions?: AutoApproveOptions
Enable and configure the 'auto approve' workflow.
Default
```
- auto approve is disabled
```
Optional ReadonlyautoApproveUpgrades?: boolean
Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued).

Throw if set to true but autoApproveOptions are not defined.
Default
```
- true
```
Optional ReadonlyautoDetectBin?: boolean
Automatically add all executables under the bin directory to your package.json file under the bin section.
Default
```
true
```
Optional ReadonlyautoMerge?: boolean
Enable automatic merging on GitHub. Has no effect if github.mergify is set to false.
Default
```
true
```
Optional ReadonlyautoMergeOptions?: AutoMergeOptions
Configure options for automatic merging on GitHub. Has no effect if github.mergify or autoMerge is set to false.
Default
- see defaults in AutoMergeOptions
Optional Readonlybin?: Record<string, string>
Binary programs vended with your module.

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.
Optional ReadonlybugsEmail?: string
The email address to which issues should be reported.
Optional ReadonlybugsUrl?: string
The url to your project's issue tracker.
Optional ReadonlybuildCommand?: string
A command to execute before synthesis. This command will be called when running cdk synth or when cdk watch identifies a change in your source code before redeployment.
Default
```
- no build command
```
Optional ReadonlybuildWorkflow?: boolean
Define a GitHub workflow for building PRs.
Default
```
- true if not a subproject
```
Optional ReadonlybuildWorkflowOptions?: BuildWorkflowOptions
Options for PR build workflow.
Optional ReadonlybuildWorkflowTriggers?: Triggers
Build workflow triggers
Default
```
"{ pullRequest: {}, workflowDispatch: {} }"
```
Deprecated
- Use buildWorkflowOptions.workflowTriggers
Optional ReadonlybundledDeps?: string[]
List of dependencies to bundle into this module. 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.
Optional ReadonlybundlerOptions?: BundlerOptions
Options for Bundler.
Optional ReadonlycdkAssert?: boolean
Warning: NodeJS only. Install the @aws-cdk/assert library?
Default
```
- will be included by default for AWS CDK >= 1.0.0 < 2.0.0
```
Deprecated
The @aws-cdk/assert library is deprecated in favor of @aws-cdk/assertions (in V1) and included in aws-cdk-lib for V2.
Optional ReadonlycdkAssertions?: boolean
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
```
Optional ReadonlycdkDependencies?: string[]
Which AWS CDKv1 modules this project requires

Deprecated
For CDK 2.x use "deps" instead. (or "peerDeps" if you're building a library)
Optional ReadonlycdkDependenciesAsDeps?: boolean
If this is enabled (default), all modules declared in cdkDependencies will be also added as normal dependencies (as well as peerDependencies).

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

Note: this setting only applies to construct library projects
Default
```
true
```
Deprecated
Not supported in CDK v2.
Optional ReadonlycdkTestDependencies?: string[]
AWS CDK modules required for testing.

Deprecated
For CDK 2.x use 'devDeps' (in node.js projects) or 'testDeps' (in java projects) instead
ReadonlycdkVersion: string
Minimum version of the AWS CDK to depend on.
Default
```
"2.1.0"
```
Optional ReadonlycdkVersionPinning?: boolean
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.
Optional Readonlycdkout?: string
cdk.out directory.
Default
```
"cdk.out"
```
Optional ReadonlycheckLicenses?: LicenseCheckerOptions
Configure which licenses should be deemed acceptable for use by dependencies

This setting will cause the build to fail, if any prohibited or not allowed licenses ares encountered.
Default
```
- no license checks are run during the build and all licenses will be accepted
```
Optional Readonlyclobber?: boolean
Add a clobber task which resets the repo to origin.
Default
```
- true, but false for subprojects
```
Optional ReadonlycodeArtifactOptions?: CodeArtifactOptions
Options for npm packages using AWS CodeArtifact. This is required if publishing packages to, or installing scoped packages from AWS CodeArtifact
Default
```
- undefined
```
Optional ReadonlycodeCov?: boolean
Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v4 A secret is required for private repos. Configured with @codeCovTokenSecret
Default
```
false
```
Optional ReadonlycodeCovTokenSecret?: string
Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories
Default
```
- if this option is not specified, only public repositories are supported
```
Optional ReadonlycommitGenerated?: boolean
Whether to commit the managed files by default.
Default
```
true
```
Optional ReadonlyconstructsVersion?: string
Minimum version of the constructs library to depend on.
Default
```
- for CDK 1.x the default is "3.2.27", for CDK 2.x the default is
"10.0.5".
```
Optional Readonlycontext?: {
[key: string]: any;
}
Additional context to include in cdk.json.
Default
```
- no additional context
```
- [key: string]: any
Optional ReadonlycopyrightOwner?: string
License copyright owner.
Default
- defaults to the value of authorName or "" if authorName is undefined.
Optional ReadonlycopyrightPeriod?: string
The copyright years to put in the LICENSE file.
Default
```
- current year
```
OptionaldefaultReleaseBranch?: string
Optional Readonlydependabot?: boolean
Use dependabot to handle dependency upgrades. Cannot be used in conjunction with depsUpgrade.
Default
```
false
```
Optional ReadonlydependabotOptions?: DependabotOptions
Options for dependabot.
Default
```
- default options
```
Optional Readonlydeps?: string[]
Runtime dependencies of this module.

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.
Example
```
[ 'express', 'lodash', 'foo@^2' ]
```
Default
```
[]
```
Featured
Optional ReadonlydepsUpgrade?: boolean
Use tasks and github workflows to handle dependency upgrades. Cannot be used in conjunction with dependabot.
Default
```
true
```
Optional ReadonlydepsUpgradeOptions?: UpgradeDependenciesOptions
Options for UpgradeDependencies.
Default
```
- default options
```
Optional Readonlydescription?: string
The description is just a string that helps people understand the purpose of the package. 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

Featured
Optional ReadonlydevContainer?: boolean
Add a VSCode development environment (used for GitHub Codespaces)
Default
```
false
```
Optional ReadonlydevDeps?: string[]
Build dependencies for this module. 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.
Example
```
[ 'typescript', '@types/express' ]
```
Default
```
[]
```
Featured
Optional ReadonlydisableTsconfig?: boolean
Do not generate a tsconfig.json file (used by jsii projects since tsconfig.json is generated by the jsii compiler).
Default
```
false
```
Optional ReadonlydisableTsconfigDev?: boolean
Do not generate a tsconfig.dev.json file.
Default
```
false
```
Optional Readonlydocgen?: boolean
Docgen by Typedoc
Default
```
false
```
Optional ReadonlydocsDirectory?: string
Docs directory
Default
```
"docs"
```
Optional ReadonlyedgeLambdaAutoDiscover?: boolean
Automatically adds an cloudfront.experimental.EdgeFunction for each .edge-lambda.ts handler in your source tree. If this is disabled, you can manually add an awscdk.AutoDiscover component to your project.
Default
```
true
```
Optionalentrypoint?: string
OptionalentrypointTypes?: string
Optional Readonlyeslint?: boolean
Setup eslint.
Default
```
true
```
Optional ReadonlyeslintOptions?: EslintOptions
Eslint options
Default
```
- opinionated default options
```
Optional Readonly ExperimentalexperimentalIntegRunner?: boolean
Enable experimental support for the AWS CDK integ-runner.
Default
```
false
@experimental
```
Optional ReadonlyfeatureFlags?: boolean
Include all feature flags in cdk.json
Default
```
true
```
Optional ReadonlygitIgnoreOptions?: IgnoreFileOptions
Configuration options for .gitignore file
Optional ReadonlygitOptions?: GitOptions
Configuration options for git
Optional Readonlygithub?: boolean
Enable GitHub integration.

Enabled by default for root projects. Disabled for non-root projects.
Default
```
true
```
Optional ReadonlygithubOptions?: GitHubOptions
Options for GitHub integration
Default
```
- see GitHubOptions
```
Optional Readonlygitignore?: string[]
Additional entries to .gitignore
Optional Readonlygitpod?: boolean
Add a Gitpod development environment
Default
```
false
```
Optional Readonlyhomepage?: string
Package's Homepage / Website
Optional ReadonlyintegrationTestAutoDiscover?: boolean
Automatically discovers and creates integration tests for each .integ.ts file in under your test directory.
Default
```
true
```
Optionaljest?: false
Optional ReadonlyjestOptions?: JestOptions
Jest options
Default
```
- default options
```
Optional ReadonlyjsiiReleaseVersion?: string
Version requirement of publib which is used to publish modules to npm.
Default
```
"latest"
```
Optional Readonlykeywords?: string[]
Keywords to include in package.json.
Optional ReadonlylambdaAutoDiscover?: boolean
Automatically adds an awscdk.LambdaFunction for each .lambda.ts handler in your source tree. If this is disabled, you can manually add an awscdk.AutoDiscover component to your project.
Default
```
true
```
Optional ReadonlylambdaExtensionAutoDiscover?: boolean
Automatically adds an awscdk.LambdaExtension for each .lambda-extension.ts entrypoint in your source tree. If this is disabled, you can manually add an awscdk.AutoDiscover component to your project
Default
```
true
```
Optional ReadonlylambdaOptions?: LambdaFunctionCommonOptions
Common options for all AWS Lambda functions.
Default
```
- default options
```
Optionallibdir?: string
Optional Readonlylicense?: string
License's SPDX identifier. 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"
```
Optional Readonlylicensed?: boolean
Indicates if a license should be added.
Default
```
true
```
Optionallogging?: {
level: INFO;
usePrefix: true;
}
- level: INFO
- usePrefix: true
Optional ReadonlymajorVersion?: number
Major version to release from the default branch.

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.
```
Optional ReadonlymaxNodeVersion?: string
Minimum node.js version to require via engines (inclusive).
Default
```
- no max
```
Optional Readonlymergify?: boolean
Whether mergify should be enabled on this repository or not.
Default
```
true
```
Deprecated
use githubOptions.mergify instead
Optional ReadonlymergifyOptions?: MergifyOptions
Options for mergify
Default
```
- default options
```
Deprecated
use githubOptions.mergifyOptions instead
Optional ReadonlyminMajorVersion?: number
Minimal Major version to release

This can be useful to set to 1, as breaking changes before the 1.x major release are not incrementing the major version number.

Can not be set together with majorVersion.
Default
```
- No minimum version is being enforced
```
Optional ReadonlyminNodeVersion?: string
Minimum Node.js version to require via package.json engines (inclusive).
Default
```
- no "engines" specified
```
Optional ReadonlymutableBuild?: boolean
Automatically update files modified during builds to pull-request branches. 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
```
Deprecated
- Use buildWorkflowOptions.mutableBuild
Readonlyname: string
This is the name of your project.
Default
```
$BASEDIR
```
Featured
OptionalnpmAccess?: PUBLIC
Optional ReadonlynpmDistTag?: string
The npmDistTag to use when publishing from the default branch.

To set the npm dist-tag for release branches, set the npmDistTag property for each branch.
Default
```
"latest"
```
Optional ReadonlynpmIgnoreOptions?: IgnoreFileOptions
Configuration options for .npmignore file
Optional ReadonlynpmProvenance?: boolean
Should provenance statements be generated when the package is published.

A supported package manager is required to publish a package with npm provenance statements and you will need to use a supported CI/CD provider.

Note that the projen Release and Publisher components are using publib to publish packages, which is using npm internally and supports provenance statements independently of the package manager used.
See
https://docs.npmjs.com/generating-provenance-statements

Default
```
- true for public packages, false otherwise
```
Optional ReadonlynpmRegistry?: string
The host name of the npm registry to publish to. Cannot be set together with npmRegistryUrl.

Deprecated
use npmRegistryUrl instead
Optional ReadonlynpmRegistryUrl?: string
The base URL of the npm package registry.

Must be a URL (e.g. start with "https://" or "http://")
Default
```
"https://registry.npmjs.org"
```
Optional ReadonlynpmTokenSecret?: string
GitHub secret which contains the NPM token to use when publishing packages.
Default
```
"NPM_TOKEN"
```
Optional Readonlynpmignore?: string[]
Additional entries to .npmignore.
Deprecated
- use project.addPackageIgnore
Optional ReadonlynpmignoreEnabled?: boolean
Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs.
Default
```
true
```
Optional Readonlyoutdir?: string
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
```
"."
```
Optional Readonlypackage?: boolean
Defines a package task that will produce an npm tarball under the artifacts directory (e.g. dist).
Default
```
true
```
OptionalpackageManager?: PNPM
Optional ReadonlypackageName?: string
The "name" in package.json
Default
```
- defaults to project name
```
Featured
Optional Readonlyparent?: Project
The parent project, if this project is part of a bigger project.
Optional ReadonlypeerDependencyOptions?: PeerDependencyOptions
Options for peerDeps.
Optional ReadonlypeerDeps?: string[]
Peer dependencies for this module. 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
```
[]
```
OptionalpnpmVersion?: string
Optional ReadonlypostBuildSteps?: JobStep[]
Steps to execute after build as part of the release workflow.
Default
```
[]
```
Optional Readonlyprerelease?: string
Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").
Default
```
- normal semantic versions
```
Optionalprettier?: true
Optional ReadonlyprettierOptions?: PrettierOptions
Prettier options
Default
```
- default options
```
Optional ReadonlyprojectType?: ProjectType
Which type of project this is (library/app).
Default
```
ProjectType.UNKNOWN
```
Deprecated
no longer supported at the base project level
OptionalprojenCommand?: string
Optional ReadonlyprojenCredentials?: GithubCredentials
Choose a method of providing GitHub API access for projen workflows.
Default
```
- use a personal access token named PROJEN_GITHUB_TOKEN
```
OptionalprojenDevDependency?: false
Optional ReadonlyprojenTokenSecret?: string
The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. This token needs to have the repo, workflows and packages scope.
Default
```
"PROJEN_GITHUB_TOKEN"
```
Deprecated
use projenCredentials
Optional ReadonlyprojenVersion?: string
Version of projen to install.
Default
```
- Defaults to the latest version.
```
Optional ReadonlyprojenrcJs?: boolean
Generate (once) .projenrc.js (in JavaScript). Set to false in order to disable .projenrc.js generation.
Default
```
- true if projenrcJson is false
```
Optional ReadonlyprojenrcJsOptions?: ProjenrcOptions
Options for .projenrc.js
Default
```
- default options
```
Optional ReadonlyprojenrcJson?: boolean
Generate (once) .projenrc.json (in JSON). Set to false in order to disable .projenrc.json generation.
Default
```
false
```
Optional ReadonlyprojenrcJsonOptions?: ProjenrcJsonOptions
Options for .projenrc.json
Default
```
- default options
```
OptionalprojenrcTs?: true
Optional ReadonlyprojenrcTsOptions?: ProjenrcOptions
Options for .projenrc.ts
Optional ReadonlypublishDryRun?: boolean
Instead of actually publishing to package managers, just print the publishing command.
Default
```
false
```
Optional ReadonlypublishTasks?: boolean
Define publishing tasks that can be executed manually as well as workflows.

Normally, publishing only happens within automated workflows. Enable this in order to create a publishing task for each publishing activity.
Default
```
false
```
Optional ReadonlypullRequestTemplate?: boolean
Include a GitHub pull request template.
Default
```
true
```
Optional ReadonlypullRequestTemplateContents?: string[]
The contents of the pull request template.
Default
```
- default content
```

`Optional` `Readonly`readme?: SampleReadmeProps

The README setup.

Default

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

Example

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

Optional ReadonlyreleasableCommits?: ReleasableCommits
Find commits that should be considered releasable Used to decide if a release is required.
Default
```
ReleasableCommits.everyCommit()
```
Optionalrelease?: true
Optional ReadonlyreleaseBranches?: {
[name: string]: BranchOptions;
}
Defines additional release branches. 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.
- [name: string]: BranchOptions
Optional ReadonlyreleaseEveryCommit?: boolean
Automatically release new versions every commit to one of branches in releaseBranches.
Default
```
true
```
Deprecated
Use releaseTrigger: ReleaseTrigger.continuous() instead
Optional ReadonlyreleaseFailureIssue?: boolean
Create a github issue on every failed publishing task.
Default
```
false
```
Optional ReadonlyreleaseFailureIssueLabel?: string
The label to apply to issues indicating publish failures. Only applies if releaseFailureIssue is true.
Default
```
"failed-release"
```
Optional ReadonlyreleaseSchedule?: string
CRON schedule to trigger new releases.
Default
```
- no scheduled releases
```
Deprecated
Use releaseTrigger: ReleaseTrigger.scheduled() instead
Optional ReadonlyreleaseTagPrefix?: string
Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers.

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
```
"v"
```
OptionalreleaseToNpm?: true
Optional ReadonlyreleaseTrigger?: ReleaseTrigger
The release trigger to use.
Default
- Continuous releases (ReleaseTrigger.continuous())
Optional ReadonlyreleaseWorkflow?: boolean
DEPRECATED: renamed to release.
Default
```
- true if not a subproject
```
Deprecated
see release.
Optional ReadonlyreleaseWorkflowName?: string
The name of the default release workflow.
Default
```
"release"
```
Optional ReadonlyreleaseWorkflowSetupSteps?: JobStep[]
A set of workflow steps to execute in order to setup the workflow container.
Optional Readonlyrenovatebot?: boolean
Use renovatebot to handle dependency upgrades.
Default
```
false
```
Optional ReadonlyrenovatebotOptions?: RenovatebotOptions
Options for renovatebot.
Default
```
- default options
```
Optional Readonlyrepository?: string
The repository is the location where the actual code for your package lives. See https://classic.yarnpkg.com/en/docs/package-json/#toc-repository
Optional ReadonlyrepositoryDirectory?: string
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.
Optional ReadonlyrequireApproval?: ApprovalLevel
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
```
Optional ReadonlysampleCode?: boolean
Generate one-time sample in src/ and test/ if there are no files there.
Default
```
true
```
Optional ReadonlyscopedPackagesOptions?: ScopedPackagesOptions[]
Options for privately hosted scoped packages
Default
```
- fetch all scoped packages from the public npm registry
```
Optional Readonlyscripts?: {
[name: string]: string;
}
npm scripts to include. If a script has the same name as a standard script, the standard script will be overwritten. Also adds the script as a task.
Default
```
{}
```
Deprecated
use project.addTask() or package.setScript()
- [name: string]: string
Optional Readonlysrcdir?: string
Typescript sources directory.
Default
```
"src"
```
Optional Readonlystability?: string
Package's Stability
Optional Readonlystale?: boolean
Auto-close of stale issues and pull request. See staleOptions for options.
Default
```
false
```
Optional ReadonlystaleOptions?: StaleOptions
Auto-close stale issues and pull requests. To disable set stale to false.
Default
- see defaults in StaleOptions
Optional Readonlytestdir?: string
Jest tests directory. Tests files should be named xxx.test.ts.

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"
```
Optional ReadonlytsJestOptions?: TsJestOptions
Options for ts-jest
Optional Readonlytsconfig?: TypescriptConfigOptions
Custom TSConfig
Default
```
- default options
```
Optional ReadonlytsconfigBase?: TypescriptConfigExtends
Optional ReadonlytsconfigDev?: TypescriptConfigOptions
Custom tsconfig options for the development tsconfig.json file (used for testing).
Default
```
- use the production tsconfig options
```
Optional ReadonlytsconfigDevFile?: string
The name of the development tsconfig.json file.
Default
```
"tsconfig.dev.json"
```
OptionaltypescriptVersion?: string
Optional Readonlyunbuild?: boolean
Optional ReadonlyunbuildCompositePreset?: boolean
Optional ReadonlyversionrcOptions?: Record<string, any>
Custom configuration used when creating changelog with standard-version package. Given values either append to default configuration or overwrite values in it.
Default
```
- standard configuration applicable for GitHub repositories
```
Optional Readonlyvscode?: boolean
Enable VSCode integration.

Enabled by default for root projects. Disabled for non-root projects.
Default
```
true
```
Optional ReadonlywatchExcludes?: string[]
Glob patterns to exclude from cdk watch.
Default
```
[]
```
Optional ReadonlywatchIncludes?: string[]
Glob patterns to include in cdk watch.
Default
```
[]
```
Optional ReadonlyworkflowBootstrapSteps?: JobStep[]
Workflow steps to use in order to bootstrap this repo.
Default
```
"yarn install --frozen-lockfile && yarn projen"
```
Optional ReadonlyworkflowContainerImage?: string
Container image to use for GitHub workflows.
Default
```
- default image
```
Optional ReadonlyworkflowGitIdentity?: GitIdentity
The git identity to use in workflows.
Default
```
- GitHub Actions
```
Optional ReadonlyworkflowNodeVersion?: string
The node version to use in GitHub workflows.
Default
- same as minNodeVersion
Optional ReadonlyworkflowPackageCache?: boolean
Enable Node.js package cache in GitHub workflows.
Default
```
false
```
Optional ReadonlyworkflowRunsOn?: string[]
Github Runner selection labels
Default
```
["ubuntu-latest"]
```
Description
Defines a target Runner by labels

Throws
if both runsOn and runsOnGroup are specified
Optional ReadonlyworkflowRunsOnGroup?: GroupRunnerOptions
Github Runner Group selection options

Description
Defines a target Runner Group by name and/or labels

Throws
if both runsOn and runsOnGroup are specified
Optional ReadonlyworkspaceDeps?: (string | NodeProject)[]
Optional ReadonlyyarnBerryOptions?: YarnBerryOptions
Options for Yarn Berry
Default
```
- Yarn Berry v4 with all default options
```

Variable AwsCdkTsAppBaseBuilderConst

Type declaration

Optional ReadonlyallowLibraryDependencies?: boolean

Default

Optional ReadonlyappEntrypoint?: string

Default

Optional ReadonlyartifactsDirectory?: string

Default

OptionalauthorEmail?: string

OptionalauthorName?: string

OptionalauthorOrganization?: true

OptionalauthorUrl?: string

Optional ReadonlyautoApproveOptions?: AutoApproveOptions

Default

Optional ReadonlyautoApproveUpgrades?: boolean

Default

Optional ReadonlyautoDetectBin?: boolean

Default

Optional ReadonlyautoMerge?: boolean

Default

Optional ReadonlyautoMergeOptions?: AutoMergeOptions

Default

Optional Readonlybin?: Record<string, string>

Optional ReadonlybugsEmail?: string

Optional ReadonlybugsUrl?: string

Optional ReadonlybuildCommand?: string

Default

Optional ReadonlybuildWorkflow?: boolean

Default

Optional ReadonlybuildWorkflowOptions?: BuildWorkflowOptions

Optional ReadonlybuildWorkflowTriggers?: Triggers

Default

Deprecated

Optional ReadonlybundledDeps?: string[]

Optional ReadonlybundlerOptions?: BundlerOptions

Optional ReadonlycdkAssert?: boolean

Default

Deprecated

Optional ReadonlycdkAssertions?: boolean

Default

Optional ReadonlycdkDependencies?: string[]

Deprecated

Optional ReadonlycdkDependenciesAsDeps?: boolean

Default

Deprecated

Optional ReadonlycdkTestDependencies?: string[]

Deprecated

ReadonlycdkVersion: string

Default

Optional ReadonlycdkVersionPinning?: boolean

Optional Readonlycdkout?: string

Default

Optional ReadonlycheckLicenses?: LicenseCheckerOptions

Default

Optional Readonlyclobber?: boolean

Default

Optional ReadonlycodeArtifactOptions?: CodeArtifactOptions

Default

Optional ReadonlycodeCov?: boolean

Default

Optional ReadonlycodeCovTokenSecret?: string

Default

Optional ReadonlycommitGenerated?: boolean

Default

Optional ReadonlyconstructsVersion?: string

Default

Optional Readonlycontext?: { [key: string]: any; }

Default

[key: string]: any

Optional ReadonlycopyrightOwner?: string

Default

Optional ReadonlycopyrightPeriod?: string

Default

OptionaldefaultReleaseBranch?: string

Optional Readonlydependabot?: boolean

Default

Optional ReadonlydependabotOptions?: DependabotOptions

Default

Optional Readonlydeps?: string[]

Example

Variable AwsCdkTsAppBaseBuilder`Const`

`Optional` `Readonly`allowLibraryDependencies?: boolean

`Optional` `Readonly`appEntrypoint?: string

`Optional` `Readonly`artifactsDirectory?: string

`Optional`authorEmail?: string

`Optional`authorName?: string

`Optional`authorOrganization?: true

`Optional`authorUrl?: string

`Optional` `Readonly`autoApproveOptions?: AutoApproveOptions

`Optional` `Readonly`autoApproveUpgrades?: boolean

`Optional` `Readonly`autoDetectBin?: boolean

`Optional` `Readonly`autoMerge?: boolean

`Optional` `Readonly`autoMergeOptions?: AutoMergeOptions

`Optional` `Readonly`bin?: Record<string, string>

`Optional` `Readonly`bugsEmail?: string

`Optional` `Readonly`bugsUrl?: string

`Optional` `Readonly`buildCommand?: string

`Optional` `Readonly`buildWorkflow?: boolean

`Optional` `Readonly`buildWorkflowOptions?: BuildWorkflowOptions

`Optional` `Readonly`buildWorkflowTriggers?: Triggers

`Optional` `Readonly`bundledDeps?: string[]

`Optional` `Readonly`bundlerOptions?: BundlerOptions

`Optional` `Readonly`cdkAssert?: boolean

`Optional` `Readonly`cdkAssertions?: boolean

`Optional` `Readonly`cdkDependencies?: string[]

`Optional` `Readonly`cdkDependenciesAsDeps?: boolean

`Optional` `Readonly`cdkTestDependencies?: string[]

`Readonly`cdkVersion: string

`Optional` `Readonly`cdkVersionPinning?: boolean

`Optional` `Readonly`cdkout?: string

`Optional` `Readonly`checkLicenses?: LicenseCheckerOptions

`Optional` `Readonly`clobber?: boolean

`Optional` `Readonly`codeArtifactOptions?: CodeArtifactOptions

`Optional` `Readonly`codeCov?: boolean

`Optional` `Readonly`codeCovTokenSecret?: string

`Optional` `Readonly`commitGenerated?: boolean

`Optional` `Readonly`constructsVersion?: string

`Optional` `Readonly`context?: {
[key: string]: any;
}

`Optional` `Readonly`copyrightOwner?: string

`Optional` `Readonly`copyrightPeriod?: string

`Optional`defaultReleaseBranch?: string

`Optional` `Readonly`dependabot?: boolean

`Optional` `Readonly`dependabotOptions?: DependabotOptions

`Optional` `Readonly`deps?: string[]

`Optional` `Readonly`depsUpgrade?: boolean

`Optional` `Readonly`depsUpgradeOptions?: UpgradeDependenciesOptions

`Optional` `Readonly`description?: string

`Optional` `Readonly`devContainer?: boolean

`Optional` `Readonly`devDeps?: string[]

`Optional` `Readonly`disableTsconfig?: boolean

`Optional` `Readonly`disableTsconfigDev?: boolean

`Optional` `Readonly`docgen?: boolean

`Optional` `Readonly`docsDirectory?: string

`Optional` `Readonly`edgeLambdaAutoDiscover?: boolean

`Optional`entrypoint?: string

`Optional`entrypointTypes?: string

`Optional` `Readonly`eslint?: boolean

`Optional` `Readonly`eslintOptions?: EslintOptions

`Optional` `Readonly` `Experimental`experimentalIntegRunner?: boolean

`Optional` `Readonly`featureFlags?: boolean

`Optional` `Readonly`gitIgnoreOptions?: IgnoreFileOptions

`Optional` `Readonly`gitOptions?: GitOptions

`Optional` `Readonly`github?: boolean

`Optional` `Readonly`githubOptions?: GitHubOptions

`Optional` `Readonly`gitignore?: string[]

`Optional` `Readonly`gitpod?: boolean

`Optional` `Readonly`homepage?: string

`Optional` `Readonly`integrationTestAutoDiscover?: boolean

`Optional`jest?: false

`Optional` `Readonly`jestOptions?: JestOptions

`Optional` `Readonly`jsiiReleaseVersion?: string

`Optional` `Readonly`keywords?: string[]

`Optional` `Readonly`lambdaAutoDiscover?: boolean

`Optional` `Readonly`lambdaExtensionAutoDiscover?: boolean

`Optional` `Readonly`lambdaOptions?: LambdaFunctionCommonOptions

`Optional`libdir?: string

`Optional` `Readonly`license?: string

`Optional` `Readonly`licensed?: boolean

`Optional`logging?: {
level: INFO;
usePrefix: true;
}

`Optional` `Readonly`majorVersion?: number