# 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 ```java import software.aws.awsprototypingsdk.pipeline.PDKPipeline; PDKPipeline.Builder.create(Construct scope, java.lang.String id) .synth(IFileSetProducer) // .artifactBucket(IBucket) // .assetPublishingCodeBuildDefaults(CodeBuildOptions) // .cliVersion(java.lang.String) // .codeBuildDefaults(CodeBuildOptions) // .codePipeline(Pipeline) // .crossAccountKeys(java.lang.Boolean) // .dockerCredentials(java.util.List) // .dockerEnabledForSelfMutation(java.lang.Boolean) // .dockerEnabledForSynth(java.lang.Boolean) // .enableKeyRotation(java.lang.Boolean) // .pipelineName(java.lang.String) // .publishAssetsInParallel(java.lang.Boolean) // .reuseCrossRegionSupportStacks(java.lang.Boolean) // .role(IRole) // .selfMutation(java.lang.Boolean) // .selfMutationCodeBuildDefaults(CodeBuildOptions) // .synthCodeBuildDefaults(CodeBuildOptions) // .useChangeSets(java.lang.Boolean) .primarySynthDirectory(java.lang.String) .repositoryName(java.lang.String) // .branchNamePrefixes(java.util.List) // .cdkCommand(java.lang.String) // .codeCommitRemovalPolicy(RemovalPolicy) // .defaultBranchName(java.lang.String) // .sonarCodeScannerConfig(SonarCodeScannerConfig) // .synthShellStepPartialProps(ShellStepProps) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | *No description.* | | id | java.lang.String | *No description.* | | synth | software.amazon.awscdk.pipelines.IFileSetProducer | The build step that produces the CDK Cloud Assembly. | | artifactBucket | software.amazon.awscdk.services.s3.IBucket | An existing S3 Bucket to use for storing the pipeline's artifact. | | assetPublishingCodeBuildDefaults | software.amazon.awscdk.pipelines.CodeBuildOptions | Additional customizations to apply to the asset publishing CodeBuild projects. | | cliVersion | java.lang.String | CDK CLI version to use in self-mutation and asset publishing steps. | | codeBuildDefaults | software.amazon.awscdk.pipelines.CodeBuildOptions | Customize the CodeBuild projects created for this pipeline. | | codePipeline | software.amazon.awscdk.services.codepipeline.Pipeline | An existing Pipeline to be reused and built upon. | | crossAccountKeys | java.lang.Boolean | Create KMS keys for the artifact buckets, allowing cross-account deployments. | | dockerCredentials | java.util.List | A list of credentials used to authenticate to Docker registries. | | dockerEnabledForSelfMutation | java.lang.Boolean | Enable Docker for the self-mutate step. | | dockerEnabledForSynth | java.lang.Boolean | Enable Docker for the 'synth' step. | | enableKeyRotation | java.lang.Boolean | Enable KMS key rotation for the generated KMS keys. | | pipelineName | java.lang.String | The name of the CodePipeline pipeline. | | publishAssetsInParallel | java.lang.Boolean | Publish assets in multiple CodeBuild projects. | | reuseCrossRegionSupportStacks | java.lang.Boolean | Reuse the same cross region support stack for all pipelines in the App. | | role | software.amazon.awscdk.services.iam.IRole | The IAM role to be assumed by this Pipeline. | | selfMutation | java.lang.Boolean | Whether the pipeline will update itself. | | selfMutationCodeBuildDefaults | software.amazon.awscdk.pipelines.CodeBuildOptions | Additional customizations to apply to the self mutation CodeBuild projects. | | synthCodeBuildDefaults | software.amazon.awscdk.pipelines.CodeBuildOptions | Additional customizations to apply to the synthesize CodeBuild projects. | | useChangeSets | java.lang.Boolean | Deploy every stack by creating a change set and executing it. | | primarySynthDirectory | java.lang.String | Output directory for cdk synthesized artifacts i.e: packages/infra/cdk.out. | | repositoryName | java.lang.String | Name of the CodeCommit repository to create. | | branchNamePrefixes | java.util.List | Branch name prefixes Any branches created matching this list of prefixes will create a new pipeline and stack. | | cdkCommand | java.lang.String | CDK command. | | codeCommitRemovalPolicy | software.amazon.awscdk.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 | java.lang.String | Branch to trigger the pipeline execution. | | sonarCodeScannerConfig | SonarCodeScannerConfig | Configuration for enabling Sonarqube code scanning on a successful synth. | | synthShellStepPartialProps | software.amazon.awscdk.pipelines.ShellStepProps | PDKPipeline by default assumes a NX Monorepo structure for it's codebase and uses sane defaults for the install and run commands. | --- ##### `scope`^Required - *Type:* software.constructs.Construct --- ##### `id`^Required - *Type:* java.lang.String --- ##### `synth`^Required - *Type:* software.amazon.awscdk.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 - *Type:* software.amazon.awscdk.services.s3.IBucket - *Default:* A new S3 bucket will be created. An existing S3 Bucket to use for storing the pipeline's artifact. --- ##### `assetPublishingCodeBuildDefaults`^Optional - *Type:* software.amazon.awscdk.pipelines.CodeBuildOptions - *Default:* Only `codeBuildDefaults` are applied Additional customizations to apply to the asset publishing CodeBuild projects. --- ##### `cliVersion`^Optional - *Type:* java.lang.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 - *Type:* software.amazon.awscdk.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 - *Type:* software.amazon.awscdk.services.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 - *Type:* java.lang.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 - *Type:* java.util.List - *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 - *Type:* java.lang.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 - *Type:* java.lang.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 - *Type:* java.lang.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 - *Type:* java.lang.String - *Default:* Automatically generated The name of the CodePipeline pipeline. --- ##### `publishAssetsInParallel`^Optional - *Type:* java.lang.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 - *Type:* java.lang.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 - *Type:* software.amazon.awscdk.services.iam.IRole - *Default:* A new role is created The IAM role to be assumed by this Pipeline. --- ##### `selfMutation`^Optional - *Type:* java.lang.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 - *Type:* software.amazon.awscdk.pipelines.CodeBuildOptions - *Default:* Only `codeBuildDefaults` are applied Additional customizations to apply to the self mutation CodeBuild projects. --- ##### `synthCodeBuildDefaults`^Optional - *Type:* software.amazon.awscdk.pipelines.CodeBuildOptions - *Default:* Only `codeBuildDefaults` are applied Additional customizations to apply to the synthesize CodeBuild projects. --- ##### `useChangeSets`^Optional - *Type:* java.lang.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 - *Type:* java.lang.String Output directory for cdk synthesized artifacts i.e: packages/infra/cdk.out. --- ##### `repositoryName`^Required - *Type:* java.lang.String Name of the CodeCommit repository to create. --- ##### `branchNamePrefixes`^Optional - *Type:* java.util.List - *Default:* undefined Branch name prefixes Any branches created matching this list of prefixes will create a new pipeline and stack. --- *Example* ```java // Example automatically generated from non-compiling source. May contain errors. // Disables feature branches (default) // Disables feature branches (default) PDKPipeline.Builder.create(this, "PDKPipeline") .repositoryName("my-repo") .branchNamePrefixes(List.of()) .build(); ``` ##### `cdkCommand`^Optional - *Type:* java.lang.String - *Default:* 'npx cdk' CDK command. Override the command used to call cdk for synth and deploy. --- ##### `codeCommitRemovalPolicy`^Optional - *Type:* software.amazon.awscdk.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 - *Type:* java.lang.String - *Default:* mainline Branch to trigger the pipeline execution. --- ##### `sonarCodeScannerConfig`^Optional - *Type:* SonarCodeScannerConfig - *Default:* undefined Configuration for enabling Sonarqube code scanning on a successful synth. --- ##### `synthShellStepPartialProps`^Optional - *Type:* software.amazon.awscdk.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. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | addStage | *No description.* | | buildPipeline | *No description.* | | suppressCDKViolations | *No description.* | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `addStage` ```java public StageDeployment addStage(Stage stage) public StageDeployment addStage(Stage stage, AddStageOpts options) ``` ###### `stage`^Required - *Type:* software.amazon.awscdk.Stage --- ###### `options`^Optional - *Type:* software.amazon.awscdk.pipelines.AddStageOpts --- ##### `buildPipeline` ```java public void buildPipeline() ``` ##### `suppressCDKViolations` ```java public void suppressCDKViolations() ``` #### 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` ```java import software.aws.awsprototypingsdk.pipeline.PDKPipeline; PDKPipeline.isConstruct(java.lang.Object x) ``` 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:* java.lang.Object Any object. --- ##### `getBranchPrefix` ```java import software.aws.awsprototypingsdk.pipeline.PDKPipeline; PDKPipeline.getBranchPrefix(),PDKPipeline.getBranchPrefix(IsDefaultBranchProps props) ``` 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` ```java import software.aws.awsprototypingsdk.pipeline.PDKPipeline; PDKPipeline.isDefaultBranch(),PDKPipeline.isDefaultBranch(IsDefaultBranchProps props) ``` 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` ```java import software.aws.awsprototypingsdk.pipeline.PDKPipeline; PDKPipeline.normalizeBranchName(java.lang.String branchName) ``` A helper function to normalize the branch name with only alphanumeric characters and hypens ('-'). ###### `branchName`^Required - *Type:* java.lang.String The name of the branch to normalize. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | codePipeline | software.amazon.awscdk.pipelines.CodePipeline | *No description.* | | codeRepository | software.amazon.awscdk.services.codecommit.IRepository | *No description.* | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `codePipeline`^Required ```java public CodePipeline getCodePipeline(); ``` - *Type:* software.amazon.awscdk.pipelines.CodePipeline --- ##### `codeRepository`^Required ```java public IRepository getCodeRepository(); ``` - *Type:* software.amazon.awscdk.services.codecommit.IRepository --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ALL_BRANCHES | java.util.List | *No description.* | | defaultBranchName | java.lang.String | *No description.* | --- ##### `ALL_BRANCHES`^Required ```java public java.util.List getAllBranches(); ``` - *Type:* java.util.List --- ##### `defaultBranchName`^Required ```java public java.lang.String getDefaultBranchName(); ``` - *Type:* java.lang.String --- ### SonarCodeScanner #### Initializers ```java import software.aws.awsprototypingsdk.pipeline.SonarCodeScanner; SonarCodeScanner.Builder.create(Construct scope, java.lang.String id) .sonarqubeAuthorizedGroup(java.lang.String) .sonarqubeDefaultProfileOrGateName(java.lang.String) .sonarqubeEndpoint(java.lang.String) .sonarqubeProjectName(java.lang.String) // .cdkOutDir(java.lang.String) // .cfnNagIgnorePath(java.lang.String) // .excludeGlobsForScan(java.util.List) // .includeGlobsForScan(java.util.List) // .preArchiveCommands(java.util.List) // .sonarqubeSpecificProfileOrGateName(java.lang.String) // .sonarqubeTags(java.util.List) .artifactBucketArn(java.lang.String) .synthBuildArn(java.lang.String) // .artifactBucketKeyArn(java.lang.String) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | *No description.* | | id | java.lang.String | *No description.* | | sonarqubeAuthorizedGroup | java.lang.String | Group name in Sonarqube with access to administer this project. | | sonarqubeDefaultProfileOrGateName | java.lang.String | Default profile/gate name i.e: your org profile. | | sonarqubeEndpoint | java.lang.String | endpoint of the sonarqube instance i.e: https://. | | sonarqubeProjectName | java.lang.String | Name of the project to create in Sonarqube. | | cdkOutDir | java.lang.String | directory containing the synthesized cdk resources. | | cfnNagIgnorePath | java.lang.String | path to a file containing the cfn nag suppression rules. | | excludeGlobsForScan | java.util.List | glob patterns to exclude from sonar scan. | | includeGlobsForScan | java.util.List | glob patterns to include from sonar scan. | | preArchiveCommands | java.util.List | Hook which allows custom commands to be executed before the process commences the archival process. | | sonarqubeSpecificProfileOrGateName | java.lang.String | Specific profile/gate name i.e: language specific. | | sonarqubeTags | java.util.List | Tags to associate with this project. | | artifactBucketArn | java.lang.String | S3 bucket ARN containing the built artifacts from the synth build. | | synthBuildArn | java.lang.String | ARN for the CodeBuild task responsible for executing the synth command. | | artifactBucketKeyArn | java.lang.String | Artifact bucket key ARN used to encrypt the artifacts. | --- ##### `scope`^Required - *Type:* software.constructs.Construct --- ##### `id`^Required - *Type:* java.lang.String --- ##### `sonarqubeAuthorizedGroup`^Required - *Type:* java.lang.String Group name in Sonarqube with access to administer this project. --- ##### `sonarqubeDefaultProfileOrGateName`^Required - *Type:* java.lang.String Default profile/gate name i.e: your org profile. Note: These need to be set up in Sonarqube manually. --- ##### `sonarqubeEndpoint`^Required - *Type:* java.lang.String endpoint of the sonarqube instance i.e: https://. Note: Ensure a trailing '/' is not included. --- ##### `sonarqubeProjectName`^Required - *Type:* java.lang.String Name of the project to create in Sonarqube. --- ##### `cdkOutDir`^Optional - *Type:* java.lang.String directory containing the synthesized cdk resources. --- ##### `cfnNagIgnorePath`^Optional - *Type:* java.lang.String path to a file containing the cfn nag suppression rules. --- ##### `excludeGlobsForScan`^Optional - *Type:* java.util.List glob patterns to exclude from sonar scan. --- ##### `includeGlobsForScan`^Optional - *Type:* java.util.List glob patterns to include from sonar scan. --- ##### `preArchiveCommands`^Optional - *Type:* java.util.List Hook which allows custom commands to be executed before the process commences the archival process. --- ##### `sonarqubeSpecificProfileOrGateName`^Optional - *Type:* java.lang.String Specific profile/gate name i.e: language specific. Note: These need to be set up in Sonarqube manually. --- ##### `sonarqubeTags`^Optional - *Type:* java.util.List Tags to associate with this project. --- ##### `artifactBucketArn`^Required - *Type:* java.lang.String S3 bucket ARN containing the built artifacts from the synth build. --- ##### `synthBuildArn`^Required - *Type:* java.lang.String ARN for the CodeBuild task responsible for executing the synth command. --- ##### `artifactBucketKeyArn`^Optional - *Type:* java.lang.String Artifact bucket key ARN used to encrypt the artifacts. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```java import software.aws.awsprototypingsdk.pipeline.SonarCodeScanner; SonarCodeScanner.isConstruct(java.lang.Object x) ``` 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:* java.lang.Object Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ## Structs ### IsDefaultBranchProps Properties to help the isDefaultBranch function determine the default branch name. #### Initializer ```java import software.aws.awsprototypingsdk.pipeline.IsDefaultBranchProps; IsDefaultBranchProps.builder() // .defaultBranchName(java.lang.String) // .node(Node) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | defaultBranchName | java.lang.String | Specify the default branch name without context. | | node | software.constructs.Node | The current node to fetch defaultBranchName from context. | --- ##### `defaultBranchName`^Optional ```java public java.lang.String getDefaultBranchName(); ``` - *Type:* java.lang.String Specify the default branch name without context. --- ##### `node`^Optional ```java public Node getNode(); ``` - *Type:* software.constructs.Node The current node to fetch defaultBranchName from context. --- ### PDKPipelineJavaProjectOptions Configuration options for the PDKPipelineJavaProject. #### Initializer ```java import software.aws.awsprototypingsdk.pipeline.PDKPipelineJavaProjectOptions; PDKPipelineJavaProjectOptions.builder() .name(java.lang.String) // .commitGenerated(java.lang.Boolean) // .gitIgnoreOptions(IgnoreFileOptions) // .gitOptions(GitOptions) // .logging(LoggerOptions) // .outdir(java.lang.String) // .parent(Project) // .projenCommand(java.lang.String) // .projenrcJson(java.lang.Boolean) // .projenrcJsonOptions(ProjenrcJsonOptions) // .renovatebot(java.lang.Boolean) // .renovatebotOptions(RenovatebotOptions) // .autoApproveOptions(AutoApproveOptions) // .autoMerge(java.lang.Boolean) // .autoMergeOptions(AutoMergeOptions) // .clobber(java.lang.Boolean) // .devContainer(java.lang.Boolean) // .github(java.lang.Boolean) // .githubOptions(GitHubOptions) // .gitpod(java.lang.Boolean) // .mergify(java.lang.Boolean) // .mergifyOptions(MergifyOptions) // .projectType(ProjectType) // .projenCredentials(GithubCredentials) // .projenTokenSecret(java.lang.String) // .readme(SampleReadmeProps) // .stale(java.lang.Boolean) // .staleOptions(StaleOptions) // .vscode(java.lang.Boolean) .artifactId(java.lang.String) .groupId(java.lang.String) .version(java.lang.String) // .description(java.lang.String) // .packaging(java.lang.String) // .url(java.lang.String) // .compileOptions(MavenCompileOptions) // .deps(java.util.List) // .distdir(java.lang.String) // .junit(java.lang.Boolean) // .junitOptions(JunitOptions) // .packagingOptions(MavenPackagingOptions) // .projenrcJava(java.lang.Boolean) // .projenrcJavaOptions(ProjenrcOptions) // .testDeps(java.util.List) // .sample(java.lang.Boolean) // .sampleJavaPackage(java.lang.String) // .buildCommand(java.lang.String) // .cdkout(java.lang.String) // .context(java.util.Map) // .featureFlags(java.lang.Boolean) // .requireApproval(ApprovalLevel) // .watchExcludes(java.util.List) // .watchIncludes(java.util.List) .cdkVersion(java.lang.String) // .cdkAssert(java.lang.Boolean) // .cdkAssertions(java.lang.Boolean) // .cdkDependencies(java.util.List) // .cdkDependenciesAsDeps(java.lang.Boolean) // .cdkTestDependencies(java.util.List) // .cdkVersionPinning(java.lang.Boolean) // .constructsVersion(java.lang.String) .mainClass(java.lang.String) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | java.lang.String | This is the name of your project. | | commitGenerated | java.lang.Boolean | Whether to commit the managed files by default. | | gitIgnoreOptions | io.github.cdklabs.projen.IgnoreFileOptions | Configuration options for .gitignore file. | | gitOptions | io.github.cdklabs.projen.GitOptions | Configuration options for git. | | logging | io.github.cdklabs.projen.LoggerOptions | Configure logging options such as verbosity. | | outdir | java.lang.String | The root directory of the project. | | parent | io.github.cdklabs.projen.Project | The parent project, if this project is part of a bigger project. | | projenCommand | java.lang.String | The shell command to use in order to run the projen CLI. | | projenrcJson | java.lang.Boolean | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. | | projenrcJsonOptions | io.github.cdklabs.projen.ProjenrcJsonOptions | Options for .projenrc.json. | | renovatebot | java.lang.Boolean | Use renovatebot to handle dependency upgrades. | | renovatebotOptions | io.github.cdklabs.projen.RenovatebotOptions | Options for renovatebot. | | autoApproveOptions | io.github.cdklabs.projen.github.AutoApproveOptions | Enable and configure the 'auto approve' workflow. | | autoMerge | java.lang.Boolean | Enable automatic merging on GitHub. | | autoMergeOptions | io.github.cdklabs.projen.github.AutoMergeOptions | Configure options for automatic merging on GitHub. | | clobber | java.lang.Boolean | Add a `clobber` task which resets the repo to origin. | | devContainer | java.lang.Boolean | Add a VSCode development environment (used for GitHub Codespaces). | | github | java.lang.Boolean | Enable GitHub integration. | | githubOptions | io.github.cdklabs.projen.github.GitHubOptions | Options for GitHub integration. | | gitpod | java.lang.Boolean | Add a Gitpod development environment. | | mergify | java.lang.Boolean | Whether mergify should be enabled on this repository or not. | | mergifyOptions | io.github.cdklabs.projen.github.MergifyOptions | Options for mergify. | | projectType | io.github.cdklabs.projen.ProjectType | Which type of project this is (library/app). | | projenCredentials | io.github.cdklabs.projen.github.GithubCredentials | Choose a method of providing GitHub API access for projen workflows. | | projenTokenSecret | java.lang.String | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. | | readme | io.github.cdklabs.projen.SampleReadmeProps | The README setup. | | stale | java.lang.Boolean | Auto-close of stale issues and pull request. | | staleOptions | io.github.cdklabs.projen.github.StaleOptions | Auto-close stale issues and pull requests. | | vscode | java.lang.Boolean | Enable VSCode integration. | | artifactId | java.lang.String | The artifactId is generally the name that the project is known by. | | groupId | java.lang.String | This is generally unique amongst an organization or a project. | | version | java.lang.String | This is the last piece of the naming puzzle. | | description | java.lang.String | Description of a project is always good. | | packaging | java.lang.String | Project packaging format. | | url | java.lang.String | The URL, like the name, is not required. | | compileOptions | io.github.cdklabs.projen.java.MavenCompileOptions | Compile options. | | deps | java.util.List | List of runtime dependencies for this project. | | distdir | java.lang.String | Final artifact output directory. | | junit | java.lang.Boolean | Include junit tests. | | junitOptions | io.github.cdklabs.projen.java.JunitOptions | junit options. | | packagingOptions | io.github.cdklabs.projen.java.MavenPackagingOptions | Packaging options. | | projenrcJava | java.lang.Boolean | Use projenrc in java. | | projenrcJavaOptions | io.github.cdklabs.projen.java.ProjenrcOptions | Options related to projenrc in java. | | testDeps | java.util.List | List of test dependencies for this project. | | sample | java.lang.Boolean | Include sample code and test if the relevant directories don't exist. | | sampleJavaPackage | java.lang.String | The java package to use for the code sample. | | buildCommand | java.lang.String | A command to execute before synthesis. | | cdkout | java.lang.String | cdk.out directory. | | context | java.util.Map | Additional context to include in `cdk.json`. | | featureFlags | java.lang.Boolean | Include all feature flags in cdk.json. | | requireApproval | io.github.cdklabs.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 | java.util.List | Glob patterns to exclude from `cdk watch`. | | watchIncludes | java.util.List | Glob patterns to include in `cdk watch`. | | cdkVersion | java.lang.String | Minimum version of the AWS CDK to depend on. | | cdkAssert | java.lang.Boolean | Warning: NodeJS only. | | cdkAssertions | java.lang.Boolean | Install the assertions library? | | cdkDependencies | java.util.List | Which AWS CDKv1 modules this project requires. | | cdkDependenciesAsDeps | java.lang.Boolean | If this is enabled (default), all modules declared in `cdkDependencies` will be also added as normal `dependencies` (as well as `peerDependencies`). | | cdkTestDependencies | java.util.List | AWS CDK modules required for testing. | | cdkVersionPinning | java.lang.Boolean | Use pinned version instead of caret version for CDK. | | constructsVersion | java.lang.String | Minimum version of the `constructs` library to depend on. | | mainClass | java.lang.String | The name of the Java class with the static `main()` method. | --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String - *Default:* $BASEDIR This is the name of your project. --- ##### `commitGenerated`^Optional ```java public java.lang.Boolean getCommitGenerated(); ``` - *Type:* java.lang.Boolean - *Default:* true Whether to commit the managed files by default. --- ##### `gitIgnoreOptions`^Optional ```java public IgnoreFileOptions getGitIgnoreOptions(); ``` - *Type:* io.github.cdklabs.projen.IgnoreFileOptions Configuration options for .gitignore file. --- ##### `gitOptions`^Optional ```java public GitOptions getGitOptions(); ``` - *Type:* io.github.cdklabs.projen.GitOptions Configuration options for git. --- ##### `logging`^Optional ```java public LoggerOptions getLogging(); ``` - *Type:* io.github.cdklabs.projen.LoggerOptions - *Default:* {} Configure logging options such as verbosity. --- ##### `outdir`^Optional ```java public java.lang.String getOutdir(); ``` - *Type:* java.lang.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 ```java public Project getParent(); ``` - *Type:* io.github.cdklabs.projen.Project The parent project, if this project is part of a bigger project. --- ##### `projenCommand`^Optional ```java public java.lang.String getProjenCommand(); ``` - *Type:* java.lang.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 ```java public java.lang.Boolean getProjenrcJson(); ``` - *Type:* java.lang.Boolean - *Default:* false Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. --- ##### `projenrcJsonOptions`^Optional ```java public ProjenrcJsonOptions getProjenrcJsonOptions(); ``` - *Type:* io.github.cdklabs.projen.ProjenrcJsonOptions - *Default:* default options Options for .projenrc.json. --- ##### `renovatebot`^Optional ```java public java.lang.Boolean getRenovatebot(); ``` - *Type:* java.lang.Boolean - *Default:* false Use renovatebot to handle dependency upgrades. --- ##### `renovatebotOptions`^Optional ```java public RenovatebotOptions getRenovatebotOptions(); ``` - *Type:* io.github.cdklabs.projen.RenovatebotOptions - *Default:* default options Options for renovatebot. --- ##### `autoApproveOptions`^Optional ```java public AutoApproveOptions getAutoApproveOptions(); ``` - *Type:* io.github.cdklabs.projen.github.AutoApproveOptions - *Default:* auto approve is disabled Enable and configure the 'auto approve' workflow. --- ##### `autoMerge`^Optional ```java public java.lang.Boolean getAutoMerge(); ``` - *Type:* java.lang.Boolean - *Default:* true Enable automatic merging on GitHub. Has no effect if `github.mergify` is set to false. --- ##### `autoMergeOptions`^Optional ```java public AutoMergeOptions getAutoMergeOptions(); ``` - *Type:* io.github.cdklabs.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 ```java public java.lang.Boolean getClobber(); ``` - *Type:* java.lang.Boolean - *Default:* true, but false for subprojects Add a `clobber` task which resets the repo to origin. --- ##### `devContainer`^Optional ```java public java.lang.Boolean getDevContainer(); ``` - *Type:* java.lang.Boolean - *Default:* false Add a VSCode development environment (used for GitHub Codespaces). --- ##### `github`^Optional ```java public java.lang.Boolean getGithub(); ``` - *Type:* java.lang.Boolean - *Default:* true Enable GitHub integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `githubOptions`^Optional ```java public GitHubOptions getGithubOptions(); ``` - *Type:* io.github.cdklabs.projen.github.GitHubOptions - *Default:* see GitHubOptions Options for GitHub integration. --- ##### `gitpod`^Optional ```java public java.lang.Boolean getGitpod(); ``` - *Type:* java.lang.Boolean - *Default:* false Add a Gitpod development environment. --- ##### ~~`mergify`~~^Optional - *Deprecated:* use `githubOptions.mergify` instead ```java public java.lang.Boolean getMergify(); ``` - *Type:* java.lang.Boolean - *Default:* true Whether mergify should be enabled on this repository or not. --- ##### ~~`mergifyOptions`~~^Optional - *Deprecated:* use `githubOptions.mergifyOptions` instead ```java public MergifyOptions getMergifyOptions(); ``` - *Type:* io.github.cdklabs.projen.github.MergifyOptions - *Default:* default options Options for mergify. --- ##### ~~`projectType`~~^Optional - *Deprecated:* no longer supported at the base project level ```java public ProjectType getProjectType(); ``` - *Type:* io.github.cdklabs.projen.ProjectType - *Default:* ProjectType.UNKNOWN Which type of project this is (library/app). --- ##### `projenCredentials`^Optional ```java public GithubCredentials getProjenCredentials(); ``` - *Type:* io.github.cdklabs.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` ```java public java.lang.String getProjenTokenSecret(); ``` - *Type:* java.lang.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 ```java public SampleReadmeProps getReadme(); ``` - *Type:* io.github.cdklabs.projen.SampleReadmeProps - *Default:* { filename: 'README.md', contents: '# replace this' } The README setup. --- *Example* ```java "{ filename: 'readme.md', contents: '# title' }" ``` ##### `stale`^Optional ```java public java.lang.Boolean getStale(); ``` - *Type:* java.lang.Boolean - *Default:* false Auto-close of stale issues and pull request. See `staleOptions` for options. --- ##### `staleOptions`^Optional ```java public StaleOptions getStaleOptions(); ``` - *Type:* io.github.cdklabs.projen.github.StaleOptions - *Default:* see defaults in `StaleOptions` Auto-close stale issues and pull requests. To disable set `stale` to `false`. --- ##### `vscode`^Optional ```java public java.lang.Boolean getVscode(); ``` - *Type:* java.lang.Boolean - *Default:* true Enable VSCode integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `artifactId`^Required ```java public java.lang.String getArtifactId(); ``` - *Type:* java.lang.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 ```java public java.lang.String getGroupId(); ``` - *Type:* java.lang.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 ```java public java.lang.String getVersion(); ``` - *Type:* java.lang.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 ```java public java.lang.String getDescription(); ``` - *Type:* java.lang.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 ```java public java.lang.String getPackaging(); ``` - *Type:* java.lang.String - *Default:* "jar" Project packaging format. --- ##### `url`^Optional ```java public java.lang.String getUrl(); ``` - *Type:* java.lang.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 ```java public MavenCompileOptions getCompileOptions(); ``` - *Type:* io.github.cdklabs.projen.java.MavenCompileOptions - *Default:* defaults Compile options. --- ##### `deps`^Optional ```java public java.util.List getDeps(); ``` - *Type:* java.util.List - *Default:* [] List of runtime dependencies for this project. Dependencies use the format: `/@` Additional dependencies can be added via `project.addDependency()`. --- ##### `distdir`^Optional ```java public java.lang.String getDistdir(); ``` - *Type:* java.lang.String - *Default:* "dist/java" Final artifact output directory. --- ##### `junit`^Optional ```java public java.lang.Boolean getJunit(); ``` - *Type:* java.lang.Boolean - *Default:* true Include junit tests. --- ##### `junitOptions`^Optional ```java public JunitOptions getJunitOptions(); ``` - *Type:* io.github.cdklabs.projen.java.JunitOptions - *Default:* defaults junit options. --- ##### `packagingOptions`^Optional ```java public MavenPackagingOptions getPackagingOptions(); ``` - *Type:* io.github.cdklabs.projen.java.MavenPackagingOptions - *Default:* defaults Packaging options. --- ##### `projenrcJava`^Optional ```java public java.lang.Boolean getProjenrcJava(); ``` - *Type:* java.lang.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 ```java public ProjenrcOptions getProjenrcJavaOptions(); ``` - *Type:* io.github.cdklabs.projen.java.ProjenrcOptions - *Default:* default options Options related to projenrc in java. --- ##### `testDeps`^Optional ```java public java.util.List getTestDeps(); ``` - *Type:* java.util.List - *Default:* [] List of test dependencies for this project. Dependencies use the format: `/@` Additional dependencies can be added via `project.addTestDependency()`. --- ##### `sample`^Optional ```java public java.lang.Boolean getSample(); ``` - *Type:* java.lang.Boolean - *Default:* true Include sample code and test if the relevant directories don't exist. --- ##### `sampleJavaPackage`^Optional ```java public java.lang.String getSampleJavaPackage(); ``` - *Type:* java.lang.String - *Default:* "org.acme" The java package to use for the code sample. --- ##### `buildCommand`^Optional ```java public java.lang.String getBuildCommand(); ``` - *Type:* java.lang.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 ```java public java.lang.String getCdkout(); ``` - *Type:* java.lang.String - *Default:* "cdk.out" cdk.out directory. --- ##### `context`^Optional ```java public java.util.Map getContext(); ``` - *Type:* java.util.Map - *Default:* no additional context Additional context to include in `cdk.json`. --- ##### `featureFlags`^Optional ```java public java.lang.Boolean getFeatureFlags(); ``` - *Type:* java.lang.Boolean - *Default:* true Include all feature flags in cdk.json. --- ##### `requireApproval`^Optional ```java public ApprovalLevel getRequireApproval(); ``` - *Type:* io.github.cdklabs.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 ```java public java.util.List getWatchExcludes(); ``` - *Type:* java.util.List - *Default:* [] Glob patterns to exclude from `cdk watch`. --- ##### `watchIncludes`^Optional ```java public java.util.List getWatchIncludes(); ``` - *Type:* java.util.List - *Default:* [] Glob patterns to include in `cdk watch`. --- ##### `cdkVersion`^Required ```java public java.lang.String getCdkVersion(); ``` - *Type:* java.lang.String - *Default:* "2.1.0" Minimum version of the AWS CDK to depend on. --- ##### ~~`cdkAssert`~~^Optional - *Deprecated:* The ```java public java.lang.Boolean getCdkAssert(); ``` - *Type:* java.lang.Boolean - *Default:* will be included by default for AWS CDK >= 1.0.0 < 2.0.0 Warning: NodeJS only. Install the --- ##### `cdkAssertions`^Optional ```java public java.lang.Boolean getCdkAssertions(); ``` - *Type:* java.lang.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) ```java public java.util.List getCdkDependencies(); ``` - *Type:* java.util.List Which AWS CDKv1 modules this project requires. --- ##### ~~`cdkDependenciesAsDeps`~~^Optional - *Deprecated:* Not supported in CDK v2. ```java public java.lang.Boolean getCdkDependenciesAsDeps(); ``` - *Type:* java.lang.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 ```java public java.util.List getCdkTestDependencies(); ``` - *Type:* java.util.List AWS CDK modules required for testing. --- ##### `cdkVersionPinning`^Optional ```java public java.lang.Boolean getCdkVersionPinning(); ``` - *Type:* java.lang.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 ```java public java.lang.String getConstructsVersion(); ``` - *Type:* java.lang.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 ```java public java.lang.String getMainClass(); ``` - *Type:* java.lang.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 ```java import software.aws.awsprototypingsdk.pipeline.PDKPipelineProps; PDKPipelineProps.builder() .synth(IFileSetProducer) // .artifactBucket(IBucket) // .assetPublishingCodeBuildDefaults(CodeBuildOptions) // .cliVersion(java.lang.String) // .codeBuildDefaults(CodeBuildOptions) // .codePipeline(Pipeline) // .crossAccountKeys(java.lang.Boolean) // .dockerCredentials(java.util.List) // .dockerEnabledForSelfMutation(java.lang.Boolean) // .dockerEnabledForSynth(java.lang.Boolean) // .enableKeyRotation(java.lang.Boolean) // .pipelineName(java.lang.String) // .publishAssetsInParallel(java.lang.Boolean) // .reuseCrossRegionSupportStacks(java.lang.Boolean) // .role(IRole) // .selfMutation(java.lang.Boolean) // .selfMutationCodeBuildDefaults(CodeBuildOptions) // .synthCodeBuildDefaults(CodeBuildOptions) // .useChangeSets(java.lang.Boolean) .primarySynthDirectory(java.lang.String) .repositoryName(java.lang.String) // .branchNamePrefixes(java.util.List) // .cdkCommand(java.lang.String) // .codeCommitRemovalPolicy(RemovalPolicy) // .defaultBranchName(java.lang.String) // .sonarCodeScannerConfig(SonarCodeScannerConfig) // .synthShellStepPartialProps(ShellStepProps) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | synth | software.amazon.awscdk.pipelines.IFileSetProducer | The build step that produces the CDK Cloud Assembly. | | artifactBucket | software.amazon.awscdk.services.s3.IBucket | An existing S3 Bucket to use for storing the pipeline's artifact. | | assetPublishingCodeBuildDefaults | software.amazon.awscdk.pipelines.CodeBuildOptions | Additional customizations to apply to the asset publishing CodeBuild projects. | | cliVersion | java.lang.String | CDK CLI version to use in self-mutation and asset publishing steps. | | codeBuildDefaults | software.amazon.awscdk.pipelines.CodeBuildOptions | Customize the CodeBuild projects created for this pipeline. | | codePipeline | software.amazon.awscdk.services.codepipeline.Pipeline | An existing Pipeline to be reused and built upon. | | crossAccountKeys | java.lang.Boolean | Create KMS keys for the artifact buckets, allowing cross-account deployments. | | dockerCredentials | java.util.List | A list of credentials used to authenticate to Docker registries. | | dockerEnabledForSelfMutation | java.lang.Boolean | Enable Docker for the self-mutate step. | | dockerEnabledForSynth | java.lang.Boolean | Enable Docker for the 'synth' step. | | enableKeyRotation | java.lang.Boolean | Enable KMS key rotation for the generated KMS keys. | | pipelineName | java.lang.String | The name of the CodePipeline pipeline. | | publishAssetsInParallel | java.lang.Boolean | Publish assets in multiple CodeBuild projects. | | reuseCrossRegionSupportStacks | java.lang.Boolean | Reuse the same cross region support stack for all pipelines in the App. | | role | software.amazon.awscdk.services.iam.IRole | The IAM role to be assumed by this Pipeline. | | selfMutation | java.lang.Boolean | Whether the pipeline will update itself. | | selfMutationCodeBuildDefaults | software.amazon.awscdk.pipelines.CodeBuildOptions | Additional customizations to apply to the self mutation CodeBuild projects. | | synthCodeBuildDefaults | software.amazon.awscdk.pipelines.CodeBuildOptions | Additional customizations to apply to the synthesize CodeBuild projects. | | useChangeSets | java.lang.Boolean | Deploy every stack by creating a change set and executing it. | | primarySynthDirectory | java.lang.String | Output directory for cdk synthesized artifacts i.e: packages/infra/cdk.out. | | repositoryName | java.lang.String | Name of the CodeCommit repository to create. | | branchNamePrefixes | java.util.List | Branch name prefixes Any branches created matching this list of prefixes will create a new pipeline and stack. | | cdkCommand | java.lang.String | CDK command. | | codeCommitRemovalPolicy | software.amazon.awscdk.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 | java.lang.String | Branch to trigger the pipeline execution. | | sonarCodeScannerConfig | SonarCodeScannerConfig | Configuration for enabling Sonarqube code scanning on a successful synth. | | synthShellStepPartialProps | software.amazon.awscdk.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 ```java public IFileSetProducer getSynth(); ``` - *Type:* software.amazon.awscdk.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 ```java public IBucket getArtifactBucket(); ``` - *Type:* software.amazon.awscdk.services.s3.IBucket - *Default:* A new S3 bucket will be created. An existing S3 Bucket to use for storing the pipeline's artifact. --- ##### `assetPublishingCodeBuildDefaults`^Optional ```java public CodeBuildOptions getAssetPublishingCodeBuildDefaults(); ``` - *Type:* software.amazon.awscdk.pipelines.CodeBuildOptions - *Default:* Only `codeBuildDefaults` are applied Additional customizations to apply to the asset publishing CodeBuild projects. --- ##### `cliVersion`^Optional ```java public java.lang.String getCliVersion(); ``` - *Type:* java.lang.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 ```java public CodeBuildOptions getCodeBuildDefaults(); ``` - *Type:* software.amazon.awscdk.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 ```java public Pipeline getCodePipeline(); ``` - *Type:* software.amazon.awscdk.services.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 ```java public java.lang.Boolean getCrossAccountKeys(); ``` - *Type:* java.lang.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 ```java public java.util.List getDockerCredentials(); ``` - *Type:* java.util.List - *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 ```java public java.lang.Boolean getDockerEnabledForSelfMutation(); ``` - *Type:* java.lang.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 ```java public java.lang.Boolean getDockerEnabledForSynth(); ``` - *Type:* java.lang.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 ```java public java.lang.Boolean getEnableKeyRotation(); ``` - *Type:* java.lang.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 ```java public java.lang.String getPipelineName(); ``` - *Type:* java.lang.String - *Default:* Automatically generated The name of the CodePipeline pipeline. --- ##### `publishAssetsInParallel`^Optional ```java public java.lang.Boolean getPublishAssetsInParallel(); ``` - *Type:* java.lang.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 ```java public java.lang.Boolean getReuseCrossRegionSupportStacks(); ``` - *Type:* java.lang.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 ```java public IRole getRole(); ``` - *Type:* software.amazon.awscdk.services.iam.IRole - *Default:* A new role is created The IAM role to be assumed by this Pipeline. --- ##### `selfMutation`^Optional ```java public java.lang.Boolean getSelfMutation(); ``` - *Type:* java.lang.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 ```java public CodeBuildOptions getSelfMutationCodeBuildDefaults(); ``` - *Type:* software.amazon.awscdk.pipelines.CodeBuildOptions - *Default:* Only `codeBuildDefaults` are applied Additional customizations to apply to the self mutation CodeBuild projects. --- ##### `synthCodeBuildDefaults`^Optional ```java public CodeBuildOptions getSynthCodeBuildDefaults(); ``` - *Type:* software.amazon.awscdk.pipelines.CodeBuildOptions - *Default:* Only `codeBuildDefaults` are applied Additional customizations to apply to the synthesize CodeBuild projects. --- ##### `useChangeSets`^Optional ```java public java.lang.Boolean getUseChangeSets(); ``` - *Type:* java.lang.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 ```java public java.lang.String getPrimarySynthDirectory(); ``` - *Type:* java.lang.String Output directory for cdk synthesized artifacts i.e: packages/infra/cdk.out. --- ##### `repositoryName`^Required ```java public java.lang.String getRepositoryName(); ``` - *Type:* java.lang.String Name of the CodeCommit repository to create. --- ##### `branchNamePrefixes`^Optional ```java public java.util.List getBranchNamePrefixes(); ``` - *Type:* java.util.List - *Default:* undefined Branch name prefixes Any branches created matching this list of prefixes will create a new pipeline and stack. --- *Example* ```java // Example automatically generated from non-compiling source. May contain errors. // Disables feature branches (default) // Disables feature branches (default) PDKPipeline.Builder.create(this, "PDKPipeline") .repositoryName("my-repo") .branchNamePrefixes(List.of()) .build(); ``` ##### `cdkCommand`^Optional ```java public java.lang.String getCdkCommand(); ``` - *Type:* java.lang.String - *Default:* 'npx cdk' CDK command. Override the command used to call cdk for synth and deploy. --- ##### `codeCommitRemovalPolicy`^Optional ```java public RemovalPolicy getCodeCommitRemovalPolicy(); ``` - *Type:* software.amazon.awscdk.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 ```java public java.lang.String getDefaultBranchName(); ``` - *Type:* java.lang.String - *Default:* mainline Branch to trigger the pipeline execution. --- ##### `sonarCodeScannerConfig`^Optional ```java public SonarCodeScannerConfig getSonarCodeScannerConfig(); ``` - *Type:* SonarCodeScannerConfig - *Default:* undefined Configuration for enabling Sonarqube code scanning on a successful synth. --- ##### `synthShellStepPartialProps`^Optional ```java public ShellStepProps getSynthShellStepPartialProps(); ``` - *Type:* software.amazon.awscdk.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 ```java import software.aws.awsprototypingsdk.pipeline.PDKPipelinePyProjectOptions; PDKPipelinePyProjectOptions.builder() .name(java.lang.String) // .commitGenerated(java.lang.Boolean) // .gitIgnoreOptions(IgnoreFileOptions) // .gitOptions(GitOptions) // .logging(LoggerOptions) // .outdir(java.lang.String) // .parent(Project) // .projenCommand(java.lang.String) // .projenrcJson(java.lang.Boolean) // .projenrcJsonOptions(ProjenrcJsonOptions) // .renovatebot(java.lang.Boolean) // .renovatebotOptions(RenovatebotOptions) // .autoApproveOptions(AutoApproveOptions) // .autoMerge(java.lang.Boolean) // .autoMergeOptions(AutoMergeOptions) // .clobber(java.lang.Boolean) // .devContainer(java.lang.Boolean) // .github(java.lang.Boolean) // .githubOptions(GitHubOptions) // .gitpod(java.lang.Boolean) // .mergify(java.lang.Boolean) // .mergifyOptions(MergifyOptions) // .projectType(ProjectType) // .projenCredentials(GithubCredentials) // .projenTokenSecret(java.lang.String) // .readme(SampleReadmeProps) // .stale(java.lang.Boolean) // .staleOptions(StaleOptions) // .vscode(java.lang.Boolean) .authorEmail(java.lang.String) .authorName(java.lang.String) .version(java.lang.String) // .classifiers(java.util.List) // .description(java.lang.String) // .homepage(java.lang.String) // .license(java.lang.String) // .packageName(java.lang.String) // .poetryOptions(PoetryPyprojectOptionsWithoutDeps) // .setupConfig(java.util.Map) .moduleName(java.lang.String) // .deps(java.util.List) // .devDeps(java.util.List) // .pip(java.lang.Boolean) // .poetry(java.lang.Boolean) // .projenrcJs(java.lang.Boolean) // .projenrcJsOptions(ProjenrcOptions) // .projenrcPython(java.lang.Boolean) // .projenrcPythonOptions(ProjenrcOptions) // .projenrcTs(java.lang.Boolean) // .projenrcTsOptions(ProjenrcTsOptions) // .pytest(java.lang.Boolean) // .pytestOptions(PytestOptions) // .pythonExec(java.lang.String) // .sample(java.lang.Boolean) // .setuptools(java.lang.Boolean) // .venv(java.lang.Boolean) // .venvOptions(VenvOptions) // .buildCommand(java.lang.String) // .cdkout(java.lang.String) // .context(java.util.Map) // .featureFlags(java.lang.Boolean) // .requireApproval(ApprovalLevel) // .watchExcludes(java.util.List) // .watchIncludes(java.util.List) .cdkVersion(java.lang.String) // .cdkAssert(java.lang.Boolean) // .cdkAssertions(java.lang.Boolean) // .cdkDependencies(java.util.List) // .cdkDependenciesAsDeps(java.lang.Boolean) // .cdkTestDependencies(java.util.List) // .cdkVersionPinning(java.lang.Boolean) // .constructsVersion(java.lang.String) // .appEntrypoint(java.lang.String) // .testdir(java.lang.String) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | java.lang.String | This is the name of your project. | | commitGenerated | java.lang.Boolean | Whether to commit the managed files by default. | | gitIgnoreOptions | io.github.cdklabs.projen.IgnoreFileOptions | Configuration options for .gitignore file. | | gitOptions | io.github.cdklabs.projen.GitOptions | Configuration options for git. | | logging | io.github.cdklabs.projen.LoggerOptions | Configure logging options such as verbosity. | | outdir | java.lang.String | The root directory of the project. | | parent | io.github.cdklabs.projen.Project | The parent project, if this project is part of a bigger project. | | projenCommand | java.lang.String | The shell command to use in order to run the projen CLI. | | projenrcJson | java.lang.Boolean | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. | | projenrcJsonOptions | io.github.cdklabs.projen.ProjenrcJsonOptions | Options for .projenrc.json. | | renovatebot | java.lang.Boolean | Use renovatebot to handle dependency upgrades. | | renovatebotOptions | io.github.cdklabs.projen.RenovatebotOptions | Options for renovatebot. | | autoApproveOptions | io.github.cdklabs.projen.github.AutoApproveOptions | Enable and configure the 'auto approve' workflow. | | autoMerge | java.lang.Boolean | Enable automatic merging on GitHub. | | autoMergeOptions | io.github.cdklabs.projen.github.AutoMergeOptions | Configure options for automatic merging on GitHub. | | clobber | java.lang.Boolean | Add a `clobber` task which resets the repo to origin. | | devContainer | java.lang.Boolean | Add a VSCode development environment (used for GitHub Codespaces). | | github | java.lang.Boolean | Enable GitHub integration. | | githubOptions | io.github.cdklabs.projen.github.GitHubOptions | Options for GitHub integration. | | gitpod | java.lang.Boolean | Add a Gitpod development environment. | | mergify | java.lang.Boolean | Whether mergify should be enabled on this repository or not. | | mergifyOptions | io.github.cdklabs.projen.github.MergifyOptions | Options for mergify. | | projectType | io.github.cdklabs.projen.ProjectType | Which type of project this is (library/app). | | projenCredentials | io.github.cdklabs.projen.github.GithubCredentials | Choose a method of providing GitHub API access for projen workflows. | | projenTokenSecret | java.lang.String | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. | | readme | io.github.cdklabs.projen.SampleReadmeProps | The README setup. | | stale | java.lang.Boolean | Auto-close of stale issues and pull request. | | staleOptions | io.github.cdklabs.projen.github.StaleOptions | Auto-close stale issues and pull requests. | | vscode | java.lang.Boolean | Enable VSCode integration. | | authorEmail | java.lang.String | Author's e-mail. | | authorName | java.lang.String | Author's name. | | version | java.lang.String | Version of the package. | | classifiers | java.util.List | A list of PyPI trove classifiers that describe the project. | | description | java.lang.String | A short description of the package. | | homepage | java.lang.String | A URL to the website of the project. | | license | java.lang.String | License of this package as an SPDX identifier. | | packageName | java.lang.String | Package name. | | poetryOptions | io.github.cdklabs.projen.python.PoetryPyprojectOptionsWithoutDeps | Additional options to set for poetry if using poetry. | | setupConfig | java.util.Map | Additional fields to pass in the setup() function if using setuptools. | | moduleName | java.lang.String | Name of the python package as used in imports and filenames. | | deps | java.util.List | List of runtime dependencies for this project. | | devDeps | java.util.List | List of dev dependencies for this project. | | pip | java.lang.Boolean | Use pip with a requirements.txt file to track project dependencies. | | poetry | java.lang.Boolean | Use poetry to manage your project dependencies, virtual environment, and (optional) packaging/publishing. | | projenrcJs | java.lang.Boolean | Use projenrc in javascript. | | projenrcJsOptions | io.github.cdklabs.projen.javascript.ProjenrcOptions | Options related to projenrc in JavaScript. | | projenrcPython | java.lang.Boolean | Use projenrc in Python. | | projenrcPythonOptions | io.github.cdklabs.projen.python.ProjenrcOptions | Options related to projenrc in python. | | projenrcTs | java.lang.Boolean | Use projenrc in TypeScript. | | projenrcTsOptions | io.github.cdklabs.projen.typescript.ProjenrcTsOptions | Options related to projenrc in TypeScript. | | pytest | java.lang.Boolean | Include pytest tests. | | pytestOptions | io.github.cdklabs.projen.python.PytestOptions | pytest options. | | pythonExec | java.lang.String | Path to the python executable to use. | | sample | java.lang.Boolean | Include sample code and test if the relevant directories don't exist. | | setuptools | java.lang.Boolean | Use setuptools with a setup.py script for packaging and publishing. | | venv | java.lang.Boolean | Use venv to manage a virtual environment for installing dependencies inside. | | venvOptions | io.github.cdklabs.projen.python.VenvOptions | Venv options. | | buildCommand | java.lang.String | A command to execute before synthesis. | | cdkout | java.lang.String | cdk.out directory. | | context | java.util.Map | Additional context to include in `cdk.json`. | | featureFlags | java.lang.Boolean | Include all feature flags in cdk.json. | | requireApproval | io.github.cdklabs.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 | java.util.List | Glob patterns to exclude from `cdk watch`. | | watchIncludes | java.util.List | Glob patterns to include in `cdk watch`. | | cdkVersion | java.lang.String | Minimum version of the AWS CDK to depend on. | | cdkAssert | java.lang.Boolean | Warning: NodeJS only. | | cdkAssertions | java.lang.Boolean | Install the assertions library? | | cdkDependencies | java.util.List | Which AWS CDKv1 modules this project requires. | | cdkDependenciesAsDeps | java.lang.Boolean | If this is enabled (default), all modules declared in `cdkDependencies` will be also added as normal `dependencies` (as well as `peerDependencies`). | | cdkTestDependencies | java.util.List | AWS CDK modules required for testing. | | cdkVersionPinning | java.lang.Boolean | Use pinned version instead of caret version for CDK. | | constructsVersion | java.lang.String | Minimum version of the `constructs` library to depend on. | | appEntrypoint | java.lang.String | The CDK app's entrypoint (relative to the source directory, which is "src" by default). | | testdir | java.lang.String | Python sources directory. | --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String - *Default:* $BASEDIR This is the name of your project. --- ##### `commitGenerated`^Optional ```java public java.lang.Boolean getCommitGenerated(); ``` - *Type:* java.lang.Boolean - *Default:* true Whether to commit the managed files by default. --- ##### `gitIgnoreOptions`^Optional ```java public IgnoreFileOptions getGitIgnoreOptions(); ``` - *Type:* io.github.cdklabs.projen.IgnoreFileOptions Configuration options for .gitignore file. --- ##### `gitOptions`^Optional ```java public GitOptions getGitOptions(); ``` - *Type:* io.github.cdklabs.projen.GitOptions Configuration options for git. --- ##### `logging`^Optional ```java public LoggerOptions getLogging(); ``` - *Type:* io.github.cdklabs.projen.LoggerOptions - *Default:* {} Configure logging options such as verbosity. --- ##### `outdir`^Optional ```java public java.lang.String getOutdir(); ``` - *Type:* java.lang.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 ```java public Project getParent(); ``` - *Type:* io.github.cdklabs.projen.Project The parent project, if this project is part of a bigger project. --- ##### `projenCommand`^Optional ```java public java.lang.String getProjenCommand(); ``` - *Type:* java.lang.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 ```java public java.lang.Boolean getProjenrcJson(); ``` - *Type:* java.lang.Boolean - *Default:* false Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. --- ##### `projenrcJsonOptions`^Optional ```java public ProjenrcJsonOptions getProjenrcJsonOptions(); ``` - *Type:* io.github.cdklabs.projen.ProjenrcJsonOptions - *Default:* default options Options for .projenrc.json. --- ##### `renovatebot`^Optional ```java public java.lang.Boolean getRenovatebot(); ``` - *Type:* java.lang.Boolean - *Default:* false Use renovatebot to handle dependency upgrades. --- ##### `renovatebotOptions`^Optional ```java public RenovatebotOptions getRenovatebotOptions(); ``` - *Type:* io.github.cdklabs.projen.RenovatebotOptions - *Default:* default options Options for renovatebot. --- ##### `autoApproveOptions`^Optional ```java public AutoApproveOptions getAutoApproveOptions(); ``` - *Type:* io.github.cdklabs.projen.github.AutoApproveOptions - *Default:* auto approve is disabled Enable and configure the 'auto approve' workflow. --- ##### `autoMerge`^Optional ```java public java.lang.Boolean getAutoMerge(); ``` - *Type:* java.lang.Boolean - *Default:* true Enable automatic merging on GitHub. Has no effect if `github.mergify` is set to false. --- ##### `autoMergeOptions`^Optional ```java public AutoMergeOptions getAutoMergeOptions(); ``` - *Type:* io.github.cdklabs.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 ```java public java.lang.Boolean getClobber(); ``` - *Type:* java.lang.Boolean - *Default:* true, but false for subprojects Add a `clobber` task which resets the repo to origin. --- ##### `devContainer`^Optional ```java public java.lang.Boolean getDevContainer(); ``` - *Type:* java.lang.Boolean - *Default:* false Add a VSCode development environment (used for GitHub Codespaces). --- ##### `github`^Optional ```java public java.lang.Boolean getGithub(); ``` - *Type:* java.lang.Boolean - *Default:* true Enable GitHub integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `githubOptions`^Optional ```java public GitHubOptions getGithubOptions(); ``` - *Type:* io.github.cdklabs.projen.github.GitHubOptions - *Default:* see GitHubOptions Options for GitHub integration. --- ##### `gitpod`^Optional ```java public java.lang.Boolean getGitpod(); ``` - *Type:* java.lang.Boolean - *Default:* false Add a Gitpod development environment. --- ##### ~~`mergify`~~^Optional - *Deprecated:* use `githubOptions.mergify` instead ```java public java.lang.Boolean getMergify(); ``` - *Type:* java.lang.Boolean - *Default:* true Whether mergify should be enabled on this repository or not. --- ##### ~~`mergifyOptions`~~^Optional - *Deprecated:* use `githubOptions.mergifyOptions` instead ```java public MergifyOptions getMergifyOptions(); ``` - *Type:* io.github.cdklabs.projen.github.MergifyOptions - *Default:* default options Options for mergify. --- ##### ~~`projectType`~~^Optional - *Deprecated:* no longer supported at the base project level ```java public ProjectType getProjectType(); ``` - *Type:* io.github.cdklabs.projen.ProjectType - *Default:* ProjectType.UNKNOWN Which type of project this is (library/app). --- ##### `projenCredentials`^Optional ```java public GithubCredentials getProjenCredentials(); ``` - *Type:* io.github.cdklabs.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` ```java public java.lang.String getProjenTokenSecret(); ``` - *Type:* java.lang.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 ```java public SampleReadmeProps getReadme(); ``` - *Type:* io.github.cdklabs.projen.SampleReadmeProps - *Default:* { filename: 'README.md', contents: '# replace this' } The README setup. --- *Example* ```java "{ filename: 'readme.md', contents: '# title' }" ``` ##### `stale`^Optional ```java public java.lang.Boolean getStale(); ``` - *Type:* java.lang.Boolean - *Default:* false Auto-close of stale issues and pull request. See `staleOptions` for options. --- ##### `staleOptions`^Optional ```java public StaleOptions getStaleOptions(); ``` - *Type:* io.github.cdklabs.projen.github.StaleOptions - *Default:* see defaults in `StaleOptions` Auto-close stale issues and pull requests. To disable set `stale` to `false`. --- ##### `vscode`^Optional ```java public java.lang.Boolean getVscode(); ``` - *Type:* java.lang.Boolean - *Default:* true Enable VSCode integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `authorEmail`^Required ```java public java.lang.String getAuthorEmail(); ``` - *Type:* java.lang.String - *Default:* $GIT_USER_EMAIL Author's e-mail. --- ##### `authorName`^Required ```java public java.lang.String getAuthorName(); ``` - *Type:* java.lang.String - *Default:* $GIT_USER_NAME Author's name. --- ##### `version`^Required ```java public java.lang.String getVersion(); ``` - *Type:* java.lang.String - *Default:* "0.1.0" Version of the package. --- ##### `classifiers`^Optional ```java public java.util.List getClassifiers(); ``` - *Type:* java.util.List A list of PyPI trove classifiers that describe the project. > [https://pypi.org/classifiers/](https://pypi.org/classifiers/) --- ##### `description`^Optional ```java public java.lang.String getDescription(); ``` - *Type:* java.lang.String A short description of the package. --- ##### `homepage`^Optional ```java public java.lang.String getHomepage(); ``` - *Type:* java.lang.String A URL to the website of the project. --- ##### `license`^Optional ```java public java.lang.String getLicense(); ``` - *Type:* java.lang.String License of this package as an SPDX identifier. --- ##### `packageName`^Optional ```java public java.lang.String getPackageName(); ``` - *Type:* java.lang.String Package name. --- ##### `poetryOptions`^Optional ```java public PoetryPyprojectOptionsWithoutDeps getPoetryOptions(); ``` - *Type:* io.github.cdklabs.projen.python.PoetryPyprojectOptionsWithoutDeps Additional options to set for poetry if using poetry. --- ##### `setupConfig`^Optional ```java public java.util.Map getSetupConfig(); ``` - *Type:* java.util.Map Additional fields to pass in the setup() function if using setuptools. --- ##### `moduleName`^Required ```java public java.lang.String getModuleName(); ``` - *Type:* java.lang.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 ```java public java.util.List getDeps(); ``` - *Type:* java.util.List - *Default:* [] List of runtime dependencies for this project. Dependencies use the format: `@` Additional dependencies can be added via `project.addDependency()`. --- ##### `devDeps`^Optional ```java public java.util.List getDevDeps(); ``` - *Type:* java.util.List - *Default:* [] List of dev dependencies for this project. Dependencies use the format: `@` Additional dependencies can be added via `project.addDevDependency()`. --- ##### `pip`^Optional ```java public java.lang.Boolean getPip(); ``` - *Type:* java.lang.Boolean - *Default:* true, unless poetry is true, then false Use pip with a requirements.txt file to track project dependencies. --- ##### `poetry`^Optional ```java public java.lang.Boolean getPoetry(); ``` - *Type:* java.lang.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 ```java public java.lang.Boolean getProjenrcJs(); ``` - *Type:* java.lang.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 ```java public ProjenrcOptions getProjenrcJsOptions(); ``` - *Type:* io.github.cdklabs.projen.javascript.ProjenrcOptions - *Default:* default options Options related to projenrc in JavaScript. --- ##### `projenrcPython`^Optional ```java public java.lang.Boolean getProjenrcPython(); ``` - *Type:* java.lang.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 ```java public ProjenrcOptions getProjenrcPythonOptions(); ``` - *Type:* io.github.cdklabs.projen.python.ProjenrcOptions - *Default:* default options Options related to projenrc in python. --- ##### `projenrcTs`^Optional ```java public java.lang.Boolean getProjenrcTs(); ``` - *Type:* java.lang.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 ```java public ProjenrcTsOptions getProjenrcTsOptions(); ``` - *Type:* io.github.cdklabs.projen.typescript.ProjenrcTsOptions - *Default:* default options Options related to projenrc in TypeScript. --- ##### `pytest`^Optional ```java public java.lang.Boolean getPytest(); ``` - *Type:* java.lang.Boolean - *Default:* true Include pytest tests. --- ##### `pytestOptions`^Optional ```java public PytestOptions getPytestOptions(); ``` - *Type:* io.github.cdklabs.projen.python.PytestOptions - *Default:* defaults pytest options. --- ##### `pythonExec`^Optional ```java public java.lang.String getPythonExec(); ``` - *Type:* java.lang.String - *Default:* "python" Path to the python executable to use. --- ##### `sample`^Optional ```java public java.lang.Boolean getSample(); ``` - *Type:* java.lang.Boolean - *Default:* true Include sample code and test if the relevant directories don't exist. --- ##### `setuptools`^Optional ```java public java.lang.Boolean getSetuptools(); ``` - *Type:* java.lang.Boolean - *Default:* true, unless poetry is true, then false Use setuptools with a setup.py script for packaging and publishing. --- ##### `venv`^Optional ```java public java.lang.Boolean getVenv(); ``` - *Type:* java.lang.Boolean - *Default:* true, unless poetry is true, then false Use venv to manage a virtual environment for installing dependencies inside. --- ##### `venvOptions`^Optional ```java public VenvOptions getVenvOptions(); ``` - *Type:* io.github.cdklabs.projen.python.VenvOptions - *Default:* defaults Venv options. --- ##### `buildCommand`^Optional ```java public java.lang.String getBuildCommand(); ``` - *Type:* java.lang.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 ```java public java.lang.String getCdkout(); ``` - *Type:* java.lang.String - *Default:* "cdk.out" cdk.out directory. --- ##### `context`^Optional ```java public java.util.Map getContext(); ``` - *Type:* java.util.Map - *Default:* no additional context Additional context to include in `cdk.json`. --- ##### `featureFlags`^Optional ```java public java.lang.Boolean getFeatureFlags(); ``` - *Type:* java.lang.Boolean - *Default:* true Include all feature flags in cdk.json. --- ##### `requireApproval`^Optional ```java public ApprovalLevel getRequireApproval(); ``` - *Type:* io.github.cdklabs.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 ```java public java.util.List getWatchExcludes(); ``` - *Type:* java.util.List - *Default:* [] Glob patterns to exclude from `cdk watch`. --- ##### `watchIncludes`^Optional ```java public java.util.List getWatchIncludes(); ``` - *Type:* java.util.List - *Default:* [] Glob patterns to include in `cdk watch`. --- ##### `cdkVersion`^Required ```java public java.lang.String getCdkVersion(); ``` - *Type:* java.lang.String - *Default:* "2.1.0" Minimum version of the AWS CDK to depend on. --- ##### ~~`cdkAssert`~~^Optional - *Deprecated:* The ```java public java.lang.Boolean getCdkAssert(); ``` - *Type:* java.lang.Boolean - *Default:* will be included by default for AWS CDK >= 1.0.0 < 2.0.0 Warning: NodeJS only. Install the --- ##### `cdkAssertions`^Optional ```java public java.lang.Boolean getCdkAssertions(); ``` - *Type:* java.lang.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) ```java public java.util.List getCdkDependencies(); ``` - *Type:* java.util.List Which AWS CDKv1 modules this project requires. --- ##### ~~`cdkDependenciesAsDeps`~~^Optional - *Deprecated:* Not supported in CDK v2. ```java public java.lang.Boolean getCdkDependenciesAsDeps(); ``` - *Type:* java.lang.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 ```java public java.util.List getCdkTestDependencies(); ``` - *Type:* java.util.List AWS CDK modules required for testing. --- ##### `cdkVersionPinning`^Optional ```java public java.lang.Boolean getCdkVersionPinning(); ``` - *Type:* java.lang.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 ```java public java.lang.String getConstructsVersion(); ``` - *Type:* java.lang.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 ```java public java.lang.String getAppEntrypoint(); ``` - *Type:* java.lang.String - *Default:* "app.py" The CDK app's entrypoint (relative to the source directory, which is "src" by default). --- ##### `testdir`^Optional ```java public java.lang.String getTestdir(); ``` - *Type:* java.lang.String - *Default:* "tests" Python sources directory. --- ### PDKPipelineTsProjectOptions Configuration options for the PDKPipelineTsProject. #### Initializer ```java import software.aws.awsprototypingsdk.pipeline.PDKPipelineTsProjectOptions; PDKPipelineTsProjectOptions.builder() .name(java.lang.String) // .commitGenerated(java.lang.Boolean) // .gitIgnoreOptions(IgnoreFileOptions) // .gitOptions(GitOptions) // .logging(LoggerOptions) // .outdir(java.lang.String) // .parent(Project) // .projenCommand(java.lang.String) // .projenrcJson(java.lang.Boolean) // .projenrcJsonOptions(ProjenrcJsonOptions) // .renovatebot(java.lang.Boolean) // .renovatebotOptions(RenovatebotOptions) // .autoApproveOptions(AutoApproveOptions) // .autoMerge(java.lang.Boolean) // .autoMergeOptions(AutoMergeOptions) // .clobber(java.lang.Boolean) // .devContainer(java.lang.Boolean) // .github(java.lang.Boolean) // .githubOptions(GitHubOptions) // .gitpod(java.lang.Boolean) // .mergify(java.lang.Boolean) // .mergifyOptions(MergifyOptions) // .projectType(ProjectType) // .projenCredentials(GithubCredentials) // .projenTokenSecret(java.lang.String) // .readme(SampleReadmeProps) // .stale(java.lang.Boolean) // .staleOptions(StaleOptions) // .vscode(java.lang.Boolean) // .allowLibraryDependencies(java.lang.Boolean) // .authorEmail(java.lang.String) // .authorName(java.lang.String) // .authorOrganization(java.lang.Boolean) // .authorUrl(java.lang.String) // .autoDetectBin(java.lang.Boolean) // .bin(java.util.Map) // .bugsEmail(java.lang.String) // .bugsUrl(java.lang.String) // .bundledDeps(java.util.List) // .codeArtifactOptions(CodeArtifactOptions) // .deps(java.util.List) // .description(java.lang.String) // .devDeps(java.util.List) // .entrypoint(java.lang.String) // .homepage(java.lang.String) // .keywords(java.util.List) // .license(java.lang.String) // .licensed(java.lang.Boolean) // .maxNodeVersion(java.lang.String) // .minNodeVersion(java.lang.String) // .npmAccess(NpmAccess) // .npmRegistry(java.lang.String) // .npmRegistryUrl(java.lang.String) // .npmTokenSecret(java.lang.String) // .packageManager(NodePackageManager) // .packageName(java.lang.String) // .peerDependencyOptions(PeerDependencyOptions) // .peerDeps(java.util.List) // .pnpmVersion(java.lang.String) // .repository(java.lang.String) // .repositoryDirectory(java.lang.String) // .scopedPackagesOptions(java.util.List) // .scripts(java.util.Map) // .stability(java.lang.String) // .jsiiReleaseVersion(java.lang.String) // .majorVersion(java.lang.Number) // .minMajorVersion(java.lang.Number) // .npmDistTag(java.lang.String) // .postBuildSteps(java.util.List) // .prerelease(java.lang.String) // .publishDryRun(java.lang.Boolean) // .publishTasks(java.lang.Boolean) // .releaseBranches(java.util.Map) // .releaseEveryCommit(java.lang.Boolean) // .releaseFailureIssue(java.lang.Boolean) // .releaseFailureIssueLabel(java.lang.String) // .releaseSchedule(java.lang.String) // .releaseTagPrefix(java.lang.String) // .releaseTrigger(ReleaseTrigger) // .releaseWorkflowName(java.lang.String) // .releaseWorkflowSetupSteps(java.util.List) // .versionrcOptions(java.util.Map) // .workflowContainerImage(java.lang.String) // .workflowRunsOn(java.util.List) .defaultReleaseBranch(java.lang.String) // .artifactsDirectory(java.lang.String) // .autoApproveUpgrades(java.lang.Boolean) // .buildWorkflow(java.lang.Boolean) // .buildWorkflowTriggers(Triggers) // .bundlerOptions(BundlerOptions) // .codeCov(java.lang.Boolean) // .codeCovTokenSecret(java.lang.String) // .copyrightOwner(java.lang.String) // .copyrightPeriod(java.lang.String) // .dependabot(java.lang.Boolean) // .dependabotOptions(DependabotOptions) // .depsUpgrade(java.lang.Boolean) // .depsUpgradeOptions(UpgradeDependenciesOptions) // .gitignore(java.util.List) // .jest(java.lang.Boolean) // .jestOptions(JestOptions) // .mutableBuild(java.lang.Boolean) // .npmignore(java.util.List) // .npmignoreEnabled(java.lang.Boolean) // .npmIgnoreOptions(IgnoreFileOptions) // .package(java.lang.Boolean) // .prettier(java.lang.Boolean) // .prettierOptions(PrettierOptions) // .projenDevDependency(java.lang.Boolean) // .projenrcJs(java.lang.Boolean) // .projenrcJsOptions(ProjenrcOptions) // .projenVersion(java.lang.String) // .pullRequestTemplate(java.lang.Boolean) // .pullRequestTemplateContents(java.util.List) // .release(java.lang.Boolean) // .releaseToNpm(java.lang.Boolean) // .releaseWorkflow(java.lang.Boolean) // .workflowBootstrapSteps(java.util.List) // .workflowGitIdentity(GitIdentity) // .workflowNodeVersion(java.lang.String) // .workflowPackageCache(java.lang.Boolean) // .disableTsconfig(java.lang.Boolean) // .disableTsconfigDev(java.lang.Boolean) // .docgen(java.lang.Boolean) // .docsDirectory(java.lang.String) // .entrypointTypes(java.lang.String) // .eslint(java.lang.Boolean) // .eslintOptions(EslintOptions) // .libdir(java.lang.String) // .projenrcTs(java.lang.Boolean) // .projenrcTsOptions(ProjenrcOptions) // .sampleCode(java.lang.Boolean) // .srcdir(java.lang.String) // .testdir(java.lang.String) // .tsconfig(TypescriptConfigOptions) // .tsconfigDev(TypescriptConfigOptions) // .tsconfigDevFile(java.lang.String) // .typescriptVersion(java.lang.String) // .buildCommand(java.lang.String) // .cdkout(java.lang.String) // .context(java.util.Map) // .featureFlags(java.lang.Boolean) // .requireApproval(ApprovalLevel) // .watchExcludes(java.util.List) // .watchIncludes(java.util.List) .cdkVersion(java.lang.String) // .cdkAssert(java.lang.Boolean) // .cdkAssertions(java.lang.Boolean) // .cdkDependencies(java.util.List) // .cdkDependenciesAsDeps(java.lang.Boolean) // .cdkTestDependencies(java.util.List) // .cdkVersionPinning(java.lang.Boolean) // .constructsVersion(java.lang.String) // .appEntrypoint(java.lang.String) // .edgeLambdaAutoDiscover(java.lang.Boolean) // .integrationTestAutoDiscover(java.lang.Boolean) // .lambdaAutoDiscover(java.lang.Boolean) // .lambdaExtensionAutoDiscover(java.lang.Boolean) // .lambdaOptions(LambdaFunctionCommonOptions) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | java.lang.String | This is the name of your project. | | commitGenerated | java.lang.Boolean | Whether to commit the managed files by default. | | gitIgnoreOptions | io.github.cdklabs.projen.IgnoreFileOptions | Configuration options for .gitignore file. | | gitOptions | io.github.cdklabs.projen.GitOptions | Configuration options for git. | | logging | io.github.cdklabs.projen.LoggerOptions | Configure logging options such as verbosity. | | outdir | java.lang.String | The root directory of the project. | | parent | io.github.cdklabs.projen.Project | The parent project, if this project is part of a bigger project. | | projenCommand | java.lang.String | The shell command to use in order to run the projen CLI. | | projenrcJson | java.lang.Boolean | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. | | projenrcJsonOptions | io.github.cdklabs.projen.ProjenrcJsonOptions | Options for .projenrc.json. | | renovatebot | java.lang.Boolean | Use renovatebot to handle dependency upgrades. | | renovatebotOptions | io.github.cdklabs.projen.RenovatebotOptions | Options for renovatebot. | | autoApproveOptions | io.github.cdklabs.projen.github.AutoApproveOptions | Enable and configure the 'auto approve' workflow. | | autoMerge | java.lang.Boolean | Enable automatic merging on GitHub. | | autoMergeOptions | io.github.cdklabs.projen.github.AutoMergeOptions | Configure options for automatic merging on GitHub. | | clobber | java.lang.Boolean | Add a `clobber` task which resets the repo to origin. | | devContainer | java.lang.Boolean | Add a VSCode development environment (used for GitHub Codespaces). | | github | java.lang.Boolean | Enable GitHub integration. | | githubOptions | io.github.cdklabs.projen.github.GitHubOptions | Options for GitHub integration. | | gitpod | java.lang.Boolean | Add a Gitpod development environment. | | mergify | java.lang.Boolean | Whether mergify should be enabled on this repository or not. | | mergifyOptions | io.github.cdklabs.projen.github.MergifyOptions | Options for mergify. | | projectType | io.github.cdklabs.projen.ProjectType | Which type of project this is (library/app). | | projenCredentials | io.github.cdklabs.projen.github.GithubCredentials | Choose a method of providing GitHub API access for projen workflows. | | projenTokenSecret | java.lang.String | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. | | readme | io.github.cdklabs.projen.SampleReadmeProps | The README setup. | | stale | java.lang.Boolean | Auto-close of stale issues and pull request. | | staleOptions | io.github.cdklabs.projen.github.StaleOptions | Auto-close stale issues and pull requests. | | vscode | java.lang.Boolean | Enable VSCode integration. | | allowLibraryDependencies | java.lang.Boolean | Allow the project to include `peerDependencies` and `bundledDependencies`. | | authorEmail | java.lang.String | Author's e-mail. | | authorName | java.lang.String | Author's name. | | authorOrganization | java.lang.Boolean | Is the author an organization. | | authorUrl | java.lang.String | Author's URL / Website. | | autoDetectBin | java.lang.Boolean | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. | | bin | java.util.Map | Binary programs vended with your module. | | bugsEmail | java.lang.String | The email address to which issues should be reported. | | bugsUrl | java.lang.String | The url to your project's issue tracker. | | bundledDeps | java.util.List | List of dependencies to bundle into this module. | | codeArtifactOptions | io.github.cdklabs.projen.javascript.CodeArtifactOptions | Options for npm packages using AWS CodeArtifact. | | deps | java.util.List | Runtime dependencies of this module. | | description | java.lang.String | The description is just a string that helps people understand the purpose of the package. | | devDeps | java.util.List | Build dependencies for this module. | | entrypoint | java.lang.String | Module entrypoint (`main` in `package.json`). | | homepage | java.lang.String | Package's Homepage / Website. | | keywords | java.util.List | Keywords to include in `package.json`. | | license | java.lang.String | License's SPDX identifier. | | licensed | java.lang.Boolean | Indicates if a license should be added. | | maxNodeVersion | java.lang.String | Minimum node.js version to require via `engines` (inclusive). | | minNodeVersion | java.lang.String | Minimum Node.js version to require via package.json `engines` (inclusive). | | npmAccess | io.github.cdklabs.projen.javascript.NpmAccess | Access level of the npm package. | | npmRegistry | java.lang.String | The host name of the npm registry to publish to. | | npmRegistryUrl | java.lang.String | The base URL of the npm package registry. | | npmTokenSecret | java.lang.String | GitHub secret which contains the NPM token to use when publishing packages. | | packageManager | io.github.cdklabs.projen.javascript.NodePackageManager | The Node Package Manager used to execute scripts. | | packageName | java.lang.String | The "name" in package.json. | | peerDependencyOptions | io.github.cdklabs.projen.javascript.PeerDependencyOptions | Options for `peerDeps`. | | peerDeps | java.util.List | Peer dependencies for this module. | | pnpmVersion | java.lang.String | The version of PNPM to use if using PNPM as a package manager. | | repository | java.lang.String | The repository is the location where the actual code for your package lives. | | repositoryDirectory | java.lang.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 | java.util.List | Options for privately hosted scoped packages. | | scripts | java.util.Map | npm scripts to include. | | stability | java.lang.String | Package's Stability. | | jsiiReleaseVersion | java.lang.String | Version requirement of `publib` which is used to publish modules to npm. | | majorVersion | java.lang.Number | Major version to release from the default branch. | | minMajorVersion | java.lang.Number | Minimal Major version to release. | | npmDistTag | java.lang.String | The npmDistTag to use when publishing from the default branch. | | postBuildSteps | java.util.List | Steps to execute after build as part of the release workflow. | | prerelease | java.lang.String | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). | | publishDryRun | java.lang.Boolean | Instead of actually publishing to package managers, just print the publishing command. | | publishTasks | java.lang.Boolean | Define publishing tasks that can be executed manually as well as workflows. | | releaseBranches | java.util.Map | Defines additional release branches. | | releaseEveryCommit | java.lang.Boolean | Automatically release new versions every commit to one of branches in `releaseBranches`. | | releaseFailureIssue | java.lang.Boolean | Create a github issue on every failed publishing task. | | releaseFailureIssueLabel | java.lang.String | The label to apply to issues indicating publish failures. | | releaseSchedule | java.lang.String | CRON schedule to trigger new releases. | | releaseTagPrefix | java.lang.String | Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. | | releaseTrigger | io.github.cdklabs.projen.release.ReleaseTrigger | The release trigger to use. | | releaseWorkflowName | java.lang.String | The name of the default release workflow. | | releaseWorkflowSetupSteps | java.util.List | A set of workflow steps to execute in order to setup the workflow container. | | versionrcOptions | java.util.Map | Custom configuration used when creating changelog with standard-version package. | | workflowContainerImage | java.lang.String | Container image to use for GitHub workflows. | | workflowRunsOn | java.util.List | Github Runner selection labels. | | defaultReleaseBranch | java.lang.String | The name of the main release branch. | | artifactsDirectory | java.lang.String | A directory which will contain build artifacts. | | autoApproveUpgrades | java.lang.Boolean | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). | | buildWorkflow | java.lang.Boolean | Define a GitHub workflow for building PRs. | | buildWorkflowTriggers | io.github.cdklabs.projen.github.workflows.Triggers | Build workflow triggers. | | bundlerOptions | io.github.cdklabs.projen.javascript.BundlerOptions | Options for `Bundler`. | | codeCov | java.lang.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 | java.lang.String | Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. | | copyrightOwner | java.lang.String | License copyright owner. | | copyrightPeriod | java.lang.String | The copyright years to put in the LICENSE file. | | dependabot | java.lang.Boolean | Use dependabot to handle dependency upgrades. | | dependabotOptions | io.github.cdklabs.projen.github.DependabotOptions | Options for dependabot. | | depsUpgrade | java.lang.Boolean | Use github workflows to handle dependency upgrades. | | depsUpgradeOptions | io.github.cdklabs.projen.javascript.UpgradeDependenciesOptions | Options for `UpgradeDependencies`. | | gitignore | java.util.List | Additional entries to .gitignore. | | jest | java.lang.Boolean | Setup jest unit tests. | | jestOptions | io.github.cdklabs.projen.javascript.JestOptions | Jest options. | | mutableBuild | java.lang.Boolean | Automatically update files modified during builds to pull-request branches. | | npmignore | java.util.List | Additional entries to .npmignore. | | npmignoreEnabled | java.lang.Boolean | Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. | | npmIgnoreOptions | io.github.cdklabs.projen.IgnoreFileOptions | Configuration options for .npmignore file. | | package | java.lang.Boolean | Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). | | prettier | java.lang.Boolean | Setup prettier. | | prettierOptions | io.github.cdklabs.projen.javascript.PrettierOptions | Prettier options. | | projenDevDependency | java.lang.Boolean | Indicates of "projen" should be installed as a devDependency. | | projenrcJs | java.lang.Boolean | Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. | | projenrcJsOptions | io.github.cdklabs.projen.javascript.ProjenrcOptions | Options for .projenrc.js. | | projenVersion | java.lang.String | Version of projen to install. | | pullRequestTemplate | java.lang.Boolean | Include a GitHub pull request template. | | pullRequestTemplateContents | java.util.List | The contents of the pull request template. | | release | java.lang.Boolean | Add release management to this project. | | releaseToNpm | java.lang.Boolean | Automatically release to npm when new versions are introduced. | | releaseWorkflow | java.lang.Boolean | DEPRECATED: renamed to `release`. | | workflowBootstrapSteps | java.util.List | Workflow steps to use in order to bootstrap this repo. | | workflowGitIdentity | io.github.cdklabs.projen.github.GitIdentity | The git identity to use in workflows. | | workflowNodeVersion | java.lang.String | The node version to use in GitHub workflows. | | workflowPackageCache | java.lang.Boolean | Enable Node.js package cache in GitHub workflows. | | disableTsconfig | java.lang.Boolean | Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). | | disableTsconfigDev | java.lang.Boolean | Do not generate a `tsconfig.dev.json` file. | | docgen | java.lang.Boolean | Docgen by Typedoc. | | docsDirectory | java.lang.String | Docs directory. | | entrypointTypes | java.lang.String | The .d.ts file that includes the type declarations for this module. | | eslint | java.lang.Boolean | Setup eslint. | | eslintOptions | io.github.cdklabs.projen.javascript.EslintOptions | Eslint options. | | libdir | java.lang.String | Typescript artifacts output directory. | | projenrcTs | java.lang.Boolean | Use TypeScript for your projenrc file (`.projenrc.ts`). | | projenrcTsOptions | io.github.cdklabs.projen.typescript.ProjenrcOptions | Options for .projenrc.ts. | | sampleCode | java.lang.Boolean | Generate one-time sample in `src/` and `test/` if there are no files there. | | srcdir | java.lang.String | Typescript sources directory. | | testdir | java.lang.String | Jest tests directory. Tests files should be named `xxx.test.ts`. | | tsconfig | io.github.cdklabs.projen.javascript.TypescriptConfigOptions | Custom TSConfig. | | tsconfigDev | io.github.cdklabs.projen.javascript.TypescriptConfigOptions | Custom tsconfig options for the development tsconfig.json file (used for testing). | | tsconfigDevFile | java.lang.String | The name of the development tsconfig.json file. | | typescriptVersion | java.lang.String | TypeScript version to use. | | buildCommand | java.lang.String | A command to execute before synthesis. | | cdkout | java.lang.String | cdk.out directory. | | context | java.util.Map | Additional context to include in `cdk.json`. | | featureFlags | java.lang.Boolean | Include all feature flags in cdk.json. | | requireApproval | io.github.cdklabs.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 | java.util.List | Glob patterns to exclude from `cdk watch`. | | watchIncludes | java.util.List | Glob patterns to include in `cdk watch`. | | cdkVersion | java.lang.String | Minimum version of the AWS CDK to depend on. | | cdkAssert | java.lang.Boolean | Warning: NodeJS only. | | cdkAssertions | java.lang.Boolean | Install the assertions library? | | cdkDependencies | java.util.List | Which AWS CDKv1 modules this project requires. | | cdkDependenciesAsDeps | java.lang.Boolean | If this is enabled (default), all modules declared in `cdkDependencies` will be also added as normal `dependencies` (as well as `peerDependencies`). | | cdkTestDependencies | java.util.List | AWS CDK modules required for testing. | | cdkVersionPinning | java.lang.Boolean | Use pinned version instead of caret version for CDK. | | constructsVersion | java.lang.String | Minimum version of the `constructs` library to depend on. | | appEntrypoint | java.lang.String | The CDK app's entrypoint (relative to the source directory, which is "src" by default). | | edgeLambdaAutoDiscover | java.lang.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 | java.lang.Boolean | Automatically discovers and creates integration tests for each `.integ.ts` file in under your test directory. | | lambdaAutoDiscover | java.lang.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 | java.lang.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 | io.github.cdklabs.projen.awscdk.LambdaFunctionCommonOptions | Common options for all AWS Lambda functions. | --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String - *Default:* $BASEDIR This is the name of your project. --- ##### `commitGenerated`^Optional ```java public java.lang.Boolean getCommitGenerated(); ``` - *Type:* java.lang.Boolean - *Default:* true Whether to commit the managed files by default. --- ##### `gitIgnoreOptions`^Optional ```java public IgnoreFileOptions getGitIgnoreOptions(); ``` - *Type:* io.github.cdklabs.projen.IgnoreFileOptions Configuration options for .gitignore file. --- ##### `gitOptions`^Optional ```java public GitOptions getGitOptions(); ``` - *Type:* io.github.cdklabs.projen.GitOptions Configuration options for git. --- ##### `logging`^Optional ```java public LoggerOptions getLogging(); ``` - *Type:* io.github.cdklabs.projen.LoggerOptions - *Default:* {} Configure logging options such as verbosity. --- ##### `outdir`^Optional ```java public java.lang.String getOutdir(); ``` - *Type:* java.lang.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 ```java public Project getParent(); ``` - *Type:* io.github.cdklabs.projen.Project The parent project, if this project is part of a bigger project. --- ##### `projenCommand`^Optional ```java public java.lang.String getProjenCommand(); ``` - *Type:* java.lang.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 ```java public java.lang.Boolean getProjenrcJson(); ``` - *Type:* java.lang.Boolean - *Default:* false Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. --- ##### `projenrcJsonOptions`^Optional ```java public ProjenrcJsonOptions getProjenrcJsonOptions(); ``` - *Type:* io.github.cdklabs.projen.ProjenrcJsonOptions - *Default:* default options Options for .projenrc.json. --- ##### `renovatebot`^Optional ```java public java.lang.Boolean getRenovatebot(); ``` - *Type:* java.lang.Boolean - *Default:* false Use renovatebot to handle dependency upgrades. --- ##### `renovatebotOptions`^Optional ```java public RenovatebotOptions getRenovatebotOptions(); ``` - *Type:* io.github.cdklabs.projen.RenovatebotOptions - *Default:* default options Options for renovatebot. --- ##### `autoApproveOptions`^Optional ```java public AutoApproveOptions getAutoApproveOptions(); ``` - *Type:* io.github.cdklabs.projen.github.AutoApproveOptions - *Default:* auto approve is disabled Enable and configure the 'auto approve' workflow. --- ##### `autoMerge`^Optional ```java public java.lang.Boolean getAutoMerge(); ``` - *Type:* java.lang.Boolean - *Default:* true Enable automatic merging on GitHub. Has no effect if `github.mergify` is set to false. --- ##### `autoMergeOptions`^Optional ```java public AutoMergeOptions getAutoMergeOptions(); ``` - *Type:* io.github.cdklabs.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 ```java public java.lang.Boolean getClobber(); ``` - *Type:* java.lang.Boolean - *Default:* true, but false for subprojects Add a `clobber` task which resets the repo to origin. --- ##### `devContainer`^Optional ```java public java.lang.Boolean getDevContainer(); ``` - *Type:* java.lang.Boolean - *Default:* false Add a VSCode development environment (used for GitHub Codespaces). --- ##### `github`^Optional ```java public java.lang.Boolean getGithub(); ``` - *Type:* java.lang.Boolean - *Default:* true Enable GitHub integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `githubOptions`^Optional ```java public GitHubOptions getGithubOptions(); ``` - *Type:* io.github.cdklabs.projen.github.GitHubOptions - *Default:* see GitHubOptions Options for GitHub integration. --- ##### `gitpod`^Optional ```java public java.lang.Boolean getGitpod(); ``` - *Type:* java.lang.Boolean - *Default:* false Add a Gitpod development environment. --- ##### ~~`mergify`~~^Optional - *Deprecated:* use `githubOptions.mergify` instead ```java public java.lang.Boolean getMergify(); ``` - *Type:* java.lang.Boolean - *Default:* true Whether mergify should be enabled on this repository or not. --- ##### ~~`mergifyOptions`~~^Optional - *Deprecated:* use `githubOptions.mergifyOptions` instead ```java public MergifyOptions getMergifyOptions(); ``` - *Type:* io.github.cdklabs.projen.github.MergifyOptions - *Default:* default options Options for mergify. --- ##### ~~`projectType`~~^Optional - *Deprecated:* no longer supported at the base project level ```java public ProjectType getProjectType(); ``` - *Type:* io.github.cdklabs.projen.ProjectType - *Default:* ProjectType.UNKNOWN Which type of project this is (library/app). --- ##### `projenCredentials`^Optional ```java public GithubCredentials getProjenCredentials(); ``` - *Type:* io.github.cdklabs.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` ```java public java.lang.String getProjenTokenSecret(); ``` - *Type:* java.lang.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 ```java public SampleReadmeProps getReadme(); ``` - *Type:* io.github.cdklabs.projen.SampleReadmeProps - *Default:* { filename: 'README.md', contents: '# replace this' } The README setup. --- *Example* ```java "{ filename: 'readme.md', contents: '# title' }" ``` ##### `stale`^Optional ```java public java.lang.Boolean getStale(); ``` - *Type:* java.lang.Boolean - *Default:* false Auto-close of stale issues and pull request. See `staleOptions` for options. --- ##### `staleOptions`^Optional ```java public StaleOptions getStaleOptions(); ``` - *Type:* io.github.cdklabs.projen.github.StaleOptions - *Default:* see defaults in `StaleOptions` Auto-close stale issues and pull requests. To disable set `stale` to `false`. --- ##### `vscode`^Optional ```java public java.lang.Boolean getVscode(); ``` - *Type:* java.lang.Boolean - *Default:* true Enable VSCode integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `allowLibraryDependencies`^Optional ```java public java.lang.Boolean getAllowLibraryDependencies(); ``` - *Type:* java.lang.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 ```java public java.lang.String getAuthorEmail(); ``` - *Type:* java.lang.String Author's e-mail. --- ##### `authorName`^Optional ```java public java.lang.String getAuthorName(); ``` - *Type:* java.lang.String Author's name. --- ##### `authorOrganization`^Optional ```java public java.lang.Boolean getAuthorOrganization(); ``` - *Type:* java.lang.Boolean Is the author an organization. --- ##### `authorUrl`^Optional ```java public java.lang.String getAuthorUrl(); ``` - *Type:* java.lang.String Author's URL / Website. --- ##### `autoDetectBin`^Optional ```java public java.lang.Boolean getAutoDetectBin(); ``` - *Type:* java.lang.Boolean - *Default:* true Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. --- ##### `bin`^Optional ```java public java.util.Map getBin(); ``` - *Type:* java.util.Map 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 ```java public java.lang.String getBugsEmail(); ``` - *Type:* java.lang.String The email address to which issues should be reported. --- ##### `bugsUrl`^Optional ```java public java.lang.String getBugsUrl(); ``` - *Type:* java.lang.String The url to your project's issue tracker. --- ##### `bundledDeps`^Optional ```java public java.util.List getBundledDeps(); ``` - *Type:* java.util.List 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 ```java public CodeArtifactOptions getCodeArtifactOptions(); ``` - *Type:* io.github.cdklabs.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 ```java public java.util.List getDeps(); ``` - *Type:* java.util.List - *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* ```java [ 'express', 'lodash', 'foo@^2' ] ``` ##### `description`^Optional ```java public java.lang.String getDescription(); ``` - *Type:* java.lang.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 ```java public java.util.List getDevDeps(); ``` - *Type:* java.util.List - *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* ```java [ 'typescript', '@types/express' ] ``` ##### `entrypoint`^Optional ```java public java.lang.String getEntrypoint(); ``` - *Type:* java.lang.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 ```java public java.lang.String getHomepage(); ``` - *Type:* java.lang.String Package's Homepage / Website. --- ##### `keywords`^Optional ```java public java.util.List getKeywords(); ``` - *Type:* java.util.List Keywords to include in `package.json`. --- ##### `license`^Optional ```java public java.lang.String getLicense(); ``` - *Type:* java.lang.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 ```java public java.lang.Boolean getLicensed(); ``` - *Type:* java.lang.Boolean - *Default:* true Indicates if a license should be added. --- ##### `maxNodeVersion`^Optional ```java public java.lang.String getMaxNodeVersion(); ``` - *Type:* java.lang.String - *Default:* no max Minimum node.js version to require via `engines` (inclusive). --- ##### `minNodeVersion`^Optional ```java public java.lang.String getMinNodeVersion(); ``` - *Type:* java.lang.String - *Default:* no "engines" specified Minimum Node.js version to require via package.json `engines` (inclusive). --- ##### `npmAccess`^Optional ```java public NpmAccess getNpmAccess(); ``` - *Type:* io.github.cdklabs.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 ```java public java.lang.String getNpmRegistry(); ``` - *Type:* java.lang.String The host name of the npm registry to publish to. Cannot be set together with `npmRegistryUrl`. --- ##### `npmRegistryUrl`^Optional ```java public java.lang.String getNpmRegistryUrl(); ``` - *Type:* java.lang.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 ```java public java.lang.String getNpmTokenSecret(); ``` - *Type:* java.lang.String - *Default:* "NPM_TOKEN" GitHub secret which contains the NPM token to use when publishing packages. --- ##### `packageManager`^Optional ```java public NodePackageManager getPackageManager(); ``` - *Type:* io.github.cdklabs.projen.javascript.NodePackageManager - *Default:* NodePackageManager.YARN The Node Package Manager used to execute scripts. --- ##### `packageName`^Optional ```java public java.lang.String getPackageName(); ``` - *Type:* java.lang.String - *Default:* defaults to project name The "name" in package.json. --- ##### `peerDependencyOptions`^Optional ```java public PeerDependencyOptions getPeerDependencyOptions(); ``` - *Type:* io.github.cdklabs.projen.javascript.PeerDependencyOptions Options for `peerDeps`. --- ##### `peerDeps`^Optional ```java public java.util.List getPeerDeps(); ``` - *Type:* java.util.List - *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 ```java public java.lang.String getPnpmVersion(); ``` - *Type:* java.lang.String - *Default:* "7" The version of PNPM to use if using PNPM as a package manager. --- ##### `repository`^Optional ```java public java.lang.String getRepository(); ``` - *Type:* java.lang.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 ```java public java.lang.String getRepositoryDirectory(); ``` - *Type:* java.lang.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 ```java public java.util.List getScopedPackagesOptions(); ``` - *Type:* java.util.List - *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()` ```java public java.util.Map getScripts(); ``` - *Type:* java.util.Map - *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 ```java public java.lang.String getStability(); ``` - *Type:* java.lang.String Package's Stability. --- ##### `jsiiReleaseVersion`^Optional ```java public java.lang.String getJsiiReleaseVersion(); ``` - *Type:* java.lang.String - *Default:* "latest" Version requirement of `publib` which is used to publish modules to npm. --- ##### `majorVersion`^Optional ```java public java.lang.Number getMajorVersion(); ``` - *Type:* java.lang.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 ```java public java.lang.Number getMinMajorVersion(); ``` - *Type:* java.lang.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 ```java public java.lang.String getNpmDistTag(); ``` - *Type:* java.lang.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 ```java public java.util.List getPostBuildSteps(); ``` - *Type:* java.util.List - *Default:* [] Steps to execute after build as part of the release workflow. --- ##### `prerelease`^Optional ```java public java.lang.String getPrerelease(); ``` - *Type:* java.lang.String - *Default:* normal semantic versions Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). --- ##### `publishDryRun`^Optional ```java public java.lang.Boolean getPublishDryRun(); ``` - *Type:* java.lang.Boolean - *Default:* false Instead of actually publishing to package managers, just print the publishing command. --- ##### `publishTasks`^Optional ```java public java.lang.Boolean getPublishTasks(); ``` - *Type:* java.lang.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 ```java public java.util.Map getReleaseBranches(); ``` - *Type:* java.util.Map - *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 ```java public java.lang.Boolean getReleaseEveryCommit(); ``` - *Type:* java.lang.Boolean - *Default:* true Automatically release new versions every commit to one of branches in `releaseBranches`. --- ##### `releaseFailureIssue`^Optional ```java public java.lang.Boolean getReleaseFailureIssue(); ``` - *Type:* java.lang.Boolean - *Default:* false Create a github issue on every failed publishing task. --- ##### `releaseFailureIssueLabel`^Optional ```java public java.lang.String getReleaseFailureIssueLabel(); ``` - *Type:* java.lang.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 ```java public java.lang.String getReleaseSchedule(); ``` - *Type:* java.lang.String - *Default:* no scheduled releases CRON schedule to trigger new releases. --- ##### `releaseTagPrefix`^Optional ```java public java.lang.String getReleaseTagPrefix(); ``` - *Type:* java.lang.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 ```java public ReleaseTrigger getReleaseTrigger(); ``` - *Type:* io.github.cdklabs.projen.release.ReleaseTrigger - *Default:* Continuous releases (`ReleaseTrigger.continuous()`) The release trigger to use. --- ##### `releaseWorkflowName`^Optional ```java public java.lang.String getReleaseWorkflowName(); ``` - *Type:* java.lang.String - *Default:* "Release" The name of the default release workflow. --- ##### `releaseWorkflowSetupSteps`^Optional ```java public java.util.List getReleaseWorkflowSetupSteps(); ``` - *Type:* java.util.List A set of workflow steps to execute in order to setup the workflow container. --- ##### `versionrcOptions`^Optional ```java public java.util.Map getVersionrcOptions(); ``` - *Type:* java.util.Map - *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 ```java public java.lang.String getWorkflowContainerImage(); ``` - *Type:* java.lang.String - *Default:* default image Container image to use for GitHub workflows. --- ##### `workflowRunsOn`^Optional ```java public java.util.List getWorkflowRunsOn(); ``` - *Type:* java.util.List - *Default:* ["ubuntu-latest"] Github Runner selection labels. --- ##### `defaultReleaseBranch`^Required ```java public java.lang.String getDefaultReleaseBranch(); ``` - *Type:* java.lang.String - *Default:* "main" The name of the main release branch. --- ##### `artifactsDirectory`^Optional ```java public java.lang.String getArtifactsDirectory(); ``` - *Type:* java.lang.String - *Default:* "dist" A directory which will contain build artifacts. --- ##### `autoApproveUpgrades`^Optional ```java public java.lang.Boolean getAutoApproveUpgrades(); ``` - *Type:* java.lang.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 ```java public java.lang.Boolean getBuildWorkflow(); ``` - *Type:* java.lang.Boolean - *Default:* true if not a subproject Define a GitHub workflow for building PRs. --- ##### `buildWorkflowTriggers`^Optional ```java public Triggers getBuildWorkflowTriggers(); ``` - *Type:* io.github.cdklabs.projen.github.workflows.Triggers - *Default:* "{ pullRequest: {}, workflowDispatch: {} }" Build workflow triggers. --- ##### `bundlerOptions`^Optional ```java public BundlerOptions getBundlerOptions(); ``` - *Type:* io.github.cdklabs.projen.javascript.BundlerOptions Options for `Bundler`. --- ##### `codeCov`^Optional ```java public java.lang.Boolean getCodeCov(); ``` - *Type:* java.lang.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 ```java public java.lang.String getCodeCovTokenSecret(); ``` - *Type:* java.lang.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 ```java public java.lang.String getCopyrightOwner(); ``` - *Type:* java.lang.String - *Default:* defaults to the value of authorName or "" if `authorName` is undefined. License copyright owner. --- ##### `copyrightPeriod`^Optional ```java public java.lang.String getCopyrightPeriod(); ``` - *Type:* java.lang.String - *Default:* current year The copyright years to put in the LICENSE file. --- ##### `dependabot`^Optional ```java public java.lang.Boolean getDependabot(); ``` - *Type:* java.lang.Boolean - *Default:* false Use dependabot to handle dependency upgrades. Cannot be used in conjunction with `depsUpgrade`. --- ##### `dependabotOptions`^Optional ```java public DependabotOptions getDependabotOptions(); ``` - *Type:* io.github.cdklabs.projen.github.DependabotOptions - *Default:* default options Options for dependabot. --- ##### `depsUpgrade`^Optional ```java public java.lang.Boolean getDepsUpgrade(); ``` - *Type:* java.lang.Boolean - *Default:* true Use github workflows to handle dependency upgrades. Cannot be used in conjunction with `dependabot`. --- ##### `depsUpgradeOptions`^Optional ```java public UpgradeDependenciesOptions getDepsUpgradeOptions(); ``` - *Type:* io.github.cdklabs.projen.javascript.UpgradeDependenciesOptions - *Default:* default options Options for `UpgradeDependencies`. --- ##### `gitignore`^Optional ```java public java.util.List getGitignore(); ``` - *Type:* java.util.List Additional entries to .gitignore. --- ##### `jest`^Optional ```java public java.lang.Boolean getJest(); ``` - *Type:* java.lang.Boolean - *Default:* true Setup jest unit tests. --- ##### `jestOptions`^Optional ```java public JestOptions getJestOptions(); ``` - *Type:* io.github.cdklabs.projen.javascript.JestOptions - *Default:* default options Jest options. --- ##### `mutableBuild`^Optional ```java public java.lang.Boolean getMutableBuild(); ``` - *Type:* java.lang.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` ```java public java.util.List getNpmignore(); ``` - *Type:* java.util.List Additional entries to .npmignore. --- ##### `npmignoreEnabled`^Optional ```java public java.lang.Boolean getNpmignoreEnabled(); ``` - *Type:* java.lang.Boolean - *Default:* true Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. --- ##### `npmIgnoreOptions`^Optional ```java public IgnoreFileOptions getNpmIgnoreOptions(); ``` - *Type:* io.github.cdklabs.projen.IgnoreFileOptions Configuration options for .npmignore file. --- ##### `package`^Optional ```java public java.lang.Boolean getPackage(); ``` - *Type:* java.lang.Boolean - *Default:* true Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). --- ##### `prettier`^Optional ```java public java.lang.Boolean getPrettier(); ``` - *Type:* java.lang.Boolean - *Default:* false Setup prettier. --- ##### `prettierOptions`^Optional ```java public PrettierOptions getPrettierOptions(); ``` - *Type:* io.github.cdklabs.projen.javascript.PrettierOptions - *Default:* default options Prettier options. --- ##### `projenDevDependency`^Optional ```java public java.lang.Boolean getProjenDevDependency(); ``` - *Type:* java.lang.Boolean - *Default:* true Indicates of "projen" should be installed as a devDependency. --- ##### `projenrcJs`^Optional ```java public java.lang.Boolean getProjenrcJs(); ``` - *Type:* java.lang.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 ```java public ProjenrcOptions getProjenrcJsOptions(); ``` - *Type:* io.github.cdklabs.projen.javascript.ProjenrcOptions - *Default:* default options Options for .projenrc.js. --- ##### `projenVersion`^Optional ```java public java.lang.String getProjenVersion(); ``` - *Type:* java.lang.String - *Default:* Defaults to the latest version. Version of projen to install. --- ##### `pullRequestTemplate`^Optional ```java public java.lang.Boolean getPullRequestTemplate(); ``` - *Type:* java.lang.Boolean - *Default:* true Include a GitHub pull request template. --- ##### `pullRequestTemplateContents`^Optional ```java public java.util.List getPullRequestTemplateContents(); ``` - *Type:* java.util.List - *Default:* default content The contents of the pull request template. --- ##### `release`^Optional ```java public java.lang.Boolean getRelease(); ``` - *Type:* java.lang.Boolean - *Default:* true (false for subprojects) Add release management to this project. --- ##### `releaseToNpm`^Optional ```java public java.lang.Boolean getReleaseToNpm(); ``` - *Type:* java.lang.Boolean - *Default:* false Automatically release to npm when new versions are introduced. --- ##### ~~`releaseWorkflow`~~^Optional - *Deprecated:* see `release`. ```java public java.lang.Boolean getReleaseWorkflow(); ``` - *Type:* java.lang.Boolean - *Default:* true if not a subproject DEPRECATED: renamed to `release`. --- ##### `workflowBootstrapSteps`^Optional ```java public java.util.List getWorkflowBootstrapSteps(); ``` - *Type:* java.util.List - *Default:* "yarn install --frozen-lockfile && yarn projen" Workflow steps to use in order to bootstrap this repo. --- ##### `workflowGitIdentity`^Optional ```java public GitIdentity getWorkflowGitIdentity(); ``` - *Type:* io.github.cdklabs.projen.github.GitIdentity - *Default:* GitHub Actions The git identity to use in workflows. --- ##### `workflowNodeVersion`^Optional ```java public java.lang.String getWorkflowNodeVersion(); ``` - *Type:* java.lang.String - *Default:* same as `minNodeVersion` The node version to use in GitHub workflows. --- ##### `workflowPackageCache`^Optional ```java public java.lang.Boolean getWorkflowPackageCache(); ``` - *Type:* java.lang.Boolean - *Default:* false Enable Node.js package cache in GitHub workflows. --- ##### `disableTsconfig`^Optional ```java public java.lang.Boolean getDisableTsconfig(); ``` - *Type:* java.lang.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 ```java public java.lang.Boolean getDisableTsconfigDev(); ``` - *Type:* java.lang.Boolean - *Default:* false Do not generate a `tsconfig.dev.json` file. --- ##### `docgen`^Optional ```java public java.lang.Boolean getDocgen(); ``` - *Type:* java.lang.Boolean - *Default:* false Docgen by Typedoc. --- ##### `docsDirectory`^Optional ```java public java.lang.String getDocsDirectory(); ``` - *Type:* java.lang.String - *Default:* "docs" Docs directory. --- ##### `entrypointTypes`^Optional ```java public java.lang.String getEntrypointTypes(); ``` - *Type:* java.lang.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 ```java public java.lang.Boolean getEslint(); ``` - *Type:* java.lang.Boolean - *Default:* true Setup eslint. --- ##### `eslintOptions`^Optional ```java public EslintOptions getEslintOptions(); ``` - *Type:* io.github.cdklabs.projen.javascript.EslintOptions - *Default:* opinionated default options Eslint options. --- ##### `libdir`^Optional ```java public java.lang.String getLibdir(); ``` - *Type:* java.lang.String - *Default:* "lib" Typescript artifacts output directory. --- ##### `projenrcTs`^Optional ```java public java.lang.Boolean getProjenrcTs(); ``` - *Type:* java.lang.Boolean - *Default:* false Use TypeScript for your projenrc file (`.projenrc.ts`). --- ##### `projenrcTsOptions`^Optional ```java public ProjenrcOptions getProjenrcTsOptions(); ``` - *Type:* io.github.cdklabs.projen.typescript.ProjenrcOptions Options for .projenrc.ts. --- ##### `sampleCode`^Optional ```java public java.lang.Boolean getSampleCode(); ``` - *Type:* java.lang.Boolean - *Default:* true Generate one-time sample in `src/` and `test/` if there are no files there. --- ##### `srcdir`^Optional ```java public java.lang.String getSrcdir(); ``` - *Type:* java.lang.String - *Default:* "src" Typescript sources directory. --- ##### `testdir`^Optional ```java public java.lang.String getTestdir(); ``` - *Type:* java.lang.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 ```java public TypescriptConfigOptions getTsconfig(); ``` - *Type:* io.github.cdklabs.projen.javascript.TypescriptConfigOptions - *Default:* default options Custom TSConfig. --- ##### `tsconfigDev`^Optional ```java public TypescriptConfigOptions getTsconfigDev(); ``` - *Type:* io.github.cdklabs.projen.javascript.TypescriptConfigOptions - *Default:* use the production tsconfig options Custom tsconfig options for the development tsconfig.json file (used for testing). --- ##### `tsconfigDevFile`^Optional ```java public java.lang.String getTsconfigDevFile(); ``` - *Type:* java.lang.String - *Default:* "tsconfig.dev.json" The name of the development tsconfig.json file. --- ##### `typescriptVersion`^Optional ```java public java.lang.String getTypescriptVersion(); ``` - *Type:* java.lang.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 ```java public java.lang.String getBuildCommand(); ``` - *Type:* java.lang.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 ```java public java.lang.String getCdkout(); ``` - *Type:* java.lang.String - *Default:* "cdk.out" cdk.out directory. --- ##### `context`^Optional ```java public java.util.Map getContext(); ``` - *Type:* java.util.Map - *Default:* no additional context Additional context to include in `cdk.json`. --- ##### `featureFlags`^Optional ```java public java.lang.Boolean getFeatureFlags(); ``` - *Type:* java.lang.Boolean - *Default:* true Include all feature flags in cdk.json. --- ##### `requireApproval`^Optional ```java public ApprovalLevel getRequireApproval(); ``` - *Type:* io.github.cdklabs.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 ```java public java.util.List getWatchExcludes(); ``` - *Type:* java.util.List - *Default:* [] Glob patterns to exclude from `cdk watch`. --- ##### `watchIncludes`^Optional ```java public java.util.List getWatchIncludes(); ``` - *Type:* java.util.List - *Default:* [] Glob patterns to include in `cdk watch`. --- ##### `cdkVersion`^Required ```java public java.lang.String getCdkVersion(); ``` - *Type:* java.lang.String - *Default:* "2.1.0" Minimum version of the AWS CDK to depend on. --- ##### ~~`cdkAssert`~~^Optional - *Deprecated:* The ```java public java.lang.Boolean getCdkAssert(); ``` - *Type:* java.lang.Boolean - *Default:* will be included by default for AWS CDK >= 1.0.0 < 2.0.0 Warning: NodeJS only. Install the --- ##### `cdkAssertions`^Optional ```java public java.lang.Boolean getCdkAssertions(); ``` - *Type:* java.lang.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) ```java public java.util.List getCdkDependencies(); ``` - *Type:* java.util.List Which AWS CDKv1 modules this project requires. --- ##### ~~`cdkDependenciesAsDeps`~~^Optional - *Deprecated:* Not supported in CDK v2. ```java public java.lang.Boolean getCdkDependenciesAsDeps(); ``` - *Type:* java.lang.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 ```java public java.util.List getCdkTestDependencies(); ``` - *Type:* java.util.List AWS CDK modules required for testing. --- ##### `cdkVersionPinning`^Optional ```java public java.lang.Boolean getCdkVersionPinning(); ``` - *Type:* java.lang.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 ```java public java.lang.String getConstructsVersion(); ``` - *Type:* java.lang.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 ```java public java.lang.String getAppEntrypoint(); ``` - *Type:* java.lang.String - *Default:* "main.ts" The CDK app's entrypoint (relative to the source directory, which is "src" by default). --- ##### `edgeLambdaAutoDiscover`^Optional ```java public java.lang.Boolean getEdgeLambdaAutoDiscover(); ``` - *Type:* java.lang.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 ```java public java.lang.Boolean getIntegrationTestAutoDiscover(); ``` - *Type:* java.lang.Boolean - *Default:* true Automatically discovers and creates integration tests for each `.integ.ts` file in under your test directory. --- ##### `lambdaAutoDiscover`^Optional ```java public java.lang.Boolean getLambdaAutoDiscover(); ``` - *Type:* java.lang.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 ```java public java.lang.Boolean getLambdaExtensionAutoDiscover(); ``` - *Type:* java.lang.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 ```java public LambdaFunctionCommonOptions getLambdaOptions(); ``` - *Type:* io.github.cdklabs.projen.awscdk.LambdaFunctionCommonOptions - *Default:* default options Common options for all AWS Lambda functions. --- ### SonarCodeScannerConfig #### Initializer ```java import software.aws.awsprototypingsdk.pipeline.SonarCodeScannerConfig; SonarCodeScannerConfig.builder() .sonarqubeAuthorizedGroup(java.lang.String) .sonarqubeDefaultProfileOrGateName(java.lang.String) .sonarqubeEndpoint(java.lang.String) .sonarqubeProjectName(java.lang.String) // .cdkOutDir(java.lang.String) // .cfnNagIgnorePath(java.lang.String) // .excludeGlobsForScan(java.util.List) // .includeGlobsForScan(java.util.List) // .preArchiveCommands(java.util.List) // .sonarqubeSpecificProfileOrGateName(java.lang.String) // .sonarqubeTags(java.util.List) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | sonarqubeAuthorizedGroup | java.lang.String | Group name in Sonarqube with access to administer this project. | | sonarqubeDefaultProfileOrGateName | java.lang.String | Default profile/gate name i.e: your org profile. | | sonarqubeEndpoint | java.lang.String | endpoint of the sonarqube instance i.e: https://. | | sonarqubeProjectName | java.lang.String | Name of the project to create in Sonarqube. | | cdkOutDir | java.lang.String | directory containing the synthesized cdk resources. | | cfnNagIgnorePath | java.lang.String | path to a file containing the cfn nag suppression rules. | | excludeGlobsForScan | java.util.List | glob patterns to exclude from sonar scan. | | includeGlobsForScan | java.util.List | glob patterns to include from sonar scan. | | preArchiveCommands | java.util.List | Hook which allows custom commands to be executed before the process commences the archival process. | | sonarqubeSpecificProfileOrGateName | java.lang.String | Specific profile/gate name i.e: language specific. | | sonarqubeTags | java.util.List | Tags to associate with this project. | --- ##### `sonarqubeAuthorizedGroup`^Required ```java public java.lang.String getSonarqubeAuthorizedGroup(); ``` - *Type:* java.lang.String Group name in Sonarqube with access to administer this project. --- ##### `sonarqubeDefaultProfileOrGateName`^Required ```java public java.lang.String getSonarqubeDefaultProfileOrGateName(); ``` - *Type:* java.lang.String Default profile/gate name i.e: your org profile. Note: These need to be set up in Sonarqube manually. --- ##### `sonarqubeEndpoint`^Required ```java public java.lang.String getSonarqubeEndpoint(); ``` - *Type:* java.lang.String endpoint of the sonarqube instance i.e: https://. Note: Ensure a trailing '/' is not included. --- ##### `sonarqubeProjectName`^Required ```java public java.lang.String getSonarqubeProjectName(); ``` - *Type:* java.lang.String Name of the project to create in Sonarqube. --- ##### `cdkOutDir`^Optional ```java public java.lang.String getCdkOutDir(); ``` - *Type:* java.lang.String directory containing the synthesized cdk resources. --- ##### `cfnNagIgnorePath`^Optional ```java public java.lang.String getCfnNagIgnorePath(); ``` - *Type:* java.lang.String path to a file containing the cfn nag suppression rules. --- ##### `excludeGlobsForScan`^Optional ```java public java.util.List getExcludeGlobsForScan(); ``` - *Type:* java.util.List glob patterns to exclude from sonar scan. --- ##### `includeGlobsForScan`^Optional ```java public java.util.List getIncludeGlobsForScan(); ``` - *Type:* java.util.List glob patterns to include from sonar scan. --- ##### `preArchiveCommands`^Optional ```java public java.util.List getPreArchiveCommands(); ``` - *Type:* java.util.List Hook which allows custom commands to be executed before the process commences the archival process. --- ##### `sonarqubeSpecificProfileOrGateName`^Optional ```java public java.lang.String getSonarqubeSpecificProfileOrGateName(); ``` - *Type:* java.lang.String Specific profile/gate name i.e: language specific. Note: These need to be set up in Sonarqube manually. --- ##### `sonarqubeTags`^Optional ```java public java.util.List getSonarqubeTags(); ``` - *Type:* java.util.List Tags to associate with this project. --- ### SonarCodeScannerProps SonarCodeScanners properties. #### Initializer ```java import software.aws.awsprototypingsdk.pipeline.SonarCodeScannerProps; SonarCodeScannerProps.builder() .sonarqubeAuthorizedGroup(java.lang.String) .sonarqubeDefaultProfileOrGateName(java.lang.String) .sonarqubeEndpoint(java.lang.String) .sonarqubeProjectName(java.lang.String) // .cdkOutDir(java.lang.String) // .cfnNagIgnorePath(java.lang.String) // .excludeGlobsForScan(java.util.List) // .includeGlobsForScan(java.util.List) // .preArchiveCommands(java.util.List) // .sonarqubeSpecificProfileOrGateName(java.lang.String) // .sonarqubeTags(java.util.List) .artifactBucketArn(java.lang.String) .synthBuildArn(java.lang.String) // .artifactBucketKeyArn(java.lang.String) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | sonarqubeAuthorizedGroup | java.lang.String | Group name in Sonarqube with access to administer this project. | | sonarqubeDefaultProfileOrGateName | java.lang.String | Default profile/gate name i.e: your org profile. | | sonarqubeEndpoint | java.lang.String | endpoint of the sonarqube instance i.e: https://. | | sonarqubeProjectName | java.lang.String | Name of the project to create in Sonarqube. | | cdkOutDir | java.lang.String | directory containing the synthesized cdk resources. | | cfnNagIgnorePath | java.lang.String | path to a file containing the cfn nag suppression rules. | | excludeGlobsForScan | java.util.List | glob patterns to exclude from sonar scan. | | includeGlobsForScan | java.util.List | glob patterns to include from sonar scan. | | preArchiveCommands | java.util.List | Hook which allows custom commands to be executed before the process commences the archival process. | | sonarqubeSpecificProfileOrGateName | java.lang.String | Specific profile/gate name i.e: language specific. | | sonarqubeTags | java.util.List | Tags to associate with this project. | | artifactBucketArn | java.lang.String | S3 bucket ARN containing the built artifacts from the synth build. | | synthBuildArn | java.lang.String | ARN for the CodeBuild task responsible for executing the synth command. | | artifactBucketKeyArn | java.lang.String | Artifact bucket key ARN used to encrypt the artifacts. | --- ##### `sonarqubeAuthorizedGroup`^Required ```java public java.lang.String getSonarqubeAuthorizedGroup(); ``` - *Type:* java.lang.String Group name in Sonarqube with access to administer this project. --- ##### `sonarqubeDefaultProfileOrGateName`^Required ```java public java.lang.String getSonarqubeDefaultProfileOrGateName(); ``` - *Type:* java.lang.String Default profile/gate name i.e: your org profile. Note: These need to be set up in Sonarqube manually. --- ##### `sonarqubeEndpoint`^Required ```java public java.lang.String getSonarqubeEndpoint(); ``` - *Type:* java.lang.String endpoint of the sonarqube instance i.e: https://. Note: Ensure a trailing '/' is not included. --- ##### `sonarqubeProjectName`^Required ```java public java.lang.String getSonarqubeProjectName(); ``` - *Type:* java.lang.String Name of the project to create in Sonarqube. --- ##### `cdkOutDir`^Optional ```java public java.lang.String getCdkOutDir(); ``` - *Type:* java.lang.String directory containing the synthesized cdk resources. --- ##### `cfnNagIgnorePath`^Optional ```java public java.lang.String getCfnNagIgnorePath(); ``` - *Type:* java.lang.String path to a file containing the cfn nag suppression rules. --- ##### `excludeGlobsForScan`^Optional ```java public java.util.List getExcludeGlobsForScan(); ``` - *Type:* java.util.List glob patterns to exclude from sonar scan. --- ##### `includeGlobsForScan`^Optional ```java public java.util.List getIncludeGlobsForScan(); ``` - *Type:* java.util.List glob patterns to include from sonar scan. --- ##### `preArchiveCommands`^Optional ```java public java.util.List getPreArchiveCommands(); ``` - *Type:* java.util.List Hook which allows custom commands to be executed before the process commences the archival process. --- ##### `sonarqubeSpecificProfileOrGateName`^Optional ```java public java.lang.String getSonarqubeSpecificProfileOrGateName(); ``` - *Type:* java.lang.String Specific profile/gate name i.e: language specific. Note: These need to be set up in Sonarqube manually. --- ##### `sonarqubeTags`^Optional ```java public java.util.List getSonarqubeTags(); ``` - *Type:* java.util.List Tags to associate with this project. --- ##### `artifactBucketArn`^Required ```java public java.lang.String getArtifactBucketArn(); ``` - *Type:* java.lang.String S3 bucket ARN containing the built artifacts from the synth build. --- ##### `synthBuildArn`^Required ```java public java.lang.String getSynthBuildArn(); ``` - *Type:* java.lang.String ARN for the CodeBuild task responsible for executing the synth command. --- ##### `artifactBucketKeyArn`^Optional ```java public java.lang.String getArtifactBucketKeyArn(); ``` - *Type:* java.lang.String Artifact bucket key ARN used to encrypt the artifacts. --- ## Classes ### PDKPipelineJavaProject Synthesizes a Java Project with a CI/CD pipeline. #### Initializers ```java import software.aws.awsprototypingsdk.pipeline.PDKPipelineJavaProject; PDKPipelineJavaProject.Builder.create() .name(java.lang.String) // .commitGenerated(java.lang.Boolean) // .gitIgnoreOptions(IgnoreFileOptions) // .gitOptions(GitOptions) // .logging(LoggerOptions) // .outdir(java.lang.String) // .parent(Project) // .projenCommand(java.lang.String) // .projenrcJson(java.lang.Boolean) // .projenrcJsonOptions(ProjenrcJsonOptions) // .renovatebot(java.lang.Boolean) // .renovatebotOptions(RenovatebotOptions) // .autoApproveOptions(AutoApproveOptions) // .autoMerge(java.lang.Boolean) // .autoMergeOptions(AutoMergeOptions) // .clobber(java.lang.Boolean) // .devContainer(java.lang.Boolean) // .github(java.lang.Boolean) // .githubOptions(GitHubOptions) // .gitpod(java.lang.Boolean) // .mergify(java.lang.Boolean) // .mergifyOptions(MergifyOptions) // .projectType(ProjectType) // .projenCredentials(GithubCredentials) // .projenTokenSecret(java.lang.String) // .readme(SampleReadmeProps) // .stale(java.lang.Boolean) // .staleOptions(StaleOptions) // .vscode(java.lang.Boolean) .artifactId(java.lang.String) .groupId(java.lang.String) .version(java.lang.String) // .description(java.lang.String) // .packaging(java.lang.String) // .url(java.lang.String) // .compileOptions(MavenCompileOptions) // .deps(java.util.List) // .distdir(java.lang.String) // .junit(java.lang.Boolean) // .junitOptions(JunitOptions) // .packagingOptions(MavenPackagingOptions) // .projenrcJava(java.lang.Boolean) // .projenrcJavaOptions(ProjenrcOptions) // .testDeps(java.util.List) // .sample(java.lang.Boolean) // .sampleJavaPackage(java.lang.String) // .buildCommand(java.lang.String) // .cdkout(java.lang.String) // .context(java.util.Map) // .featureFlags(java.lang.Boolean) // .requireApproval(ApprovalLevel) // .watchExcludes(java.util.List) // .watchIncludes(java.util.List) .cdkVersion(java.lang.String) // .cdkAssert(java.lang.Boolean) // .cdkAssertions(java.lang.Boolean) // .cdkDependencies(java.util.List) // .cdkDependenciesAsDeps(java.lang.Boolean) // .cdkTestDependencies(java.util.List) // .cdkVersionPinning(java.lang.Boolean) // .constructsVersion(java.lang.String) .mainClass(java.lang.String) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | name | java.lang.String | This is the name of your project. | | commitGenerated | java.lang.Boolean | Whether to commit the managed files by default. | | gitIgnoreOptions | io.github.cdklabs.projen.IgnoreFileOptions | Configuration options for .gitignore file. | | gitOptions | io.github.cdklabs.projen.GitOptions | Configuration options for git. | | logging | io.github.cdklabs.projen.LoggerOptions | Configure logging options such as verbosity. | | outdir | java.lang.String | The root directory of the project. | | parent | io.github.cdklabs.projen.Project | The parent project, if this project is part of a bigger project. | | projenCommand | java.lang.String | The shell command to use in order to run the projen CLI. | | projenrcJson | java.lang.Boolean | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. | | projenrcJsonOptions | io.github.cdklabs.projen.ProjenrcJsonOptions | Options for .projenrc.json. | | renovatebot | java.lang.Boolean | Use renovatebot to handle dependency upgrades. | | renovatebotOptions | io.github.cdklabs.projen.RenovatebotOptions | Options for renovatebot. | | autoApproveOptions | io.github.cdklabs.projen.github.AutoApproveOptions | Enable and configure the 'auto approve' workflow. | | autoMerge | java.lang.Boolean | Enable automatic merging on GitHub. | | autoMergeOptions | io.github.cdklabs.projen.github.AutoMergeOptions | Configure options for automatic merging on GitHub. | | clobber | java.lang.Boolean | Add a `clobber` task which resets the repo to origin. | | devContainer | java.lang.Boolean | Add a VSCode development environment (used for GitHub Codespaces). | | github | java.lang.Boolean | Enable GitHub integration. | | githubOptions | io.github.cdklabs.projen.github.GitHubOptions | Options for GitHub integration. | | gitpod | java.lang.Boolean | Add a Gitpod development environment. | | mergify | java.lang.Boolean | Whether mergify should be enabled on this repository or not. | | mergifyOptions | io.github.cdklabs.projen.github.MergifyOptions | Options for mergify. | | projectType | io.github.cdklabs.projen.ProjectType | Which type of project this is (library/app). | | projenCredentials | io.github.cdklabs.projen.github.GithubCredentials | Choose a method of providing GitHub API access for projen workflows. | | projenTokenSecret | java.lang.String | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. | | readme | io.github.cdklabs.projen.SampleReadmeProps | The README setup. | | stale | java.lang.Boolean | Auto-close of stale issues and pull request. | | staleOptions | io.github.cdklabs.projen.github.StaleOptions | Auto-close stale issues and pull requests. | | vscode | java.lang.Boolean | Enable VSCode integration. | | artifactId | java.lang.String | The artifactId is generally the name that the project is known by. | | groupId | java.lang.String | This is generally unique amongst an organization or a project. | | version | java.lang.String | This is the last piece of the naming puzzle. | | description | java.lang.String | Description of a project is always good. | | packaging | java.lang.String | Project packaging format. | | url | java.lang.String | The URL, like the name, is not required. | | compileOptions | io.github.cdklabs.projen.java.MavenCompileOptions | Compile options. | | deps | java.util.List | List of runtime dependencies for this project. | | distdir | java.lang.String | Final artifact output directory. | | junit | java.lang.Boolean | Include junit tests. | | junitOptions | io.github.cdklabs.projen.java.JunitOptions | junit options. | | packagingOptions | io.github.cdklabs.projen.java.MavenPackagingOptions | Packaging options. | | projenrcJava | java.lang.Boolean | Use projenrc in java. | | projenrcJavaOptions | io.github.cdklabs.projen.java.ProjenrcOptions | Options related to projenrc in java. | | testDeps | java.util.List | List of test dependencies for this project. | | sample | java.lang.Boolean | Include sample code and test if the relevant directories don't exist. | | sampleJavaPackage | java.lang.String | The java package to use for the code sample. | | buildCommand | java.lang.String | A command to execute before synthesis. | | cdkout | java.lang.String | cdk.out directory. | | context | java.util.Map | Additional context to include in `cdk.json`. | | featureFlags | java.lang.Boolean | Include all feature flags in cdk.json. | | requireApproval | io.github.cdklabs.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 | java.util.List | Glob patterns to exclude from `cdk watch`. | | watchIncludes | java.util.List | Glob patterns to include in `cdk watch`. | | cdkVersion | java.lang.String | Minimum version of the AWS CDK to depend on. | | cdkAssert | java.lang.Boolean | Warning: NodeJS only. | | cdkAssertions | java.lang.Boolean | Install the assertions library? | | cdkDependencies | java.util.List | Which AWS CDKv1 modules this project requires. | | cdkDependenciesAsDeps | java.lang.Boolean | If this is enabled (default), all modules declared in `cdkDependencies` will be also added as normal `dependencies` (as well as `peerDependencies`). | | cdkTestDependencies | java.util.List | AWS CDK modules required for testing. | | cdkVersionPinning | java.lang.Boolean | Use pinned version instead of caret version for CDK. | | constructsVersion | java.lang.String | Minimum version of the `constructs` library to depend on. | | mainClass | java.lang.String | The name of the Java class with the static `main()` method. | --- ##### `name`^Required - *Type:* java.lang.String - *Default:* $BASEDIR This is the name of your project. --- ##### `commitGenerated`^Optional - *Type:* java.lang.Boolean - *Default:* true Whether to commit the managed files by default. --- ##### `gitIgnoreOptions`^Optional - *Type:* io.github.cdklabs.projen.IgnoreFileOptions Configuration options for .gitignore file. --- ##### `gitOptions`^Optional - *Type:* io.github.cdklabs.projen.GitOptions Configuration options for git. --- ##### `logging`^Optional - *Type:* io.github.cdklabs.projen.LoggerOptions - *Default:* {} Configure logging options such as verbosity. --- ##### `outdir`^Optional - *Type:* java.lang.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 - *Type:* io.github.cdklabs.projen.Project The parent project, if this project is part of a bigger project. --- ##### `projenCommand`^Optional - *Type:* java.lang.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 - *Type:* java.lang.Boolean - *Default:* false Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. --- ##### `projenrcJsonOptions`^Optional - *Type:* io.github.cdklabs.projen.ProjenrcJsonOptions - *Default:* default options Options for .projenrc.json. --- ##### `renovatebot`^Optional - *Type:* java.lang.Boolean - *Default:* false Use renovatebot to handle dependency upgrades. --- ##### `renovatebotOptions`^Optional - *Type:* io.github.cdklabs.projen.RenovatebotOptions - *Default:* default options Options for renovatebot. --- ##### `autoApproveOptions`^Optional - *Type:* io.github.cdklabs.projen.github.AutoApproveOptions - *Default:* auto approve is disabled Enable and configure the 'auto approve' workflow. --- ##### `autoMerge`^Optional - *Type:* java.lang.Boolean - *Default:* true Enable automatic merging on GitHub. Has no effect if `github.mergify` is set to false. --- ##### `autoMergeOptions`^Optional - *Type:* io.github.cdklabs.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 - *Type:* java.lang.Boolean - *Default:* true, but false for subprojects Add a `clobber` task which resets the repo to origin. --- ##### `devContainer`^Optional - *Type:* java.lang.Boolean - *Default:* false Add a VSCode development environment (used for GitHub Codespaces). --- ##### `github`^Optional - *Type:* java.lang.Boolean - *Default:* true Enable GitHub integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `githubOptions`^Optional - *Type:* io.github.cdklabs.projen.github.GitHubOptions - *Default:* see GitHubOptions Options for GitHub integration. --- ##### `gitpod`^Optional - *Type:* java.lang.Boolean - *Default:* false Add a Gitpod development environment. --- ##### ~~`mergify`~~^Optional - *Deprecated:* use `githubOptions.mergify` instead - *Type:* java.lang.Boolean - *Default:* true Whether mergify should be enabled on this repository or not. --- ##### ~~`mergifyOptions`~~^Optional - *Deprecated:* use `githubOptions.mergifyOptions` instead - *Type:* io.github.cdklabs.projen.github.MergifyOptions - *Default:* default options Options for mergify. --- ##### ~~`projectType`~~^Optional - *Deprecated:* no longer supported at the base project level - *Type:* io.github.cdklabs.projen.ProjectType - *Default:* ProjectType.UNKNOWN Which type of project this is (library/app). --- ##### `projenCredentials`^Optional - *Type:* io.github.cdklabs.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` - *Type:* java.lang.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 - *Type:* io.github.cdklabs.projen.SampleReadmeProps - *Default:* { filename: 'README.md', contents: '# replace this' } The README setup. --- *Example* ```java "{ filename: 'readme.md', contents: '# title' }" ``` ##### `stale`^Optional - *Type:* java.lang.Boolean - *Default:* false Auto-close of stale issues and pull request. See `staleOptions` for options. --- ##### `staleOptions`^Optional - *Type:* io.github.cdklabs.projen.github.StaleOptions - *Default:* see defaults in `StaleOptions` Auto-close stale issues and pull requests. To disable set `stale` to `false`. --- ##### `vscode`^Optional - *Type:* java.lang.Boolean - *Default:* true Enable VSCode integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `artifactId`^Required - *Type:* java.lang.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 - *Type:* java.lang.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 - *Type:* java.lang.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 - *Type:* java.lang.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 - *Type:* java.lang.String - *Default:* "jar" Project packaging format. --- ##### `url`^Optional - *Type:* java.lang.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 - *Type:* io.github.cdklabs.projen.java.MavenCompileOptions - *Default:* defaults Compile options. --- ##### `deps`^Optional - *Type:* java.util.List - *Default:* [] List of runtime dependencies for this project. Dependencies use the format: `/@` Additional dependencies can be added via `project.addDependency()`. --- ##### `distdir`^Optional - *Type:* java.lang.String - *Default:* "dist/java" Final artifact output directory. --- ##### `junit`^Optional - *Type:* java.lang.Boolean - *Default:* true Include junit tests. --- ##### `junitOptions`^Optional - *Type:* io.github.cdklabs.projen.java.JunitOptions - *Default:* defaults junit options. --- ##### `packagingOptions`^Optional - *Type:* io.github.cdklabs.projen.java.MavenPackagingOptions - *Default:* defaults Packaging options. --- ##### `projenrcJava`^Optional - *Type:* java.lang.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 - *Type:* io.github.cdklabs.projen.java.ProjenrcOptions - *Default:* default options Options related to projenrc in java. --- ##### `testDeps`^Optional - *Type:* java.util.List - *Default:* [] List of test dependencies for this project. Dependencies use the format: `/@` Additional dependencies can be added via `project.addTestDependency()`. --- ##### `sample`^Optional - *Type:* java.lang.Boolean - *Default:* true Include sample code and test if the relevant directories don't exist. --- ##### `sampleJavaPackage`^Optional - *Type:* java.lang.String - *Default:* "org.acme" The java package to use for the code sample. --- ##### `buildCommand`^Optional - *Type:* java.lang.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 - *Type:* java.lang.String - *Default:* "cdk.out" cdk.out directory. --- ##### `context`^Optional - *Type:* java.util.Map - *Default:* no additional context Additional context to include in `cdk.json`. --- ##### `featureFlags`^Optional - *Type:* java.lang.Boolean - *Default:* true Include all feature flags in cdk.json. --- ##### `requireApproval`^Optional - *Type:* io.github.cdklabs.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 - *Type:* java.util.List - *Default:* [] Glob patterns to exclude from `cdk watch`. --- ##### `watchIncludes`^Optional - *Type:* java.util.List - *Default:* [] Glob patterns to include in `cdk watch`. --- ##### `cdkVersion`^Required - *Type:* java.lang.String - *Default:* "2.1.0" Minimum version of the AWS CDK to depend on. --- ##### ~~`cdkAssert`~~^Optional - *Deprecated:* The - *Type:* java.lang.Boolean - *Default:* will be included by default for AWS CDK >= 1.0.0 < 2.0.0 Warning: NodeJS only. Install the --- ##### `cdkAssertions`^Optional - *Type:* java.lang.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) - *Type:* java.util.List Which AWS CDKv1 modules this project requires. --- ##### ~~`cdkDependenciesAsDeps`~~^Optional - *Deprecated:* Not supported in CDK v2. - *Type:* java.lang.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 - *Type:* java.util.List AWS CDK modules required for testing. --- ##### `cdkVersionPinning`^Optional - *Type:* java.lang.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 - *Type:* java.lang.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 - *Type:* java.lang.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. --- #### 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` ```java public void addExcludeFromCleanup(java.lang.String globs) ``` 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:* java.lang.String The glob patterns to match. --- ##### `addGitIgnore` ```java public void addGitIgnore(java.lang.String pattern) ``` Adds a .gitignore pattern. ###### `pattern`^Required - *Type:* java.lang.String The glob pattern to ignore. --- ##### `addPackageIgnore` ```java public void addPackageIgnore(java.lang.String _pattern) ``` 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:* java.lang.String The glob pattern to exclude. --- ##### `addTask` ```java public Task addTask(java.lang.String name) public Task addTask(java.lang.String name, TaskOptions props) ``` Adds a new task to this project. This will fail if the project already has a task with this name. ###### `name`^Required - *Type:* java.lang.String The task name to add. --- ###### `props`^Optional - *Type:* io.github.cdklabs.projen.TaskOptions Task properties. --- ##### ~~`addTip`~~ ```java public void addTip(java.lang.String message) ``` Prints a "tip" message during synthesis. ###### `message`^Required - *Type:* java.lang.String The message. --- ##### `annotateGenerated` ```java public void annotateGenerated(java.lang.String glob) ``` 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:* java.lang.String the glob pattern to match (could be a file path). --- ##### `postSynthesize` ```java public void postSynthesize() ``` Called after all components are synthesized. Order is *not* guaranteed. ##### `preSynthesize` ```java public void preSynthesize() ``` Called before all components are synthesized. ##### `removeTask` ```java public Task removeTask(java.lang.String name) ``` Removes a task from a project. ###### `name`^Required - *Type:* java.lang.String The name of the task to remove. --- ##### `runTaskCommand` ```java public java.lang.String runTaskCommand(Task task) ``` Returns the shell command to execute in order to run a task. By default, this is `npx projen@ ` ###### `task`^Required - *Type:* io.github.cdklabs.projen.Task The task for which the command is required. --- ##### `synth` ```java public void synth() ``` 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` ```java public FileBase tryFindFile(java.lang.String filePath) ``` Finds a file at the specified relative path within this project and all its subprojects. ###### `filePath`^Required - *Type:* java.lang.String The file path. If this path is relative, it will be resolved from the root of _this_ project. --- ##### ~~`tryFindJsonFile`~~ ```java public JsonFile tryFindJsonFile(java.lang.String filePath) ``` Finds a json file by name. ###### `filePath`^Required - *Type:* java.lang.String The file path. --- ##### `tryFindObjectFile` ```java public ObjectFile tryFindObjectFile(java.lang.String filePath) ``` Finds an object file (like JsonFile, YamlFile, etc.) by name. ###### `filePath`^Required - *Type:* java.lang.String The file path. --- ##### `tryRemoveFile` ```java public FileBase tryRemoveFile(java.lang.String filePath) ``` Finds a file at the specified relative path within this project and removes it. ###### `filePath`^Required - *Type:* java.lang.String The file path. If this path is relative, it will be resolved from the root of _this_ project. --- ##### `addDependency` ```java public void addDependency(java.lang.String spec) ``` Adds a runtime dependency. ###### `spec`^Required - *Type:* java.lang.String Format `/@`. --- ##### `addPlugin` ```java public Dependency addPlugin(java.lang.String spec) public Dependency addPlugin(java.lang.String spec, PluginOptions options) ``` Adds a build plugin to the pom. The plug in is also added as a BUILD dep to the project. ###### `spec`^Required - *Type:* java.lang.String dependency spec (`group/artifact@version`). --- ###### `options`^Optional - *Type:* io.github.cdklabs.projen.java.PluginOptions plugin options. --- ##### `addTestDependency` ```java public void addTestDependency(java.lang.String spec) ``` Adds a test dependency. ###### `spec`^Required - *Type:* java.lang.String Format `/@`. --- ##### ~~`addCdkDependency`~~ ```java public void addCdkDependency(java.lang.String modules) ``` Adds an AWS CDK module dependencies. ###### `modules`^Required - *Type:* java.lang.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 | io.github.cdklabs.projen.Task | *No description.* | | commitGenerated | java.lang.Boolean | Whether to commit the managed files by default. | | compileTask | io.github.cdklabs.projen.Task | *No description.* | | components | java.util.List | Returns all the components within this project. | | deps | io.github.cdklabs.projen.Dependencies | Project dependencies. | | ejected | java.lang.Boolean | Whether or not the project is being ejected. | | files | java.util.List | All files in this project. | | gitattributes | io.github.cdklabs.projen.GitAttributesFile | The .gitattributes file for this repository. | | gitignore | io.github.cdklabs.projen.IgnoreFile | .gitignore. | | logger | io.github.cdklabs.projen.Logger | Logging utilities. | | name | java.lang.String | Project name. | | outdir | java.lang.String | Absolute output directory of this project. | | packageTask | io.github.cdklabs.projen.Task | *No description.* | | postCompileTask | io.github.cdklabs.projen.Task | *No description.* | | preCompileTask | io.github.cdklabs.projen.Task | *No description.* | | projectBuild | io.github.cdklabs.projen.ProjectBuild | Manages the build process of the project. | | projenCommand | java.lang.String | The command to use in order to run the projen CLI. | | root | io.github.cdklabs.projen.Project | The root project. | | subprojects | java.util.List | Returns all the subprojects within this project. | | tasks | io.github.cdklabs.projen.Tasks | Project tasks. | | testTask | io.github.cdklabs.projen.Task | *No description.* | | defaultTask | io.github.cdklabs.projen.Task | This is the "default" task, the one that executes "projen". | | initProject | io.github.cdklabs.projen.InitProject | The options used when this project is bootstrapped via `projen new`. | | parent | io.github.cdklabs.projen.Project | A parent project. | | projectType | io.github.cdklabs.projen.ProjectType | *No description.* | | autoApprove | io.github.cdklabs.projen.github.AutoApprove | Auto approve set up for this project. | | devContainer | io.github.cdklabs.projen.vscode.DevContainer | Access for .devcontainer.json (used for GitHub Codespaces). | | github | io.github.cdklabs.projen.github.GitHub | Access all github components. | | gitpod | io.github.cdklabs.projen.Gitpod | Access for Gitpod. | | vscode | io.github.cdklabs.projen.vscode.VsCode | Access all VSCode components. | | compile | io.github.cdklabs.projen.java.MavenCompile | Compile component. | | distdir | java.lang.String | Maven artifact output directory. | | packaging | io.github.cdklabs.projen.java.MavenPackaging | Packaging component. | | pom | io.github.cdklabs.projen.java.Pom | API for managing `pom.xml`. | | junit | io.github.cdklabs.projen.java.Junit | JUnit component. | | projenrc | io.github.cdklabs.projen.java.Projenrc | Projenrc component. | | cdkConfig | io.github.cdklabs.projen.awscdk.CdkConfig | The `cdk.json` file. | | cdkDeps | io.github.cdklabs.projen.awscdk.AwsCdkDeps | CDK dependency management helper class. | | cdkTasks | io.github.cdklabs.projen.awscdk.CdkTasks | CDK tasks. | | mainClass | java.lang.String | The full name of the main class of the java app (package.Class). | | mainClassName | java.lang.String | The name of the Java class with the static `main()` method. | | mainPackage | java.lang.String | The name of the Java package that includes the main class. | --- ##### `buildTask`^Required ```java public Task getBuildTask(); ``` - *Type:* io.github.cdklabs.projen.Task --- ##### `commitGenerated`^Required ```java public java.lang.Boolean getCommitGenerated(); ``` - *Type:* java.lang.Boolean Whether to commit the managed files by default. --- ##### `compileTask`^Required ```java public Task getCompileTask(); ``` - *Type:* io.github.cdklabs.projen.Task --- ##### `components`^Required ```java public java.util.List getComponents(); ``` - *Type:* java.util.List Returns all the components within this project. --- ##### `deps`^Required ```java public Dependencies getDeps(); ``` - *Type:* io.github.cdklabs.projen.Dependencies Project dependencies. --- ##### `ejected`^Required ```java public java.lang.Boolean getEjected(); ``` - *Type:* java.lang.Boolean Whether or not the project is being ejected. --- ##### `files`^Required ```java public java.util.List getFiles(); ``` - *Type:* java.util.List All files in this project. --- ##### `gitattributes`^Required ```java public GitAttributesFile getGitattributes(); ``` - *Type:* io.github.cdklabs.projen.GitAttributesFile The .gitattributes file for this repository. --- ##### `gitignore`^Required ```java public IgnoreFile getGitignore(); ``` - *Type:* io.github.cdklabs.projen.IgnoreFile .gitignore. --- ##### `logger`^Required ```java public Logger getLogger(); ``` - *Type:* io.github.cdklabs.projen.Logger Logging utilities. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String Project name. --- ##### `outdir`^Required ```java public java.lang.String getOutdir(); ``` - *Type:* java.lang.String Absolute output directory of this project. --- ##### `packageTask`^Required ```java public Task getPackageTask(); ``` - *Type:* io.github.cdklabs.projen.Task --- ##### `postCompileTask`^Required ```java public Task getPostCompileTask(); ``` - *Type:* io.github.cdklabs.projen.Task --- ##### `preCompileTask`^Required ```java public Task getPreCompileTask(); ``` - *Type:* io.github.cdklabs.projen.Task --- ##### `projectBuild`^Required ```java public ProjectBuild getProjectBuild(); ``` - *Type:* io.github.cdklabs.projen.ProjectBuild Manages the build process of the project. --- ##### `projenCommand`^Required ```java public java.lang.String getProjenCommand(); ``` - *Type:* java.lang.String The command to use in order to run the projen CLI. --- ##### `root`^Required ```java public Project getRoot(); ``` - *Type:* io.github.cdklabs.projen.Project The root project. --- ##### `subprojects`^Required ```java public java.util.List getSubprojects(); ``` - *Type:* java.util.List Returns all the subprojects within this project. --- ##### `tasks`^Required ```java public Tasks getTasks(); ``` - *Type:* io.github.cdklabs.projen.Tasks Project tasks. --- ##### `testTask`^Required ```java public Task getTestTask(); ``` - *Type:* io.github.cdklabs.projen.Task --- ##### `defaultTask`^Optional ```java public Task getDefaultTask(); ``` - *Type:* io.github.cdklabs.projen.Task This is the "default" task, the one that executes "projen". Undefined if the project is being ejected. --- ##### `initProject`^Optional ```java public InitProject getInitProject(); ``` - *Type:* io.github.cdklabs.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 ```java public Project getParent(); ``` - *Type:* io.github.cdklabs.projen.Project A parent project. If undefined, this is the root project. --- ##### `projectType`^Required ```java public ProjectType getProjectType(); ``` - *Type:* io.github.cdklabs.projen.ProjectType --- ##### `autoApprove`^Optional ```java public AutoApprove getAutoApprove(); ``` - *Type:* io.github.cdklabs.projen.github.AutoApprove Auto approve set up for this project. --- ##### `devContainer`^Optional ```java public DevContainer getDevContainer(); ``` - *Type:* io.github.cdklabs.projen.vscode.DevContainer Access for .devcontainer.json (used for GitHub Codespaces). This will be `undefined` if devContainer boolean is false --- ##### `github`^Optional ```java public GitHub getGithub(); ``` - *Type:* io.github.cdklabs.projen.github.GitHub Access all github components. This will be `undefined` for subprojects. --- ##### `gitpod`^Optional ```java public Gitpod getGitpod(); ``` - *Type:* io.github.cdklabs.projen.Gitpod Access for Gitpod. This will be `undefined` if gitpod boolean is false --- ##### `vscode`^Optional ```java public VsCode getVscode(); ``` - *Type:* io.github.cdklabs.projen.vscode.VsCode Access all VSCode components. This will be `undefined` for subprojects. --- ##### `compile`^Required ```java public MavenCompile getCompile(); ``` - *Type:* io.github.cdklabs.projen.java.MavenCompile Compile component. --- ##### `distdir`^Required ```java public java.lang.String getDistdir(); ``` - *Type:* java.lang.String Maven artifact output directory. --- ##### `packaging`^Required ```java public MavenPackaging getPackaging(); ``` - *Type:* io.github.cdklabs.projen.java.MavenPackaging Packaging component. --- ##### `pom`^Required ```java public Pom getPom(); ``` - *Type:* io.github.cdklabs.projen.java.Pom API for managing `pom.xml`. --- ##### `junit`^Optional ```java public Junit getJunit(); ``` - *Type:* io.github.cdklabs.projen.java.Junit JUnit component. --- ##### `projenrc`^Optional ```java public Projenrc getProjenrc(); ``` - *Type:* io.github.cdklabs.projen.java.Projenrc Projenrc component. --- ##### `cdkConfig`^Required ```java public CdkConfig getCdkConfig(); ``` - *Type:* io.github.cdklabs.projen.awscdk.CdkConfig The `cdk.json` file. --- ##### `cdkDeps`^Required ```java public AwsCdkDeps getCdkDeps(); ``` - *Type:* io.github.cdklabs.projen.awscdk.AwsCdkDeps CDK dependency management helper class. --- ##### `cdkTasks`^Required ```java public CdkTasks getCdkTasks(); ``` - *Type:* io.github.cdklabs.projen.awscdk.CdkTasks CDK tasks. --- ##### `mainClass`^Required ```java public java.lang.String getMainClass(); ``` - *Type:* java.lang.String The full name of the main class of the java app (package.Class). --- ##### `mainClassName`^Required ```java public java.lang.String getMainClassName(); ``` - *Type:* java.lang.String The name of the Java class with the static `main()` method. --- ##### `mainPackage`^Required ```java public java.lang.String getMainPackage(); ``` - *Type:* java.lang.String The name of the Java package that includes the main class. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | DEFAULT_TASK | java.lang.String | The name of the default task (the task executed when `projen` is run without arguments). | --- ##### `DEFAULT_TASK`^Required ```java public java.lang.String getDefaultTask(); ``` - *Type:* java.lang.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 ```java import software.aws.awsprototypingsdk.pipeline.PDKPipelinePyProject; PDKPipelinePyProject.Builder.create() .name(java.lang.String) // .commitGenerated(java.lang.Boolean) // .gitIgnoreOptions(IgnoreFileOptions) // .gitOptions(GitOptions) // .logging(LoggerOptions) // .outdir(java.lang.String) // .parent(Project) // .projenCommand(java.lang.String) // .projenrcJson(java.lang.Boolean) // .projenrcJsonOptions(ProjenrcJsonOptions) // .renovatebot(java.lang.Boolean) // .renovatebotOptions(RenovatebotOptions) // .autoApproveOptions(AutoApproveOptions) // .autoMerge(java.lang.Boolean) // .autoMergeOptions(AutoMergeOptions) // .clobber(java.lang.Boolean) // .devContainer(java.lang.Boolean) // .github(java.lang.Boolean) // .githubOptions(GitHubOptions) // .gitpod(java.lang.Boolean) // .mergify(java.lang.Boolean) // .mergifyOptions(MergifyOptions) // .projectType(ProjectType) // .projenCredentials(GithubCredentials) // .projenTokenSecret(java.lang.String) // .readme(SampleReadmeProps) // .stale(java.lang.Boolean) // .staleOptions(StaleOptions) // .vscode(java.lang.Boolean) .authorEmail(java.lang.String) .authorName(java.lang.String) .version(java.lang.String) // .classifiers(java.util.List) // .description(java.lang.String) // .homepage(java.lang.String) // .license(java.lang.String) // .packageName(java.lang.String) // .poetryOptions(PoetryPyprojectOptionsWithoutDeps) // .setupConfig(java.util.Map) .moduleName(java.lang.String) // .deps(java.util.List) // .devDeps(java.util.List) // .pip(java.lang.Boolean) // .poetry(java.lang.Boolean) // .projenrcJs(java.lang.Boolean) // .projenrcJsOptions(ProjenrcOptions) // .projenrcPython(java.lang.Boolean) // .projenrcPythonOptions(ProjenrcOptions) // .projenrcTs(java.lang.Boolean) // .projenrcTsOptions(ProjenrcTsOptions) // .pytest(java.lang.Boolean) // .pytestOptions(PytestOptions) // .pythonExec(java.lang.String) // .sample(java.lang.Boolean) // .setuptools(java.lang.Boolean) // .venv(java.lang.Boolean) // .venvOptions(VenvOptions) // .buildCommand(java.lang.String) // .cdkout(java.lang.String) // .context(java.util.Map) // .featureFlags(java.lang.Boolean) // .requireApproval(ApprovalLevel) // .watchExcludes(java.util.List) // .watchIncludes(java.util.List) .cdkVersion(java.lang.String) // .cdkAssert(java.lang.Boolean) // .cdkAssertions(java.lang.Boolean) // .cdkDependencies(java.util.List) // .cdkDependenciesAsDeps(java.lang.Boolean) // .cdkTestDependencies(java.util.List) // .cdkVersionPinning(java.lang.Boolean) // .constructsVersion(java.lang.String) // .appEntrypoint(java.lang.String) // .testdir(java.lang.String) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | name | java.lang.String | This is the name of your project. | | commitGenerated | java.lang.Boolean | Whether to commit the managed files by default. | | gitIgnoreOptions | io.github.cdklabs.projen.IgnoreFileOptions | Configuration options for .gitignore file. | | gitOptions | io.github.cdklabs.projen.GitOptions | Configuration options for git. | | logging | io.github.cdklabs.projen.LoggerOptions | Configure logging options such as verbosity. | | outdir | java.lang.String | The root directory of the project. | | parent | io.github.cdklabs.projen.Project | The parent project, if this project is part of a bigger project. | | projenCommand | java.lang.String | The shell command to use in order to run the projen CLI. | | projenrcJson | java.lang.Boolean | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. | | projenrcJsonOptions | io.github.cdklabs.projen.ProjenrcJsonOptions | Options for .projenrc.json. | | renovatebot | java.lang.Boolean | Use renovatebot to handle dependency upgrades. | | renovatebotOptions | io.github.cdklabs.projen.RenovatebotOptions | Options for renovatebot. | | autoApproveOptions | io.github.cdklabs.projen.github.AutoApproveOptions | Enable and configure the 'auto approve' workflow. | | autoMerge | java.lang.Boolean | Enable automatic merging on GitHub. | | autoMergeOptions | io.github.cdklabs.projen.github.AutoMergeOptions | Configure options for automatic merging on GitHub. | | clobber | java.lang.Boolean | Add a `clobber` task which resets the repo to origin. | | devContainer | java.lang.Boolean | Add a VSCode development environment (used for GitHub Codespaces). | | github | java.lang.Boolean | Enable GitHub integration. | | githubOptions | io.github.cdklabs.projen.github.GitHubOptions | Options for GitHub integration. | | gitpod | java.lang.Boolean | Add a Gitpod development environment. | | mergify | java.lang.Boolean | Whether mergify should be enabled on this repository or not. | | mergifyOptions | io.github.cdklabs.projen.github.MergifyOptions | Options for mergify. | | projectType | io.github.cdklabs.projen.ProjectType | Which type of project this is (library/app). | | projenCredentials | io.github.cdklabs.projen.github.GithubCredentials | Choose a method of providing GitHub API access for projen workflows. | | projenTokenSecret | java.lang.String | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. | | readme | io.github.cdklabs.projen.SampleReadmeProps | The README setup. | | stale | java.lang.Boolean | Auto-close of stale issues and pull request. | | staleOptions | io.github.cdklabs.projen.github.StaleOptions | Auto-close stale issues and pull requests. | | vscode | java.lang.Boolean | Enable VSCode integration. | | authorEmail | java.lang.String | Author's e-mail. | | authorName | java.lang.String | Author's name. | | version | java.lang.String | Version of the package. | | classifiers | java.util.List | A list of PyPI trove classifiers that describe the project. | | description | java.lang.String | A short description of the package. | | homepage | java.lang.String | A URL to the website of the project. | | license | java.lang.String | License of this package as an SPDX identifier. | | packageName | java.lang.String | Package name. | | poetryOptions | io.github.cdklabs.projen.python.PoetryPyprojectOptionsWithoutDeps | Additional options to set for poetry if using poetry. | | setupConfig | java.util.Map | Additional fields to pass in the setup() function if using setuptools. | | moduleName | java.lang.String | Name of the python package as used in imports and filenames. | | deps | java.util.List | List of runtime dependencies for this project. | | devDeps | java.util.List | List of dev dependencies for this project. | | pip | java.lang.Boolean | Use pip with a requirements.txt file to track project dependencies. | | poetry | java.lang.Boolean | Use poetry to manage your project dependencies, virtual environment, and (optional) packaging/publishing. | | projenrcJs | java.lang.Boolean | Use projenrc in javascript. | | projenrcJsOptions | io.github.cdklabs.projen.javascript.ProjenrcOptions | Options related to projenrc in JavaScript. | | projenrcPython | java.lang.Boolean | Use projenrc in Python. | | projenrcPythonOptions | io.github.cdklabs.projen.python.ProjenrcOptions | Options related to projenrc in python. | | projenrcTs | java.lang.Boolean | Use projenrc in TypeScript. | | projenrcTsOptions | io.github.cdklabs.projen.typescript.ProjenrcTsOptions | Options related to projenrc in TypeScript. | | pytest | java.lang.Boolean | Include pytest tests. | | pytestOptions | io.github.cdklabs.projen.python.PytestOptions | pytest options. | | pythonExec | java.lang.String | Path to the python executable to use. | | sample | java.lang.Boolean | Include sample code and test if the relevant directories don't exist. | | setuptools | java.lang.Boolean | Use setuptools with a setup.py script for packaging and publishing. | | venv | java.lang.Boolean | Use venv to manage a virtual environment for installing dependencies inside. | | venvOptions | io.github.cdklabs.projen.python.VenvOptions | Venv options. | | buildCommand | java.lang.String | A command to execute before synthesis. | | cdkout | java.lang.String | cdk.out directory. | | context | java.util.Map | Additional context to include in `cdk.json`. | | featureFlags | java.lang.Boolean | Include all feature flags in cdk.json. | | requireApproval | io.github.cdklabs.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 | java.util.List | Glob patterns to exclude from `cdk watch`. | | watchIncludes | java.util.List | Glob patterns to include in `cdk watch`. | | cdkVersion | java.lang.String | Minimum version of the AWS CDK to depend on. | | cdkAssert | java.lang.Boolean | Warning: NodeJS only. | | cdkAssertions | java.lang.Boolean | Install the assertions library? | | cdkDependencies | java.util.List | Which AWS CDKv1 modules this project requires. | | cdkDependenciesAsDeps | java.lang.Boolean | If this is enabled (default), all modules declared in `cdkDependencies` will be also added as normal `dependencies` (as well as `peerDependencies`). | | cdkTestDependencies | java.util.List | AWS CDK modules required for testing. | | cdkVersionPinning | java.lang.Boolean | Use pinned version instead of caret version for CDK. | | constructsVersion | java.lang.String | Minimum version of the `constructs` library to depend on. | | appEntrypoint | java.lang.String | The CDK app's entrypoint (relative to the source directory, which is "src" by default). | | testdir | java.lang.String | Python sources directory. | --- ##### `name`^Required - *Type:* java.lang.String - *Default:* $BASEDIR This is the name of your project. --- ##### `commitGenerated`^Optional - *Type:* java.lang.Boolean - *Default:* true Whether to commit the managed files by default. --- ##### `gitIgnoreOptions`^Optional - *Type:* io.github.cdklabs.projen.IgnoreFileOptions Configuration options for .gitignore file. --- ##### `gitOptions`^Optional - *Type:* io.github.cdklabs.projen.GitOptions Configuration options for git. --- ##### `logging`^Optional - *Type:* io.github.cdklabs.projen.LoggerOptions - *Default:* {} Configure logging options such as verbosity. --- ##### `outdir`^Optional - *Type:* java.lang.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 - *Type:* io.github.cdklabs.projen.Project The parent project, if this project is part of a bigger project. --- ##### `projenCommand`^Optional - *Type:* java.lang.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 - *Type:* java.lang.Boolean - *Default:* false Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. --- ##### `projenrcJsonOptions`^Optional - *Type:* io.github.cdklabs.projen.ProjenrcJsonOptions - *Default:* default options Options for .projenrc.json. --- ##### `renovatebot`^Optional - *Type:* java.lang.Boolean - *Default:* false Use renovatebot to handle dependency upgrades. --- ##### `renovatebotOptions`^Optional - *Type:* io.github.cdklabs.projen.RenovatebotOptions - *Default:* default options Options for renovatebot. --- ##### `autoApproveOptions`^Optional - *Type:* io.github.cdklabs.projen.github.AutoApproveOptions - *Default:* auto approve is disabled Enable and configure the 'auto approve' workflow. --- ##### `autoMerge`^Optional - *Type:* java.lang.Boolean - *Default:* true Enable automatic merging on GitHub. Has no effect if `github.mergify` is set to false. --- ##### `autoMergeOptions`^Optional - *Type:* io.github.cdklabs.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 - *Type:* java.lang.Boolean - *Default:* true, but false for subprojects Add a `clobber` task which resets the repo to origin. --- ##### `devContainer`^Optional - *Type:* java.lang.Boolean - *Default:* false Add a VSCode development environment (used for GitHub Codespaces). --- ##### `github`^Optional - *Type:* java.lang.Boolean - *Default:* true Enable GitHub integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `githubOptions`^Optional - *Type:* io.github.cdklabs.projen.github.GitHubOptions - *Default:* see GitHubOptions Options for GitHub integration. --- ##### `gitpod`^Optional - *Type:* java.lang.Boolean - *Default:* false Add a Gitpod development environment. --- ##### ~~`mergify`~~^Optional - *Deprecated:* use `githubOptions.mergify` instead - *Type:* java.lang.Boolean - *Default:* true Whether mergify should be enabled on this repository or not. --- ##### ~~`mergifyOptions`~~^Optional - *Deprecated:* use `githubOptions.mergifyOptions` instead - *Type:* io.github.cdklabs.projen.github.MergifyOptions - *Default:* default options Options for mergify. --- ##### ~~`projectType`~~^Optional - *Deprecated:* no longer supported at the base project level - *Type:* io.github.cdklabs.projen.ProjectType - *Default:* ProjectType.UNKNOWN Which type of project this is (library/app). --- ##### `projenCredentials`^Optional - *Type:* io.github.cdklabs.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` - *Type:* java.lang.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 - *Type:* io.github.cdklabs.projen.SampleReadmeProps - *Default:* { filename: 'README.md', contents: '# replace this' } The README setup. --- *Example* ```java "{ filename: 'readme.md', contents: '# title' }" ``` ##### `stale`^Optional - *Type:* java.lang.Boolean - *Default:* false Auto-close of stale issues and pull request. See `staleOptions` for options. --- ##### `staleOptions`^Optional - *Type:* io.github.cdklabs.projen.github.StaleOptions - *Default:* see defaults in `StaleOptions` Auto-close stale issues and pull requests. To disable set `stale` to `false`. --- ##### `vscode`^Optional - *Type:* java.lang.Boolean - *Default:* true Enable VSCode integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `authorEmail`^Required - *Type:* java.lang.String - *Default:* $GIT_USER_EMAIL Author's e-mail. --- ##### `authorName`^Required - *Type:* java.lang.String - *Default:* $GIT_USER_NAME Author's name. --- ##### `version`^Required - *Type:* java.lang.String - *Default:* "0.1.0" Version of the package. --- ##### `classifiers`^Optional - *Type:* java.util.List A list of PyPI trove classifiers that describe the project. > [https://pypi.org/classifiers/](https://pypi.org/classifiers/) --- ##### `description`^Optional - *Type:* java.lang.String A short description of the package. --- ##### `homepage`^Optional - *Type:* java.lang.String A URL to the website of the project. --- ##### `license`^Optional - *Type:* java.lang.String License of this package as an SPDX identifier. --- ##### `packageName`^Optional - *Type:* java.lang.String Package name. --- ##### `poetryOptions`^Optional - *Type:* io.github.cdklabs.projen.python.PoetryPyprojectOptionsWithoutDeps Additional options to set for poetry if using poetry. --- ##### `setupConfig`^Optional - *Type:* java.util.Map Additional fields to pass in the setup() function if using setuptools. --- ##### `moduleName`^Required - *Type:* java.lang.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 - *Type:* java.util.List - *Default:* [] List of runtime dependencies for this project. Dependencies use the format: `@` Additional dependencies can be added via `project.addDependency()`. --- ##### `devDeps`^Optional - *Type:* java.util.List - *Default:* [] List of dev dependencies for this project. Dependencies use the format: `@` Additional dependencies can be added via `project.addDevDependency()`. --- ##### `pip`^Optional - *Type:* java.lang.Boolean - *Default:* true, unless poetry is true, then false Use pip with a requirements.txt file to track project dependencies. --- ##### `poetry`^Optional - *Type:* java.lang.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 - *Type:* java.lang.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 - *Type:* io.github.cdklabs.projen.javascript.ProjenrcOptions - *Default:* default options Options related to projenrc in JavaScript. --- ##### `projenrcPython`^Optional - *Type:* java.lang.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 - *Type:* io.github.cdklabs.projen.python.ProjenrcOptions - *Default:* default options Options related to projenrc in python. --- ##### `projenrcTs`^Optional - *Type:* java.lang.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 - *Type:* io.github.cdklabs.projen.typescript.ProjenrcTsOptions - *Default:* default options Options related to projenrc in TypeScript. --- ##### `pytest`^Optional - *Type:* java.lang.Boolean - *Default:* true Include pytest tests. --- ##### `pytestOptions`^Optional - *Type:* io.github.cdklabs.projen.python.PytestOptions - *Default:* defaults pytest options. --- ##### `pythonExec`^Optional - *Type:* java.lang.String - *Default:* "python" Path to the python executable to use. --- ##### `sample`^Optional - *Type:* java.lang.Boolean - *Default:* true Include sample code and test if the relevant directories don't exist. --- ##### `setuptools`^Optional - *Type:* java.lang.Boolean - *Default:* true, unless poetry is true, then false Use setuptools with a setup.py script for packaging and publishing. --- ##### `venv`^Optional - *Type:* java.lang.Boolean - *Default:* true, unless poetry is true, then false Use venv to manage a virtual environment for installing dependencies inside. --- ##### `venvOptions`^Optional - *Type:* io.github.cdklabs.projen.python.VenvOptions - *Default:* defaults Venv options. --- ##### `buildCommand`^Optional - *Type:* java.lang.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 - *Type:* java.lang.String - *Default:* "cdk.out" cdk.out directory. --- ##### `context`^Optional - *Type:* java.util.Map - *Default:* no additional context Additional context to include in `cdk.json`. --- ##### `featureFlags`^Optional - *Type:* java.lang.Boolean - *Default:* true Include all feature flags in cdk.json. --- ##### `requireApproval`^Optional - *Type:* io.github.cdklabs.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 - *Type:* java.util.List - *Default:* [] Glob patterns to exclude from `cdk watch`. --- ##### `watchIncludes`^Optional - *Type:* java.util.List - *Default:* [] Glob patterns to include in `cdk watch`. --- ##### `cdkVersion`^Required - *Type:* java.lang.String - *Default:* "2.1.0" Minimum version of the AWS CDK to depend on. --- ##### ~~`cdkAssert`~~^Optional - *Deprecated:* The - *Type:* java.lang.Boolean - *Default:* will be included by default for AWS CDK >= 1.0.0 < 2.0.0 Warning: NodeJS only. Install the --- ##### `cdkAssertions`^Optional - *Type:* java.lang.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) - *Type:* java.util.List Which AWS CDKv1 modules this project requires. --- ##### ~~`cdkDependenciesAsDeps`~~^Optional - *Deprecated:* Not supported in CDK v2. - *Type:* java.lang.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 - *Type:* java.util.List AWS CDK modules required for testing. --- ##### `cdkVersionPinning`^Optional - *Type:* java.lang.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 - *Type:* java.lang.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 - *Type:* java.lang.String - *Default:* "app.py" The CDK app's entrypoint (relative to the source directory, which is "src" by default). --- ##### `testdir`^Optional - *Type:* java.lang.String - *Default:* "tests" Python sources directory. --- #### 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` ```java public void addExcludeFromCleanup(java.lang.String globs) ``` 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:* java.lang.String The glob patterns to match. --- ##### `addGitIgnore` ```java public void addGitIgnore(java.lang.String pattern) ``` Adds a .gitignore pattern. ###### `pattern`^Required - *Type:* java.lang.String The glob pattern to ignore. --- ##### `addPackageIgnore` ```java public void addPackageIgnore(java.lang.String _pattern) ``` 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:* java.lang.String The glob pattern to exclude. --- ##### `addTask` ```java public Task addTask(java.lang.String name) public Task addTask(java.lang.String name, TaskOptions props) ``` Adds a new task to this project. This will fail if the project already has a task with this name. ###### `name`^Required - *Type:* java.lang.String The task name to add. --- ###### `props`^Optional - *Type:* io.github.cdklabs.projen.TaskOptions Task properties. --- ##### ~~`addTip`~~ ```java public void addTip(java.lang.String message) ``` Prints a "tip" message during synthesis. ###### `message`^Required - *Type:* java.lang.String The message. --- ##### `annotateGenerated` ```java public void annotateGenerated(java.lang.String glob) ``` 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:* java.lang.String the glob pattern to match (could be a file path). --- ##### `postSynthesize` ```java public void postSynthesize() ``` Called after all components are synthesized. Order is *not* guaranteed. ##### `preSynthesize` ```java public void preSynthesize() ``` Called before all components are synthesized. ##### `removeTask` ```java public Task removeTask(java.lang.String name) ``` Removes a task from a project. ###### `name`^Required - *Type:* java.lang.String The name of the task to remove. --- ##### `runTaskCommand` ```java public java.lang.String runTaskCommand(Task task) ``` Returns the shell command to execute in order to run a task. By default, this is `npx projen@ ` ###### `task`^Required - *Type:* io.github.cdklabs.projen.Task The task for which the command is required. --- ##### `synth` ```java public void synth() ``` 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` ```java public FileBase tryFindFile(java.lang.String filePath) ``` Finds a file at the specified relative path within this project and all its subprojects. ###### `filePath`^Required - *Type:* java.lang.String The file path. If this path is relative, it will be resolved from the root of _this_ project. --- ##### ~~`tryFindJsonFile`~~ ```java public JsonFile tryFindJsonFile(java.lang.String filePath) ``` Finds a json file by name. ###### `filePath`^Required - *Type:* java.lang.String The file path. --- ##### `tryFindObjectFile` ```java public ObjectFile tryFindObjectFile(java.lang.String filePath) ``` Finds an object file (like JsonFile, YamlFile, etc.) by name. ###### `filePath`^Required - *Type:* java.lang.String The file path. --- ##### `tryRemoveFile` ```java public FileBase tryRemoveFile(java.lang.String filePath) ``` Finds a file at the specified relative path within this project and removes it. ###### `filePath`^Required - *Type:* java.lang.String The file path. If this path is relative, it will be resolved from the root of _this_ project. --- ##### `addDependency` ```java public void addDependency(java.lang.String spec) ``` Adds a runtime dependency. ###### `spec`^Required - *Type:* java.lang.String Format `@`. --- ##### `addDevDependency` ```java public void addDevDependency(java.lang.String spec) ``` Adds a dev dependency. ###### `spec`^Required - *Type:* java.lang.String Format `@`. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | buildTask | io.github.cdklabs.projen.Task | *No description.* | | commitGenerated | java.lang.Boolean | Whether to commit the managed files by default. | | compileTask | io.github.cdklabs.projen.Task | *No description.* | | components | java.util.List | Returns all the components within this project. | | deps | io.github.cdklabs.projen.Dependencies | Project dependencies. | | ejected | java.lang.Boolean | Whether or not the project is being ejected. | | files | java.util.List | All files in this project. | | gitattributes | io.github.cdklabs.projen.GitAttributesFile | The .gitattributes file for this repository. | | gitignore | io.github.cdklabs.projen.IgnoreFile | .gitignore. | | logger | io.github.cdklabs.projen.Logger | Logging utilities. | | name | java.lang.String | Project name. | | outdir | java.lang.String | Absolute output directory of this project. | | packageTask | io.github.cdklabs.projen.Task | *No description.* | | postCompileTask | io.github.cdklabs.projen.Task | *No description.* | | preCompileTask | io.github.cdklabs.projen.Task | *No description.* | | projectBuild | io.github.cdklabs.projen.ProjectBuild | Manages the build process of the project. | | projenCommand | java.lang.String | The command to use in order to run the projen CLI. | | root | io.github.cdklabs.projen.Project | The root project. | | subprojects | java.util.List | Returns all the subprojects within this project. | | tasks | io.github.cdklabs.projen.Tasks | Project tasks. | | testTask | io.github.cdklabs.projen.Task | *No description.* | | defaultTask | io.github.cdklabs.projen.Task | This is the "default" task, the one that executes "projen". | | initProject | io.github.cdklabs.projen.InitProject | The options used when this project is bootstrapped via `projen new`. | | parent | io.github.cdklabs.projen.Project | A parent project. | | projectType | io.github.cdklabs.projen.ProjectType | *No description.* | | autoApprove | io.github.cdklabs.projen.github.AutoApprove | Auto approve set up for this project. | | devContainer | io.github.cdklabs.projen.vscode.DevContainer | Access for .devcontainer.json (used for GitHub Codespaces). | | github | io.github.cdklabs.projen.github.GitHub | Access all github components. | | gitpod | io.github.cdklabs.projen.Gitpod | Access for Gitpod. | | vscode | io.github.cdklabs.projen.vscode.VsCode | Access all VSCode components. | | depsManager | io.github.cdklabs.projen.python.IPythonDeps | API for managing dependencies. | | envManager | io.github.cdklabs.projen.python.IPythonEnv | API for mangaging the Python runtime environment. | | moduleName | java.lang.String | Python module name (the project name, with any hyphens or periods replaced with underscores). | | version | java.lang.String | Version of the package for distribution (should follow semver). | | packagingManager | io.github.cdklabs.projen.python.IPythonPackaging | API for managing packaging the project as a library. | | pytest | io.github.cdklabs.projen.python.Pytest | Pytest component. | | appEntrypoint | java.lang.String | The CDK app entrypoint. | | cdkConfig | io.github.cdklabs.projen.awscdk.CdkConfig | cdk.json configuration. | | cdkDeps | io.github.cdklabs.projen.awscdk.AwsCdkDeps | *No description.* | | cdkTasks | io.github.cdklabs.projen.awscdk.CdkTasks | Common CDK tasks. | | cdkVersion | java.lang.String | The CDK version this app is using. | | testdir | java.lang.String | The directory in which the python tests reside. | --- ##### `buildTask`^Required ```java public Task getBuildTask(); ``` - *Type:* io.github.cdklabs.projen.Task --- ##### `commitGenerated`^Required ```java public java.lang.Boolean getCommitGenerated(); ``` - *Type:* java.lang.Boolean Whether to commit the managed files by default. --- ##### `compileTask`^Required ```java public Task getCompileTask(); ``` - *Type:* io.github.cdklabs.projen.Task --- ##### `components`^Required ```java public java.util.List getComponents(); ``` - *Type:* java.util.List Returns all the components within this project. --- ##### `deps`^Required ```java public Dependencies getDeps(); ``` - *Type:* io.github.cdklabs.projen.Dependencies Project dependencies. --- ##### `ejected`^Required ```java public java.lang.Boolean getEjected(); ``` - *Type:* java.lang.Boolean Whether or not the project is being ejected. --- ##### `files`^Required ```java public java.util.List getFiles(); ``` - *Type:* java.util.List All files in this project. --- ##### `gitattributes`^Required ```java public GitAttributesFile getGitattributes(); ``` - *Type:* io.github.cdklabs.projen.GitAttributesFile The .gitattributes file for this repository. --- ##### `gitignore`^Required ```java public IgnoreFile getGitignore(); ``` - *Type:* io.github.cdklabs.projen.IgnoreFile .gitignore. --- ##### `logger`^Required ```java public Logger getLogger(); ``` - *Type:* io.github.cdklabs.projen.Logger Logging utilities. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String Project name. --- ##### `outdir`^Required ```java public java.lang.String getOutdir(); ``` - *Type:* java.lang.String Absolute output directory of this project. --- ##### `packageTask`^Required ```java public Task getPackageTask(); ``` - *Type:* io.github.cdklabs.projen.Task --- ##### `postCompileTask`^Required ```java public Task getPostCompileTask(); ``` - *Type:* io.github.cdklabs.projen.Task --- ##### `preCompileTask`^Required ```java public Task getPreCompileTask(); ``` - *Type:* io.github.cdklabs.projen.Task --- ##### `projectBuild`^Required ```java public ProjectBuild getProjectBuild(); ``` - *Type:* io.github.cdklabs.projen.ProjectBuild Manages the build process of the project. --- ##### `projenCommand`^Required ```java public java.lang.String getProjenCommand(); ``` - *Type:* java.lang.String The command to use in order to run the projen CLI. --- ##### `root`^Required ```java public Project getRoot(); ``` - *Type:* io.github.cdklabs.projen.Project The root project. --- ##### `subprojects`^Required ```java public java.util.List getSubprojects(); ``` - *Type:* java.util.List Returns all the subprojects within this project. --- ##### `tasks`^Required ```java public Tasks getTasks(); ``` - *Type:* io.github.cdklabs.projen.Tasks Project tasks. --- ##### `testTask`^Required ```java public Task getTestTask(); ``` - *Type:* io.github.cdklabs.projen.Task --- ##### `defaultTask`^Optional ```java public Task getDefaultTask(); ``` - *Type:* io.github.cdklabs.projen.Task This is the "default" task, the one that executes "projen". Undefined if the project is being ejected. --- ##### `initProject`^Optional ```java public InitProject getInitProject(); ``` - *Type:* io.github.cdklabs.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 ```java public Project getParent(); ``` - *Type:* io.github.cdklabs.projen.Project A parent project. If undefined, this is the root project. --- ##### `projectType`^Required ```java public ProjectType getProjectType(); ``` - *Type:* io.github.cdklabs.projen.ProjectType --- ##### `autoApprove`^Optional ```java public AutoApprove getAutoApprove(); ``` - *Type:* io.github.cdklabs.projen.github.AutoApprove Auto approve set up for this project. --- ##### `devContainer`^Optional ```java public DevContainer getDevContainer(); ``` - *Type:* io.github.cdklabs.projen.vscode.DevContainer Access for .devcontainer.json (used for GitHub Codespaces). This will be `undefined` if devContainer boolean is false --- ##### `github`^Optional ```java public GitHub getGithub(); ``` - *Type:* io.github.cdklabs.projen.github.GitHub Access all github components. This will be `undefined` for subprojects. --- ##### `gitpod`^Optional ```java public Gitpod getGitpod(); ``` - *Type:* io.github.cdklabs.projen.Gitpod Access for Gitpod. This will be `undefined` if gitpod boolean is false --- ##### `vscode`^Optional ```java public VsCode getVscode(); ``` - *Type:* io.github.cdklabs.projen.vscode.VsCode Access all VSCode components. This will be `undefined` for subprojects. --- ##### `depsManager`^Required ```java public IPythonDeps getDepsManager(); ``` - *Type:* io.github.cdklabs.projen.python.IPythonDeps API for managing dependencies. --- ##### `envManager`^Required ```java public IPythonEnv getEnvManager(); ``` - *Type:* io.github.cdklabs.projen.python.IPythonEnv API for mangaging the Python runtime environment. --- ##### `moduleName`^Required ```java public java.lang.String getModuleName(); ``` - *Type:* java.lang.String Python module name (the project name, with any hyphens or periods replaced with underscores). --- ##### `version`^Required ```java public java.lang.String getVersion(); ``` - *Type:* java.lang.String Version of the package for distribution (should follow semver). --- ##### `packagingManager`^Optional ```java public IPythonPackaging getPackagingManager(); ``` - *Type:* io.github.cdklabs.projen.python.IPythonPackaging API for managing packaging the project as a library. Only applies when the `projectType` is LIB. --- ##### `pytest`^Optional ```java public Pytest getPytest(); ``` - *Type:* io.github.cdklabs.projen.python.Pytest Pytest component. --- ##### `appEntrypoint`^Required ```java public java.lang.String getAppEntrypoint(); ``` - *Type:* java.lang.String The CDK app entrypoint. --- ##### `cdkConfig`^Required ```java public CdkConfig getCdkConfig(); ``` - *Type:* io.github.cdklabs.projen.awscdk.CdkConfig cdk.json configuration. --- ##### `cdkDeps`^Required ```java public AwsCdkDeps getCdkDeps(); ``` - *Type:* io.github.cdklabs.projen.awscdk.AwsCdkDeps --- ##### `cdkTasks`^Required ```java public CdkTasks getCdkTasks(); ``` - *Type:* io.github.cdklabs.projen.awscdk.CdkTasks Common CDK tasks. --- ##### `cdkVersion`^Required ```java public java.lang.String getCdkVersion(); ``` - *Type:* java.lang.String The CDK version this app is using. --- ##### `testdir`^Required ```java public java.lang.String getTestdir(); ``` - *Type:* java.lang.String The directory in which the python tests reside. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | DEFAULT_TASK | java.lang.String | The name of the default task (the task executed when `projen` is run without arguments). | --- ##### `DEFAULT_TASK`^Required ```java public java.lang.String getDefaultTask(); ``` - *Type:* java.lang.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 ```java import software.aws.awsprototypingsdk.pipeline.PDKPipelineTsProject; PDKPipelineTsProject.Builder.create() .name(java.lang.String) // .commitGenerated(java.lang.Boolean) // .gitIgnoreOptions(IgnoreFileOptions) // .gitOptions(GitOptions) // .logging(LoggerOptions) // .outdir(java.lang.String) // .parent(Project) // .projenCommand(java.lang.String) // .projenrcJson(java.lang.Boolean) // .projenrcJsonOptions(ProjenrcJsonOptions) // .renovatebot(java.lang.Boolean) // .renovatebotOptions(RenovatebotOptions) // .autoApproveOptions(AutoApproveOptions) // .autoMerge(java.lang.Boolean) // .autoMergeOptions(AutoMergeOptions) // .clobber(java.lang.Boolean) // .devContainer(java.lang.Boolean) // .github(java.lang.Boolean) // .githubOptions(GitHubOptions) // .gitpod(java.lang.Boolean) // .mergify(java.lang.Boolean) // .mergifyOptions(MergifyOptions) // .projectType(ProjectType) // .projenCredentials(GithubCredentials) // .projenTokenSecret(java.lang.String) // .readme(SampleReadmeProps) // .stale(java.lang.Boolean) // .staleOptions(StaleOptions) // .vscode(java.lang.Boolean) // .allowLibraryDependencies(java.lang.Boolean) // .authorEmail(java.lang.String) // .authorName(java.lang.String) // .authorOrganization(java.lang.Boolean) // .authorUrl(java.lang.String) // .autoDetectBin(java.lang.Boolean) // .bin(java.util.Map) // .bugsEmail(java.lang.String) // .bugsUrl(java.lang.String) // .bundledDeps(java.util.List) // .codeArtifactOptions(CodeArtifactOptions) // .deps(java.util.List) // .description(java.lang.String) // .devDeps(java.util.List) // .entrypoint(java.lang.String) // .homepage(java.lang.String) // .keywords(java.util.List) // .license(java.lang.String) // .licensed(java.lang.Boolean) // .maxNodeVersion(java.lang.String) // .minNodeVersion(java.lang.String) // .npmAccess(NpmAccess) // .npmRegistry(java.lang.String) // .npmRegistryUrl(java.lang.String) // .npmTokenSecret(java.lang.String) // .packageManager(NodePackageManager) // .packageName(java.lang.String) // .peerDependencyOptions(PeerDependencyOptions) // .peerDeps(java.util.List) // .pnpmVersion(java.lang.String) // .repository(java.lang.String) // .repositoryDirectory(java.lang.String) // .scopedPackagesOptions(java.util.List) // .scripts(java.util.Map) // .stability(java.lang.String) // .jsiiReleaseVersion(java.lang.String) // .majorVersion(java.lang.Number) // .minMajorVersion(java.lang.Number) // .npmDistTag(java.lang.String) // .postBuildSteps(java.util.List) // .prerelease(java.lang.String) // .publishDryRun(java.lang.Boolean) // .publishTasks(java.lang.Boolean) // .releaseBranches(java.util.Map) // .releaseEveryCommit(java.lang.Boolean) // .releaseFailureIssue(java.lang.Boolean) // .releaseFailureIssueLabel(java.lang.String) // .releaseSchedule(java.lang.String) // .releaseTagPrefix(java.lang.String) // .releaseTrigger(ReleaseTrigger) // .releaseWorkflowName(java.lang.String) // .releaseWorkflowSetupSteps(java.util.List) // .versionrcOptions(java.util.Map) // .workflowContainerImage(java.lang.String) // .workflowRunsOn(java.util.List) .defaultReleaseBranch(java.lang.String) // .artifactsDirectory(java.lang.String) // .autoApproveUpgrades(java.lang.Boolean) // .buildWorkflow(java.lang.Boolean) // .buildWorkflowTriggers(Triggers) // .bundlerOptions(BundlerOptions) // .codeCov(java.lang.Boolean) // .codeCovTokenSecret(java.lang.String) // .copyrightOwner(java.lang.String) // .copyrightPeriod(java.lang.String) // .dependabot(java.lang.Boolean) // .dependabotOptions(DependabotOptions) // .depsUpgrade(java.lang.Boolean) // .depsUpgradeOptions(UpgradeDependenciesOptions) // .gitignore(java.util.List) // .jest(java.lang.Boolean) // .jestOptions(JestOptions) // .mutableBuild(java.lang.Boolean) // .npmignore(java.util.List) // .npmignoreEnabled(java.lang.Boolean) // .npmIgnoreOptions(IgnoreFileOptions) // .package(java.lang.Boolean) // .prettier(java.lang.Boolean) // .prettierOptions(PrettierOptions) // .projenDevDependency(java.lang.Boolean) // .projenrcJs(java.lang.Boolean) // .projenrcJsOptions(ProjenrcOptions) // .projenVersion(java.lang.String) // .pullRequestTemplate(java.lang.Boolean) // .pullRequestTemplateContents(java.util.List) // .release(java.lang.Boolean) // .releaseToNpm(java.lang.Boolean) // .releaseWorkflow(java.lang.Boolean) // .workflowBootstrapSteps(java.util.List) // .workflowGitIdentity(GitIdentity) // .workflowNodeVersion(java.lang.String) // .workflowPackageCache(java.lang.Boolean) // .disableTsconfig(java.lang.Boolean) // .disableTsconfigDev(java.lang.Boolean) // .docgen(java.lang.Boolean) // .docsDirectory(java.lang.String) // .entrypointTypes(java.lang.String) // .eslint(java.lang.Boolean) // .eslintOptions(EslintOptions) // .libdir(java.lang.String) // .projenrcTs(java.lang.Boolean) // .projenrcTsOptions(ProjenrcOptions) // .sampleCode(java.lang.Boolean) // .srcdir(java.lang.String) // .testdir(java.lang.String) // .tsconfig(TypescriptConfigOptions) // .tsconfigDev(TypescriptConfigOptions) // .tsconfigDevFile(java.lang.String) // .typescriptVersion(java.lang.String) // .buildCommand(java.lang.String) // .cdkout(java.lang.String) // .context(java.util.Map) // .featureFlags(java.lang.Boolean) // .requireApproval(ApprovalLevel) // .watchExcludes(java.util.List) // .watchIncludes(java.util.List) .cdkVersion(java.lang.String) // .cdkAssert(java.lang.Boolean) // .cdkAssertions(java.lang.Boolean) // .cdkDependencies(java.util.List) // .cdkDependenciesAsDeps(java.lang.Boolean) // .cdkTestDependencies(java.util.List) // .cdkVersionPinning(java.lang.Boolean) // .constructsVersion(java.lang.String) // .appEntrypoint(java.lang.String) // .edgeLambdaAutoDiscover(java.lang.Boolean) // .integrationTestAutoDiscover(java.lang.Boolean) // .lambdaAutoDiscover(java.lang.Boolean) // .lambdaExtensionAutoDiscover(java.lang.Boolean) // .lambdaOptions(LambdaFunctionCommonOptions) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | name | java.lang.String | This is the name of your project. | | commitGenerated | java.lang.Boolean | Whether to commit the managed files by default. | | gitIgnoreOptions | io.github.cdklabs.projen.IgnoreFileOptions | Configuration options for .gitignore file. | | gitOptions | io.github.cdklabs.projen.GitOptions | Configuration options for git. | | logging | io.github.cdklabs.projen.LoggerOptions | Configure logging options such as verbosity. | | outdir | java.lang.String | The root directory of the project. | | parent | io.github.cdklabs.projen.Project | The parent project, if this project is part of a bigger project. | | projenCommand | java.lang.String | The shell command to use in order to run the projen CLI. | | projenrcJson | java.lang.Boolean | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. | | projenrcJsonOptions | io.github.cdklabs.projen.ProjenrcJsonOptions | Options for .projenrc.json. | | renovatebot | java.lang.Boolean | Use renovatebot to handle dependency upgrades. | | renovatebotOptions | io.github.cdklabs.projen.RenovatebotOptions | Options for renovatebot. | | autoApproveOptions | io.github.cdklabs.projen.github.AutoApproveOptions | Enable and configure the 'auto approve' workflow. | | autoMerge | java.lang.Boolean | Enable automatic merging on GitHub. | | autoMergeOptions | io.github.cdklabs.projen.github.AutoMergeOptions | Configure options for automatic merging on GitHub. | | clobber | java.lang.Boolean | Add a `clobber` task which resets the repo to origin. | | devContainer | java.lang.Boolean | Add a VSCode development environment (used for GitHub Codespaces). | | github | java.lang.Boolean | Enable GitHub integration. | | githubOptions | io.github.cdklabs.projen.github.GitHubOptions | Options for GitHub integration. | | gitpod | java.lang.Boolean | Add a Gitpod development environment. | | mergify | java.lang.Boolean | Whether mergify should be enabled on this repository or not. | | mergifyOptions | io.github.cdklabs.projen.github.MergifyOptions | Options for mergify. | | projectType | io.github.cdklabs.projen.ProjectType | Which type of project this is (library/app). | | projenCredentials | io.github.cdklabs.projen.github.GithubCredentials | Choose a method of providing GitHub API access for projen workflows. | | projenTokenSecret | java.lang.String | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. | | readme | io.github.cdklabs.projen.SampleReadmeProps | The README setup. | | stale | java.lang.Boolean | Auto-close of stale issues and pull request. | | staleOptions | io.github.cdklabs.projen.github.StaleOptions | Auto-close stale issues and pull requests. | | vscode | java.lang.Boolean | Enable VSCode integration. | | allowLibraryDependencies | java.lang.Boolean | Allow the project to include `peerDependencies` and `bundledDependencies`. | | authorEmail | java.lang.String | Author's e-mail. | | authorName | java.lang.String | Author's name. | | authorOrganization | java.lang.Boolean | Is the author an organization. | | authorUrl | java.lang.String | Author's URL / Website. | | autoDetectBin | java.lang.Boolean | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. | | bin | java.util.Map | Binary programs vended with your module. | | bugsEmail | java.lang.String | The email address to which issues should be reported. | | bugsUrl | java.lang.String | The url to your project's issue tracker. | | bundledDeps | java.util.List | List of dependencies to bundle into this module. | | codeArtifactOptions | io.github.cdklabs.projen.javascript.CodeArtifactOptions | Options for npm packages using AWS CodeArtifact. | | deps | java.util.List | Runtime dependencies of this module. | | description | java.lang.String | The description is just a string that helps people understand the purpose of the package. | | devDeps | java.util.List | Build dependencies for this module. | | entrypoint | java.lang.String | Module entrypoint (`main` in `package.json`). | | homepage | java.lang.String | Package's Homepage / Website. | | keywords | java.util.List | Keywords to include in `package.json`. | | license | java.lang.String | License's SPDX identifier. | | licensed | java.lang.Boolean | Indicates if a license should be added. | | maxNodeVersion | java.lang.String | Minimum node.js version to require via `engines` (inclusive). | | minNodeVersion | java.lang.String | Minimum Node.js version to require via package.json `engines` (inclusive). | | npmAccess | io.github.cdklabs.projen.javascript.NpmAccess | Access level of the npm package. | | npmRegistry | java.lang.String | The host name of the npm registry to publish to. | | npmRegistryUrl | java.lang.String | The base URL of the npm package registry. | | npmTokenSecret | java.lang.String | GitHub secret which contains the NPM token to use when publishing packages. | | packageManager | io.github.cdklabs.projen.javascript.NodePackageManager | The Node Package Manager used to execute scripts. | | packageName | java.lang.String | The "name" in package.json. | | peerDependencyOptions | io.github.cdklabs.projen.javascript.PeerDependencyOptions | Options for `peerDeps`. | | peerDeps | java.util.List | Peer dependencies for this module. | | pnpmVersion | java.lang.String | The version of PNPM to use if using PNPM as a package manager. | | repository | java.lang.String | The repository is the location where the actual code for your package lives. | | repositoryDirectory | java.lang.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 | java.util.List | Options for privately hosted scoped packages. | | scripts | java.util.Map | npm scripts to include. | | stability | java.lang.String | Package's Stability. | | jsiiReleaseVersion | java.lang.String | Version requirement of `publib` which is used to publish modules to npm. | | majorVersion | java.lang.Number | Major version to release from the default branch. | | minMajorVersion | java.lang.Number | Minimal Major version to release. | | npmDistTag | java.lang.String | The npmDistTag to use when publishing from the default branch. | | postBuildSteps | java.util.List | Steps to execute after build as part of the release workflow. | | prerelease | java.lang.String | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). | | publishDryRun | java.lang.Boolean | Instead of actually publishing to package managers, just print the publishing command. | | publishTasks | java.lang.Boolean | Define publishing tasks that can be executed manually as well as workflows. | | releaseBranches | java.util.Map | Defines additional release branches. | | releaseEveryCommit | java.lang.Boolean | Automatically release new versions every commit to one of branches in `releaseBranches`. | | releaseFailureIssue | java.lang.Boolean | Create a github issue on every failed publishing task. | | releaseFailureIssueLabel | java.lang.String | The label to apply to issues indicating publish failures. | | releaseSchedule | java.lang.String | CRON schedule to trigger new releases. | | releaseTagPrefix | java.lang.String | Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. | | releaseTrigger | io.github.cdklabs.projen.release.ReleaseTrigger | The release trigger to use. | | releaseWorkflowName | java.lang.String | The name of the default release workflow. | | releaseWorkflowSetupSteps | java.util.List | A set of workflow steps to execute in order to setup the workflow container. | | versionrcOptions | java.util.Map | Custom configuration used when creating changelog with standard-version package. | | workflowContainerImage | java.lang.String | Container image to use for GitHub workflows. | | workflowRunsOn | java.util.List | Github Runner selection labels. | | defaultReleaseBranch | java.lang.String | The name of the main release branch. | | artifactsDirectory | java.lang.String | A directory which will contain build artifacts. | | autoApproveUpgrades | java.lang.Boolean | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). | | buildWorkflow | java.lang.Boolean | Define a GitHub workflow for building PRs. | | buildWorkflowTriggers | io.github.cdklabs.projen.github.workflows.Triggers | Build workflow triggers. | | bundlerOptions | io.github.cdklabs.projen.javascript.BundlerOptions | Options for `Bundler`. | | codeCov | java.lang.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 | java.lang.String | Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. | | copyrightOwner | java.lang.String | License copyright owner. | | copyrightPeriod | java.lang.String | The copyright years to put in the LICENSE file. | | dependabot | java.lang.Boolean | Use dependabot to handle dependency upgrades. | | dependabotOptions | io.github.cdklabs.projen.github.DependabotOptions | Options for dependabot. | | depsUpgrade | java.lang.Boolean | Use github workflows to handle dependency upgrades. | | depsUpgradeOptions | io.github.cdklabs.projen.javascript.UpgradeDependenciesOptions | Options for `UpgradeDependencies`. | | gitignore | java.util.List | Additional entries to .gitignore. | | jest | java.lang.Boolean | Setup jest unit tests. | | jestOptions | io.github.cdklabs.projen.javascript.JestOptions | Jest options. | | mutableBuild | java.lang.Boolean | Automatically update files modified during builds to pull-request branches. | | npmignore | java.util.List | Additional entries to .npmignore. | | npmignoreEnabled | java.lang.Boolean | Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. | | npmIgnoreOptions | io.github.cdklabs.projen.IgnoreFileOptions | Configuration options for .npmignore file. | | package | java.lang.Boolean | Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). | | prettier | java.lang.Boolean | Setup prettier. | | prettierOptions | io.github.cdklabs.projen.javascript.PrettierOptions | Prettier options. | | projenDevDependency | java.lang.Boolean | Indicates of "projen" should be installed as a devDependency. | | projenrcJs | java.lang.Boolean | Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. | | projenrcJsOptions | io.github.cdklabs.projen.javascript.ProjenrcOptions | Options for .projenrc.js. | | projenVersion | java.lang.String | Version of projen to install. | | pullRequestTemplate | java.lang.Boolean | Include a GitHub pull request template. | | pullRequestTemplateContents | java.util.List | The contents of the pull request template. | | release | java.lang.Boolean | Add release management to this project. | | releaseToNpm | java.lang.Boolean | Automatically release to npm when new versions are introduced. | | releaseWorkflow | java.lang.Boolean | DEPRECATED: renamed to `release`. | | workflowBootstrapSteps | java.util.List | Workflow steps to use in order to bootstrap this repo. | | workflowGitIdentity | io.github.cdklabs.projen.github.GitIdentity | The git identity to use in workflows. | | workflowNodeVersion | java.lang.String | The node version to use in GitHub workflows. | | workflowPackageCache | java.lang.Boolean | Enable Node.js package cache in GitHub workflows. | | disableTsconfig | java.lang.Boolean | Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). | | disableTsconfigDev | java.lang.Boolean | Do not generate a `tsconfig.dev.json` file. | | docgen | java.lang.Boolean | Docgen by Typedoc. | | docsDirectory | java.lang.String | Docs directory. | | entrypointTypes | java.lang.String | The .d.ts file that includes the type declarations for this module. | | eslint | java.lang.Boolean | Setup eslint. | | eslintOptions | io.github.cdklabs.projen.javascript.EslintOptions | Eslint options. | | libdir | java.lang.String | Typescript artifacts output directory. | | projenrcTs | java.lang.Boolean | Use TypeScript for your projenrc file (`.projenrc.ts`). | | projenrcTsOptions | io.github.cdklabs.projen.typescript.ProjenrcOptions | Options for .projenrc.ts. | | sampleCode | java.lang.Boolean | Generate one-time sample in `src/` and `test/` if there are no files there. | | srcdir | java.lang.String | Typescript sources directory. | | testdir | java.lang.String | Jest tests directory. Tests files should be named `xxx.test.ts`. | | tsconfig | io.github.cdklabs.projen.javascript.TypescriptConfigOptions | Custom TSConfig. | | tsconfigDev | io.github.cdklabs.projen.javascript.TypescriptConfigOptions | Custom tsconfig options for the development tsconfig.json file (used for testing). | | tsconfigDevFile | java.lang.String | The name of the development tsconfig.json file. | | typescriptVersion | java.lang.String | TypeScript version to use. | | buildCommand | java.lang.String | A command to execute before synthesis. | | cdkout | java.lang.String | cdk.out directory. | | context | java.util.Map | Additional context to include in `cdk.json`. | | featureFlags | java.lang.Boolean | Include all feature flags in cdk.json. | | requireApproval | io.github.cdklabs.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 | java.util.List | Glob patterns to exclude from `cdk watch`. | | watchIncludes | java.util.List | Glob patterns to include in `cdk watch`. | | cdkVersion | java.lang.String | Minimum version of the AWS CDK to depend on. | | cdkAssert | java.lang.Boolean | Warning: NodeJS only. | | cdkAssertions | java.lang.Boolean | Install the assertions library? | | cdkDependencies | java.util.List | Which AWS CDKv1 modules this project requires. | | cdkDependenciesAsDeps | java.lang.Boolean | If this is enabled (default), all modules declared in `cdkDependencies` will be also added as normal `dependencies` (as well as `peerDependencies`). | | cdkTestDependencies | java.util.List | AWS CDK modules required for testing. | | cdkVersionPinning | java.lang.Boolean | Use pinned version instead of caret version for CDK. | | constructsVersion | java.lang.String | Minimum version of the `constructs` library to depend on. | | appEntrypoint | java.lang.String | The CDK app's entrypoint (relative to the source directory, which is "src" by default). | | edgeLambdaAutoDiscover | java.lang.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 | java.lang.Boolean | Automatically discovers and creates integration tests for each `.integ.ts` file in under your test directory. | | lambdaAutoDiscover | java.lang.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 | java.lang.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 | io.github.cdklabs.projen.awscdk.LambdaFunctionCommonOptions | Common options for all AWS Lambda functions. | --- ##### `name`^Required - *Type:* java.lang.String - *Default:* $BASEDIR This is the name of your project. --- ##### `commitGenerated`^Optional - *Type:* java.lang.Boolean - *Default:* true Whether to commit the managed files by default. --- ##### `gitIgnoreOptions`^Optional - *Type:* io.github.cdklabs.projen.IgnoreFileOptions Configuration options for .gitignore file. --- ##### `gitOptions`^Optional - *Type:* io.github.cdklabs.projen.GitOptions Configuration options for git. --- ##### `logging`^Optional - *Type:* io.github.cdklabs.projen.LoggerOptions - *Default:* {} Configure logging options such as verbosity. --- ##### `outdir`^Optional - *Type:* java.lang.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 - *Type:* io.github.cdklabs.projen.Project The parent project, if this project is part of a bigger project. --- ##### `projenCommand`^Optional - *Type:* java.lang.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 - *Type:* java.lang.Boolean - *Default:* false Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. --- ##### `projenrcJsonOptions`^Optional - *Type:* io.github.cdklabs.projen.ProjenrcJsonOptions - *Default:* default options Options for .projenrc.json. --- ##### `renovatebot`^Optional - *Type:* java.lang.Boolean - *Default:* false Use renovatebot to handle dependency upgrades. --- ##### `renovatebotOptions`^Optional - *Type:* io.github.cdklabs.projen.RenovatebotOptions - *Default:* default options Options for renovatebot. --- ##### `autoApproveOptions`^Optional - *Type:* io.github.cdklabs.projen.github.AutoApproveOptions - *Default:* auto approve is disabled Enable and configure the 'auto approve' workflow. --- ##### `autoMerge`^Optional - *Type:* java.lang.Boolean - *Default:* true Enable automatic merging on GitHub. Has no effect if `github.mergify` is set to false. --- ##### `autoMergeOptions`^Optional - *Type:* io.github.cdklabs.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 - *Type:* java.lang.Boolean - *Default:* true, but false for subprojects Add a `clobber` task which resets the repo to origin. --- ##### `devContainer`^Optional - *Type:* java.lang.Boolean - *Default:* false Add a VSCode development environment (used for GitHub Codespaces). --- ##### `github`^Optional - *Type:* java.lang.Boolean - *Default:* true Enable GitHub integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `githubOptions`^Optional - *Type:* io.github.cdklabs.projen.github.GitHubOptions - *Default:* see GitHubOptions Options for GitHub integration. --- ##### `gitpod`^Optional - *Type:* java.lang.Boolean - *Default:* false Add a Gitpod development environment. --- ##### ~~`mergify`~~^Optional - *Deprecated:* use `githubOptions.mergify` instead - *Type:* java.lang.Boolean - *Default:* true Whether mergify should be enabled on this repository or not. --- ##### ~~`mergifyOptions`~~^Optional - *Deprecated:* use `githubOptions.mergifyOptions` instead - *Type:* io.github.cdklabs.projen.github.MergifyOptions - *Default:* default options Options for mergify. --- ##### ~~`projectType`~~^Optional - *Deprecated:* no longer supported at the base project level - *Type:* io.github.cdklabs.projen.ProjectType - *Default:* ProjectType.UNKNOWN Which type of project this is (library/app). --- ##### `projenCredentials`^Optional - *Type:* io.github.cdklabs.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` - *Type:* java.lang.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 - *Type:* io.github.cdklabs.projen.SampleReadmeProps - *Default:* { filename: 'README.md', contents: '# replace this' } The README setup. --- *Example* ```java "{ filename: 'readme.md', contents: '# title' }" ``` ##### `stale`^Optional - *Type:* java.lang.Boolean - *Default:* false Auto-close of stale issues and pull request. See `staleOptions` for options. --- ##### `staleOptions`^Optional - *Type:* io.github.cdklabs.projen.github.StaleOptions - *Default:* see defaults in `StaleOptions` Auto-close stale issues and pull requests. To disable set `stale` to `false`. --- ##### `vscode`^Optional - *Type:* java.lang.Boolean - *Default:* true Enable VSCode integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `allowLibraryDependencies`^Optional - *Type:* java.lang.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 - *Type:* java.lang.String Author's e-mail. --- ##### `authorName`^Optional - *Type:* java.lang.String Author's name. --- ##### `authorOrganization`^Optional - *Type:* java.lang.Boolean Is the author an organization. --- ##### `authorUrl`^Optional - *Type:* java.lang.String Author's URL / Website. --- ##### `autoDetectBin`^Optional - *Type:* java.lang.Boolean - *Default:* true Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. --- ##### `bin`^Optional - *Type:* java.util.Map 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 - *Type:* java.lang.String The email address to which issues should be reported. --- ##### `bugsUrl`^Optional - *Type:* java.lang.String The url to your project's issue tracker. --- ##### `bundledDeps`^Optional - *Type:* java.util.List 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 - *Type:* io.github.cdklabs.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 - *Type:* java.util.List - *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* ```java [ 'express', 'lodash', 'foo@^2' ] ``` ##### `description`^Optional - *Type:* java.lang.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 - *Type:* java.util.List - *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* ```java [ 'typescript', '@types/express' ] ``` ##### `entrypoint`^Optional - *Type:* java.lang.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 - *Type:* java.lang.String Package's Homepage / Website. --- ##### `keywords`^Optional - *Type:* java.util.List Keywords to include in `package.json`. --- ##### `license`^Optional - *Type:* java.lang.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 - *Type:* java.lang.Boolean - *Default:* true Indicates if a license should be added. --- ##### `maxNodeVersion`^Optional - *Type:* java.lang.String - *Default:* no max Minimum node.js version to require via `engines` (inclusive). --- ##### `minNodeVersion`^Optional - *Type:* java.lang.String - *Default:* no "engines" specified Minimum Node.js version to require via package.json `engines` (inclusive). --- ##### `npmAccess`^Optional - *Type:* io.github.cdklabs.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 - *Type:* java.lang.String The host name of the npm registry to publish to. Cannot be set together with `npmRegistryUrl`. --- ##### `npmRegistryUrl`^Optional - *Type:* java.lang.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 - *Type:* java.lang.String - *Default:* "NPM_TOKEN" GitHub secret which contains the NPM token to use when publishing packages. --- ##### `packageManager`^Optional - *Type:* io.github.cdklabs.projen.javascript.NodePackageManager - *Default:* NodePackageManager.YARN The Node Package Manager used to execute scripts. --- ##### `packageName`^Optional - *Type:* java.lang.String - *Default:* defaults to project name The "name" in package.json. --- ##### `peerDependencyOptions`^Optional - *Type:* io.github.cdklabs.projen.javascript.PeerDependencyOptions Options for `peerDeps`. --- ##### `peerDeps`^Optional - *Type:* java.util.List - *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 - *Type:* java.lang.String - *Default:* "7" The version of PNPM to use if using PNPM as a package manager. --- ##### `repository`^Optional - *Type:* java.lang.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 - *Type:* java.lang.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 - *Type:* java.util.List - *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()` - *Type:* java.util.Map - *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 - *Type:* java.lang.String Package's Stability. --- ##### `jsiiReleaseVersion`^Optional - *Type:* java.lang.String - *Default:* "latest" Version requirement of `publib` which is used to publish modules to npm. --- ##### `majorVersion`^Optional - *Type:* java.lang.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 - *Type:* java.lang.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 - *Type:* java.lang.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 - *Type:* java.util.List - *Default:* [] Steps to execute after build as part of the release workflow. --- ##### `prerelease`^Optional - *Type:* java.lang.String - *Default:* normal semantic versions Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). --- ##### `publishDryRun`^Optional - *Type:* java.lang.Boolean - *Default:* false Instead of actually publishing to package managers, just print the publishing command. --- ##### `publishTasks`^Optional - *Type:* java.lang.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 - *Type:* java.util.Map - *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 - *Type:* java.lang.Boolean - *Default:* true Automatically release new versions every commit to one of branches in `releaseBranches`. --- ##### `releaseFailureIssue`^Optional - *Type:* java.lang.Boolean - *Default:* false Create a github issue on every failed publishing task. --- ##### `releaseFailureIssueLabel`^Optional - *Type:* java.lang.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 - *Type:* java.lang.String - *Default:* no scheduled releases CRON schedule to trigger new releases. --- ##### `releaseTagPrefix`^Optional - *Type:* java.lang.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 - *Type:* io.github.cdklabs.projen.release.ReleaseTrigger - *Default:* Continuous releases (`ReleaseTrigger.continuous()`) The release trigger to use. --- ##### `releaseWorkflowName`^Optional - *Type:* java.lang.String - *Default:* "Release" The name of the default release workflow. --- ##### `releaseWorkflowSetupSteps`^Optional - *Type:* java.util.List A set of workflow steps to execute in order to setup the workflow container. --- ##### `versionrcOptions`^Optional - *Type:* java.util.Map - *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 - *Type:* java.lang.String - *Default:* default image Container image to use for GitHub workflows. --- ##### `workflowRunsOn`^Optional - *Type:* java.util.List - *Default:* ["ubuntu-latest"] Github Runner selection labels. --- ##### `defaultReleaseBranch`^Required - *Type:* java.lang.String - *Default:* "main" The name of the main release branch. --- ##### `artifactsDirectory`^Optional - *Type:* java.lang.String - *Default:* "dist" A directory which will contain build artifacts. --- ##### `autoApproveUpgrades`^Optional - *Type:* java.lang.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 - *Type:* java.lang.Boolean - *Default:* true if not a subproject Define a GitHub workflow for building PRs. --- ##### `buildWorkflowTriggers`^Optional - *Type:* io.github.cdklabs.projen.github.workflows.Triggers - *Default:* "{ pullRequest: {}, workflowDispatch: {} }" Build workflow triggers. --- ##### `bundlerOptions`^Optional - *Type:* io.github.cdklabs.projen.javascript.BundlerOptions Options for `Bundler`. --- ##### `codeCov`^Optional - *Type:* java.lang.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 - *Type:* java.lang.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 - *Type:* java.lang.String - *Default:* defaults to the value of authorName or "" if `authorName` is undefined. License copyright owner. --- ##### `copyrightPeriod`^Optional - *Type:* java.lang.String - *Default:* current year The copyright years to put in the LICENSE file. --- ##### `dependabot`^Optional - *Type:* java.lang.Boolean - *Default:* false Use dependabot to handle dependency upgrades. Cannot be used in conjunction with `depsUpgrade`. --- ##### `dependabotOptions`^Optional - *Type:* io.github.cdklabs.projen.github.DependabotOptions - *Default:* default options Options for dependabot. --- ##### `depsUpgrade`^Optional - *Type:* java.lang.Boolean - *Default:* true Use github workflows to handle dependency upgrades. Cannot be used in conjunction with `dependabot`. --- ##### `depsUpgradeOptions`^Optional - *Type:* io.github.cdklabs.projen.javascript.UpgradeDependenciesOptions - *Default:* default options Options for `UpgradeDependencies`. --- ##### `gitignore`^Optional - *Type:* java.util.List Additional entries to .gitignore. --- ##### `jest`^Optional - *Type:* java.lang.Boolean - *Default:* true Setup jest unit tests. --- ##### `jestOptions`^Optional - *Type:* io.github.cdklabs.projen.javascript.JestOptions - *Default:* default options Jest options. --- ##### `mutableBuild`^Optional - *Type:* java.lang.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` - *Type:* java.util.List Additional entries to .npmignore. --- ##### `npmignoreEnabled`^Optional - *Type:* java.lang.Boolean - *Default:* true Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. --- ##### `npmIgnoreOptions`^Optional - *Type:* io.github.cdklabs.projen.IgnoreFileOptions Configuration options for .npmignore file. --- ##### `package`^Optional - *Type:* java.lang.Boolean - *Default:* true Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). --- ##### `prettier`^Optional - *Type:* java.lang.Boolean - *Default:* false Setup prettier. --- ##### `prettierOptions`^Optional - *Type:* io.github.cdklabs.projen.javascript.PrettierOptions - *Default:* default options Prettier options. --- ##### `projenDevDependency`^Optional - *Type:* java.lang.Boolean - *Default:* true Indicates of "projen" should be installed as a devDependency. --- ##### `projenrcJs`^Optional - *Type:* java.lang.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 - *Type:* io.github.cdklabs.projen.javascript.ProjenrcOptions - *Default:* default options Options for .projenrc.js. --- ##### `projenVersion`^Optional - *Type:* java.lang.String - *Default:* Defaults to the latest version. Version of projen to install. --- ##### `pullRequestTemplate`^Optional - *Type:* java.lang.Boolean - *Default:* true Include a GitHub pull request template. --- ##### `pullRequestTemplateContents`^Optional - *Type:* java.util.List - *Default:* default content The contents of the pull request template. --- ##### `release`^Optional - *Type:* java.lang.Boolean - *Default:* true (false for subprojects) Add release management to this project. --- ##### `releaseToNpm`^Optional - *Type:* java.lang.Boolean - *Default:* false Automatically release to npm when new versions are introduced. --- ##### ~~`releaseWorkflow`~~^Optional - *Deprecated:* see `release`. - *Type:* java.lang.Boolean - *Default:* true if not a subproject DEPRECATED: renamed to `release`. --- ##### `workflowBootstrapSteps`^Optional - *Type:* java.util.List - *Default:* "yarn install --frozen-lockfile && yarn projen" Workflow steps to use in order to bootstrap this repo. --- ##### `workflowGitIdentity`^Optional - *Type:* io.github.cdklabs.projen.github.GitIdentity - *Default:* GitHub Actions The git identity to use in workflows. --- ##### `workflowNodeVersion`^Optional - *Type:* java.lang.String - *Default:* same as `minNodeVersion` The node version to use in GitHub workflows. --- ##### `workflowPackageCache`^Optional - *Type:* java.lang.Boolean - *Default:* false Enable Node.js package cache in GitHub workflows. --- ##### `disableTsconfig`^Optional - *Type:* java.lang.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 - *Type:* java.lang.Boolean - *Default:* false Do not generate a `tsconfig.dev.json` file. --- ##### `docgen`^Optional - *Type:* java.lang.Boolean - *Default:* false Docgen by Typedoc. --- ##### `docsDirectory`^Optional - *Type:* java.lang.String - *Default:* "docs" Docs directory. --- ##### `entrypointTypes`^Optional - *Type:* java.lang.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 - *Type:* java.lang.Boolean - *Default:* true Setup eslint. --- ##### `eslintOptions`^Optional - *Type:* io.github.cdklabs.projen.javascript.EslintOptions - *Default:* opinionated default options Eslint options. --- ##### `libdir`^Optional - *Type:* java.lang.String - *Default:* "lib" Typescript artifacts output directory. --- ##### `projenrcTs`^Optional - *Type:* java.lang.Boolean - *Default:* false Use TypeScript for your projenrc file (`.projenrc.ts`). --- ##### `projenrcTsOptions`^Optional - *Type:* io.github.cdklabs.projen.typescript.ProjenrcOptions Options for .projenrc.ts. --- ##### `sampleCode`^Optional - *Type:* java.lang.Boolean - *Default:* true Generate one-time sample in `src/` and `test/` if there are no files there. --- ##### `srcdir`^Optional - *Type:* java.lang.String - *Default:* "src" Typescript sources directory. --- ##### `testdir`^Optional - *Type:* java.lang.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 - *Type:* io.github.cdklabs.projen.javascript.TypescriptConfigOptions - *Default:* default options Custom TSConfig. --- ##### `tsconfigDev`^Optional - *Type:* io.github.cdklabs.projen.javascript.TypescriptConfigOptions - *Default:* use the production tsconfig options Custom tsconfig options for the development tsconfig.json file (used for testing). --- ##### `tsconfigDevFile`^Optional - *Type:* java.lang.String - *Default:* "tsconfig.dev.json" The name of the development tsconfig.json file. --- ##### `typescriptVersion`^Optional - *Type:* java.lang.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 - *Type:* java.lang.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 - *Type:* java.lang.String - *Default:* "cdk.out" cdk.out directory. --- ##### `context`^Optional - *Type:* java.util.Map - *Default:* no additional context Additional context to include in `cdk.json`. --- ##### `featureFlags`^Optional - *Type:* java.lang.Boolean - *Default:* true Include all feature flags in cdk.json. --- ##### `requireApproval`^Optional - *Type:* io.github.cdklabs.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 - *Type:* java.util.List - *Default:* [] Glob patterns to exclude from `cdk watch`. --- ##### `watchIncludes`^Optional - *Type:* java.util.List - *Default:* [] Glob patterns to include in `cdk watch`. --- ##### `cdkVersion`^Required - *Type:* java.lang.String - *Default:* "2.1.0" Minimum version of the AWS CDK to depend on. --- ##### ~~`cdkAssert`~~^Optional - *Deprecated:* The - *Type:* java.lang.Boolean - *Default:* will be included by default for AWS CDK >= 1.0.0 < 2.0.0 Warning: NodeJS only. Install the --- ##### `cdkAssertions`^Optional - *Type:* java.lang.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) - *Type:* java.util.List Which AWS CDKv1 modules this project requires. --- ##### ~~`cdkDependenciesAsDeps`~~^Optional - *Deprecated:* Not supported in CDK v2. - *Type:* java.lang.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 - *Type:* java.util.List AWS CDK modules required for testing. --- ##### `cdkVersionPinning`^Optional - *Type:* java.lang.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 - *Type:* java.lang.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 - *Type:* java.lang.String - *Default:* "main.ts" The CDK app's entrypoint (relative to the source directory, which is "src" by default). --- ##### `edgeLambdaAutoDiscover`^Optional - *Type:* java.lang.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 - *Type:* java.lang.Boolean - *Default:* true Automatically discovers and creates integration tests for each `.integ.ts` file in under your test directory. --- ##### `lambdaAutoDiscover`^Optional - *Type:* java.lang.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 - *Type:* java.lang.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 - *Type:* io.github.cdklabs.projen.awscdk.LambdaFunctionCommonOptions - *Default:* default options Common options for all AWS Lambda functions. --- #### 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` ```java public void addExcludeFromCleanup(java.lang.String globs) ``` 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:* java.lang.String The glob patterns to match. --- ##### `addGitIgnore` ```java public void addGitIgnore(java.lang.String pattern) ``` Adds a .gitignore pattern. ###### `pattern`^Required - *Type:* java.lang.String The glob pattern to ignore. --- ##### `addPackageIgnore` ```java public void addPackageIgnore(java.lang.String pattern) ``` 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:* java.lang.String --- ##### `addTask` ```java public Task addTask(java.lang.String name) public Task addTask(java.lang.String name, TaskOptions props) ``` Adds a new task to this project. This will fail if the project already has a task with this name. ###### `name`^Required - *Type:* java.lang.String The task name to add. --- ###### `props`^Optional - *Type:* io.github.cdklabs.projen.TaskOptions Task properties. --- ##### ~~`addTip`~~ ```java public void addTip(java.lang.String message) ``` Prints a "tip" message during synthesis. ###### `message`^Required - *Type:* java.lang.String The message. --- ##### `annotateGenerated` ```java public void annotateGenerated(java.lang.String glob) ``` 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:* java.lang.String the glob pattern to match (could be a file path). --- ##### `postSynthesize` ```java public void postSynthesize() ``` Called after all components are synthesized. Order is *not* guaranteed. ##### `preSynthesize` ```java public void preSynthesize() ``` Called before all components are synthesized. ##### `removeTask` ```java public Task removeTask(java.lang.String name) ``` Removes a task from a project. ###### `name`^Required - *Type:* java.lang.String The name of the task to remove. --- ##### `runTaskCommand` ```java public java.lang.String runTaskCommand(Task task) ``` Returns the shell command to execute in order to run a task. This will typically be `npx projen TASK`. ###### `task`^Required - *Type:* io.github.cdklabs.projen.Task The task for which the command is required. --- ##### `synth` ```java public void synth() ``` 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` ```java public FileBase tryFindFile(java.lang.String filePath) ``` Finds a file at the specified relative path within this project and all its subprojects. ###### `filePath`^Required - *Type:* java.lang.String The file path. If this path is relative, it will be resolved from the root of _this_ project. --- ##### ~~`tryFindJsonFile`~~ ```java public JsonFile tryFindJsonFile(java.lang.String filePath) ``` Finds a json file by name. ###### `filePath`^Required - *Type:* java.lang.String The file path. --- ##### `tryFindObjectFile` ```java public ObjectFile tryFindObjectFile(java.lang.String filePath) ``` Finds an object file (like JsonFile, YamlFile, etc.) by name. ###### `filePath`^Required - *Type:* java.lang.String The file path. --- ##### `tryRemoveFile` ```java public FileBase tryRemoveFile(java.lang.String filePath) ``` Finds a file at the specified relative path within this project and removes it. ###### `filePath`^Required - *Type:* java.lang.String The file path. If this path is relative, it will be resolved from the root of _this_ project. --- ##### `addBins` ```java public void addBins(java.util.Map bins) ``` ###### `bins`^Required - *Type:* java.util.Map --- ##### `addBundledDeps` ```java public void addBundledDeps(java.lang.String deps) ``` 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:* java.lang.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`~~ ```java public void addCompileCommand(java.lang.String commands) ``` DEPRECATED. ###### `commands`^Required - *Type:* java.lang.String --- ##### `addDeps` ```java public void addDeps(java.lang.String deps) ``` Defines normal dependencies. ###### `deps`^Required - *Type:* java.lang.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` ```java public void addDevDeps(java.lang.String deps) ``` Defines development/test dependencies. ###### `deps`^Required - *Type:* java.lang.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` ```java public void addFields(java.util.Map fields) ``` Directly set fields in `package.json`. ###### `fields`^Required - *Type:* java.util.Map The fields to set. --- ##### `addKeywords` ```java public void addKeywords(java.lang.String keywords) ``` Adds keywords to package.json (deduplicated). ###### `keywords`^Required - *Type:* java.lang.String The keywords to add. --- ##### `addPeerDeps` ```java public void addPeerDeps(java.lang.String deps) ``` 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:* java.lang.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` ```java public void addScripts(java.util.Map scripts) ``` Replaces the contents of multiple npm package.json scripts. ###### `scripts`^Required - *Type:* java.util.Map The scripts to set. --- ##### ~~`addTestCommand`~~ ```java public void addTestCommand(java.lang.String commands) ``` DEPRECATED. ###### `commands`^Required - *Type:* java.lang.String --- ##### ~~`hasScript`~~ ```java public java.lang.Boolean hasScript(java.lang.String name) ``` Indicates if a script by the name name is defined. ###### `name`^Required - *Type:* java.lang.String The name of the script. --- ##### `removeScript` ```java public void removeScript(java.lang.String name) ``` Removes the npm script (always successful). ###### `name`^Required - *Type:* java.lang.String The name of the script. --- ##### `renderWorkflowSetup` ```java public java.util.List renderWorkflowSetup() public java.util.List renderWorkflowSetup(RenderWorkflowSetupOptions options) ``` Returns the set of workflow steps which should be executed to bootstrap a workflow. ###### `options`^Optional - *Type:* io.github.cdklabs.projen.javascript.RenderWorkflowSetupOptions Options. --- ##### `setScript` ```java public void setScript(java.lang.String name, java.lang.String command) ``` Replaces the contents of an npm package.json script. ###### `name`^Required - *Type:* java.lang.String The script name. --- ###### `command`^Required - *Type:* java.lang.String The command to execute. --- ##### `addCdkDependency` ```java public void addCdkDependency(java.lang.String modules) ``` Adds an AWS CDK module dependencies. ###### `modules`^Required - *Type:* java.lang.String The list of modules to depend on. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | buildTask | io.github.cdklabs.projen.Task | *No description.* | | commitGenerated | java.lang.Boolean | Whether to commit the managed files by default. | | compileTask | io.github.cdklabs.projen.Task | *No description.* | | components | java.util.List | Returns all the components within this project. | | deps | io.github.cdklabs.projen.Dependencies | Project dependencies. | | ejected | java.lang.Boolean | Whether or not the project is being ejected. | | files | java.util.List | All files in this project. | | gitattributes | io.github.cdklabs.projen.GitAttributesFile | The .gitattributes file for this repository. | | gitignore | io.github.cdklabs.projen.IgnoreFile | .gitignore. | | logger | io.github.cdklabs.projen.Logger | Logging utilities. | | name | java.lang.String | Project name. | | outdir | java.lang.String | Absolute output directory of this project. | | packageTask | io.github.cdklabs.projen.Task | *No description.* | | postCompileTask | io.github.cdklabs.projen.Task | *No description.* | | preCompileTask | io.github.cdklabs.projen.Task | *No description.* | | projectBuild | io.github.cdklabs.projen.ProjectBuild | Manages the build process of the project. | | projenCommand | java.lang.String | The command to use in order to run the projen CLI. | | root | io.github.cdklabs.projen.Project | The root project. | | subprojects | java.util.List | Returns all the subprojects within this project. | | tasks | io.github.cdklabs.projen.Tasks | Project tasks. | | testTask | io.github.cdklabs.projen.Task | *No description.* | | defaultTask | io.github.cdklabs.projen.Task | This is the "default" task, the one that executes "projen". | | initProject | io.github.cdklabs.projen.InitProject | The options used when this project is bootstrapped via `projen new`. | | parent | io.github.cdklabs.projen.Project | A parent project. | | projectType | io.github.cdklabs.projen.ProjectType | *No description.* | | autoApprove | io.github.cdklabs.projen.github.AutoApprove | Auto approve set up for this project. | | devContainer | io.github.cdklabs.projen.vscode.DevContainer | Access for .devcontainer.json (used for GitHub Codespaces). | | github | io.github.cdklabs.projen.github.GitHub | Access all github components. | | gitpod | io.github.cdklabs.projen.Gitpod | Access for Gitpod. | | vscode | io.github.cdklabs.projen.vscode.VsCode | Access all VSCode components. | | allowLibraryDependencies | java.lang.Boolean | *No description.* | | artifactsDirectory | java.lang.String | The build output directory. | | artifactsJavascriptDirectory | java.lang.String | The location of the npm tarball after build (`${artifactsDirectory}/js`). | | bundler | io.github.cdklabs.projen.javascript.Bundler | *No description.* | | entrypoint | java.lang.String | *No description.* | | manifest | java.lang.Object | *No description.* | | npmrc | io.github.cdklabs.projen.javascript.NpmConfig | The .npmrc file. | | package | io.github.cdklabs.projen.javascript.NodePackage | API for managing the node package. | | packageManager | io.github.cdklabs.projen.javascript.NodePackageManager | The package manager to use. | | runScriptCommand | java.lang.String | The command to use to run scripts (e.g. `yarn run` or `npm run` depends on the package manager). | | autoMerge | io.github.cdklabs.projen.github.AutoMerge | Component that sets up mergify for merging approved pull requests. | | buildWorkflow | io.github.cdklabs.projen.build.BuildWorkflow | The PR build GitHub workflow. | | buildWorkflowJobId | java.lang.String | The job ID of the build workflow. | | jest | io.github.cdklabs.projen.javascript.Jest | The Jest configuration (if enabled). | | maxNodeVersion | java.lang.String | Maximum node version required by this package. | | minNodeVersion | java.lang.String | Minimum node.js version required by this package. | | npmignore | io.github.cdklabs.projen.IgnoreFile | The .npmignore file. | | prettier | io.github.cdklabs.projen.javascript.Prettier | *No description.* | | publisher | io.github.cdklabs.projen.release.Publisher | Package publisher. | | release | io.github.cdklabs.projen.release.Release | Release management. | | upgradeWorkflow | io.github.cdklabs.projen.javascript.UpgradeDependencies | The upgrade workflow. | | docsDirectory | java.lang.String | *No description.* | | libdir | java.lang.String | The directory in which compiled .js files reside. | | srcdir | java.lang.String | The directory in which the .ts sources reside. | | testdir | java.lang.String | The directory in which tests reside. | | tsconfigDev | io.github.cdklabs.projen.javascript.TypescriptConfig | A typescript configuration file which covers all files (sources, tests, projen). | | watchTask | io.github.cdklabs.projen.Task | The "watch" task. | | docgen | java.lang.Boolean | *No description.* | | eslint | io.github.cdklabs.projen.javascript.Eslint | *No description.* | | tsconfig | io.github.cdklabs.projen.javascript.TypescriptConfig | *No description.* | | tsconfigEslint | io.github.cdklabs.projen.javascript.TypescriptConfig | *No description.* | | appEntrypoint | java.lang.String | The CDK app entrypoint. | | cdkConfig | io.github.cdklabs.projen.awscdk.CdkConfig | cdk.json configuration. | | cdkDeps | io.github.cdklabs.projen.awscdk.AwsCdkDeps | *No description.* | | cdkTasks | io.github.cdklabs.projen.awscdk.CdkTasks | Common CDK tasks. | | cdkVersion | java.lang.String | The CDK version this app is using. | --- ##### `buildTask`^Required ```java public Task getBuildTask(); ``` - *Type:* io.github.cdklabs.projen.Task --- ##### `commitGenerated`^Required ```java public java.lang.Boolean getCommitGenerated(); ``` - *Type:* java.lang.Boolean Whether to commit the managed files by default. --- ##### `compileTask`^Required ```java public Task getCompileTask(); ``` - *Type:* io.github.cdklabs.projen.Task --- ##### `components`^Required ```java public java.util.List getComponents(); ``` - *Type:* java.util.List Returns all the components within this project. --- ##### `deps`^Required ```java public Dependencies getDeps(); ``` - *Type:* io.github.cdklabs.projen.Dependencies Project dependencies. --- ##### `ejected`^Required ```java public java.lang.Boolean getEjected(); ``` - *Type:* java.lang.Boolean Whether or not the project is being ejected. --- ##### `files`^Required ```java public java.util.List getFiles(); ``` - *Type:* java.util.List All files in this project. --- ##### `gitattributes`^Required ```java public GitAttributesFile getGitattributes(); ``` - *Type:* io.github.cdklabs.projen.GitAttributesFile The .gitattributes file for this repository. --- ##### `gitignore`^Required ```java public IgnoreFile getGitignore(); ``` - *Type:* io.github.cdklabs.projen.IgnoreFile .gitignore. --- ##### `logger`^Required ```java public Logger getLogger(); ``` - *Type:* io.github.cdklabs.projen.Logger Logging utilities. --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String Project name. --- ##### `outdir`^Required ```java public java.lang.String getOutdir(); ``` - *Type:* java.lang.String Absolute output directory of this project. --- ##### `packageTask`^Required ```java public Task getPackageTask(); ``` - *Type:* io.github.cdklabs.projen.Task --- ##### `postCompileTask`^Required ```java public Task getPostCompileTask(); ``` - *Type:* io.github.cdklabs.projen.Task --- ##### `preCompileTask`^Required ```java public Task getPreCompileTask(); ``` - *Type:* io.github.cdklabs.projen.Task --- ##### `projectBuild`^Required ```java public ProjectBuild getProjectBuild(); ``` - *Type:* io.github.cdklabs.projen.ProjectBuild Manages the build process of the project. --- ##### `projenCommand`^Required ```java public java.lang.String getProjenCommand(); ``` - *Type:* java.lang.String The command to use in order to run the projen CLI. --- ##### `root`^Required ```java public Project getRoot(); ``` - *Type:* io.github.cdklabs.projen.Project The root project. --- ##### `subprojects`^Required ```java public java.util.List getSubprojects(); ``` - *Type:* java.util.List Returns all the subprojects within this project. --- ##### `tasks`^Required ```java public Tasks getTasks(); ``` - *Type:* io.github.cdklabs.projen.Tasks Project tasks. --- ##### `testTask`^Required ```java public Task getTestTask(); ``` - *Type:* io.github.cdklabs.projen.Task --- ##### `defaultTask`^Optional ```java public Task getDefaultTask(); ``` - *Type:* io.github.cdklabs.projen.Task This is the "default" task, the one that executes "projen". Undefined if the project is being ejected. --- ##### `initProject`^Optional ```java public InitProject getInitProject(); ``` - *Type:* io.github.cdklabs.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 ```java public Project getParent(); ``` - *Type:* io.github.cdklabs.projen.Project A parent project. If undefined, this is the root project. --- ##### `projectType`^Required ```java public ProjectType getProjectType(); ``` - *Type:* io.github.cdklabs.projen.ProjectType --- ##### `autoApprove`^Optional ```java public AutoApprove getAutoApprove(); ``` - *Type:* io.github.cdklabs.projen.github.AutoApprove Auto approve set up for this project. --- ##### `devContainer`^Optional ```java public DevContainer getDevContainer(); ``` - *Type:* io.github.cdklabs.projen.vscode.DevContainer Access for .devcontainer.json (used for GitHub Codespaces). This will be `undefined` if devContainer boolean is false --- ##### `github`^Optional ```java public GitHub getGithub(); ``` - *Type:* io.github.cdklabs.projen.github.GitHub Access all github components. This will be `undefined` for subprojects. --- ##### `gitpod`^Optional ```java public Gitpod getGitpod(); ``` - *Type:* io.github.cdklabs.projen.Gitpod Access for Gitpod. This will be `undefined` if gitpod boolean is false --- ##### `vscode`^Optional ```java public VsCode getVscode(); ``` - *Type:* io.github.cdklabs.projen.vscode.VsCode Access all VSCode components. This will be `undefined` for subprojects. --- ##### ~~`allowLibraryDependencies`~~^Required - *Deprecated:* use `package.allowLibraryDependencies` ```java public java.lang.Boolean getAllowLibraryDependencies(); ``` - *Type:* java.lang.Boolean --- ##### `artifactsDirectory`^Required ```java public java.lang.String getArtifactsDirectory(); ``` - *Type:* java.lang.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 ```java public java.lang.String getArtifactsJavascriptDirectory(); ``` - *Type:* java.lang.String The location of the npm tarball after build (`${artifactsDirectory}/js`). --- ##### `bundler`^Required ```java public Bundler getBundler(); ``` - *Type:* io.github.cdklabs.projen.javascript.Bundler --- ##### ~~`entrypoint`~~^Required - *Deprecated:* use `package.entrypoint` ```java public java.lang.String getEntrypoint(); ``` - *Type:* java.lang.String --- ##### ~~`manifest`~~^Required - *Deprecated:* use `package.addField(x, y)` ```java public java.lang.Object getManifest(); ``` - *Type:* java.lang.Object --- ##### `npmrc`^Required ```java public NpmConfig getNpmrc(); ``` - *Type:* io.github.cdklabs.projen.javascript.NpmConfig The .npmrc file. --- ##### `package`^Required ```java public NodePackage getPackage(); ``` - *Type:* io.github.cdklabs.projen.javascript.NodePackage API for managing the node package. --- ##### ~~`packageManager`~~^Required - *Deprecated:* use `package.packageManager` ```java public NodePackageManager getPackageManager(); ``` - *Type:* io.github.cdklabs.projen.javascript.NodePackageManager The package manager to use. --- ##### `runScriptCommand`^Required ```java public java.lang.String getRunScriptCommand(); ``` - *Type:* java.lang.String The command to use to run scripts (e.g. `yarn run` or `npm run` depends on the package manager). --- ##### `autoMerge`^Optional ```java public AutoMerge getAutoMerge(); ``` - *Type:* io.github.cdklabs.projen.github.AutoMerge Component that sets up mergify for merging approved pull requests. --- ##### `buildWorkflow`^Optional ```java public BuildWorkflow getBuildWorkflow(); ``` - *Type:* io.github.cdklabs.projen.build.BuildWorkflow The PR build GitHub workflow. `undefined` if `buildWorkflow` is disabled. --- ##### `buildWorkflowJobId`^Optional ```java public java.lang.String getBuildWorkflowJobId(); ``` - *Type:* java.lang.String The job ID of the build workflow. --- ##### `jest`^Optional ```java public Jest getJest(); ``` - *Type:* io.github.cdklabs.projen.javascript.Jest The Jest configuration (if enabled). --- ##### `maxNodeVersion`^Optional ```java public java.lang.String getMaxNodeVersion(); ``` - *Type:* java.lang.String Maximum node version required by this package. --- ##### `minNodeVersion`^Optional ```java public java.lang.String getMinNodeVersion(); ``` - *Type:* java.lang.String Minimum node.js version required by this package. --- ##### `npmignore`^Optional ```java public IgnoreFile getNpmignore(); ``` - *Type:* io.github.cdklabs.projen.IgnoreFile The .npmignore file. --- ##### `prettier`^Optional ```java public Prettier getPrettier(); ``` - *Type:* io.github.cdklabs.projen.javascript.Prettier --- ##### ~~`publisher`~~^Optional - *Deprecated:* use `release.publisher`. ```java public Publisher getPublisher(); ``` - *Type:* io.github.cdklabs.projen.release.Publisher Package publisher. This will be `undefined` if the project does not have a release workflow. --- ##### `release`^Optional ```java public Release getRelease(); ``` - *Type:* io.github.cdklabs.projen.release.Release Release management. --- ##### `upgradeWorkflow`^Optional ```java public UpgradeDependencies getUpgradeWorkflow(); ``` - *Type:* io.github.cdklabs.projen.javascript.UpgradeDependencies The upgrade workflow. --- ##### `docsDirectory`^Required ```java public java.lang.String getDocsDirectory(); ``` - *Type:* java.lang.String --- ##### `libdir`^Required ```java public java.lang.String getLibdir(); ``` - *Type:* java.lang.String The directory in which compiled .js files reside. --- ##### `srcdir`^Required ```java public java.lang.String getSrcdir(); ``` - *Type:* java.lang.String The directory in which the .ts sources reside. --- ##### `testdir`^Required ```java public java.lang.String getTestdir(); ``` - *Type:* java.lang.String The directory in which tests reside. --- ##### `tsconfigDev`^Required ```java public TypescriptConfig getTsconfigDev(); ``` - *Type:* io.github.cdklabs.projen.javascript.TypescriptConfig A typescript configuration file which covers all files (sources, tests, projen). --- ##### `watchTask`^Required ```java public Task getWatchTask(); ``` - *Type:* io.github.cdklabs.projen.Task The "watch" task. --- ##### `docgen`^Optional ```java public java.lang.Boolean getDocgen(); ``` - *Type:* java.lang.Boolean --- ##### `eslint`^Optional ```java public Eslint getEslint(); ``` - *Type:* io.github.cdklabs.projen.javascript.Eslint --- ##### `tsconfig`^Optional ```java public TypescriptConfig getTsconfig(); ``` - *Type:* io.github.cdklabs.projen.javascript.TypescriptConfig --- ##### `tsconfigEslint`^Optional ```java public TypescriptConfig getTsconfigEslint(); ``` - *Type:* io.github.cdklabs.projen.javascript.TypescriptConfig --- ##### `appEntrypoint`^Required ```java public java.lang.String getAppEntrypoint(); ``` - *Type:* java.lang.String The CDK app entrypoint. --- ##### `cdkConfig`^Required ```java public CdkConfig getCdkConfig(); ``` - *Type:* io.github.cdklabs.projen.awscdk.CdkConfig cdk.json configuration. --- ##### `cdkDeps`^Required ```java public AwsCdkDeps getCdkDeps(); ``` - *Type:* io.github.cdklabs.projen.awscdk.AwsCdkDeps --- ##### `cdkTasks`^Required ```java public CdkTasks getCdkTasks(); ``` - *Type:* io.github.cdklabs.projen.awscdk.CdkTasks Common CDK tasks. --- ##### `cdkVersion`^Required ```java public java.lang.String getCdkVersion(); ``` - *Type:* java.lang.String The CDK version this app is using. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | DEFAULT_TASK | java.lang.String | The name of the default task (the task executed when `projen` is run without arguments). | --- ##### `DEFAULT_TASK`^Required ```java public java.lang.String getDefaultTask(); ``` - *Type:* java.lang.String The name of the default task (the task executed when `projen` is run without arguments). Normally this task should synthesize the project files. ---