# API Reference ## Constructs ### PDKPipeline An extension to CodePipeline which configures sane defaults for a NX Monorepo codebase. In addition to this, it also creates a CodeCommit repository with automated PR builds and approvals. #### Initializers ```typescript import { PDKPipeline } from '@aws-prototyping-sdk/pipeline' new PDKPipeline(scope: Construct, id: string, props: PDKPipelineProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | PDKPipelineProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* PDKPipelineProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | addStage | *No description.* | | buildPipeline | *No description.* | | suppressCDKViolations | *No description.* | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `addStage` ```typescript public addStage(stage: Stage, options?: AddStageOpts): StageDeployment ``` ###### `stage`^Required - *Type:* aws-cdk-lib.Stage --- ###### `options`^Optional - *Type:* aws-cdk-lib.pipelines.AddStageOpts --- ##### `buildPipeline` ```typescript public buildPipeline(): void ``` ##### `suppressCDKViolations` ```typescript public suppressCDKViolations(): void ``` #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | getBranchPrefix | A helper function to create a branch prefix. | | isDefaultBranch | A helper function to determine if the current branch is the default branch. | | normalizeBranchName | A helper function to normalize the branch name with only alphanumeric characters and hypens ('-'). | --- ##### `isConstruct` ```typescript import { PDKPipeline } from '@aws-prototyping-sdk/pipeline' PDKPipeline.isConstruct(x: any) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* any Any object. --- ##### `getBranchPrefix` ```typescript import { PDKPipeline } from '@aws-prototyping-sdk/pipeline' PDKPipeline.getBranchPrefix(props?: IsDefaultBranchProps) ``` A helper function to create a branch prefix. The prefix is empty on the default branch. ###### `props`^Optional - *Type:* IsDefaultBranchProps ? { defaultBranchName? Specify the default branch name without context. node? The current app to fetch defaultBranchName from context. }. --- ##### `isDefaultBranch` ```typescript import { PDKPipeline } from '@aws-prototyping-sdk/pipeline' PDKPipeline.isDefaultBranch(props?: IsDefaultBranchProps) ``` A helper function to determine if the current branch is the default branch. If there is no BRANCH environment variable, then assume this is the default branch. Otherwise, check that BRANCH matches the default branch name. The default branch name is determined in the following priority: 1. defaultBranchName property 2. defaultBranchName context 3. PDKPipeline.defaultBranchName constant ###### `props`^Optional - *Type:* IsDefaultBranchProps ? { defaultBranchName? Specify the default branch name without context. node? The current app to fetch defaultBranchName from context. }. --- ##### `normalizeBranchName` ```typescript import { PDKPipeline } from '@aws-prototyping-sdk/pipeline' PDKPipeline.normalizeBranchName(branchName: string) ``` A helper function to normalize the branch name with only alphanumeric characters and hypens ('-'). ###### `branchName`^Required - *Type:* string The name of the branch to normalize. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | codePipeline | aws-cdk-lib.pipelines.CodePipeline | *No description.* | | codeRepository | aws-cdk-lib.aws_codecommit.IRepository | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `codePipeline`^Required ```typescript public readonly codePipeline: CodePipeline; ``` - *Type:* aws-cdk-lib.pipelines.CodePipeline --- ##### `codeRepository`^Required ```typescript public readonly codeRepository: IRepository; ``` - *Type:* aws-cdk-lib.aws_codecommit.IRepository --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ALL_BRANCHES | string[] | *No description.* | | defaultBranchName | string | *No description.* | --- ##### `ALL_BRANCHES`^Required ```typescript public readonly ALL_BRANCHES: string[]; ``` - *Type:* string[] --- ##### `defaultBranchName`^Required ```typescript public readonly defaultBranchName: string; ``` - *Type:* string --- ### SonarCodeScanner #### Initializers ```typescript import { SonarCodeScanner } from '@aws-prototyping-sdk/pipeline' new SonarCodeScanner(scope: Construct, id: string, props: SonarCodeScannerProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | SonarCodeScannerProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* SonarCodeScannerProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```typescript import { SonarCodeScanner } from '@aws-prototyping-sdk/pipeline' SonarCodeScanner.isConstruct(x: any) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ## Structs ### IsDefaultBranchProps Properties to help the isDefaultBranch function determine the default branch name. #### Initializer ```typescript import { IsDefaultBranchProps } from '@aws-prototyping-sdk/pipeline' const isDefaultBranchProps: IsDefaultBranchProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | defaultBranchName | string | Specify the default branch name without context. | | node | constructs.Node | The current node to fetch defaultBranchName from context. | --- ##### `defaultBranchName`^Optional ```typescript public readonly defaultBranchName: string; ``` - *Type:* string Specify the default branch name without context. --- ##### `node`^Optional ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The current node to fetch defaultBranchName from context. --- ### PDKPipelineJavaProjectOptions Configuration options for the PDKPipelineJavaProject. #### Initializer ```typescript import { PDKPipelineJavaProjectOptions } from '@aws-prototyping-sdk/pipeline' const pDKPipelineJavaProjectOptions: PDKPipelineJavaProjectOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | This is the name of your project. | | commitGenerated | boolean | Whether to commit the managed files by default. | | gitIgnoreOptions | projen.IgnoreFileOptions | Configuration options for .gitignore file. | | gitOptions | projen.GitOptions | Configuration options for git. | | logging | projen.LoggerOptions | Configure logging options such as verbosity. | | outdir | string | The root directory of the project. | | parent | projen.Project | The parent project, if this project is part of a bigger project. | | projenCommand | string | The shell command to use in order to run the projen CLI. | | projenrcJson | boolean | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. | | projenrcJsonOptions | projen.ProjenrcJsonOptions | Options for .projenrc.json. | | renovatebot | boolean | Use renovatebot to handle dependency upgrades. | | renovatebotOptions | projen.RenovatebotOptions | Options for renovatebot. | | autoApproveOptions | projen.github.AutoApproveOptions | Enable and configure the 'auto approve' workflow. | | autoMerge | boolean | Enable automatic merging on GitHub. | | autoMergeOptions | projen.github.AutoMergeOptions | Configure options for automatic merging on GitHub. | | clobber | boolean | Add a `clobber` task which resets the repo to origin. | | devContainer | boolean | Add a VSCode development environment (used for GitHub Codespaces). | | github | boolean | Enable GitHub integration. | | githubOptions | projen.github.GitHubOptions | Options for GitHub integration. | | gitpod | boolean | Add a Gitpod development environment. | | mergify | boolean | Whether mergify should be enabled on this repository or not. | | mergifyOptions | projen.github.MergifyOptions | Options for mergify. | | projectType | projen.ProjectType | Which type of project this is (library/app). | | projenCredentials | projen.github.GithubCredentials | Choose a method of providing GitHub API access for projen workflows. | | projenTokenSecret | string | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. | | readme | projen.SampleReadmeProps | The README setup. | | stale | boolean | Auto-close of stale issues and pull request. | | staleOptions | projen.github.StaleOptions | Auto-close stale issues and pull requests. | | vscode | boolean | Enable VSCode integration. | | artifactId | string | The artifactId is generally the name that the project is known by. | | groupId | string | This is generally unique amongst an organization or a project. | | version | string | This is the last piece of the naming puzzle. | | description | string | Description of a project is always good. | | packaging | string | Project packaging format. | | url | string | The URL, like the name, is not required. | | compileOptions | projen.java.MavenCompileOptions | Compile options. | | deps | string[] | List of runtime dependencies for this project. | | distdir | string | Final artifact output directory. | | junit | boolean | Include junit tests. | | junitOptions | projen.java.JunitOptions | junit options. | | packagingOptions | projen.java.MavenPackagingOptions | Packaging options. | | projenrcJava | boolean | Use projenrc in java. | | projenrcJavaOptions | projen.java.ProjenrcOptions | Options related to projenrc in java. | | testDeps | string[] | List of test dependencies for this project. | | sample | boolean | Include sample code and test if the relevant directories don't exist. | | sampleJavaPackage | string | The java package to use for the code sample. | | buildCommand | string | A command to execute before synthesis. | | cdkout | string | cdk.out directory. | | context | {[ key: string ]: any} | Additional context to include in `cdk.json`. | | featureFlags | boolean | Include all feature flags in cdk.json. | | requireApproval | projen.awscdk.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. | | watchExcludes | string[] | Glob patterns to exclude from `cdk watch`. | | watchIncludes | string[] | Glob patterns to include in `cdk watch`. | | cdkVersion | string | Minimum version of the AWS CDK to depend on. | | cdkAssert | boolean | Warning: NodeJS only. | | cdkAssertions | boolean | Install the assertions library? | | cdkDependencies | string[] | Which AWS CDKv1 modules this project requires. | | cdkDependenciesAsDeps | boolean | If this is enabled (default), all modules declared in `cdkDependencies` will be also added as normal `dependencies` (as well as `peerDependencies`). | | cdkTestDependencies | string[] | AWS CDK modules required for testing. | | cdkVersionPinning | boolean | Use pinned version instead of caret version for CDK. | | constructsVersion | string | Minimum version of the `constructs` library to depend on. | | mainClass | string | The name of the Java class with the static `main()` method. | --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string - *Default:* $BASEDIR This is the name of your project. --- ##### `commitGenerated`^Optional ```typescript public readonly commitGenerated: boolean; ``` - *Type:* boolean - *Default:* true Whether to commit the managed files by default. --- ##### `gitIgnoreOptions`^Optional ```typescript public readonly gitIgnoreOptions: IgnoreFileOptions; ``` - *Type:* projen.IgnoreFileOptions Configuration options for .gitignore file. --- ##### `gitOptions`^Optional ```typescript public readonly gitOptions: GitOptions; ``` - *Type:* projen.GitOptions Configuration options for git. --- ##### `logging`^Optional ```typescript public readonly logging: LoggerOptions; ``` - *Type:* projen.LoggerOptions - *Default:* {} Configure logging options such as verbosity. --- ##### `outdir`^Optional ```typescript public readonly outdir: string; ``` - *Type:* string - *Default:* "." 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 sub-projects. --- ##### `parent`^Optional ```typescript public readonly parent: Project; ``` - *Type:* projen.Project The parent project, if this project is part of a bigger project. --- ##### `projenCommand`^Optional ```typescript public readonly projenCommand: string; ``` - *Type:* string - *Default:* "npx projen" The shell command to use in order to run the projen CLI. Can be used to customize in special environments. --- ##### `projenrcJson`^Optional ```typescript public readonly projenrcJson: boolean; ``` - *Type:* boolean - *Default:* false Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. --- ##### `projenrcJsonOptions`^Optional ```typescript public readonly projenrcJsonOptions: ProjenrcJsonOptions; ``` - *Type:* projen.ProjenrcJsonOptions - *Default:* default options Options for .projenrc.json. --- ##### `renovatebot`^Optional ```typescript public readonly renovatebot: boolean; ``` - *Type:* boolean - *Default:* false Use renovatebot to handle dependency upgrades. --- ##### `renovatebotOptions`^Optional ```typescript public readonly renovatebotOptions: RenovatebotOptions; ``` - *Type:* projen.RenovatebotOptions - *Default:* default options Options for renovatebot. --- ##### `autoApproveOptions`^Optional ```typescript public readonly autoApproveOptions: AutoApproveOptions; ``` - *Type:* projen.github.AutoApproveOptions - *Default:* auto approve is disabled Enable and configure the 'auto approve' workflow. --- ##### `autoMerge`^Optional ```typescript public readonly autoMerge: boolean; ``` - *Type:* boolean - *Default:* true Enable automatic merging on GitHub. Has no effect if `github.mergify` is set to false. --- ##### `autoMergeOptions`^Optional ```typescript public readonly autoMergeOptions: AutoMergeOptions; ``` - *Type:* projen.github.AutoMergeOptions - *Default:* see defaults in `AutoMergeOptions` Configure options for automatic merging on GitHub. Has no effect if `github.mergify` or `autoMerge` is set to false. --- ##### `clobber`^Optional ```typescript public readonly clobber: boolean; ``` - *Type:* boolean - *Default:* true, but false for subprojects Add a `clobber` task which resets the repo to origin. --- ##### `devContainer`^Optional ```typescript public readonly devContainer: boolean; ``` - *Type:* boolean - *Default:* false Add a VSCode development environment (used for GitHub Codespaces). --- ##### `github`^Optional ```typescript public readonly github: boolean; ``` - *Type:* boolean - *Default:* true Enable GitHub integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `githubOptions`^Optional ```typescript public readonly githubOptions: GitHubOptions; ``` - *Type:* projen.github.GitHubOptions - *Default:* see GitHubOptions Options for GitHub integration. --- ##### `gitpod`^Optional ```typescript public readonly gitpod: boolean; ``` - *Type:* boolean - *Default:* false Add a Gitpod development environment. --- ##### ~~`mergify`~~^Optional - *Deprecated:* use `githubOptions.mergify` instead ```typescript public readonly mergify: boolean; ``` - *Type:* boolean - *Default:* true Whether mergify should be enabled on this repository or not. --- ##### ~~`mergifyOptions`~~^Optional - *Deprecated:* use `githubOptions.mergifyOptions` instead ```typescript public readonly mergifyOptions: MergifyOptions; ``` - *Type:* projen.github.MergifyOptions - *Default:* default options Options for mergify. --- ##### ~~`projectType`~~^Optional - *Deprecated:* no longer supported at the base project level ```typescript public readonly projectType: ProjectType; ``` - *Type:* projen.ProjectType - *Default:* ProjectType.UNKNOWN Which type of project this is (library/app). --- ##### `projenCredentials`^Optional ```typescript public readonly projenCredentials: GithubCredentials; ``` - *Type:* projen.github.GithubCredentials - *Default:* use a personal access token named PROJEN_GITHUB_TOKEN Choose a method of providing GitHub API access for projen workflows. --- ##### ~~`projenTokenSecret`~~^Optional - *Deprecated:* use `projenCredentials` ```typescript public readonly projenTokenSecret: string; ``` - *Type:* string - *Default:* "PROJEN_GITHUB_TOKEN" 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. --- ##### `readme`^Optional ```typescript public readonly readme: SampleReadmeProps; ``` - *Type:* projen.SampleReadmeProps - *Default:* { filename: 'README.md', contents: '# replace this' } The README setup. --- *Example* ```typescript "{ filename: 'readme.md', contents: '# title' }" ``` ##### `stale`^Optional ```typescript public readonly stale: boolean; ``` - *Type:* boolean - *Default:* false Auto-close of stale issues and pull request. See `staleOptions` for options. --- ##### `staleOptions`^Optional ```typescript public readonly staleOptions: StaleOptions; ``` - *Type:* projen.github.StaleOptions - *Default:* see defaults in `StaleOptions` Auto-close stale issues and pull requests. To disable set `stale` to `false`. --- ##### `vscode`^Optional ```typescript public readonly vscode: boolean; ``` - *Type:* boolean - *Default:* true Enable VSCode integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `artifactId`^Required ```typescript public readonly artifactId: string; ``` - *Type:* string - *Default:* "my-app" The artifactId is generally the name that the project is known by. Although the groupId is important, people within the group will rarely mention the groupId in discussion (they are often all be the same ID, such as the MojoHaus project groupId: org.codehaus.mojo). It, along with the groupId, creates a key that separates this project from every other project in the world (at least, it should :) ). Along with the groupId, the artifactId fully defines the artifact's living quarters within the repository. In the case of the above project, my-project lives in $M2_REPO/org/codehaus/mojo/my-project. --- ##### `groupId`^Required ```typescript public readonly groupId: string; ``` - *Type:* string - *Default:* "org.acme" This is generally unique amongst an organization or a project. For example, all core Maven artifacts do (well, should) live under the groupId org.apache.maven. Group ID's do not necessarily use the dot notation, for example, the junit project. Note that the dot-notated groupId does not have to correspond to the package structure that the project contains. It is, however, a good practice to follow. When stored within a repository, the group acts much like the Java packaging structure does in an operating system. The dots are replaced by OS specific directory separators (such as '/' in Unix) which becomes a relative directory structure from the base repository. In the example given, the org.codehaus.mojo group lives within the directory $M2_REPO/org/codehaus/mojo. --- ##### `version`^Required ```typescript public readonly version: string; ``` - *Type:* string - *Default:* "0.1.0" This is the last piece of the naming puzzle. groupId:artifactId denotes a single project but they cannot delineate which incarnation of that project we are talking about. Do we want the junit:junit of 2018 (version 4.12), or of 2007 (version 3.8.2)? In short: code changes, those changes should be versioned, and this element keeps those versions in line. It is also used within an artifact's repository to separate versions from each other. my-project version 1.0 files live in the directory structure $M2_REPO/org/codehaus/mojo/my-project/1.0. --- ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string - *Default:* undefined Description of a project is always good. Although this should not replace formal documentation, a quick comment to any readers of the POM is always helpful. --- ##### `packaging`^Optional ```typescript public readonly packaging: string; ``` - *Type:* string - *Default:* "jar" Project packaging format. --- ##### `url`^Optional ```typescript public readonly url: string; ``` - *Type:* string - *Default:* undefined The URL, like the name, is not required. This is a nice gesture for projects users, however, so that they know where the project lives. --- ##### `compileOptions`^Optional ```typescript public readonly compileOptions: MavenCompileOptions; ``` - *Type:* projen.java.MavenCompileOptions - *Default:* defaults Compile options. --- ##### `deps`^Optional ```typescript public readonly deps: string[]; ``` - *Type:* string[] - *Default:* [] List of runtime dependencies for this project. Dependencies use the format: `/@` Additional dependencies can be added via `project.addDependency()`. --- ##### `distdir`^Optional ```typescript public readonly distdir: string; ``` - *Type:* string - *Default:* "dist/java" Final artifact output directory. --- ##### `junit`^Optional ```typescript public readonly junit: boolean; ``` - *Type:* boolean - *Default:* true Include junit tests. --- ##### `junitOptions`^Optional ```typescript public readonly junitOptions: JunitOptions; ``` - *Type:* projen.java.JunitOptions - *Default:* defaults junit options. --- ##### `packagingOptions`^Optional ```typescript public readonly packagingOptions: MavenPackagingOptions; ``` - *Type:* projen.java.MavenPackagingOptions - *Default:* defaults Packaging options. --- ##### `projenrcJava`^Optional ```typescript public readonly projenrcJava: boolean; ``` - *Type:* boolean - *Default:* true Use projenrc in java. This will install `projen` as a java dependency and will add a `synth` task which will compile & execute `main()` from `src/main/java/projenrc.java`. --- ##### `projenrcJavaOptions`^Optional ```typescript public readonly projenrcJavaOptions: ProjenrcOptions; ``` - *Type:* projen.java.ProjenrcOptions - *Default:* default options Options related to projenrc in java. --- ##### `testDeps`^Optional ```typescript public readonly testDeps: string[]; ``` - *Type:* string[] - *Default:* [] List of test dependencies for this project. Dependencies use the format: `/@` Additional dependencies can be added via `project.addTestDependency()`. --- ##### `sample`^Optional ```typescript public readonly sample: boolean; ``` - *Type:* boolean - *Default:* true Include sample code and test if the relevant directories don't exist. --- ##### `sampleJavaPackage`^Optional ```typescript public readonly sampleJavaPackage: string; ``` - *Type:* string - *Default:* "org.acme" The java package to use for the code sample. --- ##### `buildCommand`^Optional ```typescript public readonly buildCommand: string; ``` - *Type:* string - *Default:* no build command 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. --- ##### `cdkout`^Optional ```typescript public readonly cdkout: string; ``` - *Type:* string - *Default:* "cdk.out" cdk.out directory. --- ##### `context`^Optional ```typescript public readonly context: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* no additional context Additional context to include in `cdk.json`. --- ##### `featureFlags`^Optional ```typescript public readonly featureFlags: boolean; ``` - *Type:* boolean - *Default:* true Include all feature flags in cdk.json. --- ##### `requireApproval`^Optional ```typescript public readonly requireApproval: ApprovalLevel; ``` - *Type:* projen.awscdk.ApprovalLevel - *Default:* ApprovalLevel.BROADENING 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. --- ##### `watchExcludes`^Optional ```typescript public readonly watchExcludes: string[]; ``` - *Type:* string[] - *Default:* [] Glob patterns to exclude from `cdk watch`. --- ##### `watchIncludes`^Optional ```typescript public readonly watchIncludes: string[]; ``` - *Type:* string[] - *Default:* [] Glob patterns to include in `cdk watch`. --- ##### `cdkVersion`^Required ```typescript public readonly cdkVersion: string; ``` - *Type:* string - *Default:* "2.1.0" Minimum version of the AWS CDK to depend on. --- ##### ~~`cdkAssert`~~^Optional - *Deprecated:* The ```typescript public readonly cdkAssert: boolean; ``` - *Type:* boolean - *Default:* will be included by default for AWS CDK >= 1.0.0 < 2.0.0 Warning: NodeJS only. Install the --- ##### `cdkAssertions`^Optional ```typescript public readonly cdkAssertions: boolean; ``` - *Type:* boolean - *Default:* will be included by default for AWS CDK >= 1.111.0 < 2.0.0 Install the assertions library? Only needed for CDK 1.x. If using CDK 2.x then assertions is already included in 'aws-cdk-lib' --- ##### ~~`cdkDependencies`~~^Optional - *Deprecated:* For CDK 2.x use "deps" instead. (or "peerDeps" if you're building a library) ```typescript public readonly cdkDependencies: string[]; ``` - *Type:* string[] Which AWS CDKv1 modules this project requires. --- ##### ~~`cdkDependenciesAsDeps`~~^Optional - *Deprecated:* Not supported in CDK v2. ```typescript public readonly cdkDependenciesAsDeps: boolean; ``` - *Type:* boolean - *Default:* true 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 --- ##### ~~`cdkTestDependencies`~~^Optional - *Deprecated:* For CDK 2.x use 'devDeps' (in node.js projects) or 'testDeps' (in java projects) instead ```typescript public readonly cdkTestDependencies: string[]; ``` - *Type:* string[] AWS CDK modules required for testing. --- ##### `cdkVersionPinning`^Optional ```typescript public readonly cdkVersionPinning: boolean; ``` - *Type:* 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. --- ##### `constructsVersion`^Optional ```typescript public readonly constructsVersion: string; ``` - *Type:* string - *Default:* for CDK 1.x the default is "3.2.27", for CDK 2.x the default is "10.0.5". Minimum version of the `constructs` library to depend on. --- ##### `mainClass`^Required ```typescript public readonly mainClass: string; ``` - *Type:* string - *Default:* "org.acme.MyApp" The name of the Java class with the static `main()` method. This method should call `app.synth()` on the CDK app. --- ### PDKPipelineProps Properties to configure the PDKPipeline. Note: Due to limitations with JSII and generic support it should be noted that the synth, synthShellStepPartialProps.input and synthShellStepPartialProps.primaryOutputDirectory properties will be ignored if passed in to this construct. synthShellStepPartialProps.commands is marked as a required field, however if you pass in [] the default commands of this construct will be retained. #### Initializer ```typescript import { PDKPipelineProps } from '@aws-prototyping-sdk/pipeline' const pDKPipelineProps: PDKPipelineProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | synth | aws-cdk-lib.pipelines.IFileSetProducer | The build step that produces the CDK Cloud Assembly. | | artifactBucket | aws-cdk-lib.aws_s3.IBucket | An existing S3 Bucket to use for storing the pipeline's artifact. | | assetPublishingCodeBuildDefaults | aws-cdk-lib.pipelines.CodeBuildOptions | Additional customizations to apply to the asset publishing CodeBuild projects. | | cliVersion | string | CDK CLI version to use in self-mutation and asset publishing steps. | | codeBuildDefaults | aws-cdk-lib.pipelines.CodeBuildOptions | Customize the CodeBuild projects created for this pipeline. | | codePipeline | aws-cdk-lib.aws_codepipeline.Pipeline | An existing Pipeline to be reused and built upon. | | crossAccountKeys | boolean | Create KMS keys for the artifact buckets, allowing cross-account deployments. | | dockerCredentials | aws-cdk-lib.pipelines.DockerCredential[] | A list of credentials used to authenticate to Docker registries. | | dockerEnabledForSelfMutation | boolean | Enable Docker for the self-mutate step. | | dockerEnabledForSynth | boolean | Enable Docker for the 'synth' step. | | enableKeyRotation | boolean | Enable KMS key rotation for the generated KMS keys. | | pipelineName | string | The name of the CodePipeline pipeline. | | publishAssetsInParallel | boolean | Publish assets in multiple CodeBuild projects. | | reuseCrossRegionSupportStacks | boolean | Reuse the same cross region support stack for all pipelines in the App. | | role | aws-cdk-lib.aws_iam.IRole | The IAM role to be assumed by this Pipeline. | | selfMutation | boolean | Whether the pipeline will update itself. | | selfMutationCodeBuildDefaults | aws-cdk-lib.pipelines.CodeBuildOptions | Additional customizations to apply to the self mutation CodeBuild projects. | | synthCodeBuildDefaults | aws-cdk-lib.pipelines.CodeBuildOptions | Additional customizations to apply to the synthesize CodeBuild projects. | | useChangeSets | boolean | Deploy every stack by creating a change set and executing it. | | primarySynthDirectory | string | Output directory for cdk synthesized artifacts i.e: packages/infra/cdk.out. | | repositoryName | string | Name of the CodeCommit repository to create. | | branchNamePrefixes | string[] | Branch name prefixes Any branches created matching this list of prefixes will create a new pipeline and stack. | | cdkCommand | string | CDK command. | | codeCommitRemovalPolicy | aws-cdk-lib.RemovalPolicy | Possible values for a resource's Removal Policy The removal policy controls what happens to the resource if it stops being managed by CloudFormation. | | defaultBranchName | string | Branch to trigger the pipeline execution. | | sonarCodeScannerConfig | SonarCodeScannerConfig | Configuration for enabling Sonarqube code scanning on a successful synth. | | synthShellStepPartialProps | aws-cdk-lib.pipelines.ShellStepProps | PDKPipeline by default assumes a NX Monorepo structure for it's codebase and uses sane defaults for the install and run commands. | --- ##### `synth`^Required ```typescript public readonly synth: IFileSetProducer; ``` - *Type:* aws-cdk-lib.pipelines.IFileSetProducer The build step that produces the CDK Cloud Assembly. The primary output of this step needs to be the `cdk.out` directory generated by the `cdk synth` command. If you use a `ShellStep` here and you don't configure an output directory, the output directory will automatically be assumed to be `cdk.out`. --- ##### `artifactBucket`^Optional ```typescript public readonly artifactBucket: IBucket; ``` - *Type:* aws-cdk-lib.aws_s3.IBucket - *Default:* A new S3 bucket will be created. An existing S3 Bucket to use for storing the pipeline's artifact. --- ##### `assetPublishingCodeBuildDefaults`^Optional ```typescript public readonly assetPublishingCodeBuildDefaults: CodeBuildOptions; ``` - *Type:* aws-cdk-lib.pipelines.CodeBuildOptions - *Default:* Only `codeBuildDefaults` are applied Additional customizations to apply to the asset publishing CodeBuild projects. --- ##### `cliVersion`^Optional ```typescript public readonly cliVersion: string; ``` - *Type:* string - *Default:* Latest version CDK CLI version to use in self-mutation and asset publishing steps. If you want to lock the CDK CLI version used in the pipeline, by steps that are automatically generated for you, specify the version here. We recommend you do not specify this value, as not specifying it always uses the latest CLI version which is backwards compatible with old versions. If you do specify it, be aware that this version should always be equal to or higher than the version of the CDK framework used by the CDK app, when the CDK commands are run during your pipeline execution. When you change this version, the *next time* the `SelfMutate` step runs it will still be using the CLI of the the *previous* version that was in this property: it will only start using the new version after `SelfMutate` completes successfully. That means that if you want to update both framework and CLI version, you should update the CLI version first, commit, push and deploy, and only then update the framework version. --- ##### `codeBuildDefaults`^Optional ```typescript public readonly codeBuildDefaults: CodeBuildOptions; ``` - *Type:* aws-cdk-lib.pipelines.CodeBuildOptions - *Default:* All projects run non-privileged build, SMALL instance, LinuxBuildImage.STANDARD_6_0 Customize the CodeBuild projects created for this pipeline. --- ##### `codePipeline`^Optional ```typescript public readonly codePipeline: Pipeline; ``` - *Type:* aws-cdk-lib.aws_codepipeline.Pipeline - *Default:* a new underlying pipeline is created. An existing Pipeline to be reused and built upon. [disable-awslint:ref-via-interface] --- ##### `crossAccountKeys`^Optional ```typescript public readonly crossAccountKeys: boolean; ``` - *Type:* boolean - *Default:* false Create KMS keys for the artifact buckets, allowing cross-account deployments. The artifact buckets have to be encrypted to support deploying CDK apps to another account, so if you want to do that or want to have your artifact buckets encrypted, be sure to set this value to `true`. Be aware there is a cost associated with maintaining the KMS keys. --- ##### `dockerCredentials`^Optional ```typescript public readonly dockerCredentials: DockerCredential[]; ``` - *Type:* aws-cdk-lib.pipelines.DockerCredential[] - *Default:* [] A list of credentials used to authenticate to Docker registries. Specify any credentials necessary within the pipeline to build, synth, update, or publish assets. --- ##### `dockerEnabledForSelfMutation`^Optional ```typescript public readonly dockerEnabledForSelfMutation: boolean; ``` - *Type:* boolean - *Default:* false Enable Docker for the self-mutate step. Set this to true if the pipeline itself uses Docker container assets (for example, if you use `LinuxBuildImage.fromAsset()` as the build image of a CodeBuild step in the pipeline). You do not need to set it if you build Docker image assets in the application Stages and Stacks that are *deployed* by this pipeline. Configures privileged mode for the self-mutation CodeBuild action. If you are about to turn this on in an already-deployed Pipeline, set the value to `true` first, commit and allow the pipeline to self-update, and only then use the Docker asset in the pipeline. --- ##### `dockerEnabledForSynth`^Optional ```typescript public readonly dockerEnabledForSynth: boolean; ``` - *Type:* boolean - *Default:* false Enable Docker for the 'synth' step. Set this to true if you are using file assets that require "bundling" anywhere in your application (meaning an asset compilation step will be run with the tools provided by a Docker image), both for the Pipeline stack as well as the application stacks. A common way to use bundling assets in your application is by using the `@aws-cdk/aws-lambda-nodejs` library. Configures privileged mode for the synth CodeBuild action. If you are about to turn this on in an already-deployed Pipeline, set the value to `true` first, commit and allow the pipeline to self-update, and only then use the bundled asset. --- ##### `enableKeyRotation`^Optional ```typescript public readonly enableKeyRotation: boolean; ``` - *Type:* boolean - *Default:* false (key rotation is disabled) Enable KMS key rotation for the generated KMS keys. By default KMS key rotation is disabled, but will add additional costs when enabled. --- ##### `pipelineName`^Optional ```typescript public readonly pipelineName: string; ``` - *Type:* string - *Default:* Automatically generated The name of the CodePipeline pipeline. --- ##### `publishAssetsInParallel`^Optional ```typescript public readonly publishAssetsInParallel: boolean; ``` - *Type:* boolean - *Default:* true Publish assets in multiple CodeBuild projects. If set to false, use one Project per type to publish all assets. Publishing in parallel improves concurrency and may reduce publishing latency, but may also increase overall provisioning time of the CodeBuild projects. Experiment and see what value works best for you. --- ##### `reuseCrossRegionSupportStacks`^Optional ```typescript public readonly reuseCrossRegionSupportStacks: boolean; ``` - *Type:* boolean - *Default:* true (Use the same support stack for all pipelines in App) Reuse the same cross region support stack for all pipelines in the App. --- ##### `role`^Optional ```typescript public readonly role: IRole; ``` - *Type:* aws-cdk-lib.aws_iam.IRole - *Default:* A new role is created The IAM role to be assumed by this Pipeline. --- ##### `selfMutation`^Optional ```typescript public readonly selfMutation: boolean; ``` - *Type:* boolean - *Default:* true Whether the pipeline will update itself. This needs to be set to `true` to allow the pipeline to reconfigure itself when assets or stages are being added to it, and `true` is the recommended setting. You can temporarily set this to `false` while you are iterating on the pipeline itself and prefer to deploy changes using `cdk deploy`. --- ##### `selfMutationCodeBuildDefaults`^Optional ```typescript public readonly selfMutationCodeBuildDefaults: CodeBuildOptions; ``` - *Type:* aws-cdk-lib.pipelines.CodeBuildOptions - *Default:* Only `codeBuildDefaults` are applied Additional customizations to apply to the self mutation CodeBuild projects. --- ##### `synthCodeBuildDefaults`^Optional ```typescript public readonly synthCodeBuildDefaults: CodeBuildOptions; ``` - *Type:* aws-cdk-lib.pipelines.CodeBuildOptions - *Default:* Only `codeBuildDefaults` are applied Additional customizations to apply to the synthesize CodeBuild projects. --- ##### `useChangeSets`^Optional ```typescript public readonly useChangeSets: boolean; ``` - *Type:* boolean - *Default:* true Deploy every stack by creating a change set and executing it. When enabled, creates a "Prepare" and "Execute" action for each stack. Disable to deploy the stack in one pipeline action. --- ##### `primarySynthDirectory`^Required ```typescript public readonly primarySynthDirectory: string; ``` - *Type:* string Output directory for cdk synthesized artifacts i.e: packages/infra/cdk.out. --- ##### `repositoryName`^Required ```typescript public readonly repositoryName: string; ``` - *Type:* string Name of the CodeCommit repository to create. --- ##### `branchNamePrefixes`^Optional ```typescript public readonly branchNamePrefixes: string[]; ``` - *Type:* string[] - *Default:* undefined Branch name prefixes Any branches created matching this list of prefixes will create a new pipeline and stack. --- *Example* ```typescript // Disables feature branches (default) new PDKPipeline(this, 'PDKPipeline', { repositoryName: 'my-repo', branchNamePrefixes: [], // or simply exclude this line } ``` ##### `cdkCommand`^Optional ```typescript public readonly cdkCommand: string; ``` - *Type:* string - *Default:* 'npx cdk' CDK command. Override the command used to call cdk for synth and deploy. --- ##### `codeCommitRemovalPolicy`^Optional ```typescript public readonly codeCommitRemovalPolicy: RemovalPolicy; ``` - *Type:* aws-cdk-lib.RemovalPolicy Possible values for a resource's Removal Policy The removal policy controls what happens to the resource if it stops being managed by CloudFormation. --- ##### `defaultBranchName`^Optional ```typescript public readonly defaultBranchName: string; ``` - *Type:* string - *Default:* mainline Branch to trigger the pipeline execution. --- ##### `sonarCodeScannerConfig`^Optional ```typescript public readonly sonarCodeScannerConfig: SonarCodeScannerConfig; ``` - *Type:* SonarCodeScannerConfig - *Default:* undefined Configuration for enabling Sonarqube code scanning on a successful synth. --- ##### `synthShellStepPartialProps`^Optional ```typescript public readonly synthShellStepPartialProps: ShellStepProps; ``` - *Type:* aws-cdk-lib.pipelines.ShellStepProps PDKPipeline by default assumes a NX Monorepo structure for it's codebase and uses sane defaults for the install and run commands. To override these defaults and/or provide additional inputs, specify env settings, etc you can provide a partial ShellStepProps. --- ### PDKPipelinePyProjectOptions Configuration options for the PDKPipelinePyProject. #### Initializer ```typescript import { PDKPipelinePyProjectOptions } from '@aws-prototyping-sdk/pipeline' const pDKPipelinePyProjectOptions: PDKPipelinePyProjectOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | This is the name of your project. | | commitGenerated | boolean | Whether to commit the managed files by default. | | gitIgnoreOptions | projen.IgnoreFileOptions | Configuration options for .gitignore file. | | gitOptions | projen.GitOptions | Configuration options for git. | | logging | projen.LoggerOptions | Configure logging options such as verbosity. | | outdir | string | The root directory of the project. | | parent | projen.Project | The parent project, if this project is part of a bigger project. | | projenCommand | string | The shell command to use in order to run the projen CLI. | | projenrcJson | boolean | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. | | projenrcJsonOptions | projen.ProjenrcJsonOptions | Options for .projenrc.json. | | renovatebot | boolean | Use renovatebot to handle dependency upgrades. | | renovatebotOptions | projen.RenovatebotOptions | Options for renovatebot. | | autoApproveOptions | projen.github.AutoApproveOptions | Enable and configure the 'auto approve' workflow. | | autoMerge | boolean | Enable automatic merging on GitHub. | | autoMergeOptions | projen.github.AutoMergeOptions | Configure options for automatic merging on GitHub. | | clobber | boolean | Add a `clobber` task which resets the repo to origin. | | devContainer | boolean | Add a VSCode development environment (used for GitHub Codespaces). | | github | boolean | Enable GitHub integration. | | githubOptions | projen.github.GitHubOptions | Options for GitHub integration. | | gitpod | boolean | Add a Gitpod development environment. | | mergify | boolean | Whether mergify should be enabled on this repository or not. | | mergifyOptions | projen.github.MergifyOptions | Options for mergify. | | projectType | projen.ProjectType | Which type of project this is (library/app). | | projenCredentials | projen.github.GithubCredentials | Choose a method of providing GitHub API access for projen workflows. | | projenTokenSecret | string | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. | | readme | projen.SampleReadmeProps | The README setup. | | stale | boolean | Auto-close of stale issues and pull request. | | staleOptions | projen.github.StaleOptions | Auto-close stale issues and pull requests. | | vscode | boolean | Enable VSCode integration. | | authorEmail | string | Author's e-mail. | | authorName | string | Author's name. | | version | string | Version of the package. | | classifiers | string[] | A list of PyPI trove classifiers that describe the project. | | description | string | A short description of the package. | | homepage | string | A URL to the website of the project. | | license | string | License of this package as an SPDX identifier. | | packageName | string | Package name. | | poetryOptions | projen.python.PoetryPyprojectOptionsWithoutDeps | Additional options to set for poetry if using poetry. | | setupConfig | {[ key: string ]: any} | Additional fields to pass in the setup() function if using setuptools. | | moduleName | string | Name of the python package as used in imports and filenames. | | deps | string[] | List of runtime dependencies for this project. | | devDeps | string[] | List of dev dependencies for this project. | | pip | boolean | Use pip with a requirements.txt file to track project dependencies. | | poetry | boolean | Use poetry to manage your project dependencies, virtual environment, and (optional) packaging/publishing. | | projenrcJs | boolean | Use projenrc in javascript. | | projenrcJsOptions | projen.javascript.ProjenrcOptions | Options related to projenrc in JavaScript. | | projenrcPython | boolean | Use projenrc in Python. | | projenrcPythonOptions | projen.python.ProjenrcOptions | Options related to projenrc in python. | | projenrcTs | boolean | Use projenrc in TypeScript. | | projenrcTsOptions | projen.typescript.ProjenrcTsOptions | Options related to projenrc in TypeScript. | | pytest | boolean | Include pytest tests. | | pytestOptions | projen.python.PytestOptions | pytest options. | | pythonExec | string | Path to the python executable to use. | | sample | boolean | Include sample code and test if the relevant directories don't exist. | | setuptools | boolean | Use setuptools with a setup.py script for packaging and publishing. | | venv | boolean | Use venv to manage a virtual environment for installing dependencies inside. | | venvOptions | projen.python.VenvOptions | Venv options. | | buildCommand | string | A command to execute before synthesis. | | cdkout | string | cdk.out directory. | | context | {[ key: string ]: any} | Additional context to include in `cdk.json`. | | featureFlags | boolean | Include all feature flags in cdk.json. | | requireApproval | projen.awscdk.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. | | watchExcludes | string[] | Glob patterns to exclude from `cdk watch`. | | watchIncludes | string[] | Glob patterns to include in `cdk watch`. | | cdkVersion | string | Minimum version of the AWS CDK to depend on. | | cdkAssert | boolean | Warning: NodeJS only. | | cdkAssertions | boolean | Install the assertions library? | | cdkDependencies | string[] | Which AWS CDKv1 modules this project requires. | | cdkDependenciesAsDeps | boolean | If this is enabled (default), all modules declared in `cdkDependencies` will be also added as normal `dependencies` (as well as `peerDependencies`). | | cdkTestDependencies | string[] | AWS CDK modules required for testing. | | cdkVersionPinning | boolean | Use pinned version instead of caret version for CDK. | | constructsVersion | string | Minimum version of the `constructs` library to depend on. | | appEntrypoint | string | The CDK app's entrypoint (relative to the source directory, which is "src" by default). | | testdir | string | Python sources directory. | --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string - *Default:* $BASEDIR This is the name of your project. --- ##### `commitGenerated`^Optional ```typescript public readonly commitGenerated: boolean; ``` - *Type:* boolean - *Default:* true Whether to commit the managed files by default. --- ##### `gitIgnoreOptions`^Optional ```typescript public readonly gitIgnoreOptions: IgnoreFileOptions; ``` - *Type:* projen.IgnoreFileOptions Configuration options for .gitignore file. --- ##### `gitOptions`^Optional ```typescript public readonly gitOptions: GitOptions; ``` - *Type:* projen.GitOptions Configuration options for git. --- ##### `logging`^Optional ```typescript public readonly logging: LoggerOptions; ``` - *Type:* projen.LoggerOptions - *Default:* {} Configure logging options such as verbosity. --- ##### `outdir`^Optional ```typescript public readonly outdir: string; ``` - *Type:* string - *Default:* "." 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 sub-projects. --- ##### `parent`^Optional ```typescript public readonly parent: Project; ``` - *Type:* projen.Project The parent project, if this project is part of a bigger project. --- ##### `projenCommand`^Optional ```typescript public readonly projenCommand: string; ``` - *Type:* string - *Default:* "npx projen" The shell command to use in order to run the projen CLI. Can be used to customize in special environments. --- ##### `projenrcJson`^Optional ```typescript public readonly projenrcJson: boolean; ``` - *Type:* boolean - *Default:* false Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. --- ##### `projenrcJsonOptions`^Optional ```typescript public readonly projenrcJsonOptions: ProjenrcJsonOptions; ``` - *Type:* projen.ProjenrcJsonOptions - *Default:* default options Options for .projenrc.json. --- ##### `renovatebot`^Optional ```typescript public readonly renovatebot: boolean; ``` - *Type:* boolean - *Default:* false Use renovatebot to handle dependency upgrades. --- ##### `renovatebotOptions`^Optional ```typescript public readonly renovatebotOptions: RenovatebotOptions; ``` - *Type:* projen.RenovatebotOptions - *Default:* default options Options for renovatebot. --- ##### `autoApproveOptions`^Optional ```typescript public readonly autoApproveOptions: AutoApproveOptions; ``` - *Type:* projen.github.AutoApproveOptions - *Default:* auto approve is disabled Enable and configure the 'auto approve' workflow. --- ##### `autoMerge`^Optional ```typescript public readonly autoMerge: boolean; ``` - *Type:* boolean - *Default:* true Enable automatic merging on GitHub. Has no effect if `github.mergify` is set to false. --- ##### `autoMergeOptions`^Optional ```typescript public readonly autoMergeOptions: AutoMergeOptions; ``` - *Type:* projen.github.AutoMergeOptions - *Default:* see defaults in `AutoMergeOptions` Configure options for automatic merging on GitHub. Has no effect if `github.mergify` or `autoMerge` is set to false. --- ##### `clobber`^Optional ```typescript public readonly clobber: boolean; ``` - *Type:* boolean - *Default:* true, but false for subprojects Add a `clobber` task which resets the repo to origin. --- ##### `devContainer`^Optional ```typescript public readonly devContainer: boolean; ``` - *Type:* boolean - *Default:* false Add a VSCode development environment (used for GitHub Codespaces). --- ##### `github`^Optional ```typescript public readonly github: boolean; ``` - *Type:* boolean - *Default:* true Enable GitHub integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `githubOptions`^Optional ```typescript public readonly githubOptions: GitHubOptions; ``` - *Type:* projen.github.GitHubOptions - *Default:* see GitHubOptions Options for GitHub integration. --- ##### `gitpod`^Optional ```typescript public readonly gitpod: boolean; ``` - *Type:* boolean - *Default:* false Add a Gitpod development environment. --- ##### ~~`mergify`~~^Optional - *Deprecated:* use `githubOptions.mergify` instead ```typescript public readonly mergify: boolean; ``` - *Type:* boolean - *Default:* true Whether mergify should be enabled on this repository or not. --- ##### ~~`mergifyOptions`~~^Optional - *Deprecated:* use `githubOptions.mergifyOptions` instead ```typescript public readonly mergifyOptions: MergifyOptions; ``` - *Type:* projen.github.MergifyOptions - *Default:* default options Options for mergify. --- ##### ~~`projectType`~~^Optional - *Deprecated:* no longer supported at the base project level ```typescript public readonly projectType: ProjectType; ``` - *Type:* projen.ProjectType - *Default:* ProjectType.UNKNOWN Which type of project this is (library/app). --- ##### `projenCredentials`^Optional ```typescript public readonly projenCredentials: GithubCredentials; ``` - *Type:* projen.github.GithubCredentials - *Default:* use a personal access token named PROJEN_GITHUB_TOKEN Choose a method of providing GitHub API access for projen workflows. --- ##### ~~`projenTokenSecret`~~^Optional - *Deprecated:* use `projenCredentials` ```typescript public readonly projenTokenSecret: string; ``` - *Type:* string - *Default:* "PROJEN_GITHUB_TOKEN" 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. --- ##### `readme`^Optional ```typescript public readonly readme: SampleReadmeProps; ``` - *Type:* projen.SampleReadmeProps - *Default:* { filename: 'README.md', contents: '# replace this' } The README setup. --- *Example* ```typescript "{ filename: 'readme.md', contents: '# title' }" ``` ##### `stale`^Optional ```typescript public readonly stale: boolean; ``` - *Type:* boolean - *Default:* false Auto-close of stale issues and pull request. See `staleOptions` for options. --- ##### `staleOptions`^Optional ```typescript public readonly staleOptions: StaleOptions; ``` - *Type:* projen.github.StaleOptions - *Default:* see defaults in `StaleOptions` Auto-close stale issues and pull requests. To disable set `stale` to `false`. --- ##### `vscode`^Optional ```typescript public readonly vscode: boolean; ``` - *Type:* boolean - *Default:* true Enable VSCode integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `authorEmail`^Required ```typescript public readonly authorEmail: string; ``` - *Type:* string - *Default:* $GIT_USER_EMAIL Author's e-mail. --- ##### `authorName`^Required ```typescript public readonly authorName: string; ``` - *Type:* string - *Default:* $GIT_USER_NAME Author's name. --- ##### `version`^Required ```typescript public readonly version: string; ``` - *Type:* string - *Default:* "0.1.0" Version of the package. --- ##### `classifiers`^Optional ```typescript public readonly classifiers: string[]; ``` - *Type:* string[] A list of PyPI trove classifiers that describe the project. > [https://pypi.org/classifiers/](https://pypi.org/classifiers/) --- ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string A short description of the package. --- ##### `homepage`^Optional ```typescript public readonly homepage: string; ``` - *Type:* string A URL to the website of the project. --- ##### `license`^Optional ```typescript public readonly license: string; ``` - *Type:* string License of this package as an SPDX identifier. --- ##### `packageName`^Optional ```typescript public readonly packageName: string; ``` - *Type:* string Package name. --- ##### `poetryOptions`^Optional ```typescript public readonly poetryOptions: PoetryPyprojectOptionsWithoutDeps; ``` - *Type:* projen.python.PoetryPyprojectOptionsWithoutDeps Additional options to set for poetry if using poetry. --- ##### `setupConfig`^Optional ```typescript public readonly setupConfig: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} Additional fields to pass in the setup() function if using setuptools. --- ##### `moduleName`^Required ```typescript public readonly moduleName: string; ``` - *Type:* string - *Default:* $PYTHON_MODULE_NAME Name of the python package as used in imports and filenames. Must only consist of alphanumeric characters and underscores. --- ##### `deps`^Optional ```typescript public readonly deps: string[]; ``` - *Type:* string[] - *Default:* [] List of runtime dependencies for this project. Dependencies use the format: `@` Additional dependencies can be added via `project.addDependency()`. --- ##### `devDeps`^Optional ```typescript public readonly devDeps: string[]; ``` - *Type:* string[] - *Default:* [] List of dev dependencies for this project. Dependencies use the format: `@` Additional dependencies can be added via `project.addDevDependency()`. --- ##### `pip`^Optional ```typescript public readonly pip: boolean; ``` - *Type:* boolean - *Default:* true, unless poetry is true, then false Use pip with a requirements.txt file to track project dependencies. --- ##### `poetry`^Optional ```typescript public readonly poetry: boolean; ``` - *Type:* boolean - *Default:* false Use poetry to manage your project dependencies, virtual environment, and (optional) packaging/publishing. This feature is incompatible with pip, setuptools, or venv. If you set this option to `true`, then pip, setuptools, and venv must be set to `false`. --- ##### `projenrcJs`^Optional ```typescript public readonly projenrcJs: boolean; ``` - *Type:* boolean - *Default:* false Use projenrc in javascript. This will install `projen` as a JavaScript dependency and add a `synth` task which will run `.projenrc.js`. --- ##### `projenrcJsOptions`^Optional ```typescript public readonly projenrcJsOptions: ProjenrcOptions; ``` - *Type:* projen.javascript.ProjenrcOptions - *Default:* default options Options related to projenrc in JavaScript. --- ##### `projenrcPython`^Optional ```typescript public readonly projenrcPython: boolean; ``` - *Type:* boolean - *Default:* true Use projenrc in Python. This will install `projen` as a Python dependency and add a `synth` task which will run `.projenrc.py`. --- ##### `projenrcPythonOptions`^Optional ```typescript public readonly projenrcPythonOptions: ProjenrcOptions; ``` - *Type:* projen.python.ProjenrcOptions - *Default:* default options Options related to projenrc in python. --- ##### `projenrcTs`^Optional ```typescript public readonly projenrcTs: boolean; ``` - *Type:* boolean - *Default:* false Use projenrc in TypeScript. This will create a tsconfig file (default: `tsconfig.projen.json`) and use `ts-node` in the default task to parse the project source files. --- ##### `projenrcTsOptions`^Optional ```typescript public readonly projenrcTsOptions: ProjenrcTsOptions; ``` - *Type:* projen.typescript.ProjenrcTsOptions - *Default:* default options Options related to projenrc in TypeScript. --- ##### `pytest`^Optional ```typescript public readonly pytest: boolean; ``` - *Type:* boolean - *Default:* true Include pytest tests. --- ##### `pytestOptions`^Optional ```typescript public readonly pytestOptions: PytestOptions; ``` - *Type:* projen.python.PytestOptions - *Default:* defaults pytest options. --- ##### `pythonExec`^Optional ```typescript public readonly pythonExec: string; ``` - *Type:* string - *Default:* "python" Path to the python executable to use. --- ##### `sample`^Optional ```typescript public readonly sample: boolean; ``` - *Type:* boolean - *Default:* true Include sample code and test if the relevant directories don't exist. --- ##### `setuptools`^Optional ```typescript public readonly setuptools: boolean; ``` - *Type:* boolean - *Default:* true, unless poetry is true, then false Use setuptools with a setup.py script for packaging and publishing. --- ##### `venv`^Optional ```typescript public readonly venv: boolean; ``` - *Type:* boolean - *Default:* true, unless poetry is true, then false Use venv to manage a virtual environment for installing dependencies inside. --- ##### `venvOptions`^Optional ```typescript public readonly venvOptions: VenvOptions; ``` - *Type:* projen.python.VenvOptions - *Default:* defaults Venv options. --- ##### `buildCommand`^Optional ```typescript public readonly buildCommand: string; ``` - *Type:* string - *Default:* no build command 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. --- ##### `cdkout`^Optional ```typescript public readonly cdkout: string; ``` - *Type:* string - *Default:* "cdk.out" cdk.out directory. --- ##### `context`^Optional ```typescript public readonly context: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* no additional context Additional context to include in `cdk.json`. --- ##### `featureFlags`^Optional ```typescript public readonly featureFlags: boolean; ``` - *Type:* boolean - *Default:* true Include all feature flags in cdk.json. --- ##### `requireApproval`^Optional ```typescript public readonly requireApproval: ApprovalLevel; ``` - *Type:* projen.awscdk.ApprovalLevel - *Default:* ApprovalLevel.BROADENING 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. --- ##### `watchExcludes`^Optional ```typescript public readonly watchExcludes: string[]; ``` - *Type:* string[] - *Default:* [] Glob patterns to exclude from `cdk watch`. --- ##### `watchIncludes`^Optional ```typescript public readonly watchIncludes: string[]; ``` - *Type:* string[] - *Default:* [] Glob patterns to include in `cdk watch`. --- ##### `cdkVersion`^Required ```typescript public readonly cdkVersion: string; ``` - *Type:* string - *Default:* "2.1.0" Minimum version of the AWS CDK to depend on. --- ##### ~~`cdkAssert`~~^Optional - *Deprecated:* The ```typescript public readonly cdkAssert: boolean; ``` - *Type:* boolean - *Default:* will be included by default for AWS CDK >= 1.0.0 < 2.0.0 Warning: NodeJS only. Install the --- ##### `cdkAssertions`^Optional ```typescript public readonly cdkAssertions: boolean; ``` - *Type:* boolean - *Default:* will be included by default for AWS CDK >= 1.111.0 < 2.0.0 Install the assertions library? Only needed for CDK 1.x. If using CDK 2.x then assertions is already included in 'aws-cdk-lib' --- ##### ~~`cdkDependencies`~~^Optional - *Deprecated:* For CDK 2.x use "deps" instead. (or "peerDeps" if you're building a library) ```typescript public readonly cdkDependencies: string[]; ``` - *Type:* string[] Which AWS CDKv1 modules this project requires. --- ##### ~~`cdkDependenciesAsDeps`~~^Optional - *Deprecated:* Not supported in CDK v2. ```typescript public readonly cdkDependenciesAsDeps: boolean; ``` - *Type:* boolean - *Default:* true 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 --- ##### ~~`cdkTestDependencies`~~^Optional - *Deprecated:* For CDK 2.x use 'devDeps' (in node.js projects) or 'testDeps' (in java projects) instead ```typescript public readonly cdkTestDependencies: string[]; ``` - *Type:* string[] AWS CDK modules required for testing. --- ##### `cdkVersionPinning`^Optional ```typescript public readonly cdkVersionPinning: boolean; ``` - *Type:* 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. --- ##### `constructsVersion`^Optional ```typescript public readonly constructsVersion: string; ``` - *Type:* string - *Default:* for CDK 1.x the default is "3.2.27", for CDK 2.x the default is "10.0.5". Minimum version of the `constructs` library to depend on. --- ##### `appEntrypoint`^Optional ```typescript public readonly appEntrypoint: string; ``` - *Type:* string - *Default:* "app.py" The CDK app's entrypoint (relative to the source directory, which is "src" by default). --- ##### `testdir`^Optional ```typescript public readonly testdir: string; ``` - *Type:* string - *Default:* "tests" Python sources directory. --- ### PDKPipelineTsProjectOptions Configuration options for the PDKPipelineTsProject. #### Initializer ```typescript import { PDKPipelineTsProjectOptions } from '@aws-prototyping-sdk/pipeline' const pDKPipelineTsProjectOptions: PDKPipelineTsProjectOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | This is the name of your project. | | commitGenerated | boolean | Whether to commit the managed files by default. | | gitIgnoreOptions | projen.IgnoreFileOptions | Configuration options for .gitignore file. | | gitOptions | projen.GitOptions | Configuration options for git. | | logging | projen.LoggerOptions | Configure logging options such as verbosity. | | outdir | string | The root directory of the project. | | parent | projen.Project | The parent project, if this project is part of a bigger project. | | projenCommand | string | The shell command to use in order to run the projen CLI. | | projenrcJson | boolean | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. | | projenrcJsonOptions | projen.ProjenrcJsonOptions | Options for .projenrc.json. | | renovatebot | boolean | Use renovatebot to handle dependency upgrades. | | renovatebotOptions | projen.RenovatebotOptions | Options for renovatebot. | | autoApproveOptions | projen.github.AutoApproveOptions | Enable and configure the 'auto approve' workflow. | | autoMerge | boolean | Enable automatic merging on GitHub. | | autoMergeOptions | projen.github.AutoMergeOptions | Configure options for automatic merging on GitHub. | | clobber | boolean | Add a `clobber` task which resets the repo to origin. | | devContainer | boolean | Add a VSCode development environment (used for GitHub Codespaces). | | github | boolean | Enable GitHub integration. | | githubOptions | projen.github.GitHubOptions | Options for GitHub integration. | | gitpod | boolean | Add a Gitpod development environment. | | mergify | boolean | Whether mergify should be enabled on this repository or not. | | mergifyOptions | projen.github.MergifyOptions | Options for mergify. | | projectType | projen.ProjectType | Which type of project this is (library/app). | | projenCredentials | projen.github.GithubCredentials | Choose a method of providing GitHub API access for projen workflows. | | projenTokenSecret | string | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. | | readme | projen.SampleReadmeProps | The README setup. | | stale | boolean | Auto-close of stale issues and pull request. | | staleOptions | projen.github.StaleOptions | Auto-close stale issues and pull requests. | | vscode | boolean | Enable VSCode integration. | | allowLibraryDependencies | boolean | Allow the project to include `peerDependencies` and `bundledDependencies`. | | authorEmail | string | Author's e-mail. | | authorName | string | Author's name. | | authorOrganization | boolean | Is the author an organization. | | authorUrl | string | Author's URL / Website. | | autoDetectBin | boolean | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. | | bin | {[ key: string ]: string} | Binary programs vended with your module. | | bugsEmail | string | The email address to which issues should be reported. | | bugsUrl | string | The url to your project's issue tracker. | | bundledDeps | string[] | List of dependencies to bundle into this module. | | codeArtifactOptions | projen.javascript.CodeArtifactOptions | Options for npm packages using AWS CodeArtifact. | | deps | string[] | Runtime dependencies of this module. | | description | string | The description is just a string that helps people understand the purpose of the package. | | devDeps | string[] | Build dependencies for this module. | | entrypoint | string | Module entrypoint (`main` in `package.json`). | | homepage | string | Package's Homepage / Website. | | keywords | string[] | Keywords to include in `package.json`. | | license | string | License's SPDX identifier. | | licensed | boolean | Indicates if a license should be added. | | maxNodeVersion | string | Minimum node.js version to require via `engines` (inclusive). | | minNodeVersion | string | Minimum Node.js version to require via package.json `engines` (inclusive). | | npmAccess | projen.javascript.NpmAccess | Access level of the npm package. | | npmRegistry | string | The host name of the npm registry to publish to. | | npmRegistryUrl | string | The base URL of the npm package registry. | | npmTokenSecret | string | GitHub secret which contains the NPM token to use when publishing packages. | | packageManager | projen.javascript.NodePackageManager | The Node Package Manager used to execute scripts. | | packageName | string | The "name" in package.json. | | peerDependencyOptions | projen.javascript.PeerDependencyOptions | Options for `peerDeps`. | | peerDeps | string[] | Peer dependencies for this module. | | pnpmVersion | string | The version of PNPM to use if using PNPM as a package manager. | | repository | string | The repository is the location where the actual code for your package lives. | | repositoryDirectory | 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. | | scopedPackagesOptions | projen.javascript.ScopedPackagesOptions[] | Options for privately hosted scoped packages. | | scripts | {[ key: string ]: string} | npm scripts to include. | | stability | string | Package's Stability. | | jsiiReleaseVersion | string | Version requirement of `publib` which is used to publish modules to npm. | | majorVersion | number | Major version to release from the default branch. | | minMajorVersion | number | Minimal Major version to release. | | npmDistTag | string | The npmDistTag to use when publishing from the default branch. | | postBuildSteps | projen.github.workflows.JobStep[] | Steps to execute after build as part of the release workflow. | | prerelease | string | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). | | publishDryRun | boolean | Instead of actually publishing to package managers, just print the publishing command. | | publishTasks | boolean | Define publishing tasks that can be executed manually as well as workflows. | | releaseBranches | {[ key: string ]: projen.release.BranchOptions} | Defines additional release branches. | | releaseEveryCommit | boolean | Automatically release new versions every commit to one of branches in `releaseBranches`. | | releaseFailureIssue | boolean | Create a github issue on every failed publishing task. | | releaseFailureIssueLabel | string | The label to apply to issues indicating publish failures. | | releaseSchedule | string | CRON schedule to trigger new releases. | | releaseTagPrefix | string | Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. | | releaseTrigger | projen.release.ReleaseTrigger | The release trigger to use. | | releaseWorkflowName | string | The name of the default release workflow. | | releaseWorkflowSetupSteps | projen.github.workflows.JobStep[] | A set of workflow steps to execute in order to setup the workflow container. | | versionrcOptions | {[ key: string ]: any} | Custom configuration used when creating changelog with standard-version package. | | workflowContainerImage | string | Container image to use for GitHub workflows. | | workflowRunsOn | string[] | Github Runner selection labels. | | defaultReleaseBranch | string | The name of the main release branch. | | artifactsDirectory | string | A directory which will contain build artifacts. | | autoApproveUpgrades | boolean | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). | | buildWorkflow | boolean | Define a GitHub workflow for building PRs. | | buildWorkflowTriggers | projen.github.workflows.Triggers | Build workflow triggers. | | bundlerOptions | projen.javascript.BundlerOptions | Options for `Bundler`. | | codeCov | boolean | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v3 A secret is required for private repos. Configured with `@codeCovTokenSecret`. | | codeCovTokenSecret | string | Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. | | copyrightOwner | string | License copyright owner. | | copyrightPeriod | string | The copyright years to put in the LICENSE file. | | dependabot | boolean | Use dependabot to handle dependency upgrades. | | dependabotOptions | projen.github.DependabotOptions | Options for dependabot. | | depsUpgrade | boolean | Use github workflows to handle dependency upgrades. | | depsUpgradeOptions | projen.javascript.UpgradeDependenciesOptions | Options for `UpgradeDependencies`. | | gitignore | string[] | Additional entries to .gitignore. | | jest | boolean | Setup jest unit tests. | | jestOptions | projen.javascript.JestOptions | Jest options. | | mutableBuild | boolean | Automatically update files modified during builds to pull-request branches. | | npmignore | string[] | Additional entries to .npmignore. | | npmignoreEnabled | boolean | Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. | | npmIgnoreOptions | projen.IgnoreFileOptions | Configuration options for .npmignore file. | | package | boolean | Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). | | prettier | boolean | Setup prettier. | | prettierOptions | projen.javascript.PrettierOptions | Prettier options. | | projenDevDependency | boolean | Indicates of "projen" should be installed as a devDependency. | | projenrcJs | boolean | Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. | | projenrcJsOptions | projen.javascript.ProjenrcOptions | Options for .projenrc.js. | | projenVersion | string | Version of projen to install. | | pullRequestTemplate | boolean | Include a GitHub pull request template. | | pullRequestTemplateContents | string[] | The contents of the pull request template. | | release | boolean | Add release management to this project. | | releaseToNpm | boolean | Automatically release to npm when new versions are introduced. | | releaseWorkflow | boolean | DEPRECATED: renamed to `release`. | | workflowBootstrapSteps | projen.github.workflows.JobStep[] | Workflow steps to use in order to bootstrap this repo. | | workflowGitIdentity | projen.github.GitIdentity | The git identity to use in workflows. | | workflowNodeVersion | string | The node version to use in GitHub workflows. | | workflowPackageCache | boolean | Enable Node.js package cache in GitHub workflows. | | disableTsconfig | boolean | Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). | | disableTsconfigDev | boolean | Do not generate a `tsconfig.dev.json` file. | | docgen | boolean | Docgen by Typedoc. | | docsDirectory | string | Docs directory. | | entrypointTypes | string | The .d.ts file that includes the type declarations for this module. | | eslint | boolean | Setup eslint. | | eslintOptions | projen.javascript.EslintOptions | Eslint options. | | libdir | string | Typescript artifacts output directory. | | projenrcTs | boolean | Use TypeScript for your projenrc file (`.projenrc.ts`). | | projenrcTsOptions | projen.typescript.ProjenrcOptions | Options for .projenrc.ts. | | sampleCode | boolean | Generate one-time sample in `src/` and `test/` if there are no files there. | | srcdir | string | Typescript sources directory. | | testdir | string | Jest tests directory. Tests files should be named `xxx.test.ts`. | | tsconfig | projen.javascript.TypescriptConfigOptions | Custom TSConfig. | | tsconfigDev | projen.javascript.TypescriptConfigOptions | Custom tsconfig options for the development tsconfig.json file (used for testing). | | tsconfigDevFile | string | The name of the development tsconfig.json file. | | typescriptVersion | string | TypeScript version to use. | | buildCommand | string | A command to execute before synthesis. | | cdkout | string | cdk.out directory. | | context | {[ key: string ]: any} | Additional context to include in `cdk.json`. | | featureFlags | boolean | Include all feature flags in cdk.json. | | requireApproval | projen.awscdk.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. | | watchExcludes | string[] | Glob patterns to exclude from `cdk watch`. | | watchIncludes | string[] | Glob patterns to include in `cdk watch`. | | cdkVersion | string | Minimum version of the AWS CDK to depend on. | | cdkAssert | boolean | Warning: NodeJS only. | | cdkAssertions | boolean | Install the assertions library? | | cdkDependencies | string[] | Which AWS CDKv1 modules this project requires. | | cdkDependenciesAsDeps | boolean | If this is enabled (default), all modules declared in `cdkDependencies` will be also added as normal `dependencies` (as well as `peerDependencies`). | | cdkTestDependencies | string[] | AWS CDK modules required for testing. | | cdkVersionPinning | boolean | Use pinned version instead of caret version for CDK. | | constructsVersion | string | Minimum version of the `constructs` library to depend on. | | appEntrypoint | string | The CDK app's entrypoint (relative to the source directory, which is "src" by default). | | edgeLambdaAutoDiscover | 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. | | integrationTestAutoDiscover | boolean | Automatically discovers and creates integration tests for each `.integ.ts` file in under your test directory. | | lambdaAutoDiscover | 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. | | lambdaExtensionAutoDiscover | 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. | | lambdaOptions | projen.awscdk.LambdaFunctionCommonOptions | Common options for all AWS Lambda functions. | --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string - *Default:* $BASEDIR This is the name of your project. --- ##### `commitGenerated`^Optional ```typescript public readonly commitGenerated: boolean; ``` - *Type:* boolean - *Default:* true Whether to commit the managed files by default. --- ##### `gitIgnoreOptions`^Optional ```typescript public readonly gitIgnoreOptions: IgnoreFileOptions; ``` - *Type:* projen.IgnoreFileOptions Configuration options for .gitignore file. --- ##### `gitOptions`^Optional ```typescript public readonly gitOptions: GitOptions; ``` - *Type:* projen.GitOptions Configuration options for git. --- ##### `logging`^Optional ```typescript public readonly logging: LoggerOptions; ``` - *Type:* projen.LoggerOptions - *Default:* {} Configure logging options such as verbosity. --- ##### `outdir`^Optional ```typescript public readonly outdir: string; ``` - *Type:* string - *Default:* "." 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 sub-projects. --- ##### `parent`^Optional ```typescript public readonly parent: Project; ``` - *Type:* projen.Project The parent project, if this project is part of a bigger project. --- ##### `projenCommand`^Optional ```typescript public readonly projenCommand: string; ``` - *Type:* string - *Default:* "npx projen" The shell command to use in order to run the projen CLI. Can be used to customize in special environments. --- ##### `projenrcJson`^Optional ```typescript public readonly projenrcJson: boolean; ``` - *Type:* boolean - *Default:* false Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. --- ##### `projenrcJsonOptions`^Optional ```typescript public readonly projenrcJsonOptions: ProjenrcJsonOptions; ``` - *Type:* projen.ProjenrcJsonOptions - *Default:* default options Options for .projenrc.json. --- ##### `renovatebot`^Optional ```typescript public readonly renovatebot: boolean; ``` - *Type:* boolean - *Default:* false Use renovatebot to handle dependency upgrades. --- ##### `renovatebotOptions`^Optional ```typescript public readonly renovatebotOptions: RenovatebotOptions; ``` - *Type:* projen.RenovatebotOptions - *Default:* default options Options for renovatebot. --- ##### `autoApproveOptions`^Optional ```typescript public readonly autoApproveOptions: AutoApproveOptions; ``` - *Type:* projen.github.AutoApproveOptions - *Default:* auto approve is disabled Enable and configure the 'auto approve' workflow. --- ##### `autoMerge`^Optional ```typescript public readonly autoMerge: boolean; ``` - *Type:* boolean - *Default:* true Enable automatic merging on GitHub. Has no effect if `github.mergify` is set to false. --- ##### `autoMergeOptions`^Optional ```typescript public readonly autoMergeOptions: AutoMergeOptions; ``` - *Type:* projen.github.AutoMergeOptions - *Default:* see defaults in `AutoMergeOptions` Configure options for automatic merging on GitHub. Has no effect if `github.mergify` or `autoMerge` is set to false. --- ##### `clobber`^Optional ```typescript public readonly clobber: boolean; ``` - *Type:* boolean - *Default:* true, but false for subprojects Add a `clobber` task which resets the repo to origin. --- ##### `devContainer`^Optional ```typescript public readonly devContainer: boolean; ``` - *Type:* boolean - *Default:* false Add a VSCode development environment (used for GitHub Codespaces). --- ##### `github`^Optional ```typescript public readonly github: boolean; ``` - *Type:* boolean - *Default:* true Enable GitHub integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `githubOptions`^Optional ```typescript public readonly githubOptions: GitHubOptions; ``` - *Type:* projen.github.GitHubOptions - *Default:* see GitHubOptions Options for GitHub integration. --- ##### `gitpod`^Optional ```typescript public readonly gitpod: boolean; ``` - *Type:* boolean - *Default:* false Add a Gitpod development environment. --- ##### ~~`mergify`~~^Optional - *Deprecated:* use `githubOptions.mergify` instead ```typescript public readonly mergify: boolean; ``` - *Type:* boolean - *Default:* true Whether mergify should be enabled on this repository or not. --- ##### ~~`mergifyOptions`~~^Optional - *Deprecated:* use `githubOptions.mergifyOptions` instead ```typescript public readonly mergifyOptions: MergifyOptions; ``` - *Type:* projen.github.MergifyOptions - *Default:* default options Options for mergify. --- ##### ~~`projectType`~~^Optional - *Deprecated:* no longer supported at the base project level ```typescript public readonly projectType: ProjectType; ``` - *Type:* projen.ProjectType - *Default:* ProjectType.UNKNOWN Which type of project this is (library/app). --- ##### `projenCredentials`^Optional ```typescript public readonly projenCredentials: GithubCredentials; ``` - *Type:* projen.github.GithubCredentials - *Default:* use a personal access token named PROJEN_GITHUB_TOKEN Choose a method of providing GitHub API access for projen workflows. --- ##### ~~`projenTokenSecret`~~^Optional - *Deprecated:* use `projenCredentials` ```typescript public readonly projenTokenSecret: string; ``` - *Type:* string - *Default:* "PROJEN_GITHUB_TOKEN" 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. --- ##### `readme`^Optional ```typescript public readonly readme: SampleReadmeProps; ``` - *Type:* projen.SampleReadmeProps - *Default:* { filename: 'README.md', contents: '# replace this' } The README setup. --- *Example* ```typescript "{ filename: 'readme.md', contents: '# title' }" ``` ##### `stale`^Optional ```typescript public readonly stale: boolean; ``` - *Type:* boolean - *Default:* false Auto-close of stale issues and pull request. See `staleOptions` for options. --- ##### `staleOptions`^Optional ```typescript public readonly staleOptions: StaleOptions; ``` - *Type:* projen.github.StaleOptions - *Default:* see defaults in `StaleOptions` Auto-close stale issues and pull requests. To disable set `stale` to `false`. --- ##### `vscode`^Optional ```typescript public readonly vscode: boolean; ``` - *Type:* boolean - *Default:* true Enable VSCode integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `allowLibraryDependencies`^Optional ```typescript public readonly allowLibraryDependencies: boolean; ``` - *Type:* boolean - *Default:* true Allow the project to include `peerDependencies` and `bundledDependencies`. This is normally only allowed for libraries. For apps, there's no meaning for specifying these. --- ##### `authorEmail`^Optional ```typescript public readonly authorEmail: string; ``` - *Type:* string Author's e-mail. --- ##### `authorName`^Optional ```typescript public readonly authorName: string; ``` - *Type:* string Author's name. --- ##### `authorOrganization`^Optional ```typescript public readonly authorOrganization: boolean; ``` - *Type:* boolean Is the author an organization. --- ##### `authorUrl`^Optional ```typescript public readonly authorUrl: string; ``` - *Type:* string Author's URL / Website. --- ##### `autoDetectBin`^Optional ```typescript public readonly autoDetectBin: boolean; ``` - *Type:* boolean - *Default:* true Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. --- ##### `bin`^Optional ```typescript public readonly bin: {[ key: string ]: string}; ``` - *Type:* {[ key: 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. --- ##### `bugsEmail`^Optional ```typescript public readonly bugsEmail: string; ``` - *Type:* string The email address to which issues should be reported. --- ##### `bugsUrl`^Optional ```typescript public readonly bugsUrl: string; ``` - *Type:* string The url to your project's issue tracker. --- ##### `bundledDeps`^Optional ```typescript public readonly bundledDeps: string[]; ``` - *Type:* 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. --- ##### `codeArtifactOptions`^Optional ```typescript public readonly codeArtifactOptions: CodeArtifactOptions; ``` - *Type:* projen.javascript.CodeArtifactOptions - *Default:* undefined Options for npm packages using AWS CodeArtifact. This is required if publishing packages to, or installing scoped packages from AWS CodeArtifact --- ##### `deps`^Optional ```typescript public readonly deps: string[]; ``` - *Type:* string[] - *Default:* [] 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* ```typescript [ 'express', 'lodash', 'foo@^2' ] ``` ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* 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 --- ##### `devDeps`^Optional ```typescript public readonly devDeps: string[]; ``` - *Type:* string[] - *Default:* [] 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 [ 'typescript', '@types/express' ] ``` ##### `entrypoint`^Optional ```typescript public readonly entrypoint: string; ``` - *Type:* string - *Default:* "lib/index.js" Module entrypoint (`main` in `package.json`). Set to an empty string to not include `main` in your package.json --- ##### `homepage`^Optional ```typescript public readonly homepage: string; ``` - *Type:* string Package's Homepage / Website. --- ##### `keywords`^Optional ```typescript public readonly keywords: string[]; ``` - *Type:* string[] Keywords to include in `package.json`. --- ##### `license`^Optional ```typescript public readonly license: string; ``` - *Type:* string - *Default:* "Apache-2.0" 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. --- ##### `licensed`^Optional ```typescript public readonly licensed: boolean; ``` - *Type:* boolean - *Default:* true Indicates if a license should be added. --- ##### `maxNodeVersion`^Optional ```typescript public readonly maxNodeVersion: string; ``` - *Type:* string - *Default:* no max Minimum node.js version to require via `engines` (inclusive). --- ##### `minNodeVersion`^Optional ```typescript public readonly minNodeVersion: string; ``` - *Type:* string - *Default:* no "engines" specified Minimum Node.js version to require via package.json `engines` (inclusive). --- ##### `npmAccess`^Optional ```typescript public readonly npmAccess: NpmAccess; ``` - *Type:* projen.javascript.NpmAccess - *Default:* for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`. Access level of the npm package. --- ##### ~~`npmRegistry`~~^Optional - *Deprecated:* use `npmRegistryUrl` instead ```typescript public readonly npmRegistry: string; ``` - *Type:* string The host name of the npm registry to publish to. Cannot be set together with `npmRegistryUrl`. --- ##### `npmRegistryUrl`^Optional ```typescript public readonly npmRegistryUrl: string; ``` - *Type:* string - *Default:* "https://registry.npmjs.org" The base URL of the npm package registry. Must be a URL (e.g. start with "https://" or "http://") --- ##### `npmTokenSecret`^Optional ```typescript public readonly npmTokenSecret: string; ``` - *Type:* string - *Default:* "NPM_TOKEN" GitHub secret which contains the NPM token to use when publishing packages. --- ##### `packageManager`^Optional ```typescript public readonly packageManager: NodePackageManager; ``` - *Type:* projen.javascript.NodePackageManager - *Default:* NodePackageManager.YARN The Node Package Manager used to execute scripts. --- ##### `packageName`^Optional ```typescript public readonly packageName: string; ``` - *Type:* string - *Default:* defaults to project name The "name" in package.json. --- ##### `peerDependencyOptions`^Optional ```typescript public readonly peerDependencyOptions: PeerDependencyOptions; ``` - *Type:* projen.javascript.PeerDependencyOptions Options for `peerDeps`. --- ##### `peerDeps`^Optional ```typescript public readonly peerDeps: string[]; ``` - *Type:* string[] - *Default:* [] 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. --- ##### `pnpmVersion`^Optional ```typescript public readonly pnpmVersion: string; ``` - *Type:* string - *Default:* "7" The version of PNPM to use if using PNPM as a package manager. --- ##### `repository`^Optional ```typescript public readonly repository: string; ``` - *Type:* 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 --- ##### `repositoryDirectory`^Optional ```typescript public readonly repositoryDirectory: string; ``` - *Type:* 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. --- ##### `scopedPackagesOptions`^Optional ```typescript public readonly scopedPackagesOptions: ScopedPackagesOptions[]; ``` - *Type:* projen.javascript.ScopedPackagesOptions[] - *Default:* fetch all scoped packages from the public npm registry Options for privately hosted scoped packages. --- ##### ~~`scripts`~~^Optional - *Deprecated:* use `project.addTask()` or `package.setScript()` ```typescript public readonly scripts: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} - *Default:* {} 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. --- ##### `stability`^Optional ```typescript public readonly stability: string; ``` - *Type:* string Package's Stability. --- ##### `jsiiReleaseVersion`^Optional ```typescript public readonly jsiiReleaseVersion: string; ``` - *Type:* string - *Default:* "latest" Version requirement of `publib` which is used to publish modules to npm. --- ##### `majorVersion`^Optional ```typescript public readonly majorVersion: number; ``` - *Type:* number - *Default:* Major version is not enforced. 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. --- ##### `minMajorVersion`^Optional ```typescript public readonly minMajorVersion: number; ``` - *Type:* number - *Default:* No minimum version is being enforced 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`. --- ##### `npmDistTag`^Optional ```typescript public readonly npmDistTag: string; ``` - *Type:* string - *Default:* "latest" 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. --- ##### `postBuildSteps`^Optional ```typescript public readonly postBuildSteps: JobStep[]; ``` - *Type:* projen.github.workflows.JobStep[] - *Default:* [] Steps to execute after build as part of the release workflow. --- ##### `prerelease`^Optional ```typescript public readonly prerelease: string; ``` - *Type:* string - *Default:* normal semantic versions Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). --- ##### `publishDryRun`^Optional ```typescript public readonly publishDryRun: boolean; ``` - *Type:* boolean - *Default:* false Instead of actually publishing to package managers, just print the publishing command. --- ##### `publishTasks`^Optional ```typescript public readonly publishTasks: boolean; ``` - *Type:* boolean - *Default:* false 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. --- ##### `releaseBranches`^Optional ```typescript public readonly releaseBranches: {[ key: string ]: BranchOptions}; ``` - *Type:* {[ key: string ]: projen.release.BranchOptions} - *Default:* no additional branches are used for release. you can use `addBranch()` to add additional branches. 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. --- ##### ~~`releaseEveryCommit`~~^Optional - *Deprecated:* Use `releaseTrigger: ReleaseTrigger.continuous()` instead ```typescript public readonly releaseEveryCommit: boolean; ``` - *Type:* boolean - *Default:* true Automatically release new versions every commit to one of branches in `releaseBranches`. --- ##### `releaseFailureIssue`^Optional ```typescript public readonly releaseFailureIssue: boolean; ``` - *Type:* boolean - *Default:* false Create a github issue on every failed publishing task. --- ##### `releaseFailureIssueLabel`^Optional ```typescript public readonly releaseFailureIssueLabel: string; ``` - *Type:* string - *Default:* "failed-release" The label to apply to issues indicating publish failures. Only applies if `releaseFailureIssue` is true. --- ##### ~~`releaseSchedule`~~^Optional - *Deprecated:* Use `releaseTrigger: ReleaseTrigger.scheduled()` instead ```typescript public readonly releaseSchedule: string; ``` - *Type:* string - *Default:* no scheduled releases CRON schedule to trigger new releases. --- ##### `releaseTagPrefix`^Optional ```typescript public readonly releaseTagPrefix: string; ``` - *Type:* string - *Default:* "v" 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. --- ##### `releaseTrigger`^Optional ```typescript public readonly releaseTrigger: ReleaseTrigger; ``` - *Type:* projen.release.ReleaseTrigger - *Default:* Continuous releases (`ReleaseTrigger.continuous()`) The release trigger to use. --- ##### `releaseWorkflowName`^Optional ```typescript public readonly releaseWorkflowName: string; ``` - *Type:* string - *Default:* "Release" The name of the default release workflow. --- ##### `releaseWorkflowSetupSteps`^Optional ```typescript public readonly releaseWorkflowSetupSteps: JobStep[]; ``` - *Type:* projen.github.workflows.JobStep[] A set of workflow steps to execute in order to setup the workflow container. --- ##### `versionrcOptions`^Optional ```typescript public readonly versionrcOptions: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* standard configuration applicable for GitHub repositories Custom configuration used when creating changelog with standard-version package. Given values either append to default configuration or overwrite values in it. --- ##### `workflowContainerImage`^Optional ```typescript public readonly workflowContainerImage: string; ``` - *Type:* string - *Default:* default image Container image to use for GitHub workflows. --- ##### `workflowRunsOn`^Optional ```typescript public readonly workflowRunsOn: string[]; ``` - *Type:* string[] - *Default:* ["ubuntu-latest"] Github Runner selection labels. --- ##### `defaultReleaseBranch`^Required ```typescript public readonly defaultReleaseBranch: string; ``` - *Type:* string - *Default:* "main" The name of the main release branch. --- ##### `artifactsDirectory`^Optional ```typescript public readonly artifactsDirectory: string; ``` - *Type:* string - *Default:* "dist" A directory which will contain build artifacts. --- ##### `autoApproveUpgrades`^Optional ```typescript public readonly autoApproveUpgrades: boolean; ``` - *Type:* boolean - *Default:* true Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). Throw if set to true but `autoApproveOptions` are not defined. --- ##### `buildWorkflow`^Optional ```typescript public readonly buildWorkflow: boolean; ``` - *Type:* boolean - *Default:* true if not a subproject Define a GitHub workflow for building PRs. --- ##### `buildWorkflowTriggers`^Optional ```typescript public readonly buildWorkflowTriggers: Triggers; ``` - *Type:* projen.github.workflows.Triggers - *Default:* "{ pullRequest: {}, workflowDispatch: {} }" Build workflow triggers. --- ##### `bundlerOptions`^Optional ```typescript public readonly bundlerOptions: BundlerOptions; ``` - *Type:* projen.javascript.BundlerOptions Options for `Bundler`. --- ##### `codeCov`^Optional ```typescript public readonly codeCov: boolean; ``` - *Type:* boolean - *Default:* false Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v3 A secret is required for private repos. Configured with `@codeCovTokenSecret`. --- ##### `codeCovTokenSecret`^Optional ```typescript public readonly codeCovTokenSecret: string; ``` - *Type:* string - *Default:* if this option is not specified, only public repositories are supported Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. --- ##### `copyrightOwner`^Optional ```typescript public readonly copyrightOwner: string; ``` - *Type:* string - *Default:* defaults to the value of authorName or "" if `authorName` is undefined. License copyright owner. --- ##### `copyrightPeriod`^Optional ```typescript public readonly copyrightPeriod: string; ``` - *Type:* string - *Default:* current year The copyright years to put in the LICENSE file. --- ##### `dependabot`^Optional ```typescript public readonly dependabot: boolean; ``` - *Type:* boolean - *Default:* false Use dependabot to handle dependency upgrades. Cannot be used in conjunction with `depsUpgrade`. --- ##### `dependabotOptions`^Optional ```typescript public readonly dependabotOptions: DependabotOptions; ``` - *Type:* projen.github.DependabotOptions - *Default:* default options Options for dependabot. --- ##### `depsUpgrade`^Optional ```typescript public readonly depsUpgrade: boolean; ``` - *Type:* boolean - *Default:* true Use github workflows to handle dependency upgrades. Cannot be used in conjunction with `dependabot`. --- ##### `depsUpgradeOptions`^Optional ```typescript public readonly depsUpgradeOptions: UpgradeDependenciesOptions; ``` - *Type:* projen.javascript.UpgradeDependenciesOptions - *Default:* default options Options for `UpgradeDependencies`. --- ##### `gitignore`^Optional ```typescript public readonly gitignore: string[]; ``` - *Type:* string[] Additional entries to .gitignore. --- ##### `jest`^Optional ```typescript public readonly jest: boolean; ``` - *Type:* boolean - *Default:* true Setup jest unit tests. --- ##### `jestOptions`^Optional ```typescript public readonly jestOptions: JestOptions; ``` - *Type:* projen.javascript.JestOptions - *Default:* default options Jest options. --- ##### `mutableBuild`^Optional ```typescript public readonly mutableBuild: boolean; ``` - *Type:* boolean - *Default:* true 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. --- ##### ~~`npmignore`~~^Optional - *Deprecated:* - use `project.addPackageIgnore` ```typescript public readonly npmignore: string[]; ``` - *Type:* string[] Additional entries to .npmignore. --- ##### `npmignoreEnabled`^Optional ```typescript public readonly npmignoreEnabled: boolean; ``` - *Type:* boolean - *Default:* true Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. --- ##### `npmIgnoreOptions`^Optional ```typescript public readonly npmIgnoreOptions: IgnoreFileOptions; ``` - *Type:* projen.IgnoreFileOptions Configuration options for .npmignore file. --- ##### `package`^Optional ```typescript public readonly package: boolean; ``` - *Type:* boolean - *Default:* true Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). --- ##### `prettier`^Optional ```typescript public readonly prettier: boolean; ``` - *Type:* boolean - *Default:* false Setup prettier. --- ##### `prettierOptions`^Optional ```typescript public readonly prettierOptions: PrettierOptions; ``` - *Type:* projen.javascript.PrettierOptions - *Default:* default options Prettier options. --- ##### `projenDevDependency`^Optional ```typescript public readonly projenDevDependency: boolean; ``` - *Type:* boolean - *Default:* true Indicates of "projen" should be installed as a devDependency. --- ##### `projenrcJs`^Optional ```typescript public readonly projenrcJs: boolean; ``` - *Type:* boolean - *Default:* true if projenrcJson is false Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. --- ##### `projenrcJsOptions`^Optional ```typescript public readonly projenrcJsOptions: ProjenrcOptions; ``` - *Type:* projen.javascript.ProjenrcOptions - *Default:* default options Options for .projenrc.js. --- ##### `projenVersion`^Optional ```typescript public readonly projenVersion: string; ``` - *Type:* string - *Default:* Defaults to the latest version. Version of projen to install. --- ##### `pullRequestTemplate`^Optional ```typescript public readonly pullRequestTemplate: boolean; ``` - *Type:* boolean - *Default:* true Include a GitHub pull request template. --- ##### `pullRequestTemplateContents`^Optional ```typescript public readonly pullRequestTemplateContents: string[]; ``` - *Type:* string[] - *Default:* default content The contents of the pull request template. --- ##### `release`^Optional ```typescript public readonly release: boolean; ``` - *Type:* boolean - *Default:* true (false for subprojects) Add release management to this project. --- ##### `releaseToNpm`^Optional ```typescript public readonly releaseToNpm: boolean; ``` - *Type:* boolean - *Default:* false Automatically release to npm when new versions are introduced. --- ##### ~~`releaseWorkflow`~~^Optional - *Deprecated:* see `release`. ```typescript public readonly releaseWorkflow: boolean; ``` - *Type:* boolean - *Default:* true if not a subproject DEPRECATED: renamed to `release`. --- ##### `workflowBootstrapSteps`^Optional ```typescript public readonly workflowBootstrapSteps: JobStep[]; ``` - *Type:* projen.github.workflows.JobStep[] - *Default:* "yarn install --frozen-lockfile && yarn projen" Workflow steps to use in order to bootstrap this repo. --- ##### `workflowGitIdentity`^Optional ```typescript public readonly workflowGitIdentity: GitIdentity; ``` - *Type:* projen.github.GitIdentity - *Default:* GitHub Actions The git identity to use in workflows. --- ##### `workflowNodeVersion`^Optional ```typescript public readonly workflowNodeVersion: string; ``` - *Type:* string - *Default:* same as `minNodeVersion` The node version to use in GitHub workflows. --- ##### `workflowPackageCache`^Optional ```typescript public readonly workflowPackageCache: boolean; ``` - *Type:* boolean - *Default:* false Enable Node.js package cache in GitHub workflows. --- ##### `disableTsconfig`^Optional ```typescript public readonly disableTsconfig: boolean; ``` - *Type:* boolean - *Default:* false Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). --- ##### `disableTsconfigDev`^Optional ```typescript public readonly disableTsconfigDev: boolean; ``` - *Type:* boolean - *Default:* false Do not generate a `tsconfig.dev.json` file. --- ##### `docgen`^Optional ```typescript public readonly docgen: boolean; ``` - *Type:* boolean - *Default:* false Docgen by Typedoc. --- ##### `docsDirectory`^Optional ```typescript public readonly docsDirectory: string; ``` - *Type:* string - *Default:* "docs" Docs directory. --- ##### `entrypointTypes`^Optional ```typescript public readonly entrypointTypes: string; ``` - *Type:* string - *Default:* .d.ts file derived from the project's entrypoint (usually lib/index.d.ts) The .d.ts file that includes the type declarations for this module. --- ##### `eslint`^Optional ```typescript public readonly eslint: boolean; ``` - *Type:* boolean - *Default:* true Setup eslint. --- ##### `eslintOptions`^Optional ```typescript public readonly eslintOptions: EslintOptions; ``` - *Type:* projen.javascript.EslintOptions - *Default:* opinionated default options Eslint options. --- ##### `libdir`^Optional ```typescript public readonly libdir: string; ``` - *Type:* string - *Default:* "lib" Typescript artifacts output directory. --- ##### `projenrcTs`^Optional ```typescript public readonly projenrcTs: boolean; ``` - *Type:* boolean - *Default:* false Use TypeScript for your projenrc file (`.projenrc.ts`). --- ##### `projenrcTsOptions`^Optional ```typescript public readonly projenrcTsOptions: ProjenrcOptions; ``` - *Type:* projen.typescript.ProjenrcOptions Options for .projenrc.ts. --- ##### `sampleCode`^Optional ```typescript public readonly sampleCode: boolean; ``` - *Type:* boolean - *Default:* true Generate one-time sample in `src/` and `test/` if there are no files there. --- ##### `srcdir`^Optional ```typescript public readonly srcdir: string; ``` - *Type:* string - *Default:* "src" Typescript sources directory. --- ##### `testdir`^Optional ```typescript public readonly testdir: string; ``` - *Type:* string - *Default:* "test" 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. --- ##### `tsconfig`^Optional ```typescript public readonly tsconfig: TypescriptConfigOptions; ``` - *Type:* projen.javascript.TypescriptConfigOptions - *Default:* default options Custom TSConfig. --- ##### `tsconfigDev`^Optional ```typescript public readonly tsconfigDev: TypescriptConfigOptions; ``` - *Type:* projen.javascript.TypescriptConfigOptions - *Default:* use the production tsconfig options Custom tsconfig options for the development tsconfig.json file (used for testing). --- ##### `tsconfigDevFile`^Optional ```typescript public readonly tsconfigDevFile: string; ``` - *Type:* string - *Default:* "tsconfig.dev.json" The name of the development tsconfig.json file. --- ##### `typescriptVersion`^Optional ```typescript public readonly typescriptVersion: string; ``` - *Type:* string - *Default:* "latest" TypeScript version to use. NOTE: Typescript is not semantically versioned and should remain on the same minor, so we recommend using a `~` dependency (e.g. `~1.2.3`). --- ##### `buildCommand`^Optional ```typescript public readonly buildCommand: string; ``` - *Type:* string - *Default:* no build command 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. --- ##### `cdkout`^Optional ```typescript public readonly cdkout: string; ``` - *Type:* string - *Default:* "cdk.out" cdk.out directory. --- ##### `context`^Optional ```typescript public readonly context: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* no additional context Additional context to include in `cdk.json`. --- ##### `featureFlags`^Optional ```typescript public readonly featureFlags: boolean; ``` - *Type:* boolean - *Default:* true Include all feature flags in cdk.json. --- ##### `requireApproval`^Optional ```typescript public readonly requireApproval: ApprovalLevel; ``` - *Type:* projen.awscdk.ApprovalLevel - *Default:* ApprovalLevel.BROADENING 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. --- ##### `watchExcludes`^Optional ```typescript public readonly watchExcludes: string[]; ``` - *Type:* string[] - *Default:* [] Glob patterns to exclude from `cdk watch`. --- ##### `watchIncludes`^Optional ```typescript public readonly watchIncludes: string[]; ``` - *Type:* string[] - *Default:* [] Glob patterns to include in `cdk watch`. --- ##### `cdkVersion`^Required ```typescript public readonly cdkVersion: string; ``` - *Type:* string - *Default:* "2.1.0" Minimum version of the AWS CDK to depend on. --- ##### ~~`cdkAssert`~~^Optional - *Deprecated:* The ```typescript public readonly cdkAssert: boolean; ``` - *Type:* boolean - *Default:* will be included by default for AWS CDK >= 1.0.0 < 2.0.0 Warning: NodeJS only. Install the --- ##### `cdkAssertions`^Optional ```typescript public readonly cdkAssertions: boolean; ``` - *Type:* boolean - *Default:* will be included by default for AWS CDK >= 1.111.0 < 2.0.0 Install the assertions library? Only needed for CDK 1.x. If using CDK 2.x then assertions is already included in 'aws-cdk-lib' --- ##### ~~`cdkDependencies`~~^Optional - *Deprecated:* For CDK 2.x use "deps" instead. (or "peerDeps" if you're building a library) ```typescript public readonly cdkDependencies: string[]; ``` - *Type:* string[] Which AWS CDKv1 modules this project requires. --- ##### ~~`cdkDependenciesAsDeps`~~^Optional - *Deprecated:* Not supported in CDK v2. ```typescript public readonly cdkDependenciesAsDeps: boolean; ``` - *Type:* boolean - *Default:* true 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 --- ##### ~~`cdkTestDependencies`~~^Optional - *Deprecated:* For CDK 2.x use 'devDeps' (in node.js projects) or 'testDeps' (in java projects) instead ```typescript public readonly cdkTestDependencies: string[]; ``` - *Type:* string[] AWS CDK modules required for testing. --- ##### `cdkVersionPinning`^Optional ```typescript public readonly cdkVersionPinning: boolean; ``` - *Type:* 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. --- ##### `constructsVersion`^Optional ```typescript public readonly constructsVersion: string; ``` - *Type:* string - *Default:* for CDK 1.x the default is "3.2.27", for CDK 2.x the default is "10.0.5". Minimum version of the `constructs` library to depend on. --- ##### `appEntrypoint`^Optional ```typescript public readonly appEntrypoint: string; ``` - *Type:* string - *Default:* "main.ts" The CDK app's entrypoint (relative to the source directory, which is "src" by default). --- ##### `edgeLambdaAutoDiscover`^Optional ```typescript public readonly edgeLambdaAutoDiscover: boolean; ``` - *Type:* boolean - *Default:* true 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. --- ##### `integrationTestAutoDiscover`^Optional ```typescript public readonly integrationTestAutoDiscover: boolean; ``` - *Type:* boolean - *Default:* true Automatically discovers and creates integration tests for each `.integ.ts` file in under your test directory. --- ##### `lambdaAutoDiscover`^Optional ```typescript public readonly lambdaAutoDiscover: boolean; ``` - *Type:* boolean - *Default:* true 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. --- ##### `lambdaExtensionAutoDiscover`^Optional ```typescript public readonly lambdaExtensionAutoDiscover: boolean; ``` - *Type:* boolean - *Default:* true 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. --- ##### `lambdaOptions`^Optional ```typescript public readonly lambdaOptions: LambdaFunctionCommonOptions; ``` - *Type:* projen.awscdk.LambdaFunctionCommonOptions - *Default:* default options Common options for all AWS Lambda functions. --- ### SonarCodeScannerConfig #### Initializer ```typescript import { SonarCodeScannerConfig } from '@aws-prototyping-sdk/pipeline' const sonarCodeScannerConfig: SonarCodeScannerConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | sonarqubeAuthorizedGroup | string | Group name in Sonarqube with access to administer this project. | | sonarqubeDefaultProfileOrGateName | string | Default profile/gate name i.e: your org profile. | | sonarqubeEndpoint | string | endpoint of the sonarqube instance i.e: https://. | | sonarqubeProjectName | string | Name of the project to create in Sonarqube. | | cdkOutDir | string | directory containing the synthesized cdk resources. | | cfnNagIgnorePath | string | path to a file containing the cfn nag suppression rules. | | excludeGlobsForScan | string[] | glob patterns to exclude from sonar scan. | | includeGlobsForScan | string[] | glob patterns to include from sonar scan. | | preArchiveCommands | string[] | Hook which allows custom commands to be executed before the process commences the archival process. | | sonarqubeSpecificProfileOrGateName | string | Specific profile/gate name i.e: language specific. | | sonarqubeTags | string[] | Tags to associate with this project. | --- ##### `sonarqubeAuthorizedGroup`^Required ```typescript public readonly sonarqubeAuthorizedGroup: string; ``` - *Type:* string Group name in Sonarqube with access to administer this project. --- ##### `sonarqubeDefaultProfileOrGateName`^Required ```typescript public readonly sonarqubeDefaultProfileOrGateName: string; ``` - *Type:* string Default profile/gate name i.e: your org profile. Note: These need to be set up in Sonarqube manually. --- ##### `sonarqubeEndpoint`^Required ```typescript public readonly sonarqubeEndpoint: string; ``` - *Type:* string endpoint of the sonarqube instance i.e: https://. Note: Ensure a trailing '/' is not included. --- ##### `sonarqubeProjectName`^Required ```typescript public readonly sonarqubeProjectName: string; ``` - *Type:* string Name of the project to create in Sonarqube. --- ##### `cdkOutDir`^Optional ```typescript public readonly cdkOutDir: string; ``` - *Type:* string directory containing the synthesized cdk resources. --- ##### `cfnNagIgnorePath`^Optional ```typescript public readonly cfnNagIgnorePath: string; ``` - *Type:* string path to a file containing the cfn nag suppression rules. --- ##### `excludeGlobsForScan`^Optional ```typescript public readonly excludeGlobsForScan: string[]; ``` - *Type:* string[] glob patterns to exclude from sonar scan. --- ##### `includeGlobsForScan`^Optional ```typescript public readonly includeGlobsForScan: string[]; ``` - *Type:* string[] glob patterns to include from sonar scan. --- ##### `preArchiveCommands`^Optional ```typescript public readonly preArchiveCommands: string[]; ``` - *Type:* string[] Hook which allows custom commands to be executed before the process commences the archival process. --- ##### `sonarqubeSpecificProfileOrGateName`^Optional ```typescript public readonly sonarqubeSpecificProfileOrGateName: string; ``` - *Type:* string Specific profile/gate name i.e: language specific. Note: These need to be set up in Sonarqube manually. --- ##### `sonarqubeTags`^Optional ```typescript public readonly sonarqubeTags: string[]; ``` - *Type:* string[] Tags to associate with this project. --- ### SonarCodeScannerProps SonarCodeScanners properties. #### Initializer ```typescript import { SonarCodeScannerProps } from '@aws-prototyping-sdk/pipeline' const sonarCodeScannerProps: SonarCodeScannerProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | sonarqubeAuthorizedGroup | string | Group name in Sonarqube with access to administer this project. | | sonarqubeDefaultProfileOrGateName | string | Default profile/gate name i.e: your org profile. | | sonarqubeEndpoint | string | endpoint of the sonarqube instance i.e: https://. | | sonarqubeProjectName | string | Name of the project to create in Sonarqube. | | cdkOutDir | string | directory containing the synthesized cdk resources. | | cfnNagIgnorePath | string | path to a file containing the cfn nag suppression rules. | | excludeGlobsForScan | string[] | glob patterns to exclude from sonar scan. | | includeGlobsForScan | string[] | glob patterns to include from sonar scan. | | preArchiveCommands | string[] | Hook which allows custom commands to be executed before the process commences the archival process. | | sonarqubeSpecificProfileOrGateName | string | Specific profile/gate name i.e: language specific. | | sonarqubeTags | string[] | Tags to associate with this project. | | artifactBucketArn | string | S3 bucket ARN containing the built artifacts from the synth build. | | synthBuildArn | string | ARN for the CodeBuild task responsible for executing the synth command. | | artifactBucketKeyArn | string | Artifact bucket key ARN used to encrypt the artifacts. | --- ##### `sonarqubeAuthorizedGroup`^Required ```typescript public readonly sonarqubeAuthorizedGroup: string; ``` - *Type:* string Group name in Sonarqube with access to administer this project. --- ##### `sonarqubeDefaultProfileOrGateName`^Required ```typescript public readonly sonarqubeDefaultProfileOrGateName: string; ``` - *Type:* string Default profile/gate name i.e: your org profile. Note: These need to be set up in Sonarqube manually. --- ##### `sonarqubeEndpoint`^Required ```typescript public readonly sonarqubeEndpoint: string; ``` - *Type:* string endpoint of the sonarqube instance i.e: https://. Note: Ensure a trailing '/' is not included. --- ##### `sonarqubeProjectName`^Required ```typescript public readonly sonarqubeProjectName: string; ``` - *Type:* string Name of the project to create in Sonarqube. --- ##### `cdkOutDir`^Optional ```typescript public readonly cdkOutDir: string; ``` - *Type:* string directory containing the synthesized cdk resources. --- ##### `cfnNagIgnorePath`^Optional ```typescript public readonly cfnNagIgnorePath: string; ``` - *Type:* string path to a file containing the cfn nag suppression rules. --- ##### `excludeGlobsForScan`^Optional ```typescript public readonly excludeGlobsForScan: string[]; ``` - *Type:* string[] glob patterns to exclude from sonar scan. --- ##### `includeGlobsForScan`^Optional ```typescript public readonly includeGlobsForScan: string[]; ``` - *Type:* string[] glob patterns to include from sonar scan. --- ##### `preArchiveCommands`^Optional ```typescript public readonly preArchiveCommands: string[]; ``` - *Type:* string[] Hook which allows custom commands to be executed before the process commences the archival process. --- ##### `sonarqubeSpecificProfileOrGateName`^Optional ```typescript public readonly sonarqubeSpecificProfileOrGateName: string; ``` - *Type:* string Specific profile/gate name i.e: language specific. Note: These need to be set up in Sonarqube manually. --- ##### `sonarqubeTags`^Optional ```typescript public readonly sonarqubeTags: string[]; ``` - *Type:* string[] Tags to associate with this project. --- ##### `artifactBucketArn`^Required ```typescript public readonly artifactBucketArn: string; ``` - *Type:* string S3 bucket ARN containing the built artifacts from the synth build. --- ##### `synthBuildArn`^Required ```typescript public readonly synthBuildArn: string; ``` - *Type:* string ARN for the CodeBuild task responsible for executing the synth command. --- ##### `artifactBucketKeyArn`^Optional ```typescript public readonly artifactBucketKeyArn: string; ``` - *Type:* string Artifact bucket key ARN used to encrypt the artifacts. --- ## Classes ### PDKPipelineJavaProject Synthesizes a Java Project with a CI/CD pipeline. #### Initializers ```typescript import { PDKPipelineJavaProject } from '@aws-prototyping-sdk/pipeline' new PDKPipelineJavaProject(options: PDKPipelineJavaProjectOptions) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | options | PDKPipelineJavaProjectOptions | *No description.* | --- ##### `options`^Required - *Type:* PDKPipelineJavaProjectOptions --- #### Methods | **Name** | **Description** | | --- | --- | | addExcludeFromCleanup | Exclude the matching files from pre-synth cleanup. | | addGitIgnore | Adds a .gitignore pattern. | | addPackageIgnore | Exclude these files from the bundled package. | | addTask | Adds a new task to this project. | | addTip | Prints a "tip" message during synthesis. | | annotateGenerated | Marks the provided file(s) as being generated. | | postSynthesize | Called after all components are synthesized. | | preSynthesize | Called before all components are synthesized. | | removeTask | Removes a task from a project. | | runTaskCommand | Returns the shell command to execute in order to run a task. | | synth | Synthesize all project files into `outdir`. | | tryFindFile | Finds a file at the specified relative path within this project and all its subprojects. | | tryFindJsonFile | Finds a json file by name. | | tryFindObjectFile | Finds an object file (like JsonFile, YamlFile, etc.) by name. | | tryRemoveFile | Finds a file at the specified relative path within this project and removes it. | | addDependency | Adds a runtime dependency. | | addPlugin | Adds a build plugin to the pom. | | addTestDependency | Adds a test dependency. | | addCdkDependency | Adds an AWS CDK module dependencies. | --- ##### `addExcludeFromCleanup` ```typescript public addExcludeFromCleanup(globs: string): void ``` Exclude the matching files from pre-synth cleanup. Can be used when, for example, some source files include the projen marker and we don't want them to be erased during synth. ###### `globs`^Required - *Type:* string The glob patterns to match. --- ##### `addGitIgnore` ```typescript public addGitIgnore(pattern: string): void ``` Adds a .gitignore pattern. ###### `pattern`^Required - *Type:* string The glob pattern to ignore. --- ##### `addPackageIgnore` ```typescript public addPackageIgnore(_pattern: string): void ``` Exclude these files from the bundled package. Implemented by project types based on the packaging mechanism. For example, `NodeProject` delegates this to `.npmignore`. ###### `_pattern`^Required - *Type:* string The glob pattern to exclude. --- ##### `addTask` ```typescript public addTask(name: string, props?: TaskOptions): Task ``` Adds a new task to this project. This will fail if the project already has a task with this name. ###### `name`^Required - *Type:* string The task name to add. --- ###### `props`^Optional - *Type:* projen.TaskOptions Task properties. --- ##### ~~`addTip`~~ ```typescript public addTip(message: string): void ``` Prints a "tip" message during synthesis. ###### `message`^Required - *Type:* string The message. --- ##### `annotateGenerated` ```typescript public annotateGenerated(glob: string): void ``` Marks the provided file(s) as being generated. This is achieved using the github-linguist attributes. Generated files do not count against the repository statistics and language breakdown. > [https://github.com/github/linguist/blob/master/docs/overrides.md](https://github.com/github/linguist/blob/master/docs/overrides.md) ###### `glob`^Required - *Type:* string the glob pattern to match (could be a file path). --- ##### `postSynthesize` ```typescript public postSynthesize(): void ``` Called after all components are synthesized. Order is *not* guaranteed. ##### `preSynthesize` ```typescript public preSynthesize(): void ``` Called before all components are synthesized. ##### `removeTask` ```typescript public removeTask(name: string): Task ``` Removes a task from a project. ###### `name`^Required - *Type:* string The name of the task to remove. --- ##### `runTaskCommand` ```typescript public runTaskCommand(task: Task): string ``` Returns the shell command to execute in order to run a task. By default, this is `npx projen@ ` ###### `task`^Required - *Type:* projen.Task The task for which the command is required. --- ##### `synth` ```typescript public synth(): void ``` Synthesize all project files into `outdir`. 1. Call "this.preSynthesize()" 2. Delete all generated files 3. Synthesize all sub-projects 4. Synthesize all components of this project 5. Call "postSynthesize()" for all components of this project 6. Call "this.postSynthesize()" ##### `tryFindFile` ```typescript public tryFindFile(filePath: string): FileBase ``` Finds a file at the specified relative path within this project and all its subprojects. ###### `filePath`^Required - *Type:* string The file path. If this path is relative, it will be resolved from the root of _this_ project. --- ##### ~~`tryFindJsonFile`~~ ```typescript public tryFindJsonFile(filePath: string): JsonFile ``` Finds a json file by name. ###### `filePath`^Required - *Type:* string The file path. --- ##### `tryFindObjectFile` ```typescript public tryFindObjectFile(filePath: string): ObjectFile ``` Finds an object file (like JsonFile, YamlFile, etc.) by name. ###### `filePath`^Required - *Type:* string The file path. --- ##### `tryRemoveFile` ```typescript public tryRemoveFile(filePath: string): FileBase ``` Finds a file at the specified relative path within this project and removes it. ###### `filePath`^Required - *Type:* string The file path. If this path is relative, it will be resolved from the root of _this_ project. --- ##### `addDependency` ```typescript public addDependency(spec: string): void ``` Adds a runtime dependency. ###### `spec`^Required - *Type:* string Format `/@`. --- ##### `addPlugin` ```typescript public addPlugin(spec: string, options?: PluginOptions): Dependency ``` Adds a build plugin to the pom. The plug in is also added as a BUILD dep to the project. ###### `spec`^Required - *Type:* string dependency spec (`group/artifact@version`). --- ###### `options`^Optional - *Type:* projen.java.PluginOptions plugin options. --- ##### `addTestDependency` ```typescript public addTestDependency(spec: string): void ``` Adds a test dependency. ###### `spec`^Required - *Type:* string Format `/@`. --- ##### ~~`addCdkDependency`~~ ```typescript public addCdkDependency(modules: string): void ``` Adds an AWS CDK module dependencies. ###### `modules`^Required - *Type:* string The list of modules to depend on (e.g. "software.amazon.awscdk/aws-lambda", "software.amazon.awscdk/aws-iam", etc). --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | buildTask | projen.Task | *No description.* | | commitGenerated | boolean | Whether to commit the managed files by default. | | compileTask | projen.Task | *No description.* | | components | projen.Component[] | Returns all the components within this project. | | deps | projen.Dependencies | Project dependencies. | | ejected | boolean | Whether or not the project is being ejected. | | files | projen.FileBase[] | All files in this project. | | gitattributes | projen.GitAttributesFile | The .gitattributes file for this repository. | | gitignore | projen.IgnoreFile | .gitignore. | | logger | projen.Logger | Logging utilities. | | name | string | Project name. | | outdir | string | Absolute output directory of this project. | | packageTask | projen.Task | *No description.* | | postCompileTask | projen.Task | *No description.* | | preCompileTask | projen.Task | *No description.* | | projectBuild | projen.ProjectBuild | Manages the build process of the project. | | projenCommand | string | The command to use in order to run the projen CLI. | | root | projen.Project | The root project. | | subprojects | projen.Project[] | Returns all the subprojects within this project. | | tasks | projen.Tasks | Project tasks. | | testTask | projen.Task | *No description.* | | defaultTask | projen.Task | This is the "default" task, the one that executes "projen". | | initProject | projen.InitProject | The options used when this project is bootstrapped via `projen new`. | | parent | projen.Project | A parent project. | | projectType | projen.ProjectType | *No description.* | | autoApprove | projen.github.AutoApprove | Auto approve set up for this project. | | devContainer | projen.vscode.DevContainer | Access for .devcontainer.json (used for GitHub Codespaces). | | github | projen.github.GitHub | Access all github components. | | gitpod | projen.Gitpod | Access for Gitpod. | | vscode | projen.vscode.VsCode | Access all VSCode components. | | compile | projen.java.MavenCompile | Compile component. | | distdir | string | Maven artifact output directory. | | packaging | projen.java.MavenPackaging | Packaging component. | | pom | projen.java.Pom | API for managing `pom.xml`. | | junit | projen.java.Junit | JUnit component. | | projenrc | projen.java.Projenrc | Projenrc component. | | cdkConfig | projen.awscdk.CdkConfig | The `cdk.json` file. | | cdkDeps | projen.awscdk.AwsCdkDeps | CDK dependency management helper class. | | cdkTasks | projen.awscdk.CdkTasks | CDK tasks. | | mainClass | string | The full name of the main class of the java app (package.Class). | | mainClassName | string | The name of the Java class with the static `main()` method. | | mainPackage | string | The name of the Java package that includes the main class. | --- ##### `buildTask`^Required ```typescript public readonly buildTask: Task; ``` - *Type:* projen.Task --- ##### `commitGenerated`^Required ```typescript public readonly commitGenerated: boolean; ``` - *Type:* boolean Whether to commit the managed files by default. --- ##### `compileTask`^Required ```typescript public readonly compileTask: Task; ``` - *Type:* projen.Task --- ##### `components`^Required ```typescript public readonly components: Component[]; ``` - *Type:* projen.Component[] Returns all the components within this project. --- ##### `deps`^Required ```typescript public readonly deps: Dependencies; ``` - *Type:* projen.Dependencies Project dependencies. --- ##### `ejected`^Required ```typescript public readonly ejected: boolean; ``` - *Type:* boolean Whether or not the project is being ejected. --- ##### `files`^Required ```typescript public readonly files: FileBase[]; ``` - *Type:* projen.FileBase[] All files in this project. --- ##### `gitattributes`^Required ```typescript public readonly gitattributes: GitAttributesFile; ``` - *Type:* projen.GitAttributesFile The .gitattributes file for this repository. --- ##### `gitignore`^Required ```typescript public readonly gitignore: IgnoreFile; ``` - *Type:* projen.IgnoreFile .gitignore. --- ##### `logger`^Required ```typescript public readonly logger: Logger; ``` - *Type:* projen.Logger Logging utilities. --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string Project name. --- ##### `outdir`^Required ```typescript public readonly outdir: string; ``` - *Type:* string Absolute output directory of this project. --- ##### `packageTask`^Required ```typescript public readonly packageTask: Task; ``` - *Type:* projen.Task --- ##### `postCompileTask`^Required ```typescript public readonly postCompileTask: Task; ``` - *Type:* projen.Task --- ##### `preCompileTask`^Required ```typescript public readonly preCompileTask: Task; ``` - *Type:* projen.Task --- ##### `projectBuild`^Required ```typescript public readonly projectBuild: ProjectBuild; ``` - *Type:* projen.ProjectBuild Manages the build process of the project. --- ##### `projenCommand`^Required ```typescript public readonly projenCommand: string; ``` - *Type:* string The command to use in order to run the projen CLI. --- ##### `root`^Required ```typescript public readonly root: Project; ``` - *Type:* projen.Project The root project. --- ##### `subprojects`^Required ```typescript public readonly subprojects: Project[]; ``` - *Type:* projen.Project[] Returns all the subprojects within this project. --- ##### `tasks`^Required ```typescript public readonly tasks: Tasks; ``` - *Type:* projen.Tasks Project tasks. --- ##### `testTask`^Required ```typescript public readonly testTask: Task; ``` - *Type:* projen.Task --- ##### `defaultTask`^Optional ```typescript public readonly defaultTask: Task; ``` - *Type:* projen.Task This is the "default" task, the one that executes "projen". Undefined if the project is being ejected. --- ##### `initProject`^Optional ```typescript public readonly initProject: InitProject; ``` - *Type:* projen.InitProject The options used when this project is bootstrapped via `projen new`. It includes the original set of options passed to the CLI and also the JSII FQN of the project type. --- ##### `parent`^Optional ```typescript public readonly parent: Project; ``` - *Type:* projen.Project A parent project. If undefined, this is the root project. --- ##### `projectType`^Required ```typescript public readonly projectType: ProjectType; ``` - *Type:* projen.ProjectType --- ##### `autoApprove`^Optional ```typescript public readonly autoApprove: AutoApprove; ``` - *Type:* projen.github.AutoApprove Auto approve set up for this project. --- ##### `devContainer`^Optional ```typescript public readonly devContainer: DevContainer; ``` - *Type:* projen.vscode.DevContainer Access for .devcontainer.json (used for GitHub Codespaces). This will be `undefined` if devContainer boolean is false --- ##### `github`^Optional ```typescript public readonly github: GitHub; ``` - *Type:* projen.github.GitHub Access all github components. This will be `undefined` for subprojects. --- ##### `gitpod`^Optional ```typescript public readonly gitpod: Gitpod; ``` - *Type:* projen.Gitpod Access for Gitpod. This will be `undefined` if gitpod boolean is false --- ##### `vscode`^Optional ```typescript public readonly vscode: VsCode; ``` - *Type:* projen.vscode.VsCode Access all VSCode components. This will be `undefined` for subprojects. --- ##### `compile`^Required ```typescript public readonly compile: MavenCompile; ``` - *Type:* projen.java.MavenCompile Compile component. --- ##### `distdir`^Required ```typescript public readonly distdir: string; ``` - *Type:* string Maven artifact output directory. --- ##### `packaging`^Required ```typescript public readonly packaging: MavenPackaging; ``` - *Type:* projen.java.MavenPackaging Packaging component. --- ##### `pom`^Required ```typescript public readonly pom: Pom; ``` - *Type:* projen.java.Pom API for managing `pom.xml`. --- ##### `junit`^Optional ```typescript public readonly junit: Junit; ``` - *Type:* projen.java.Junit JUnit component. --- ##### `projenrc`^Optional ```typescript public readonly projenrc: Projenrc; ``` - *Type:* projen.java.Projenrc Projenrc component. --- ##### `cdkConfig`^Required ```typescript public readonly cdkConfig: CdkConfig; ``` - *Type:* projen.awscdk.CdkConfig The `cdk.json` file. --- ##### `cdkDeps`^Required ```typescript public readonly cdkDeps: AwsCdkDeps; ``` - *Type:* projen.awscdk.AwsCdkDeps CDK dependency management helper class. --- ##### `cdkTasks`^Required ```typescript public readonly cdkTasks: CdkTasks; ``` - *Type:* projen.awscdk.CdkTasks CDK tasks. --- ##### `mainClass`^Required ```typescript public readonly mainClass: string; ``` - *Type:* string The full name of the main class of the java app (package.Class). --- ##### `mainClassName`^Required ```typescript public readonly mainClassName: string; ``` - *Type:* string The name of the Java class with the static `main()` method. --- ##### `mainPackage`^Required ```typescript public readonly mainPackage: string; ``` - *Type:* string The name of the Java package that includes the main class. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | DEFAULT_TASK | string | The name of the default task (the task executed when `projen` is run without arguments). | --- ##### `DEFAULT_TASK`^Required ```typescript public readonly DEFAULT_TASK: string; ``` - *Type:* string The name of the default task (the task executed when `projen` is run without arguments). Normally this task should synthesize the project files. --- ### PDKPipelinePyProject Synthesizes a Python Project with a CI/CD pipeline. #### Initializers ```typescript import { PDKPipelinePyProject } from '@aws-prototyping-sdk/pipeline' new PDKPipelinePyProject(options: PDKPipelinePyProjectOptions) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | options | PDKPipelinePyProjectOptions | *No description.* | --- ##### `options`^Required - *Type:* PDKPipelinePyProjectOptions --- #### Methods | **Name** | **Description** | | --- | --- | | addExcludeFromCleanup | Exclude the matching files from pre-synth cleanup. | | addGitIgnore | Adds a .gitignore pattern. | | addPackageIgnore | Exclude these files from the bundled package. | | addTask | Adds a new task to this project. | | addTip | Prints a "tip" message during synthesis. | | annotateGenerated | Marks the provided file(s) as being generated. | | postSynthesize | Called after all components are synthesized. | | preSynthesize | Called before all components are synthesized. | | removeTask | Removes a task from a project. | | runTaskCommand | Returns the shell command to execute in order to run a task. | | synth | Synthesize all project files into `outdir`. | | tryFindFile | Finds a file at the specified relative path within this project and all its subprojects. | | tryFindJsonFile | Finds a json file by name. | | tryFindObjectFile | Finds an object file (like JsonFile, YamlFile, etc.) by name. | | tryRemoveFile | Finds a file at the specified relative path within this project and removes it. | | addDependency | Adds a runtime dependency. | | addDevDependency | Adds a dev dependency. | --- ##### `addExcludeFromCleanup` ```typescript public addExcludeFromCleanup(globs: string): void ``` Exclude the matching files from pre-synth cleanup. Can be used when, for example, some source files include the projen marker and we don't want them to be erased during synth. ###### `globs`^Required - *Type:* string The glob patterns to match. --- ##### `addGitIgnore` ```typescript public addGitIgnore(pattern: string): void ``` Adds a .gitignore pattern. ###### `pattern`^Required - *Type:* string The glob pattern to ignore. --- ##### `addPackageIgnore` ```typescript public addPackageIgnore(_pattern: string): void ``` Exclude these files from the bundled package. Implemented by project types based on the packaging mechanism. For example, `NodeProject` delegates this to `.npmignore`. ###### `_pattern`^Required - *Type:* string The glob pattern to exclude. --- ##### `addTask` ```typescript public addTask(name: string, props?: TaskOptions): Task ``` Adds a new task to this project. This will fail if the project already has a task with this name. ###### `name`^Required - *Type:* string The task name to add. --- ###### `props`^Optional - *Type:* projen.TaskOptions Task properties. --- ##### ~~`addTip`~~ ```typescript public addTip(message: string): void ``` Prints a "tip" message during synthesis. ###### `message`^Required - *Type:* string The message. --- ##### `annotateGenerated` ```typescript public annotateGenerated(glob: string): void ``` Marks the provided file(s) as being generated. This is achieved using the github-linguist attributes. Generated files do not count against the repository statistics and language breakdown. > [https://github.com/github/linguist/blob/master/docs/overrides.md](https://github.com/github/linguist/blob/master/docs/overrides.md) ###### `glob`^Required - *Type:* string the glob pattern to match (could be a file path). --- ##### `postSynthesize` ```typescript public postSynthesize(): void ``` Called after all components are synthesized. Order is *not* guaranteed. ##### `preSynthesize` ```typescript public preSynthesize(): void ``` Called before all components are synthesized. ##### `removeTask` ```typescript public removeTask(name: string): Task ``` Removes a task from a project. ###### `name`^Required - *Type:* string The name of the task to remove. --- ##### `runTaskCommand` ```typescript public runTaskCommand(task: Task): string ``` Returns the shell command to execute in order to run a task. By default, this is `npx projen@ ` ###### `task`^Required - *Type:* projen.Task The task for which the command is required. --- ##### `synth` ```typescript public synth(): void ``` Synthesize all project files into `outdir`. 1. Call "this.preSynthesize()" 2. Delete all generated files 3. Synthesize all sub-projects 4. Synthesize all components of this project 5. Call "postSynthesize()" for all components of this project 6. Call "this.postSynthesize()" ##### `tryFindFile` ```typescript public tryFindFile(filePath: string): FileBase ``` Finds a file at the specified relative path within this project and all its subprojects. ###### `filePath`^Required - *Type:* string The file path. If this path is relative, it will be resolved from the root of _this_ project. --- ##### ~~`tryFindJsonFile`~~ ```typescript public tryFindJsonFile(filePath: string): JsonFile ``` Finds a json file by name. ###### `filePath`^Required - *Type:* string The file path. --- ##### `tryFindObjectFile` ```typescript public tryFindObjectFile(filePath: string): ObjectFile ``` Finds an object file (like JsonFile, YamlFile, etc.) by name. ###### `filePath`^Required - *Type:* string The file path. --- ##### `tryRemoveFile` ```typescript public tryRemoveFile(filePath: string): FileBase ``` Finds a file at the specified relative path within this project and removes it. ###### `filePath`^Required - *Type:* string The file path. If this path is relative, it will be resolved from the root of _this_ project. --- ##### `addDependency` ```typescript public addDependency(spec: string): void ``` Adds a runtime dependency. ###### `spec`^Required - *Type:* string Format `@`. --- ##### `addDevDependency` ```typescript public addDevDependency(spec: string): void ``` Adds a dev dependency. ###### `spec`^Required - *Type:* string Format `@`. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | buildTask | projen.Task | *No description.* | | commitGenerated | boolean | Whether to commit the managed files by default. | | compileTask | projen.Task | *No description.* | | components | projen.Component[] | Returns all the components within this project. | | deps | projen.Dependencies | Project dependencies. | | ejected | boolean | Whether or not the project is being ejected. | | files | projen.FileBase[] | All files in this project. | | gitattributes | projen.GitAttributesFile | The .gitattributes file for this repository. | | gitignore | projen.IgnoreFile | .gitignore. | | logger | projen.Logger | Logging utilities. | | name | string | Project name. | | outdir | string | Absolute output directory of this project. | | packageTask | projen.Task | *No description.* | | postCompileTask | projen.Task | *No description.* | | preCompileTask | projen.Task | *No description.* | | projectBuild | projen.ProjectBuild | Manages the build process of the project. | | projenCommand | string | The command to use in order to run the projen CLI. | | root | projen.Project | The root project. | | subprojects | projen.Project[] | Returns all the subprojects within this project. | | tasks | projen.Tasks | Project tasks. | | testTask | projen.Task | *No description.* | | defaultTask | projen.Task | This is the "default" task, the one that executes "projen". | | initProject | projen.InitProject | The options used when this project is bootstrapped via `projen new`. | | parent | projen.Project | A parent project. | | projectType | projen.ProjectType | *No description.* | | autoApprove | projen.github.AutoApprove | Auto approve set up for this project. | | devContainer | projen.vscode.DevContainer | Access for .devcontainer.json (used for GitHub Codespaces). | | github | projen.github.GitHub | Access all github components. | | gitpod | projen.Gitpod | Access for Gitpod. | | vscode | projen.vscode.VsCode | Access all VSCode components. | | depsManager | projen.python.IPythonDeps | API for managing dependencies. | | envManager | projen.python.IPythonEnv | API for mangaging the Python runtime environment. | | moduleName | string | Python module name (the project name, with any hyphens or periods replaced with underscores). | | version | string | Version of the package for distribution (should follow semver). | | packagingManager | projen.python.IPythonPackaging | API for managing packaging the project as a library. | | pytest | projen.python.Pytest | Pytest component. | | appEntrypoint | string | The CDK app entrypoint. | | cdkConfig | projen.awscdk.CdkConfig | cdk.json configuration. | | cdkDeps | projen.awscdk.AwsCdkDeps | *No description.* | | cdkTasks | projen.awscdk.CdkTasks | Common CDK tasks. | | cdkVersion | string | The CDK version this app is using. | | testdir | string | The directory in which the python tests reside. | --- ##### `buildTask`^Required ```typescript public readonly buildTask: Task; ``` - *Type:* projen.Task --- ##### `commitGenerated`^Required ```typescript public readonly commitGenerated: boolean; ``` - *Type:* boolean Whether to commit the managed files by default. --- ##### `compileTask`^Required ```typescript public readonly compileTask: Task; ``` - *Type:* projen.Task --- ##### `components`^Required ```typescript public readonly components: Component[]; ``` - *Type:* projen.Component[] Returns all the components within this project. --- ##### `deps`^Required ```typescript public readonly deps: Dependencies; ``` - *Type:* projen.Dependencies Project dependencies. --- ##### `ejected`^Required ```typescript public readonly ejected: boolean; ``` - *Type:* boolean Whether or not the project is being ejected. --- ##### `files`^Required ```typescript public readonly files: FileBase[]; ``` - *Type:* projen.FileBase[] All files in this project. --- ##### `gitattributes`^Required ```typescript public readonly gitattributes: GitAttributesFile; ``` - *Type:* projen.GitAttributesFile The .gitattributes file for this repository. --- ##### `gitignore`^Required ```typescript public readonly gitignore: IgnoreFile; ``` - *Type:* projen.IgnoreFile .gitignore. --- ##### `logger`^Required ```typescript public readonly logger: Logger; ``` - *Type:* projen.Logger Logging utilities. --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string Project name. --- ##### `outdir`^Required ```typescript public readonly outdir: string; ``` - *Type:* string Absolute output directory of this project. --- ##### `packageTask`^Required ```typescript public readonly packageTask: Task; ``` - *Type:* projen.Task --- ##### `postCompileTask`^Required ```typescript public readonly postCompileTask: Task; ``` - *Type:* projen.Task --- ##### `preCompileTask`^Required ```typescript public readonly preCompileTask: Task; ``` - *Type:* projen.Task --- ##### `projectBuild`^Required ```typescript public readonly projectBuild: ProjectBuild; ``` - *Type:* projen.ProjectBuild Manages the build process of the project. --- ##### `projenCommand`^Required ```typescript public readonly projenCommand: string; ``` - *Type:* string The command to use in order to run the projen CLI. --- ##### `root`^Required ```typescript public readonly root: Project; ``` - *Type:* projen.Project The root project. --- ##### `subprojects`^Required ```typescript public readonly subprojects: Project[]; ``` - *Type:* projen.Project[] Returns all the subprojects within this project. --- ##### `tasks`^Required ```typescript public readonly tasks: Tasks; ``` - *Type:* projen.Tasks Project tasks. --- ##### `testTask`^Required ```typescript public readonly testTask: Task; ``` - *Type:* projen.Task --- ##### `defaultTask`^Optional ```typescript public readonly defaultTask: Task; ``` - *Type:* projen.Task This is the "default" task, the one that executes "projen". Undefined if the project is being ejected. --- ##### `initProject`^Optional ```typescript public readonly initProject: InitProject; ``` - *Type:* projen.InitProject The options used when this project is bootstrapped via `projen new`. It includes the original set of options passed to the CLI and also the JSII FQN of the project type. --- ##### `parent`^Optional ```typescript public readonly parent: Project; ``` - *Type:* projen.Project A parent project. If undefined, this is the root project. --- ##### `projectType`^Required ```typescript public readonly projectType: ProjectType; ``` - *Type:* projen.ProjectType --- ##### `autoApprove`^Optional ```typescript public readonly autoApprove: AutoApprove; ``` - *Type:* projen.github.AutoApprove Auto approve set up for this project. --- ##### `devContainer`^Optional ```typescript public readonly devContainer: DevContainer; ``` - *Type:* projen.vscode.DevContainer Access for .devcontainer.json (used for GitHub Codespaces). This will be `undefined` if devContainer boolean is false --- ##### `github`^Optional ```typescript public readonly github: GitHub; ``` - *Type:* projen.github.GitHub Access all github components. This will be `undefined` for subprojects. --- ##### `gitpod`^Optional ```typescript public readonly gitpod: Gitpod; ``` - *Type:* projen.Gitpod Access for Gitpod. This will be `undefined` if gitpod boolean is false --- ##### `vscode`^Optional ```typescript public readonly vscode: VsCode; ``` - *Type:* projen.vscode.VsCode Access all VSCode components. This will be `undefined` for subprojects. --- ##### `depsManager`^Required ```typescript public readonly depsManager: IPythonDeps; ``` - *Type:* projen.python.IPythonDeps API for managing dependencies. --- ##### `envManager`^Required ```typescript public readonly envManager: IPythonEnv; ``` - *Type:* projen.python.IPythonEnv API for mangaging the Python runtime environment. --- ##### `moduleName`^Required ```typescript public readonly moduleName: string; ``` - *Type:* string Python module name (the project name, with any hyphens or periods replaced with underscores). --- ##### `version`^Required ```typescript public readonly version: string; ``` - *Type:* string Version of the package for distribution (should follow semver). --- ##### `packagingManager`^Optional ```typescript public readonly packagingManager: IPythonPackaging; ``` - *Type:* projen.python.IPythonPackaging API for managing packaging the project as a library. Only applies when the `projectType` is LIB. --- ##### `pytest`^Optional ```typescript public readonly pytest: Pytest; ``` - *Type:* projen.python.Pytest Pytest component. --- ##### `appEntrypoint`^Required ```typescript public readonly appEntrypoint: string; ``` - *Type:* string The CDK app entrypoint. --- ##### `cdkConfig`^Required ```typescript public readonly cdkConfig: CdkConfig; ``` - *Type:* projen.awscdk.CdkConfig cdk.json configuration. --- ##### `cdkDeps`^Required ```typescript public readonly cdkDeps: AwsCdkDeps; ``` - *Type:* projen.awscdk.AwsCdkDeps --- ##### `cdkTasks`^Required ```typescript public readonly cdkTasks: CdkTasks; ``` - *Type:* projen.awscdk.CdkTasks Common CDK tasks. --- ##### `cdkVersion`^Required ```typescript public readonly cdkVersion: string; ``` - *Type:* string The CDK version this app is using. --- ##### `testdir`^Required ```typescript public readonly testdir: string; ``` - *Type:* string The directory in which the python tests reside. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | DEFAULT_TASK | string | The name of the default task (the task executed when `projen` is run without arguments). | --- ##### `DEFAULT_TASK`^Required ```typescript public readonly DEFAULT_TASK: string; ``` - *Type:* string The name of the default task (the task executed when `projen` is run without arguments). Normally this task should synthesize the project files. --- ### PDKPipelineTsProject Synthesizes a Typescript Project with a CI/CD pipeline. #### Initializers ```typescript import { PDKPipelineTsProject } from '@aws-prototyping-sdk/pipeline' new PDKPipelineTsProject(options: PDKPipelineTsProjectOptions) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | options | PDKPipelineTsProjectOptions | *No description.* | --- ##### `options`^Required - *Type:* PDKPipelineTsProjectOptions --- #### Methods | **Name** | **Description** | | --- | --- | | addExcludeFromCleanup | Exclude the matching files from pre-synth cleanup. | | addGitIgnore | Adds a .gitignore pattern. | | addPackageIgnore | Exclude these files from the bundled package. | | addTask | Adds a new task to this project. | | addTip | Prints a "tip" message during synthesis. | | annotateGenerated | Marks the provided file(s) as being generated. | | postSynthesize | Called after all components are synthesized. | | preSynthesize | Called before all components are synthesized. | | removeTask | Removes a task from a project. | | runTaskCommand | Returns the shell command to execute in order to run a task. | | synth | Synthesize all project files into `outdir`. | | tryFindFile | Finds a file at the specified relative path within this project and all its subprojects. | | tryFindJsonFile | Finds a json file by name. | | tryFindObjectFile | Finds an object file (like JsonFile, YamlFile, etc.) by name. | | tryRemoveFile | Finds a file at the specified relative path within this project and removes it. | | addBins | *No description.* | | addBundledDeps | Defines bundled dependencies. | | addCompileCommand | DEPRECATED. | | addDeps | Defines normal dependencies. | | addDevDeps | Defines development/test dependencies. | | addFields | Directly set fields in `package.json`. | | addKeywords | Adds keywords to package.json (deduplicated). | | addPeerDeps | Defines peer dependencies. | | addScripts | Replaces the contents of multiple npm package.json scripts. | | addTestCommand | DEPRECATED. | | hasScript | Indicates if a script by the name name is defined. | | removeScript | Removes the npm script (always successful). | | renderWorkflowSetup | Returns the set of workflow steps which should be executed to bootstrap a workflow. | | setScript | Replaces the contents of an npm package.json script. | | addCdkDependency | Adds an AWS CDK module dependencies. | --- ##### `addExcludeFromCleanup` ```typescript public addExcludeFromCleanup(globs: string): void ``` Exclude the matching files from pre-synth cleanup. Can be used when, for example, some source files include the projen marker and we don't want them to be erased during synth. ###### `globs`^Required - *Type:* string The glob patterns to match. --- ##### `addGitIgnore` ```typescript public addGitIgnore(pattern: string): void ``` Adds a .gitignore pattern. ###### `pattern`^Required - *Type:* string The glob pattern to ignore. --- ##### `addPackageIgnore` ```typescript public addPackageIgnore(pattern: string): void ``` Exclude these files from the bundled package. Implemented by project types based on the packaging mechanism. For example, `NodeProject` delegates this to `.npmignore`. ###### `pattern`^Required - *Type:* string --- ##### `addTask` ```typescript public addTask(name: string, props?: TaskOptions): Task ``` Adds a new task to this project. This will fail if the project already has a task with this name. ###### `name`^Required - *Type:* string The task name to add. --- ###### `props`^Optional - *Type:* projen.TaskOptions Task properties. --- ##### ~~`addTip`~~ ```typescript public addTip(message: string): void ``` Prints a "tip" message during synthesis. ###### `message`^Required - *Type:* string The message. --- ##### `annotateGenerated` ```typescript public annotateGenerated(glob: string): void ``` Marks the provided file(s) as being generated. This is achieved using the github-linguist attributes. Generated files do not count against the repository statistics and language breakdown. > [https://github.com/github/linguist/blob/master/docs/overrides.md](https://github.com/github/linguist/blob/master/docs/overrides.md) ###### `glob`^Required - *Type:* string the glob pattern to match (could be a file path). --- ##### `postSynthesize` ```typescript public postSynthesize(): void ``` Called after all components are synthesized. Order is *not* guaranteed. ##### `preSynthesize` ```typescript public preSynthesize(): void ``` Called before all components are synthesized. ##### `removeTask` ```typescript public removeTask(name: string): Task ``` Removes a task from a project. ###### `name`^Required - *Type:* string The name of the task to remove. --- ##### `runTaskCommand` ```typescript public runTaskCommand(task: Task): string ``` Returns the shell command to execute in order to run a task. This will typically be `npx projen TASK`. ###### `task`^Required - *Type:* projen.Task The task for which the command is required. --- ##### `synth` ```typescript public synth(): void ``` Synthesize all project files into `outdir`. 1. Call "this.preSynthesize()" 2. Delete all generated files 3. Synthesize all sub-projects 4. Synthesize all components of this project 5. Call "postSynthesize()" for all components of this project 6. Call "this.postSynthesize()" ##### `tryFindFile` ```typescript public tryFindFile(filePath: string): FileBase ``` Finds a file at the specified relative path within this project and all its subprojects. ###### `filePath`^Required - *Type:* string The file path. If this path is relative, it will be resolved from the root of _this_ project. --- ##### ~~`tryFindJsonFile`~~ ```typescript public tryFindJsonFile(filePath: string): JsonFile ``` Finds a json file by name. ###### `filePath`^Required - *Type:* string The file path. --- ##### `tryFindObjectFile` ```typescript public tryFindObjectFile(filePath: string): ObjectFile ``` Finds an object file (like JsonFile, YamlFile, etc.) by name. ###### `filePath`^Required - *Type:* string The file path. --- ##### `tryRemoveFile` ```typescript public tryRemoveFile(filePath: string): FileBase ``` Finds a file at the specified relative path within this project and removes it. ###### `filePath`^Required - *Type:* string The file path. If this path is relative, it will be resolved from the root of _this_ project. --- ##### `addBins` ```typescript public addBins(bins: {[ key: string ]: string}): void ``` ###### `bins`^Required - *Type:* {[ key: string ]: string} --- ##### `addBundledDeps` ```typescript public addBundledDeps(deps: string): void ``` Defines bundled dependencies. Bundled dependencies will be added as normal dependencies as well as to the `bundledDependencies` section of your `package.json`. ###### `deps`^Required - *Type:* string Names modules to install. By default, the the dependency will be installed in the next `npx projen` run and the version will be recorded in your `package.json` file. You can upgrade manually or using `yarn add/upgrade`. If you wish to specify a version range use this syntax: `module@^7`. --- ##### ~~`addCompileCommand`~~ ```typescript public addCompileCommand(commands: string): void ``` DEPRECATED. ###### `commands`^Required - *Type:* string --- ##### `addDeps` ```typescript public addDeps(deps: string): void ``` Defines normal dependencies. ###### `deps`^Required - *Type:* string Names modules to install. By default, the the dependency will be installed in the next `npx projen` run and the version will be recorded in your `package.json` file. You can upgrade manually or using `yarn add/upgrade`. If you wish to specify a version range use this syntax: `module@^7`. --- ##### `addDevDeps` ```typescript public addDevDeps(deps: string): void ``` Defines development/test dependencies. ###### `deps`^Required - *Type:* string Names modules to install. By default, the the dependency will be installed in the next `npx projen` run and the version will be recorded in your `package.json` file. You can upgrade manually or using `yarn add/upgrade`. If you wish to specify a version range use this syntax: `module@^7`. --- ##### `addFields` ```typescript public addFields(fields: {[ key: string ]: any}): void ``` Directly set fields in `package.json`. ###### `fields`^Required - *Type:* {[ key: string ]: any} The fields to set. --- ##### `addKeywords` ```typescript public addKeywords(keywords: string): void ``` Adds keywords to package.json (deduplicated). ###### `keywords`^Required - *Type:* string The keywords to add. --- ##### `addPeerDeps` ```typescript public addPeerDeps(deps: string): void ``` Defines peer dependencies. When adding peer dependencies, a devDependency will also be added on the pinned version of the declared peer. This will ensure that you are testing your code against the minimum version required from your consumers. ###### `deps`^Required - *Type:* string Names modules to install. By default, the the dependency will be installed in the next `npx projen` run and the version will be recorded in your `package.json` file. You can upgrade manually or using `yarn add/upgrade`. If you wish to specify a version range use this syntax: `module@^7`. --- ##### `addScripts` ```typescript public addScripts(scripts: {[ key: string ]: string}): void ``` Replaces the contents of multiple npm package.json scripts. ###### `scripts`^Required - *Type:* {[ key: string ]: string} The scripts to set. --- ##### ~~`addTestCommand`~~ ```typescript public addTestCommand(commands: string): void ``` DEPRECATED. ###### `commands`^Required - *Type:* string --- ##### ~~`hasScript`~~ ```typescript public hasScript(name: string): boolean ``` Indicates if a script by the name name is defined. ###### `name`^Required - *Type:* string The name of the script. --- ##### `removeScript` ```typescript public removeScript(name: string): void ``` Removes the npm script (always successful). ###### `name`^Required - *Type:* string The name of the script. --- ##### `renderWorkflowSetup` ```typescript public renderWorkflowSetup(options?: RenderWorkflowSetupOptions): JobStep[] ``` Returns the set of workflow steps which should be executed to bootstrap a workflow. ###### `options`^Optional - *Type:* projen.javascript.RenderWorkflowSetupOptions Options. --- ##### `setScript` ```typescript public setScript(name: string, command: string): void ``` Replaces the contents of an npm package.json script. ###### `name`^Required - *Type:* string The script name. --- ###### `command`^Required - *Type:* string The command to execute. --- ##### `addCdkDependency` ```typescript public addCdkDependency(modules: string): void ``` Adds an AWS CDK module dependencies. ###### `modules`^Required - *Type:* string The list of modules to depend on. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | buildTask | projen.Task | *No description.* | | commitGenerated | boolean | Whether to commit the managed files by default. | | compileTask | projen.Task | *No description.* | | components | projen.Component[] | Returns all the components within this project. | | deps | projen.Dependencies | Project dependencies. | | ejected | boolean | Whether or not the project is being ejected. | | files | projen.FileBase[] | All files in this project. | | gitattributes | projen.GitAttributesFile | The .gitattributes file for this repository. | | gitignore | projen.IgnoreFile | .gitignore. | | logger | projen.Logger | Logging utilities. | | name | string | Project name. | | outdir | string | Absolute output directory of this project. | | packageTask | projen.Task | *No description.* | | postCompileTask | projen.Task | *No description.* | | preCompileTask | projen.Task | *No description.* | | projectBuild | projen.ProjectBuild | Manages the build process of the project. | | projenCommand | string | The command to use in order to run the projen CLI. | | root | projen.Project | The root project. | | subprojects | projen.Project[] | Returns all the subprojects within this project. | | tasks | projen.Tasks | Project tasks. | | testTask | projen.Task | *No description.* | | defaultTask | projen.Task | This is the "default" task, the one that executes "projen". | | initProject | projen.InitProject | The options used when this project is bootstrapped via `projen new`. | | parent | projen.Project | A parent project. | | projectType | projen.ProjectType | *No description.* | | autoApprove | projen.github.AutoApprove | Auto approve set up for this project. | | devContainer | projen.vscode.DevContainer | Access for .devcontainer.json (used for GitHub Codespaces). | | github | projen.github.GitHub | Access all github components. | | gitpod | projen.Gitpod | Access for Gitpod. | | vscode | projen.vscode.VsCode | Access all VSCode components. | | allowLibraryDependencies | boolean | *No description.* | | artifactsDirectory | string | The build output directory. | | artifactsJavascriptDirectory | string | The location of the npm tarball after build (`${artifactsDirectory}/js`). | | bundler | projen.javascript.Bundler | *No description.* | | entrypoint | string | *No description.* | | manifest | any | *No description.* | | npmrc | projen.javascript.NpmConfig | The .npmrc file. | | package | projen.javascript.NodePackage | API for managing the node package. | | packageManager | projen.javascript.NodePackageManager | The package manager to use. | | runScriptCommand | string | The command to use to run scripts (e.g. `yarn run` or `npm run` depends on the package manager). | | autoMerge | projen.github.AutoMerge | Component that sets up mergify for merging approved pull requests. | | buildWorkflow | projen.build.BuildWorkflow | The PR build GitHub workflow. | | buildWorkflowJobId | string | The job ID of the build workflow. | | jest | projen.javascript.Jest | The Jest configuration (if enabled). | | maxNodeVersion | string | Maximum node version required by this package. | | minNodeVersion | string | Minimum node.js version required by this package. | | npmignore | projen.IgnoreFile | The .npmignore file. | | prettier | projen.javascript.Prettier | *No description.* | | publisher | projen.release.Publisher | Package publisher. | | release | projen.release.Release | Release management. | | upgradeWorkflow | projen.javascript.UpgradeDependencies | The upgrade workflow. | | docsDirectory | string | *No description.* | | libdir | string | The directory in which compiled .js files reside. | | srcdir | string | The directory in which the .ts sources reside. | | testdir | string | The directory in which tests reside. | | tsconfigDev | projen.javascript.TypescriptConfig | A typescript configuration file which covers all files (sources, tests, projen). | | watchTask | projen.Task | The "watch" task. | | docgen | boolean | *No description.* | | eslint | projen.javascript.Eslint | *No description.* | | tsconfig | projen.javascript.TypescriptConfig | *No description.* | | tsconfigEslint | projen.javascript.TypescriptConfig | *No description.* | | appEntrypoint | string | The CDK app entrypoint. | | cdkConfig | projen.awscdk.CdkConfig | cdk.json configuration. | | cdkDeps | projen.awscdk.AwsCdkDeps | *No description.* | | cdkTasks | projen.awscdk.CdkTasks | Common CDK tasks. | | cdkVersion | string | The CDK version this app is using. | --- ##### `buildTask`^Required ```typescript public readonly buildTask: Task; ``` - *Type:* projen.Task --- ##### `commitGenerated`^Required ```typescript public readonly commitGenerated: boolean; ``` - *Type:* boolean Whether to commit the managed files by default. --- ##### `compileTask`^Required ```typescript public readonly compileTask: Task; ``` - *Type:* projen.Task --- ##### `components`^Required ```typescript public readonly components: Component[]; ``` - *Type:* projen.Component[] Returns all the components within this project. --- ##### `deps`^Required ```typescript public readonly deps: Dependencies; ``` - *Type:* projen.Dependencies Project dependencies. --- ##### `ejected`^Required ```typescript public readonly ejected: boolean; ``` - *Type:* boolean Whether or not the project is being ejected. --- ##### `files`^Required ```typescript public readonly files: FileBase[]; ``` - *Type:* projen.FileBase[] All files in this project. --- ##### `gitattributes`^Required ```typescript public readonly gitattributes: GitAttributesFile; ``` - *Type:* projen.GitAttributesFile The .gitattributes file for this repository. --- ##### `gitignore`^Required ```typescript public readonly gitignore: IgnoreFile; ``` - *Type:* projen.IgnoreFile .gitignore. --- ##### `logger`^Required ```typescript public readonly logger: Logger; ``` - *Type:* projen.Logger Logging utilities. --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string Project name. --- ##### `outdir`^Required ```typescript public readonly outdir: string; ``` - *Type:* string Absolute output directory of this project. --- ##### `packageTask`^Required ```typescript public readonly packageTask: Task; ``` - *Type:* projen.Task --- ##### `postCompileTask`^Required ```typescript public readonly postCompileTask: Task; ``` - *Type:* projen.Task --- ##### `preCompileTask`^Required ```typescript public readonly preCompileTask: Task; ``` - *Type:* projen.Task --- ##### `projectBuild`^Required ```typescript public readonly projectBuild: ProjectBuild; ``` - *Type:* projen.ProjectBuild Manages the build process of the project. --- ##### `projenCommand`^Required ```typescript public readonly projenCommand: string; ``` - *Type:* string The command to use in order to run the projen CLI. --- ##### `root`^Required ```typescript public readonly root: Project; ``` - *Type:* projen.Project The root project. --- ##### `subprojects`^Required ```typescript public readonly subprojects: Project[]; ``` - *Type:* projen.Project[] Returns all the subprojects within this project. --- ##### `tasks`^Required ```typescript public readonly tasks: Tasks; ``` - *Type:* projen.Tasks Project tasks. --- ##### `testTask`^Required ```typescript public readonly testTask: Task; ``` - *Type:* projen.Task --- ##### `defaultTask`^Optional ```typescript public readonly defaultTask: Task; ``` - *Type:* projen.Task This is the "default" task, the one that executes "projen". Undefined if the project is being ejected. --- ##### `initProject`^Optional ```typescript public readonly initProject: InitProject; ``` - *Type:* projen.InitProject The options used when this project is bootstrapped via `projen new`. It includes the original set of options passed to the CLI and also the JSII FQN of the project type. --- ##### `parent`^Optional ```typescript public readonly parent: Project; ``` - *Type:* projen.Project A parent project. If undefined, this is the root project. --- ##### `projectType`^Required ```typescript public readonly projectType: ProjectType; ``` - *Type:* projen.ProjectType --- ##### `autoApprove`^Optional ```typescript public readonly autoApprove: AutoApprove; ``` - *Type:* projen.github.AutoApprove Auto approve set up for this project. --- ##### `devContainer`^Optional ```typescript public readonly devContainer: DevContainer; ``` - *Type:* projen.vscode.DevContainer Access for .devcontainer.json (used for GitHub Codespaces). This will be `undefined` if devContainer boolean is false --- ##### `github`^Optional ```typescript public readonly github: GitHub; ``` - *Type:* projen.github.GitHub Access all github components. This will be `undefined` for subprojects. --- ##### `gitpod`^Optional ```typescript public readonly gitpod: Gitpod; ``` - *Type:* projen.Gitpod Access for Gitpod. This will be `undefined` if gitpod boolean is false --- ##### `vscode`^Optional ```typescript public readonly vscode: VsCode; ``` - *Type:* projen.vscode.VsCode Access all VSCode components. This will be `undefined` for subprojects. --- ##### ~~`allowLibraryDependencies`~~^Required - *Deprecated:* use `package.allowLibraryDependencies` ```typescript public readonly allowLibraryDependencies: boolean; ``` - *Type:* boolean --- ##### `artifactsDirectory`^Required ```typescript public readonly artifactsDirectory: string; ``` - *Type:* string The build output directory. An npm tarball will be created under the `js` subdirectory. For example, if this is set to `dist` (the default), the npm tarball will be placed under `dist/js/boom-boom-1.2.3.tg`. --- ##### `artifactsJavascriptDirectory`^Required ```typescript public readonly artifactsJavascriptDirectory: string; ``` - *Type:* string The location of the npm tarball after build (`${artifactsDirectory}/js`). --- ##### `bundler`^Required ```typescript public readonly bundler: Bundler; ``` - *Type:* projen.javascript.Bundler --- ##### ~~`entrypoint`~~^Required - *Deprecated:* use `package.entrypoint` ```typescript public readonly entrypoint: string; ``` - *Type:* string --- ##### ~~`manifest`~~^Required - *Deprecated:* use `package.addField(x, y)` ```typescript public readonly manifest: any; ``` - *Type:* any --- ##### `npmrc`^Required ```typescript public readonly npmrc: NpmConfig; ``` - *Type:* projen.javascript.NpmConfig The .npmrc file. --- ##### `package`^Required ```typescript public readonly package: NodePackage; ``` - *Type:* projen.javascript.NodePackage API for managing the node package. --- ##### ~~`packageManager`~~^Required - *Deprecated:* use `package.packageManager` ```typescript public readonly packageManager: NodePackageManager; ``` - *Type:* projen.javascript.NodePackageManager The package manager to use. --- ##### `runScriptCommand`^Required ```typescript public readonly runScriptCommand: string; ``` - *Type:* string The command to use to run scripts (e.g. `yarn run` or `npm run` depends on the package manager). --- ##### `autoMerge`^Optional ```typescript public readonly autoMerge: AutoMerge; ``` - *Type:* projen.github.AutoMerge Component that sets up mergify for merging approved pull requests. --- ##### `buildWorkflow`^Optional ```typescript public readonly buildWorkflow: BuildWorkflow; ``` - *Type:* projen.build.BuildWorkflow The PR build GitHub workflow. `undefined` if `buildWorkflow` is disabled. --- ##### `buildWorkflowJobId`^Optional ```typescript public readonly buildWorkflowJobId: string; ``` - *Type:* string The job ID of the build workflow. --- ##### `jest`^Optional ```typescript public readonly jest: Jest; ``` - *Type:* projen.javascript.Jest The Jest configuration (if enabled). --- ##### `maxNodeVersion`^Optional ```typescript public readonly maxNodeVersion: string; ``` - *Type:* string Maximum node version required by this package. --- ##### `minNodeVersion`^Optional ```typescript public readonly minNodeVersion: string; ``` - *Type:* string Minimum node.js version required by this package. --- ##### `npmignore`^Optional ```typescript public readonly npmignore: IgnoreFile; ``` - *Type:* projen.IgnoreFile The .npmignore file. --- ##### `prettier`^Optional ```typescript public readonly prettier: Prettier; ``` - *Type:* projen.javascript.Prettier --- ##### ~~`publisher`~~^Optional - *Deprecated:* use `release.publisher`. ```typescript public readonly publisher: Publisher; ``` - *Type:* projen.release.Publisher Package publisher. This will be `undefined` if the project does not have a release workflow. --- ##### `release`^Optional ```typescript public readonly release: Release; ``` - *Type:* projen.release.Release Release management. --- ##### `upgradeWorkflow`^Optional ```typescript public readonly upgradeWorkflow: UpgradeDependencies; ``` - *Type:* projen.javascript.UpgradeDependencies The upgrade workflow. --- ##### `docsDirectory`^Required ```typescript public readonly docsDirectory: string; ``` - *Type:* string --- ##### `libdir`^Required ```typescript public readonly libdir: string; ``` - *Type:* string The directory in which compiled .js files reside. --- ##### `srcdir`^Required ```typescript public readonly srcdir: string; ``` - *Type:* string The directory in which the .ts sources reside. --- ##### `testdir`^Required ```typescript public readonly testdir: string; ``` - *Type:* string The directory in which tests reside. --- ##### `tsconfigDev`^Required ```typescript public readonly tsconfigDev: TypescriptConfig; ``` - *Type:* projen.javascript.TypescriptConfig A typescript configuration file which covers all files (sources, tests, projen). --- ##### `watchTask`^Required ```typescript public readonly watchTask: Task; ``` - *Type:* projen.Task The "watch" task. --- ##### `docgen`^Optional ```typescript public readonly docgen: boolean; ``` - *Type:* boolean --- ##### `eslint`^Optional ```typescript public readonly eslint: Eslint; ``` - *Type:* projen.javascript.Eslint --- ##### `tsconfig`^Optional ```typescript public readonly tsconfig: TypescriptConfig; ``` - *Type:* projen.javascript.TypescriptConfig --- ##### `tsconfigEslint`^Optional ```typescript public readonly tsconfigEslint: TypescriptConfig; ``` - *Type:* projen.javascript.TypescriptConfig --- ##### `appEntrypoint`^Required ```typescript public readonly appEntrypoint: string; ``` - *Type:* string The CDK app entrypoint. --- ##### `cdkConfig`^Required ```typescript public readonly cdkConfig: CdkConfig; ``` - *Type:* projen.awscdk.CdkConfig cdk.json configuration. --- ##### `cdkDeps`^Required ```typescript public readonly cdkDeps: AwsCdkDeps; ``` - *Type:* projen.awscdk.AwsCdkDeps --- ##### `cdkTasks`^Required ```typescript public readonly cdkTasks: CdkTasks; ``` - *Type:* projen.awscdk.CdkTasks Common CDK tasks. --- ##### `cdkVersion`^Required ```typescript public readonly cdkVersion: string; ``` - *Type:* string The CDK version this app is using. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | DEFAULT_TASK | string | The name of the default task (the task executed when `projen` is run without arguments). | --- ##### `DEFAULT_TASK`^Required ```typescript public readonly DEFAULT_TASK: string; ``` - *Type:* string The name of the default task (the task executed when `projen` is run without arguments). Normally this task should synthesize the project files. ---