# 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 ```python import aws_prototyping_sdk.pipeline aws_prototyping_sdk.pipeline.PDKPipeline( scope: Construct, id: str, synth: IFileSetProducer, artifact_bucket: IBucket = None, asset_publishing_code_build_defaults: CodeBuildOptions = None, cli_version: str = None, code_build_defaults: CodeBuildOptions = None, code_pipeline: Pipeline = None, cross_account_keys: bool = None, docker_credentials: typing.List[DockerCredential] = None, docker_enabled_for_self_mutation: bool = None, docker_enabled_for_synth: bool = None, enable_key_rotation: bool = None, pipeline_name: str = None, publish_assets_in_parallel: bool = None, reuse_cross_region_support_stacks: bool = None, role: IRole = None, self_mutation: bool = None, self_mutation_code_build_defaults: CodeBuildOptions = None, synth_code_build_defaults: CodeBuildOptions = None, use_change_sets: bool = None, primary_synth_directory: str, repository_name: str, branch_name_prefixes: typing.List[str] = None, cdk_command: str = None, code_commit_removal_policy: RemovalPolicy = None, default_branch_name: str = None, sonar_code_scanner_config: SonarCodeScannerConfig = None, synth_shell_step_partial_props: ShellStepProps = None ) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | str | *No description.* | | synth | aws_cdk.pipelines.IFileSetProducer | The build step that produces the CDK Cloud Assembly. | | artifact_bucket | aws_cdk.aws_s3.IBucket | An existing S3 Bucket to use for storing the pipeline's artifact. | | asset_publishing_code_build_defaults | aws_cdk.pipelines.CodeBuildOptions | Additional customizations to apply to the asset publishing CodeBuild projects. | | cli_version | str | CDK CLI version to use in self-mutation and asset publishing steps. | | code_build_defaults | aws_cdk.pipelines.CodeBuildOptions | Customize the CodeBuild projects created for this pipeline. | | code_pipeline | aws_cdk.aws_codepipeline.Pipeline | An existing Pipeline to be reused and built upon. | | cross_account_keys | bool | Create KMS keys for the artifact buckets, allowing cross-account deployments. | | docker_credentials | typing.List[aws_cdk.pipelines.DockerCredential] | A list of credentials used to authenticate to Docker registries. | | docker_enabled_for_self_mutation | bool | Enable Docker for the self-mutate step. | | docker_enabled_for_synth | bool | Enable Docker for the 'synth' step. | | enable_key_rotation | bool | Enable KMS key rotation for the generated KMS keys. | | pipeline_name | str | The name of the CodePipeline pipeline. | | publish_assets_in_parallel | bool | Publish assets in multiple CodeBuild projects. | | reuse_cross_region_support_stacks | bool | Reuse the same cross region support stack for all pipelines in the App. | | role | aws_cdk.aws_iam.IRole | The IAM role to be assumed by this Pipeline. | | self_mutation | bool | Whether the pipeline will update itself. | | self_mutation_code_build_defaults | aws_cdk.pipelines.CodeBuildOptions | Additional customizations to apply to the self mutation CodeBuild projects. | | synth_code_build_defaults | aws_cdk.pipelines.CodeBuildOptions | Additional customizations to apply to the synthesize CodeBuild projects. | | use_change_sets | bool | Deploy every stack by creating a change set and executing it. | | primary_synth_directory | str | Output directory for cdk synthesized artifacts i.e: packages/infra/cdk.out. | | repository_name | str | Name of the CodeCommit repository to create. | | branch_name_prefixes | typing.List[str] | Branch name prefixes Any branches created matching this list of prefixes will create a new pipeline and stack. | | cdk_command | str | CDK command. | | code_commit_removal_policy | aws_cdk.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. | | default_branch_name | str | Branch to trigger the pipeline execution. | | sonar_code_scanner_config | SonarCodeScannerConfig | Configuration for enabling Sonarqube code scanning on a successful synth. | | synth_shell_step_partial_props | aws_cdk.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:* constructs.Construct --- ##### `id`^Required - *Type:* str --- ##### `synth`^Required - *Type:* aws_cdk.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`. --- ##### `artifact_bucket`^Optional - *Type:* aws_cdk.aws_s3.IBucket - *Default:* A new S3 bucket will be created. An existing S3 Bucket to use for storing the pipeline's artifact. --- ##### `asset_publishing_code_build_defaults`^Optional - *Type:* aws_cdk.pipelines.CodeBuildOptions - *Default:* Only `codeBuildDefaults` are applied Additional customizations to apply to the asset publishing CodeBuild projects. --- ##### `cli_version`^Optional - *Type:* str - *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. --- ##### `code_build_defaults`^Optional - *Type:* aws_cdk.pipelines.CodeBuildOptions - *Default:* All projects run non-privileged build, SMALL instance, LinuxBuildImage.STANDARD_6_0 Customize the CodeBuild projects created for this pipeline. --- ##### `code_pipeline`^Optional - *Type:* aws_cdk.aws_codepipeline.Pipeline - *Default:* a new underlying pipeline is created. An existing Pipeline to be reused and built upon. [disable-awslint:ref-via-interface] --- ##### `cross_account_keys`^Optional - *Type:* bool - *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. --- ##### `docker_credentials`^Optional - *Type:* typing.List[aws_cdk.pipelines.DockerCredential] - *Default:* [] A list of credentials used to authenticate to Docker registries. Specify any credentials necessary within the pipeline to build, synth, update, or publish assets. --- ##### `docker_enabled_for_self_mutation`^Optional - *Type:* bool - *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. --- ##### `docker_enabled_for_synth`^Optional - *Type:* bool - *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. --- ##### `enable_key_rotation`^Optional - *Type:* bool - *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. --- ##### `pipeline_name`^Optional - *Type:* str - *Default:* Automatically generated The name of the CodePipeline pipeline. --- ##### `publish_assets_in_parallel`^Optional - *Type:* bool - *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. --- ##### `reuse_cross_region_support_stacks`^Optional - *Type:* bool - *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:* aws_cdk.aws_iam.IRole - *Default:* A new role is created The IAM role to be assumed by this Pipeline. --- ##### `self_mutation`^Optional - *Type:* bool - *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`. --- ##### `self_mutation_code_build_defaults`^Optional - *Type:* aws_cdk.pipelines.CodeBuildOptions - *Default:* Only `codeBuildDefaults` are applied Additional customizations to apply to the self mutation CodeBuild projects. --- ##### `synth_code_build_defaults`^Optional - *Type:* aws_cdk.pipelines.CodeBuildOptions - *Default:* Only `codeBuildDefaults` are applied Additional customizations to apply to the synthesize CodeBuild projects. --- ##### `use_change_sets`^Optional - *Type:* bool - *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. --- ##### `primary_synth_directory`^Required - *Type:* str Output directory for cdk synthesized artifacts i.e: packages/infra/cdk.out. --- ##### `repository_name`^Required - *Type:* str Name of the CodeCommit repository to create. --- ##### `branch_name_prefixes`^Optional - *Type:* typing.List[str] - *Default:* undefined Branch name prefixes Any branches created matching this list of prefixes will create a new pipeline and stack. --- *Example* ```python # Example automatically generated from non-compiling source. May contain errors. # Disables feature branches (default) PDKPipeline(self, "PDKPipeline", repository_name="my-repo", branch_name_prefixes=[] ) ``` ##### `cdk_command`^Optional - *Type:* str - *Default:* 'npx cdk' CDK command. Override the command used to call cdk for synth and deploy. --- ##### `code_commit_removal_policy`^Optional - *Type:* aws_cdk.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. --- ##### `default_branch_name`^Optional - *Type:* str - *Default:* mainline Branch to trigger the pipeline execution. --- ##### `sonar_code_scanner_config`^Optional - *Type:* SonarCodeScannerConfig - *Default:* undefined Configuration for enabling Sonarqube code scanning on a successful synth. --- ##### `synth_shell_step_partial_props`^Optional - *Type:* aws_cdk.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** | | --- | --- | | to_string | Returns a string representation of this construct. | | add_stage | *No description.* | | build_pipeline | *No description.* | | suppress_cdk_violations | *No description.* | --- ##### `to_string` ```python def to_string() -> str ``` Returns a string representation of this construct. ##### `add_stage` ```python def add_stage( stage: Stage, post: typing.List[Step] = None, pre: typing.List[Step] = None, stack_steps: typing.List[StackSteps] = None ) -> StageDeployment ``` ###### `stage`^Required - *Type:* aws_cdk.Stage --- ###### `post`^Optional - *Type:* typing.List[aws_cdk.pipelines.Step] - *Default:* No additional steps Additional steps to run after all of the stacks in the stage. --- ###### `pre`^Optional - *Type:* typing.List[aws_cdk.pipelines.Step] - *Default:* No additional steps Additional steps to run before any of the stacks in the stage. --- ###### `stack_steps`^Optional - *Type:* typing.List[aws_cdk.pipelines.StackSteps] - *Default:* No additional instructions Instructions for stack level steps. --- ##### `build_pipeline` ```python def build_pipeline() -> None ``` ##### `suppress_cdk_violations` ```python def suppress_cdk_violations() -> None ``` #### Static Functions | **Name** | **Description** | | --- | --- | | is_construct | Checks if `x` is a construct. | | get_branch_prefix | A helper function to create a branch prefix. | | is_default_branch | A helper function to determine if the current branch is the default branch. | | normalize_branch_name | A helper function to normalize the branch name with only alphanumeric characters and hypens ('-'). | --- ##### `is_construct` ```python import aws_prototyping_sdk.pipeline aws_prototyping_sdk.pipeline.PDKPipeline.is_construct( x: typing.Any ) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* typing.Any Any object. --- ##### `get_branch_prefix` ```python import aws_prototyping_sdk.pipeline aws_prototyping_sdk.pipeline.PDKPipeline.get_branch_prefix( default_branch_name: str = None, node: Node = None ) ``` A helper function to create a branch prefix. The prefix is empty on the default branch. ###### `default_branch_name`^Optional - *Type:* str Specify the default branch name without context. --- ###### `node`^Optional - *Type:* constructs.Node The current node to fetch defaultBranchName from context. --- ##### `is_default_branch` ```python import aws_prototyping_sdk.pipeline aws_prototyping_sdk.pipeline.PDKPipeline.is_default_branch( default_branch_name: str = None, node: Node = None ) ``` 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 ###### `default_branch_name`^Optional - *Type:* str Specify the default branch name without context. --- ###### `node`^Optional - *Type:* constructs.Node The current node to fetch defaultBranchName from context. --- ##### `normalize_branch_name` ```python import aws_prototyping_sdk.pipeline aws_prototyping_sdk.pipeline.PDKPipeline.normalize_branch_name( branch_name: str ) ``` A helper function to normalize the branch name with only alphanumeric characters and hypens ('-'). ###### `branch_name`^Required - *Type:* str The name of the branch to normalize. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | code_pipeline | aws_cdk.pipelines.CodePipeline | *No description.* | | code_repository | aws_cdk.aws_codecommit.IRepository | *No description.* | --- ##### `node`^Required ```python node: Node ``` - *Type:* constructs.Node The tree node. --- ##### `code_pipeline`^Required ```python code_pipeline: CodePipeline ``` - *Type:* aws_cdk.pipelines.CodePipeline --- ##### `code_repository`^Required ```python code_repository: IRepository ``` - *Type:* aws_cdk.aws_codecommit.IRepository --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ALL_BRANCHES | typing.List[str] | *No description.* | | defaultBranchName | str | *No description.* | --- ##### `ALL_BRANCHES`^Required ```python ALL_BRANCHES: typing.List[str] ``` - *Type:* typing.List[str] --- ##### `defaultBranchName`^Required ```python defaultBranchName: str ``` - *Type:* str --- ### SonarCodeScanner #### Initializers ```python import aws_prototyping_sdk.pipeline aws_prototyping_sdk.pipeline.SonarCodeScanner( scope: Construct, id: str, sonarqube_authorized_group: str, sonarqube_default_profile_or_gate_name: str, sonarqube_endpoint: str, sonarqube_project_name: str, cdk_out_dir: str = None, cfn_nag_ignore_path: str = None, exclude_globs_for_scan: typing.List[str] = None, include_globs_for_scan: typing.List[str] = None, pre_archive_commands: typing.List[str] = None, sonarqube_specific_profile_or_gate_name: str = None, sonarqube_tags: typing.List[str] = None, artifact_bucket_arn: str, synth_build_arn: str, artifact_bucket_key_arn: str = None ) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | str | *No description.* | | sonarqube_authorized_group | str | Group name in Sonarqube with access to administer this project. | | sonarqube_default_profile_or_gate_name | str | Default profile/gate name i.e: your org profile. | | sonarqube_endpoint | str | endpoint of the sonarqube instance i.e: https://. | | sonarqube_project_name | str | Name of the project to create in Sonarqube. | | cdk_out_dir | str | directory containing the synthesized cdk resources. | | cfn_nag_ignore_path | str | path to a file containing the cfn nag suppression rules. | | exclude_globs_for_scan | typing.List[str] | glob patterns to exclude from sonar scan. | | include_globs_for_scan | typing.List[str] | glob patterns to include from sonar scan. | | pre_archive_commands | typing.List[str] | Hook which allows custom commands to be executed before the process commences the archival process. | | sonarqube_specific_profile_or_gate_name | str | Specific profile/gate name i.e: language specific. | | sonarqube_tags | typing.List[str] | Tags to associate with this project. | | artifact_bucket_arn | str | S3 bucket ARN containing the built artifacts from the synth build. | | synth_build_arn | str | ARN for the CodeBuild task responsible for executing the synth command. | | artifact_bucket_key_arn | str | Artifact bucket key ARN used to encrypt the artifacts. | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* str --- ##### `sonarqube_authorized_group`^Required - *Type:* str Group name in Sonarqube with access to administer this project. --- ##### `sonarqube_default_profile_or_gate_name`^Required - *Type:* str Default profile/gate name i.e: your org profile. Note: These need to be set up in Sonarqube manually. --- ##### `sonarqube_endpoint`^Required - *Type:* str endpoint of the sonarqube instance i.e: https://. Note: Ensure a trailing '/' is not included. --- ##### `sonarqube_project_name`^Required - *Type:* str Name of the project to create in Sonarqube. --- ##### `cdk_out_dir`^Optional - *Type:* str directory containing the synthesized cdk resources. --- ##### `cfn_nag_ignore_path`^Optional - *Type:* str path to a file containing the cfn nag suppression rules. --- ##### `exclude_globs_for_scan`^Optional - *Type:* typing.List[str] glob patterns to exclude from sonar scan. --- ##### `include_globs_for_scan`^Optional - *Type:* typing.List[str] glob patterns to include from sonar scan. --- ##### `pre_archive_commands`^Optional - *Type:* typing.List[str] Hook which allows custom commands to be executed before the process commences the archival process. --- ##### `sonarqube_specific_profile_or_gate_name`^Optional - *Type:* str Specific profile/gate name i.e: language specific. Note: These need to be set up in Sonarqube manually. --- ##### `sonarqube_tags`^Optional - *Type:* typing.List[str] Tags to associate with this project. --- ##### `artifact_bucket_arn`^Required - *Type:* str S3 bucket ARN containing the built artifacts from the synth build. --- ##### `synth_build_arn`^Required - *Type:* str ARN for the CodeBuild task responsible for executing the synth command. --- ##### `artifact_bucket_key_arn`^Optional - *Type:* str Artifact bucket key ARN used to encrypt the artifacts. --- #### Methods | **Name** | **Description** | | --- | --- | | to_string | Returns a string representation of this construct. | --- ##### `to_string` ```python def to_string() -> str ``` Returns a string representation of this construct. #### Static Functions | **Name** | **Description** | | --- | --- | | is_construct | Checks if `x` is a construct. | --- ##### `is_construct` ```python import aws_prototyping_sdk.pipeline aws_prototyping_sdk.pipeline.SonarCodeScanner.is_construct( x: typing.Any ) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* typing.Any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | --- ##### `node`^Required ```python node: Node ``` - *Type:* constructs.Node The tree node. --- ## Structs ### IsDefaultBranchProps Properties to help the isDefaultBranch function determine the default branch name. #### Initializer ```python import aws_prototyping_sdk.pipeline aws_prototyping_sdk.pipeline.IsDefaultBranchProps( default_branch_name: str = None, node: Node = None ) ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | default_branch_name | str | Specify the default branch name without context. | | node | constructs.Node | The current node to fetch defaultBranchName from context. | --- ##### `default_branch_name`^Optional ```python default_branch_name: str ``` - *Type:* str Specify the default branch name without context. --- ##### `node`^Optional ```python node: Node ``` - *Type:* constructs.Node The current node to fetch defaultBranchName from context. --- ### PDKPipelineJavaProjectOptions Configuration options for the PDKPipelineJavaProject. #### Initializer ```python import aws_prototyping_sdk.pipeline aws_prototyping_sdk.pipeline.PDKPipelineJavaProjectOptions( name: str, commit_generated: bool = None, git_ignore_options: IgnoreFileOptions = None, git_options: GitOptions = None, logging: LoggerOptions = None, outdir: str = None, parent: Project = None, projen_command: str = None, projenrc_json: bool = None, projenrc_json_options: ProjenrcJsonOptions = None, renovatebot: bool = None, renovatebot_options: RenovatebotOptions = None, auto_approve_options: AutoApproveOptions = None, auto_merge: bool = None, auto_merge_options: AutoMergeOptions = None, clobber: bool = None, dev_container: bool = None, github: bool = None, github_options: GitHubOptions = None, gitpod: bool = None, mergify: bool = None, mergify_options: MergifyOptions = None, project_type: ProjectType = None, projen_credentials: GithubCredentials = None, projen_token_secret: str = None, readme: SampleReadmeProps = None, stale: bool = None, stale_options: StaleOptions = None, vscode: bool = None, artifact_id: str, group_id: str, version: str, description: str = None, packaging: str = None, url: str = None, compile_options: MavenCompileOptions = None, deps: typing.List[str] = None, distdir: str = None, junit: bool = None, junit_options: JunitOptions = None, packaging_options: MavenPackagingOptions = None, projenrc_java: bool = None, projenrc_java_options: ProjenrcOptions = None, test_deps: typing.List[str] = None, sample: bool = None, sample_java_package: str = None, build_command: str = None, cdkout: str = None, context: typing.Mapping[typing.Any] = None, feature_flags: bool = None, require_approval: ApprovalLevel = None, watch_excludes: typing.List[str] = None, watch_includes: typing.List[str] = None, cdk_version: str, cdk_assert: bool = None, cdk_assertions: bool = None, cdk_dependencies: typing.List[str] = None, cdk_dependencies_as_deps: bool = None, cdk_test_dependencies: typing.List[str] = None, cdk_version_pinning: bool = None, constructs_version: str = None, main_class: str ) ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | str | This is the name of your project. | | commit_generated | bool | Whether to commit the managed files by default. | | git_ignore_options | projen.IgnoreFileOptions | Configuration options for .gitignore file. | | git_options | projen.GitOptions | Configuration options for git. | | logging | projen.LoggerOptions | Configure logging options such as verbosity. | | outdir | str | The root directory of the project. | | parent | projen.Project | The parent project, if this project is part of a bigger project. | | projen_command | str | The shell command to use in order to run the projen CLI. | | projenrc_json | bool | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. | | projenrc_json_options | projen.ProjenrcJsonOptions | Options for .projenrc.json. | | renovatebot | bool | Use renovatebot to handle dependency upgrades. | | renovatebot_options | projen.RenovatebotOptions | Options for renovatebot. | | auto_approve_options | projen.github.AutoApproveOptions | Enable and configure the 'auto approve' workflow. | | auto_merge | bool | Enable automatic merging on GitHub. | | auto_merge_options | projen.github.AutoMergeOptions | Configure options for automatic merging on GitHub. | | clobber | bool | Add a `clobber` task which resets the repo to origin. | | dev_container | bool | Add a VSCode development environment (used for GitHub Codespaces). | | github | bool | Enable GitHub integration. | | github_options | projen.github.GitHubOptions | Options for GitHub integration. | | gitpod | bool | Add a Gitpod development environment. | | mergify | bool | Whether mergify should be enabled on this repository or not. | | mergify_options | projen.github.MergifyOptions | Options for mergify. | | project_type | projen.ProjectType | Which type of project this is (library/app). | | projen_credentials | projen.github.GithubCredentials | Choose a method of providing GitHub API access for projen workflows. | | projen_token_secret | str | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. | | readme | projen.SampleReadmeProps | The README setup. | | stale | bool | Auto-close of stale issues and pull request. | | stale_options | projen.github.StaleOptions | Auto-close stale issues and pull requests. | | vscode | bool | Enable VSCode integration. | | artifact_id | str | The artifactId is generally the name that the project is known by. | | group_id | str | This is generally unique amongst an organization or a project. | | version | str | This is the last piece of the naming puzzle. | | description | str | Description of a project is always good. | | packaging | str | Project packaging format. | | url | str | The URL, like the name, is not required. | | compile_options | projen.java.MavenCompileOptions | Compile options. | | deps | typing.List[str] | List of runtime dependencies for this project. | | distdir | str | Final artifact output directory. | | junit | bool | Include junit tests. | | junit_options | projen.java.JunitOptions | junit options. | | packaging_options | projen.java.MavenPackagingOptions | Packaging options. | | projenrc_java | bool | Use projenrc in java. | | projenrc_java_options | projen.java.ProjenrcOptions | Options related to projenrc in java. | | test_deps | typing.List[str] | List of test dependencies for this project. | | sample | bool | Include sample code and test if the relevant directories don't exist. | | sample_java_package | str | The java package to use for the code sample. | | build_command | str | A command to execute before synthesis. | | cdkout | str | cdk.out directory. | | context | typing.Mapping[typing.Any] | Additional context to include in `cdk.json`. | | feature_flags | bool | Include all feature flags in cdk.json. | | require_approval | 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. | | watch_excludes | typing.List[str] | Glob patterns to exclude from `cdk watch`. | | watch_includes | typing.List[str] | Glob patterns to include in `cdk watch`. | | cdk_version | str | Minimum version of the AWS CDK to depend on. | | cdk_assert | bool | Warning: NodeJS only. | | cdk_assertions | bool | Install the assertions library? | | cdk_dependencies | typing.List[str] | Which AWS CDKv1 modules this project requires. | | cdk_dependencies_as_deps | bool | If this is enabled (default), all modules declared in `cdkDependencies` will be also added as normal `dependencies` (as well as `peerDependencies`). | | cdk_test_dependencies | typing.List[str] | AWS CDK modules required for testing. | | cdk_version_pinning | bool | Use pinned version instead of caret version for CDK. | | constructs_version | str | Minimum version of the `constructs` library to depend on. | | main_class | str | The name of the Java class with the static `main()` method. | --- ##### `name`^Required ```python name: str ``` - *Type:* str - *Default:* $BASEDIR This is the name of your project. --- ##### `commit_generated`^Optional ```python commit_generated: bool ``` - *Type:* bool - *Default:* true Whether to commit the managed files by default. --- ##### `git_ignore_options`^Optional ```python git_ignore_options: IgnoreFileOptions ``` - *Type:* projen.IgnoreFileOptions Configuration options for .gitignore file. --- ##### `git_options`^Optional ```python git_options: GitOptions ``` - *Type:* projen.GitOptions Configuration options for git. --- ##### `logging`^Optional ```python logging: LoggerOptions ``` - *Type:* projen.LoggerOptions - *Default:* {} Configure logging options such as verbosity. --- ##### `outdir`^Optional ```python outdir: str ``` - *Type:* str - *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 ```python parent: Project ``` - *Type:* projen.Project The parent project, if this project is part of a bigger project. --- ##### `projen_command`^Optional ```python projen_command: str ``` - *Type:* str - *Default:* "npx projen" The shell command to use in order to run the projen CLI. Can be used to customize in special environments. --- ##### `projenrc_json`^Optional ```python projenrc_json: bool ``` - *Type:* bool - *Default:* false Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. --- ##### `projenrc_json_options`^Optional ```python projenrc_json_options: ProjenrcJsonOptions ``` - *Type:* projen.ProjenrcJsonOptions - *Default:* default options Options for .projenrc.json. --- ##### `renovatebot`^Optional ```python renovatebot: bool ``` - *Type:* bool - *Default:* false Use renovatebot to handle dependency upgrades. --- ##### `renovatebot_options`^Optional ```python renovatebot_options: RenovatebotOptions ``` - *Type:* projen.RenovatebotOptions - *Default:* default options Options for renovatebot. --- ##### `auto_approve_options`^Optional ```python auto_approve_options: AutoApproveOptions ``` - *Type:* projen.github.AutoApproveOptions - *Default:* auto approve is disabled Enable and configure the 'auto approve' workflow. --- ##### `auto_merge`^Optional ```python auto_merge: bool ``` - *Type:* bool - *Default:* true Enable automatic merging on GitHub. Has no effect if `github.mergify` is set to false. --- ##### `auto_merge_options`^Optional ```python auto_merge_options: AutoMergeOptions ``` - *Type:* projen.github.AutoMergeOptions - *Default:* see defaults in `AutoMergeOptions` Configure options for automatic merging on GitHub. Has no effect if `github.mergify` or `autoMerge` is set to false. --- ##### `clobber`^Optional ```python clobber: bool ``` - *Type:* bool - *Default:* true, but false for subprojects Add a `clobber` task which resets the repo to origin. --- ##### `dev_container`^Optional ```python dev_container: bool ``` - *Type:* bool - *Default:* false Add a VSCode development environment (used for GitHub Codespaces). --- ##### `github`^Optional ```python github: bool ``` - *Type:* bool - *Default:* true Enable GitHub integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `github_options`^Optional ```python github_options: GitHubOptions ``` - *Type:* projen.github.GitHubOptions - *Default:* see GitHubOptions Options for GitHub integration. --- ##### `gitpod`^Optional ```python gitpod: bool ``` - *Type:* bool - *Default:* false Add a Gitpod development environment. --- ##### ~~`mergify`~~^Optional - *Deprecated:* use `githubOptions.mergify` instead ```python mergify: bool ``` - *Type:* bool - *Default:* true Whether mergify should be enabled on this repository or not. --- ##### ~~`mergify_options`~~^Optional - *Deprecated:* use `githubOptions.mergifyOptions` instead ```python mergify_options: MergifyOptions ``` - *Type:* projen.github.MergifyOptions - *Default:* default options Options for mergify. --- ##### ~~`project_type`~~^Optional - *Deprecated:* no longer supported at the base project level ```python project_type: ProjectType ``` - *Type:* projen.ProjectType - *Default:* ProjectType.UNKNOWN Which type of project this is (library/app). --- ##### `projen_credentials`^Optional ```python projen_credentials: GithubCredentials ``` - *Type:* projen.github.GithubCredentials - *Default:* use a personal access token named PROJEN_GITHUB_TOKEN Choose a method of providing GitHub API access for projen workflows. --- ##### ~~`projen_token_secret`~~^Optional - *Deprecated:* use `projenCredentials` ```python projen_token_secret: str ``` - *Type:* str - *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 ```python readme: SampleReadmeProps ``` - *Type:* projen.SampleReadmeProps - *Default:* { filename: 'README.md', contents: '# replace this' } The README setup. --- *Example* ```python "{ filename: 'readme.md', contents: '# title' }" ``` ##### `stale`^Optional ```python stale: bool ``` - *Type:* bool - *Default:* false Auto-close of stale issues and pull request. See `staleOptions` for options. --- ##### `stale_options`^Optional ```python stale_options: StaleOptions ``` - *Type:* projen.github.StaleOptions - *Default:* see defaults in `StaleOptions` Auto-close stale issues and pull requests. To disable set `stale` to `false`. --- ##### `vscode`^Optional ```python vscode: bool ``` - *Type:* bool - *Default:* true Enable VSCode integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `artifact_id`^Required ```python artifact_id: str ``` - *Type:* str - *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. --- ##### `group_id`^Required ```python group_id: str ``` - *Type:* str - *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 ```python version: str ``` - *Type:* str - *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 ```python description: str ``` - *Type:* str - *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 ```python packaging: str ``` - *Type:* str - *Default:* "jar" Project packaging format. --- ##### `url`^Optional ```python url: str ``` - *Type:* str - *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. --- ##### `compile_options`^Optional ```python compile_options: MavenCompileOptions ``` - *Type:* projen.java.MavenCompileOptions - *Default:* defaults Compile options. --- ##### `deps`^Optional ```python deps: typing.List[str] ``` - *Type:* typing.List[str] - *Default:* [] List of runtime dependencies for this project. Dependencies use the format: `/@` Additional dependencies can be added via `project.addDependency()`. --- ##### `distdir`^Optional ```python distdir: str ``` - *Type:* str - *Default:* "dist/java" Final artifact output directory. --- ##### `junit`^Optional ```python junit: bool ``` - *Type:* bool - *Default:* true Include junit tests. --- ##### `junit_options`^Optional ```python junit_options: JunitOptions ``` - *Type:* projen.java.JunitOptions - *Default:* defaults junit options. --- ##### `packaging_options`^Optional ```python packaging_options: MavenPackagingOptions ``` - *Type:* projen.java.MavenPackagingOptions - *Default:* defaults Packaging options. --- ##### `projenrc_java`^Optional ```python projenrc_java: bool ``` - *Type:* bool - *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`. --- ##### `projenrc_java_options`^Optional ```python projenrc_java_options: ProjenrcOptions ``` - *Type:* projen.java.ProjenrcOptions - *Default:* default options Options related to projenrc in java. --- ##### `test_deps`^Optional ```python test_deps: typing.List[str] ``` - *Type:* typing.List[str] - *Default:* [] List of test dependencies for this project. Dependencies use the format: `/@` Additional dependencies can be added via `project.addTestDependency()`. --- ##### `sample`^Optional ```python sample: bool ``` - *Type:* bool - *Default:* true Include sample code and test if the relevant directories don't exist. --- ##### `sample_java_package`^Optional ```python sample_java_package: str ``` - *Type:* str - *Default:* "org.acme" The java package to use for the code sample. --- ##### `build_command`^Optional ```python build_command: str ``` - *Type:* str - *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 ```python cdkout: str ``` - *Type:* str - *Default:* "cdk.out" cdk.out directory. --- ##### `context`^Optional ```python context: typing.Mapping[typing.Any] ``` - *Type:* typing.Mapping[typing.Any] - *Default:* no additional context Additional context to include in `cdk.json`. --- ##### `feature_flags`^Optional ```python feature_flags: bool ``` - *Type:* bool - *Default:* true Include all feature flags in cdk.json. --- ##### `require_approval`^Optional ```python require_approval: ApprovalLevel ``` - *Type:* projen.awscdk.ApprovalLevel - *Default:* ApprovalLevel.BROADENING To protect you against unintended changes that affect your security posture, the AWS CDK Toolkit prompts you to approve security-related changes before deploying them. --- ##### `watch_excludes`^Optional ```python watch_excludes: typing.List[str] ``` - *Type:* typing.List[str] - *Default:* [] Glob patterns to exclude from `cdk watch`. --- ##### `watch_includes`^Optional ```python watch_includes: typing.List[str] ``` - *Type:* typing.List[str] - *Default:* [] Glob patterns to include in `cdk watch`. --- ##### `cdk_version`^Required ```python cdk_version: str ``` - *Type:* str - *Default:* "2.1.0" Minimum version of the AWS CDK to depend on. --- ##### ~~`cdk_assert`~~^Optional - *Deprecated:* The ```python cdk_assert: bool ``` - *Type:* bool - *Default:* will be included by default for AWS CDK >= 1.0.0 < 2.0.0 Warning: NodeJS only. Install the --- ##### `cdk_assertions`^Optional ```python cdk_assertions: bool ``` - *Type:* bool - *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' --- ##### ~~`cdk_dependencies`~~^Optional - *Deprecated:* For CDK 2.x use "deps" instead. (or "peerDeps" if you're building a library) ```python cdk_dependencies: typing.List[str] ``` - *Type:* typing.List[str] Which AWS CDKv1 modules this project requires. --- ##### ~~`cdk_dependencies_as_deps`~~^Optional - *Deprecated:* Not supported in CDK v2. ```python cdk_dependencies_as_deps: bool ``` - *Type:* bool - *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 --- ##### ~~`cdk_test_dependencies`~~^Optional - *Deprecated:* For CDK 2.x use 'devDeps' (in node.js projects) or 'testDeps' (in java projects) instead ```python cdk_test_dependencies: typing.List[str] ``` - *Type:* typing.List[str] AWS CDK modules required for testing. --- ##### `cdk_version_pinning`^Optional ```python cdk_version_pinning: bool ``` - *Type:* bool 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. --- ##### `constructs_version`^Optional ```python constructs_version: str ``` - *Type:* str - *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. --- ##### `main_class`^Required ```python main_class: str ``` - *Type:* str - *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 ```python import aws_prototyping_sdk.pipeline aws_prototyping_sdk.pipeline.PDKPipelineProps( synth: IFileSetProducer, artifact_bucket: IBucket = None, asset_publishing_code_build_defaults: CodeBuildOptions = None, cli_version: str = None, code_build_defaults: CodeBuildOptions = None, code_pipeline: Pipeline = None, cross_account_keys: bool = None, docker_credentials: typing.List[DockerCredential] = None, docker_enabled_for_self_mutation: bool = None, docker_enabled_for_synth: bool = None, enable_key_rotation: bool = None, pipeline_name: str = None, publish_assets_in_parallel: bool = None, reuse_cross_region_support_stacks: bool = None, role: IRole = None, self_mutation: bool = None, self_mutation_code_build_defaults: CodeBuildOptions = None, synth_code_build_defaults: CodeBuildOptions = None, use_change_sets: bool = None, primary_synth_directory: str, repository_name: str, branch_name_prefixes: typing.List[str] = None, cdk_command: str = None, code_commit_removal_policy: RemovalPolicy = None, default_branch_name: str = None, sonar_code_scanner_config: SonarCodeScannerConfig = None, synth_shell_step_partial_props: ShellStepProps = None ) ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | synth | aws_cdk.pipelines.IFileSetProducer | The build step that produces the CDK Cloud Assembly. | | artifact_bucket | aws_cdk.aws_s3.IBucket | An existing S3 Bucket to use for storing the pipeline's artifact. | | asset_publishing_code_build_defaults | aws_cdk.pipelines.CodeBuildOptions | Additional customizations to apply to the asset publishing CodeBuild projects. | | cli_version | str | CDK CLI version to use in self-mutation and asset publishing steps. | | code_build_defaults | aws_cdk.pipelines.CodeBuildOptions | Customize the CodeBuild projects created for this pipeline. | | code_pipeline | aws_cdk.aws_codepipeline.Pipeline | An existing Pipeline to be reused and built upon. | | cross_account_keys | bool | Create KMS keys for the artifact buckets, allowing cross-account deployments. | | docker_credentials | typing.List[aws_cdk.pipelines.DockerCredential] | A list of credentials used to authenticate to Docker registries. | | docker_enabled_for_self_mutation | bool | Enable Docker for the self-mutate step. | | docker_enabled_for_synth | bool | Enable Docker for the 'synth' step. | | enable_key_rotation | bool | Enable KMS key rotation for the generated KMS keys. | | pipeline_name | str | The name of the CodePipeline pipeline. | | publish_assets_in_parallel | bool | Publish assets in multiple CodeBuild projects. | | reuse_cross_region_support_stacks | bool | Reuse the same cross region support stack for all pipelines in the App. | | role | aws_cdk.aws_iam.IRole | The IAM role to be assumed by this Pipeline. | | self_mutation | bool | Whether the pipeline will update itself. | | self_mutation_code_build_defaults | aws_cdk.pipelines.CodeBuildOptions | Additional customizations to apply to the self mutation CodeBuild projects. | | synth_code_build_defaults | aws_cdk.pipelines.CodeBuildOptions | Additional customizations to apply to the synthesize CodeBuild projects. | | use_change_sets | bool | Deploy every stack by creating a change set and executing it. | | primary_synth_directory | str | Output directory for cdk synthesized artifacts i.e: packages/infra/cdk.out. | | repository_name | str | Name of the CodeCommit repository to create. | | branch_name_prefixes | typing.List[str] | Branch name prefixes Any branches created matching this list of prefixes will create a new pipeline and stack. | | cdk_command | str | CDK command. | | code_commit_removal_policy | aws_cdk.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. | | default_branch_name | str | Branch to trigger the pipeline execution. | | sonar_code_scanner_config | SonarCodeScannerConfig | Configuration for enabling Sonarqube code scanning on a successful synth. | | synth_shell_step_partial_props | aws_cdk.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 ```python synth: IFileSetProducer ``` - *Type:* aws_cdk.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`. --- ##### `artifact_bucket`^Optional ```python artifact_bucket: IBucket ``` - *Type:* aws_cdk.aws_s3.IBucket - *Default:* A new S3 bucket will be created. An existing S3 Bucket to use for storing the pipeline's artifact. --- ##### `asset_publishing_code_build_defaults`^Optional ```python asset_publishing_code_build_defaults: CodeBuildOptions ``` - *Type:* aws_cdk.pipelines.CodeBuildOptions - *Default:* Only `codeBuildDefaults` are applied Additional customizations to apply to the asset publishing CodeBuild projects. --- ##### `cli_version`^Optional ```python cli_version: str ``` - *Type:* str - *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. --- ##### `code_build_defaults`^Optional ```python code_build_defaults: CodeBuildOptions ``` - *Type:* aws_cdk.pipelines.CodeBuildOptions - *Default:* All projects run non-privileged build, SMALL instance, LinuxBuildImage.STANDARD_6_0 Customize the CodeBuild projects created for this pipeline. --- ##### `code_pipeline`^Optional ```python code_pipeline: Pipeline ``` - *Type:* aws_cdk.aws_codepipeline.Pipeline - *Default:* a new underlying pipeline is created. An existing Pipeline to be reused and built upon. [disable-awslint:ref-via-interface] --- ##### `cross_account_keys`^Optional ```python cross_account_keys: bool ``` - *Type:* bool - *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. --- ##### `docker_credentials`^Optional ```python docker_credentials: typing.List[DockerCredential] ``` - *Type:* typing.List[aws_cdk.pipelines.DockerCredential] - *Default:* [] A list of credentials used to authenticate to Docker registries. Specify any credentials necessary within the pipeline to build, synth, update, or publish assets. --- ##### `docker_enabled_for_self_mutation`^Optional ```python docker_enabled_for_self_mutation: bool ``` - *Type:* bool - *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. --- ##### `docker_enabled_for_synth`^Optional ```python docker_enabled_for_synth: bool ``` - *Type:* bool - *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. --- ##### `enable_key_rotation`^Optional ```python enable_key_rotation: bool ``` - *Type:* bool - *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. --- ##### `pipeline_name`^Optional ```python pipeline_name: str ``` - *Type:* str - *Default:* Automatically generated The name of the CodePipeline pipeline. --- ##### `publish_assets_in_parallel`^Optional ```python publish_assets_in_parallel: bool ``` - *Type:* bool - *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. --- ##### `reuse_cross_region_support_stacks`^Optional ```python reuse_cross_region_support_stacks: bool ``` - *Type:* bool - *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 ```python role: IRole ``` - *Type:* aws_cdk.aws_iam.IRole - *Default:* A new role is created The IAM role to be assumed by this Pipeline. --- ##### `self_mutation`^Optional ```python self_mutation: bool ``` - *Type:* bool - *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`. --- ##### `self_mutation_code_build_defaults`^Optional ```python self_mutation_code_build_defaults: CodeBuildOptions ``` - *Type:* aws_cdk.pipelines.CodeBuildOptions - *Default:* Only `codeBuildDefaults` are applied Additional customizations to apply to the self mutation CodeBuild projects. --- ##### `synth_code_build_defaults`^Optional ```python synth_code_build_defaults: CodeBuildOptions ``` - *Type:* aws_cdk.pipelines.CodeBuildOptions - *Default:* Only `codeBuildDefaults` are applied Additional customizations to apply to the synthesize CodeBuild projects. --- ##### `use_change_sets`^Optional ```python use_change_sets: bool ``` - *Type:* bool - *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. --- ##### `primary_synth_directory`^Required ```python primary_synth_directory: str ``` - *Type:* str Output directory for cdk synthesized artifacts i.e: packages/infra/cdk.out. --- ##### `repository_name`^Required ```python repository_name: str ``` - *Type:* str Name of the CodeCommit repository to create. --- ##### `branch_name_prefixes`^Optional ```python branch_name_prefixes: typing.List[str] ``` - *Type:* typing.List[str] - *Default:* undefined Branch name prefixes Any branches created matching this list of prefixes will create a new pipeline and stack. --- *Example* ```python # Example automatically generated from non-compiling source. May contain errors. # Disables feature branches (default) PDKPipeline(self, "PDKPipeline", repository_name="my-repo", branch_name_prefixes=[] ) ``` ##### `cdk_command`^Optional ```python cdk_command: str ``` - *Type:* str - *Default:* 'npx cdk' CDK command. Override the command used to call cdk for synth and deploy. --- ##### `code_commit_removal_policy`^Optional ```python code_commit_removal_policy: RemovalPolicy ``` - *Type:* aws_cdk.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. --- ##### `default_branch_name`^Optional ```python default_branch_name: str ``` - *Type:* str - *Default:* mainline Branch to trigger the pipeline execution. --- ##### `sonar_code_scanner_config`^Optional ```python sonar_code_scanner_config: SonarCodeScannerConfig ``` - *Type:* SonarCodeScannerConfig - *Default:* undefined Configuration for enabling Sonarqube code scanning on a successful synth. --- ##### `synth_shell_step_partial_props`^Optional ```python synth_shell_step_partial_props: ShellStepProps ``` - *Type:* aws_cdk.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 ```python import aws_prototyping_sdk.pipeline aws_prototyping_sdk.pipeline.PDKPipelinePyProjectOptions( name: str, commit_generated: bool = None, git_ignore_options: IgnoreFileOptions = None, git_options: GitOptions = None, logging: LoggerOptions = None, outdir: str = None, parent: Project = None, projen_command: str = None, projenrc_json: bool = None, projenrc_json_options: ProjenrcJsonOptions = None, renovatebot: bool = None, renovatebot_options: RenovatebotOptions = None, auto_approve_options: AutoApproveOptions = None, auto_merge: bool = None, auto_merge_options: AutoMergeOptions = None, clobber: bool = None, dev_container: bool = None, github: bool = None, github_options: GitHubOptions = None, gitpod: bool = None, mergify: bool = None, mergify_options: MergifyOptions = None, project_type: ProjectType = None, projen_credentials: GithubCredentials = None, projen_token_secret: str = None, readme: SampleReadmeProps = None, stale: bool = None, stale_options: StaleOptions = None, vscode: bool = None, author_email: str, author_name: str, version: str, classifiers: typing.List[str] = None, description: str = None, homepage: str = None, license: str = None, package_name: str = None, poetry_options: PoetryPyprojectOptionsWithoutDeps = None, setup_config: typing.Mapping[typing.Any] = None, module_name: str, deps: typing.List[str] = None, dev_deps: typing.List[str] = None, pip: bool = None, poetry: bool = None, projenrc_js: bool = None, projenrc_js_options: ProjenrcOptions = None, projenrc_python: bool = None, projenrc_python_options: ProjenrcOptions = None, projenrc_ts: bool = None, projenrc_ts_options: ProjenrcTsOptions = None, pytest: bool = None, pytest_options: PytestOptions = None, python_exec: str = None, sample: bool = None, setuptools: bool = None, venv: bool = None, venv_options: VenvOptions = None, build_command: str = None, cdkout: str = None, context: typing.Mapping[typing.Any] = None, feature_flags: bool = None, require_approval: ApprovalLevel = None, watch_excludes: typing.List[str] = None, watch_includes: typing.List[str] = None, cdk_version: str, cdk_assert: bool = None, cdk_assertions: bool = None, cdk_dependencies: typing.List[str] = None, cdk_dependencies_as_deps: bool = None, cdk_test_dependencies: typing.List[str] = None, cdk_version_pinning: bool = None, constructs_version: str = None, app_entrypoint: str = None, testdir: str = None ) ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | str | This is the name of your project. | | commit_generated | bool | Whether to commit the managed files by default. | | git_ignore_options | projen.IgnoreFileOptions | Configuration options for .gitignore file. | | git_options | projen.GitOptions | Configuration options for git. | | logging | projen.LoggerOptions | Configure logging options such as verbosity. | | outdir | str | The root directory of the project. | | parent | projen.Project | The parent project, if this project is part of a bigger project. | | projen_command | str | The shell command to use in order to run the projen CLI. | | projenrc_json | bool | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. | | projenrc_json_options | projen.ProjenrcJsonOptions | Options for .projenrc.json. | | renovatebot | bool | Use renovatebot to handle dependency upgrades. | | renovatebot_options | projen.RenovatebotOptions | Options for renovatebot. | | auto_approve_options | projen.github.AutoApproveOptions | Enable and configure the 'auto approve' workflow. | | auto_merge | bool | Enable automatic merging on GitHub. | | auto_merge_options | projen.github.AutoMergeOptions | Configure options for automatic merging on GitHub. | | clobber | bool | Add a `clobber` task which resets the repo to origin. | | dev_container | bool | Add a VSCode development environment (used for GitHub Codespaces). | | github | bool | Enable GitHub integration. | | github_options | projen.github.GitHubOptions | Options for GitHub integration. | | gitpod | bool | Add a Gitpod development environment. | | mergify | bool | Whether mergify should be enabled on this repository or not. | | mergify_options | projen.github.MergifyOptions | Options for mergify. | | project_type | projen.ProjectType | Which type of project this is (library/app). | | projen_credentials | projen.github.GithubCredentials | Choose a method of providing GitHub API access for projen workflows. | | projen_token_secret | str | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. | | readme | projen.SampleReadmeProps | The README setup. | | stale | bool | Auto-close of stale issues and pull request. | | stale_options | projen.github.StaleOptions | Auto-close stale issues and pull requests. | | vscode | bool | Enable VSCode integration. | | author_email | str | Author's e-mail. | | author_name | str | Author's name. | | version | str | Version of the package. | | classifiers | typing.List[str] | A list of PyPI trove classifiers that describe the project. | | description | str | A short description of the package. | | homepage | str | A URL to the website of the project. | | license | str | License of this package as an SPDX identifier. | | package_name | str | Package name. | | poetry_options | projen.python.PoetryPyprojectOptionsWithoutDeps | Additional options to set for poetry if using poetry. | | setup_config | typing.Mapping[typing.Any] | Additional fields to pass in the setup() function if using setuptools. | | module_name | str | Name of the python package as used in imports and filenames. | | deps | typing.List[str] | List of runtime dependencies for this project. | | dev_deps | typing.List[str] | List of dev dependencies for this project. | | pip | bool | Use pip with a requirements.txt file to track project dependencies. | | poetry | bool | Use poetry to manage your project dependencies, virtual environment, and (optional) packaging/publishing. | | projenrc_js | bool | Use projenrc in javascript. | | projenrc_js_options | projen.javascript.ProjenrcOptions | Options related to projenrc in JavaScript. | | projenrc_python | bool | Use projenrc in Python. | | projenrc_python_options | projen.python.ProjenrcOptions | Options related to projenrc in python. | | projenrc_ts | bool | Use projenrc in TypeScript. | | projenrc_ts_options | projen.typescript.ProjenrcTsOptions | Options related to projenrc in TypeScript. | | pytest | bool | Include pytest tests. | | pytest_options | projen.python.PytestOptions | pytest options. | | python_exec | str | Path to the python executable to use. | | sample | bool | Include sample code and test if the relevant directories don't exist. | | setuptools | bool | Use setuptools with a setup.py script for packaging and publishing. | | venv | bool | Use venv to manage a virtual environment for installing dependencies inside. | | venv_options | projen.python.VenvOptions | Venv options. | | build_command | str | A command to execute before synthesis. | | cdkout | str | cdk.out directory. | | context | typing.Mapping[typing.Any] | Additional context to include in `cdk.json`. | | feature_flags | bool | Include all feature flags in cdk.json. | | require_approval | 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. | | watch_excludes | typing.List[str] | Glob patterns to exclude from `cdk watch`. | | watch_includes | typing.List[str] | Glob patterns to include in `cdk watch`. | | cdk_version | str | Minimum version of the AWS CDK to depend on. | | cdk_assert | bool | Warning: NodeJS only. | | cdk_assertions | bool | Install the assertions library? | | cdk_dependencies | typing.List[str] | Which AWS CDKv1 modules this project requires. | | cdk_dependencies_as_deps | bool | If this is enabled (default), all modules declared in `cdkDependencies` will be also added as normal `dependencies` (as well as `peerDependencies`). | | cdk_test_dependencies | typing.List[str] | AWS CDK modules required for testing. | | cdk_version_pinning | bool | Use pinned version instead of caret version for CDK. | | constructs_version | str | Minimum version of the `constructs` library to depend on. | | app_entrypoint | str | The CDK app's entrypoint (relative to the source directory, which is "src" by default). | | testdir | str | Python sources directory. | --- ##### `name`^Required ```python name: str ``` - *Type:* str - *Default:* $BASEDIR This is the name of your project. --- ##### `commit_generated`^Optional ```python commit_generated: bool ``` - *Type:* bool - *Default:* true Whether to commit the managed files by default. --- ##### `git_ignore_options`^Optional ```python git_ignore_options: IgnoreFileOptions ``` - *Type:* projen.IgnoreFileOptions Configuration options for .gitignore file. --- ##### `git_options`^Optional ```python git_options: GitOptions ``` - *Type:* projen.GitOptions Configuration options for git. --- ##### `logging`^Optional ```python logging: LoggerOptions ``` - *Type:* projen.LoggerOptions - *Default:* {} Configure logging options such as verbosity. --- ##### `outdir`^Optional ```python outdir: str ``` - *Type:* str - *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 ```python parent: Project ``` - *Type:* projen.Project The parent project, if this project is part of a bigger project. --- ##### `projen_command`^Optional ```python projen_command: str ``` - *Type:* str - *Default:* "npx projen" The shell command to use in order to run the projen CLI. Can be used to customize in special environments. --- ##### `projenrc_json`^Optional ```python projenrc_json: bool ``` - *Type:* bool - *Default:* false Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. --- ##### `projenrc_json_options`^Optional ```python projenrc_json_options: ProjenrcJsonOptions ``` - *Type:* projen.ProjenrcJsonOptions - *Default:* default options Options for .projenrc.json. --- ##### `renovatebot`^Optional ```python renovatebot: bool ``` - *Type:* bool - *Default:* false Use renovatebot to handle dependency upgrades. --- ##### `renovatebot_options`^Optional ```python renovatebot_options: RenovatebotOptions ``` - *Type:* projen.RenovatebotOptions - *Default:* default options Options for renovatebot. --- ##### `auto_approve_options`^Optional ```python auto_approve_options: AutoApproveOptions ``` - *Type:* projen.github.AutoApproveOptions - *Default:* auto approve is disabled Enable and configure the 'auto approve' workflow. --- ##### `auto_merge`^Optional ```python auto_merge: bool ``` - *Type:* bool - *Default:* true Enable automatic merging on GitHub. Has no effect if `github.mergify` is set to false. --- ##### `auto_merge_options`^Optional ```python auto_merge_options: AutoMergeOptions ``` - *Type:* projen.github.AutoMergeOptions - *Default:* see defaults in `AutoMergeOptions` Configure options for automatic merging on GitHub. Has no effect if `github.mergify` or `autoMerge` is set to false. --- ##### `clobber`^Optional ```python clobber: bool ``` - *Type:* bool - *Default:* true, but false for subprojects Add a `clobber` task which resets the repo to origin. --- ##### `dev_container`^Optional ```python dev_container: bool ``` - *Type:* bool - *Default:* false Add a VSCode development environment (used for GitHub Codespaces). --- ##### `github`^Optional ```python github: bool ``` - *Type:* bool - *Default:* true Enable GitHub integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `github_options`^Optional ```python github_options: GitHubOptions ``` - *Type:* projen.github.GitHubOptions - *Default:* see GitHubOptions Options for GitHub integration. --- ##### `gitpod`^Optional ```python gitpod: bool ``` - *Type:* bool - *Default:* false Add a Gitpod development environment. --- ##### ~~`mergify`~~^Optional - *Deprecated:* use `githubOptions.mergify` instead ```python mergify: bool ``` - *Type:* bool - *Default:* true Whether mergify should be enabled on this repository or not. --- ##### ~~`mergify_options`~~^Optional - *Deprecated:* use `githubOptions.mergifyOptions` instead ```python mergify_options: MergifyOptions ``` - *Type:* projen.github.MergifyOptions - *Default:* default options Options for mergify. --- ##### ~~`project_type`~~^Optional - *Deprecated:* no longer supported at the base project level ```python project_type: ProjectType ``` - *Type:* projen.ProjectType - *Default:* ProjectType.UNKNOWN Which type of project this is (library/app). --- ##### `projen_credentials`^Optional ```python projen_credentials: GithubCredentials ``` - *Type:* projen.github.GithubCredentials - *Default:* use a personal access token named PROJEN_GITHUB_TOKEN Choose a method of providing GitHub API access for projen workflows. --- ##### ~~`projen_token_secret`~~^Optional - *Deprecated:* use `projenCredentials` ```python projen_token_secret: str ``` - *Type:* str - *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 ```python readme: SampleReadmeProps ``` - *Type:* projen.SampleReadmeProps - *Default:* { filename: 'README.md', contents: '# replace this' } The README setup. --- *Example* ```python "{ filename: 'readme.md', contents: '# title' }" ``` ##### `stale`^Optional ```python stale: bool ``` - *Type:* bool - *Default:* false Auto-close of stale issues and pull request. See `staleOptions` for options. --- ##### `stale_options`^Optional ```python stale_options: StaleOptions ``` - *Type:* projen.github.StaleOptions - *Default:* see defaults in `StaleOptions` Auto-close stale issues and pull requests. To disable set `stale` to `false`. --- ##### `vscode`^Optional ```python vscode: bool ``` - *Type:* bool - *Default:* true Enable VSCode integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `author_email`^Required ```python author_email: str ``` - *Type:* str - *Default:* $GIT_USER_EMAIL Author's e-mail. --- ##### `author_name`^Required ```python author_name: str ``` - *Type:* str - *Default:* $GIT_USER_NAME Author's name. --- ##### `version`^Required ```python version: str ``` - *Type:* str - *Default:* "0.1.0" Version of the package. --- ##### `classifiers`^Optional ```python classifiers: typing.List[str] ``` - *Type:* typing.List[str] A list of PyPI trove classifiers that describe the project. > [https://pypi.org/classifiers/](https://pypi.org/classifiers/) --- ##### `description`^Optional ```python description: str ``` - *Type:* str A short description of the package. --- ##### `homepage`^Optional ```python homepage: str ``` - *Type:* str A URL to the website of the project. --- ##### `license`^Optional ```python license: str ``` - *Type:* str License of this package as an SPDX identifier. --- ##### `package_name`^Optional ```python package_name: str ``` - *Type:* str Package name. --- ##### `poetry_options`^Optional ```python poetry_options: PoetryPyprojectOptionsWithoutDeps ``` - *Type:* projen.python.PoetryPyprojectOptionsWithoutDeps Additional options to set for poetry if using poetry. --- ##### `setup_config`^Optional ```python setup_config: typing.Mapping[typing.Any] ``` - *Type:* typing.Mapping[typing.Any] Additional fields to pass in the setup() function if using setuptools. --- ##### `module_name`^Required ```python module_name: str ``` - *Type:* str - *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 ```python deps: typing.List[str] ``` - *Type:* typing.List[str] - *Default:* [] List of runtime dependencies for this project. Dependencies use the format: `@` Additional dependencies can be added via `project.addDependency()`. --- ##### `dev_deps`^Optional ```python dev_deps: typing.List[str] ``` - *Type:* typing.List[str] - *Default:* [] List of dev dependencies for this project. Dependencies use the format: `@` Additional dependencies can be added via `project.addDevDependency()`. --- ##### `pip`^Optional ```python pip: bool ``` - *Type:* bool - *Default:* true, unless poetry is true, then false Use pip with a requirements.txt file to track project dependencies. --- ##### `poetry`^Optional ```python poetry: bool ``` - *Type:* bool - *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`. --- ##### `projenrc_js`^Optional ```python projenrc_js: bool ``` - *Type:* bool - *Default:* false Use projenrc in javascript. This will install `projen` as a JavaScript dependency and add a `synth` task which will run `.projenrc.js`. --- ##### `projenrc_js_options`^Optional ```python projenrc_js_options: ProjenrcOptions ``` - *Type:* projen.javascript.ProjenrcOptions - *Default:* default options Options related to projenrc in JavaScript. --- ##### `projenrc_python`^Optional ```python projenrc_python: bool ``` - *Type:* bool - *Default:* true Use projenrc in Python. This will install `projen` as a Python dependency and add a `synth` task which will run `.projenrc.py`. --- ##### `projenrc_python_options`^Optional ```python projenrc_python_options: ProjenrcOptions ``` - *Type:* projen.python.ProjenrcOptions - *Default:* default options Options related to projenrc in python. --- ##### `projenrc_ts`^Optional ```python projenrc_ts: bool ``` - *Type:* bool - *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. --- ##### `projenrc_ts_options`^Optional ```python projenrc_ts_options: ProjenrcTsOptions ``` - *Type:* projen.typescript.ProjenrcTsOptions - *Default:* default options Options related to projenrc in TypeScript. --- ##### `pytest`^Optional ```python pytest: bool ``` - *Type:* bool - *Default:* true Include pytest tests. --- ##### `pytest_options`^Optional ```python pytest_options: PytestOptions ``` - *Type:* projen.python.PytestOptions - *Default:* defaults pytest options. --- ##### `python_exec`^Optional ```python python_exec: str ``` - *Type:* str - *Default:* "python" Path to the python executable to use. --- ##### `sample`^Optional ```python sample: bool ``` - *Type:* bool - *Default:* true Include sample code and test if the relevant directories don't exist. --- ##### `setuptools`^Optional ```python setuptools: bool ``` - *Type:* bool - *Default:* true, unless poetry is true, then false Use setuptools with a setup.py script for packaging and publishing. --- ##### `venv`^Optional ```python venv: bool ``` - *Type:* bool - *Default:* true, unless poetry is true, then false Use venv to manage a virtual environment for installing dependencies inside. --- ##### `venv_options`^Optional ```python venv_options: VenvOptions ``` - *Type:* projen.python.VenvOptions - *Default:* defaults Venv options. --- ##### `build_command`^Optional ```python build_command: str ``` - *Type:* str - *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 ```python cdkout: str ``` - *Type:* str - *Default:* "cdk.out" cdk.out directory. --- ##### `context`^Optional ```python context: typing.Mapping[typing.Any] ``` - *Type:* typing.Mapping[typing.Any] - *Default:* no additional context Additional context to include in `cdk.json`. --- ##### `feature_flags`^Optional ```python feature_flags: bool ``` - *Type:* bool - *Default:* true Include all feature flags in cdk.json. --- ##### `require_approval`^Optional ```python require_approval: ApprovalLevel ``` - *Type:* projen.awscdk.ApprovalLevel - *Default:* ApprovalLevel.BROADENING To protect you against unintended changes that affect your security posture, the AWS CDK Toolkit prompts you to approve security-related changes before deploying them. --- ##### `watch_excludes`^Optional ```python watch_excludes: typing.List[str] ``` - *Type:* typing.List[str] - *Default:* [] Glob patterns to exclude from `cdk watch`. --- ##### `watch_includes`^Optional ```python watch_includes: typing.List[str] ``` - *Type:* typing.List[str] - *Default:* [] Glob patterns to include in `cdk watch`. --- ##### `cdk_version`^Required ```python cdk_version: str ``` - *Type:* str - *Default:* "2.1.0" Minimum version of the AWS CDK to depend on. --- ##### ~~`cdk_assert`~~^Optional - *Deprecated:* The ```python cdk_assert: bool ``` - *Type:* bool - *Default:* will be included by default for AWS CDK >= 1.0.0 < 2.0.0 Warning: NodeJS only. Install the --- ##### `cdk_assertions`^Optional ```python cdk_assertions: bool ``` - *Type:* bool - *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' --- ##### ~~`cdk_dependencies`~~^Optional - *Deprecated:* For CDK 2.x use "deps" instead. (or "peerDeps" if you're building a library) ```python cdk_dependencies: typing.List[str] ``` - *Type:* typing.List[str] Which AWS CDKv1 modules this project requires. --- ##### ~~`cdk_dependencies_as_deps`~~^Optional - *Deprecated:* Not supported in CDK v2. ```python cdk_dependencies_as_deps: bool ``` - *Type:* bool - *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 --- ##### ~~`cdk_test_dependencies`~~^Optional - *Deprecated:* For CDK 2.x use 'devDeps' (in node.js projects) or 'testDeps' (in java projects) instead ```python cdk_test_dependencies: typing.List[str] ``` - *Type:* typing.List[str] AWS CDK modules required for testing. --- ##### `cdk_version_pinning`^Optional ```python cdk_version_pinning: bool ``` - *Type:* bool 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. --- ##### `constructs_version`^Optional ```python constructs_version: str ``` - *Type:* str - *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. --- ##### `app_entrypoint`^Optional ```python app_entrypoint: str ``` - *Type:* str - *Default:* "app.py" The CDK app's entrypoint (relative to the source directory, which is "src" by default). --- ##### `testdir`^Optional ```python testdir: str ``` - *Type:* str - *Default:* "tests" Python sources directory. --- ### PDKPipelineTsProjectOptions Configuration options for the PDKPipelineTsProject. #### Initializer ```python import aws_prototyping_sdk.pipeline aws_prototyping_sdk.pipeline.PDKPipelineTsProjectOptions( name: str, commit_generated: bool = None, git_ignore_options: IgnoreFileOptions = None, git_options: GitOptions = None, logging: LoggerOptions = None, outdir: str = None, parent: Project = None, projen_command: str = None, projenrc_json: bool = None, projenrc_json_options: ProjenrcJsonOptions = None, renovatebot: bool = None, renovatebot_options: RenovatebotOptions = None, auto_approve_options: AutoApproveOptions = None, auto_merge: bool = None, auto_merge_options: AutoMergeOptions = None, clobber: bool = None, dev_container: bool = None, github: bool = None, github_options: GitHubOptions = None, gitpod: bool = None, mergify: bool = None, mergify_options: MergifyOptions = None, project_type: ProjectType = None, projen_credentials: GithubCredentials = None, projen_token_secret: str = None, readme: SampleReadmeProps = None, stale: bool = None, stale_options: StaleOptions = None, vscode: bool = None, allow_library_dependencies: bool = None, author_email: str = None, author_name: str = None, author_organization: bool = None, author_url: str = None, auto_detect_bin: bool = None, bin: typing.Mapping[str] = None, bugs_email: str = None, bugs_url: str = None, bundled_deps: typing.List[str] = None, code_artifact_options: CodeArtifactOptions = None, deps: typing.List[str] = None, description: str = None, dev_deps: typing.List[str] = None, entrypoint: str = None, homepage: str = None, keywords: typing.List[str] = None, license: str = None, licensed: bool = None, max_node_version: str = None, min_node_version: str = None, npm_access: NpmAccess = None, npm_registry: str = None, npm_registry_url: str = None, npm_token_secret: str = None, package_manager: NodePackageManager = None, package_name: str = None, peer_dependency_options: PeerDependencyOptions = None, peer_deps: typing.List[str] = None, pnpm_version: str = None, repository: str = None, repository_directory: str = None, scoped_packages_options: typing.List[ScopedPackagesOptions] = None, scripts: typing.Mapping[str] = None, stability: str = None, jsii_release_version: str = None, major_version: typing.Union[int, float] = None, min_major_version: typing.Union[int, float] = None, npm_dist_tag: str = None, post_build_steps: typing.List[JobStep] = None, prerelease: str = None, publish_dry_run: bool = None, publish_tasks: bool = None, release_branches: typing.Mapping[BranchOptions] = None, release_every_commit: bool = None, release_failure_issue: bool = None, release_failure_issue_label: str = None, release_schedule: str = None, release_tag_prefix: str = None, release_trigger: ReleaseTrigger = None, release_workflow_name: str = None, release_workflow_setup_steps: typing.List[JobStep] = None, versionrc_options: typing.Mapping[typing.Any] = None, workflow_container_image: str = None, workflow_runs_on: typing.List[str] = None, default_release_branch: str, artifacts_directory: str = None, auto_approve_upgrades: bool = None, build_workflow: bool = None, build_workflow_triggers: Triggers = None, bundler_options: BundlerOptions = None, code_cov: bool = None, code_cov_token_secret: str = None, copyright_owner: str = None, copyright_period: str = None, dependabot: bool = None, dependabot_options: DependabotOptions = None, deps_upgrade: bool = None, deps_upgrade_options: UpgradeDependenciesOptions = None, gitignore: typing.List[str] = None, jest: bool = None, jest_options: JestOptions = None, mutable_build: bool = None, npmignore: typing.List[str] = None, npmignore_enabled: bool = None, npm_ignore_options: IgnoreFileOptions = None, package: bool = None, prettier: bool = None, prettier_options: PrettierOptions = None, projen_dev_dependency: bool = None, projenrc_js: bool = None, projenrc_js_options: ProjenrcOptions = None, projen_version: str = None, pull_request_template: bool = None, pull_request_template_contents: typing.List[str] = None, release: bool = None, release_to_npm: bool = None, release_workflow: bool = None, workflow_bootstrap_steps: typing.List[JobStep] = None, workflow_git_identity: GitIdentity = None, workflow_node_version: str = None, workflow_package_cache: bool = None, disable_tsconfig: bool = None, disable_tsconfig_dev: bool = None, docgen: bool = None, docs_directory: str = None, entrypoint_types: str = None, eslint: bool = None, eslint_options: EslintOptions = None, libdir: str = None, projenrc_ts: bool = None, projenrc_ts_options: ProjenrcOptions = None, sample_code: bool = None, srcdir: str = None, testdir: str = None, tsconfig: TypescriptConfigOptions = None, tsconfig_dev: TypescriptConfigOptions = None, tsconfig_dev_file: str = None, typescript_version: str = None, build_command: str = None, cdkout: str = None, context: typing.Mapping[typing.Any] = None, feature_flags: bool = None, require_approval: ApprovalLevel = None, watch_excludes: typing.List[str] = None, watch_includes: typing.List[str] = None, cdk_version: str, cdk_assert: bool = None, cdk_assertions: bool = None, cdk_dependencies: typing.List[str] = None, cdk_dependencies_as_deps: bool = None, cdk_test_dependencies: typing.List[str] = None, cdk_version_pinning: bool = None, constructs_version: str = None, app_entrypoint: str = None, edge_lambda_auto_discover: bool = None, integration_test_auto_discover: bool = None, lambda_auto_discover: bool = None, lambda_extension_auto_discover: bool = None, lambda_options: LambdaFunctionCommonOptions = None ) ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | str | This is the name of your project. | | commit_generated | bool | Whether to commit the managed files by default. | | git_ignore_options | projen.IgnoreFileOptions | Configuration options for .gitignore file. | | git_options | projen.GitOptions | Configuration options for git. | | logging | projen.LoggerOptions | Configure logging options such as verbosity. | | outdir | str | The root directory of the project. | | parent | projen.Project | The parent project, if this project is part of a bigger project. | | projen_command | str | The shell command to use in order to run the projen CLI. | | projenrc_json | bool | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. | | projenrc_json_options | projen.ProjenrcJsonOptions | Options for .projenrc.json. | | renovatebot | bool | Use renovatebot to handle dependency upgrades. | | renovatebot_options | projen.RenovatebotOptions | Options for renovatebot. | | auto_approve_options | projen.github.AutoApproveOptions | Enable and configure the 'auto approve' workflow. | | auto_merge | bool | Enable automatic merging on GitHub. | | auto_merge_options | projen.github.AutoMergeOptions | Configure options for automatic merging on GitHub. | | clobber | bool | Add a `clobber` task which resets the repo to origin. | | dev_container | bool | Add a VSCode development environment (used for GitHub Codespaces). | | github | bool | Enable GitHub integration. | | github_options | projen.github.GitHubOptions | Options for GitHub integration. | | gitpod | bool | Add a Gitpod development environment. | | mergify | bool | Whether mergify should be enabled on this repository or not. | | mergify_options | projen.github.MergifyOptions | Options for mergify. | | project_type | projen.ProjectType | Which type of project this is (library/app). | | projen_credentials | projen.github.GithubCredentials | Choose a method of providing GitHub API access for projen workflows. | | projen_token_secret | str | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. | | readme | projen.SampleReadmeProps | The README setup. | | stale | bool | Auto-close of stale issues and pull request. | | stale_options | projen.github.StaleOptions | Auto-close stale issues and pull requests. | | vscode | bool | Enable VSCode integration. | | allow_library_dependencies | bool | Allow the project to include `peerDependencies` and `bundledDependencies`. | | author_email | str | Author's e-mail. | | author_name | str | Author's name. | | author_organization | bool | Is the author an organization. | | author_url | str | Author's URL / Website. | | auto_detect_bin | bool | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. | | bin | typing.Mapping[str] | Binary programs vended with your module. | | bugs_email | str | The email address to which issues should be reported. | | bugs_url | str | The url to your project's issue tracker. | | bundled_deps | typing.List[str] | List of dependencies to bundle into this module. | | code_artifact_options | projen.javascript.CodeArtifactOptions | Options for npm packages using AWS CodeArtifact. | | deps | typing.List[str] | Runtime dependencies of this module. | | description | str | The description is just a string that helps people understand the purpose of the package. | | dev_deps | typing.List[str] | Build dependencies for this module. | | entrypoint | str | Module entrypoint (`main` in `package.json`). | | homepage | str | Package's Homepage / Website. | | keywords | typing.List[str] | Keywords to include in `package.json`. | | license | str | License's SPDX identifier. | | licensed | bool | Indicates if a license should be added. | | max_node_version | str | Minimum node.js version to require via `engines` (inclusive). | | min_node_version | str | Minimum Node.js version to require via package.json `engines` (inclusive). | | npm_access | projen.javascript.NpmAccess | Access level of the npm package. | | npm_registry | str | The host name of the npm registry to publish to. | | npm_registry_url | str | The base URL of the npm package registry. | | npm_token_secret | str | GitHub secret which contains the NPM token to use when publishing packages. | | package_manager | projen.javascript.NodePackageManager | The Node Package Manager used to execute scripts. | | package_name | str | The "name" in package.json. | | peer_dependency_options | projen.javascript.PeerDependencyOptions | Options for `peerDeps`. | | peer_deps | typing.List[str] | Peer dependencies for this module. | | pnpm_version | str | The version of PNPM to use if using PNPM as a package manager. | | repository | str | The repository is the location where the actual code for your package lives. | | repository_directory | str | 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. | | scoped_packages_options | typing.List[projen.javascript.ScopedPackagesOptions] | Options for privately hosted scoped packages. | | scripts | typing.Mapping[str] | npm scripts to include. | | stability | str | Package's Stability. | | jsii_release_version | str | Version requirement of `publib` which is used to publish modules to npm. | | major_version | typing.Union[int, float] | Major version to release from the default branch. | | min_major_version | typing.Union[int, float] | Minimal Major version to release. | | npm_dist_tag | str | The npmDistTag to use when publishing from the default branch. | | post_build_steps | typing.List[projen.github.workflows.JobStep] | Steps to execute after build as part of the release workflow. | | prerelease | str | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). | | publish_dry_run | bool | Instead of actually publishing to package managers, just print the publishing command. | | publish_tasks | bool | Define publishing tasks that can be executed manually as well as workflows. | | release_branches | typing.Mapping[projen.release.BranchOptions] | Defines additional release branches. | | release_every_commit | bool | Automatically release new versions every commit to one of branches in `releaseBranches`. | | release_failure_issue | bool | Create a github issue on every failed publishing task. | | release_failure_issue_label | str | The label to apply to issues indicating publish failures. | | release_schedule | str | CRON schedule to trigger new releases. | | release_tag_prefix | str | Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. | | release_trigger | projen.release.ReleaseTrigger | The release trigger to use. | | release_workflow_name | str | The name of the default release workflow. | | release_workflow_setup_steps | typing.List[projen.github.workflows.JobStep] | A set of workflow steps to execute in order to setup the workflow container. | | versionrc_options | typing.Mapping[typing.Any] | Custom configuration used when creating changelog with standard-version package. | | workflow_container_image | str | Container image to use for GitHub workflows. | | workflow_runs_on | typing.List[str] | Github Runner selection labels. | | default_release_branch | str | The name of the main release branch. | | artifacts_directory | str | A directory which will contain build artifacts. | | auto_approve_upgrades | bool | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). | | build_workflow | bool | Define a GitHub workflow for building PRs. | | build_workflow_triggers | projen.github.workflows.Triggers | Build workflow triggers. | | bundler_options | projen.javascript.BundlerOptions | Options for `Bundler`. | | code_cov | bool | 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`. | | code_cov_token_secret | str | Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. | | copyright_owner | str | License copyright owner. | | copyright_period | str | The copyright years to put in the LICENSE file. | | dependabot | bool | Use dependabot to handle dependency upgrades. | | dependabot_options | projen.github.DependabotOptions | Options for dependabot. | | deps_upgrade | bool | Use github workflows to handle dependency upgrades. | | deps_upgrade_options | projen.javascript.UpgradeDependenciesOptions | Options for `UpgradeDependencies`. | | gitignore | typing.List[str] | Additional entries to .gitignore. | | jest | bool | Setup jest unit tests. | | jest_options | projen.javascript.JestOptions | Jest options. | | mutable_build | bool | Automatically update files modified during builds to pull-request branches. | | npmignore | typing.List[str] | Additional entries to .npmignore. | | npmignore_enabled | bool | Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. | | npm_ignore_options | projen.IgnoreFileOptions | Configuration options for .npmignore file. | | package | bool | Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). | | prettier | bool | Setup prettier. | | prettier_options | projen.javascript.PrettierOptions | Prettier options. | | projen_dev_dependency | bool | Indicates of "projen" should be installed as a devDependency. | | projenrc_js | bool | Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. | | projenrc_js_options | projen.javascript.ProjenrcOptions | Options for .projenrc.js. | | projen_version | str | Version of projen to install. | | pull_request_template | bool | Include a GitHub pull request template. | | pull_request_template_contents | typing.List[str] | The contents of the pull request template. | | release | bool | Add release management to this project. | | release_to_npm | bool | Automatically release to npm when new versions are introduced. | | release_workflow | bool | DEPRECATED: renamed to `release`. | | workflow_bootstrap_steps | typing.List[projen.github.workflows.JobStep] | Workflow steps to use in order to bootstrap this repo. | | workflow_git_identity | projen.github.GitIdentity | The git identity to use in workflows. | | workflow_node_version | str | The node version to use in GitHub workflows. | | workflow_package_cache | bool | Enable Node.js package cache in GitHub workflows. | | disable_tsconfig | bool | Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). | | disable_tsconfig_dev | bool | Do not generate a `tsconfig.dev.json` file. | | docgen | bool | Docgen by Typedoc. | | docs_directory | str | Docs directory. | | entrypoint_types | str | The .d.ts file that includes the type declarations for this module. | | eslint | bool | Setup eslint. | | eslint_options | projen.javascript.EslintOptions | Eslint options. | | libdir | str | Typescript artifacts output directory. | | projenrc_ts | bool | Use TypeScript for your projenrc file (`.projenrc.ts`). | | projenrc_ts_options | projen.typescript.ProjenrcOptions | Options for .projenrc.ts. | | sample_code | bool | Generate one-time sample in `src/` and `test/` if there are no files there. | | srcdir | str | Typescript sources directory. | | testdir | str | Jest tests directory. Tests files should be named `xxx.test.ts`. | | tsconfig | projen.javascript.TypescriptConfigOptions | Custom TSConfig. | | tsconfig_dev | projen.javascript.TypescriptConfigOptions | Custom tsconfig options for the development tsconfig.json file (used for testing). | | tsconfig_dev_file | str | The name of the development tsconfig.json file. | | typescript_version | str | TypeScript version to use. | | build_command | str | A command to execute before synthesis. | | cdkout | str | cdk.out directory. | | context | typing.Mapping[typing.Any] | Additional context to include in `cdk.json`. | | feature_flags | bool | Include all feature flags in cdk.json. | | require_approval | 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. | | watch_excludes | typing.List[str] | Glob patterns to exclude from `cdk watch`. | | watch_includes | typing.List[str] | Glob patterns to include in `cdk watch`. | | cdk_version | str | Minimum version of the AWS CDK to depend on. | | cdk_assert | bool | Warning: NodeJS only. | | cdk_assertions | bool | Install the assertions library? | | cdk_dependencies | typing.List[str] | Which AWS CDKv1 modules this project requires. | | cdk_dependencies_as_deps | bool | If this is enabled (default), all modules declared in `cdkDependencies` will be also added as normal `dependencies` (as well as `peerDependencies`). | | cdk_test_dependencies | typing.List[str] | AWS CDK modules required for testing. | | cdk_version_pinning | bool | Use pinned version instead of caret version for CDK. | | constructs_version | str | Minimum version of the `constructs` library to depend on. | | app_entrypoint | str | The CDK app's entrypoint (relative to the source directory, which is "src" by default). | | edge_lambda_auto_discover | bool | 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. | | integration_test_auto_discover | bool | Automatically discovers and creates integration tests for each `.integ.ts` file in under your test directory. | | lambda_auto_discover | bool | 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. | | lambda_extension_auto_discover | bool | 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. | | lambda_options | projen.awscdk.LambdaFunctionCommonOptions | Common options for all AWS Lambda functions. | --- ##### `name`^Required ```python name: str ``` - *Type:* str - *Default:* $BASEDIR This is the name of your project. --- ##### `commit_generated`^Optional ```python commit_generated: bool ``` - *Type:* bool - *Default:* true Whether to commit the managed files by default. --- ##### `git_ignore_options`^Optional ```python git_ignore_options: IgnoreFileOptions ``` - *Type:* projen.IgnoreFileOptions Configuration options for .gitignore file. --- ##### `git_options`^Optional ```python git_options: GitOptions ``` - *Type:* projen.GitOptions Configuration options for git. --- ##### `logging`^Optional ```python logging: LoggerOptions ``` - *Type:* projen.LoggerOptions - *Default:* {} Configure logging options such as verbosity. --- ##### `outdir`^Optional ```python outdir: str ``` - *Type:* str - *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 ```python parent: Project ``` - *Type:* projen.Project The parent project, if this project is part of a bigger project. --- ##### `projen_command`^Optional ```python projen_command: str ``` - *Type:* str - *Default:* "npx projen" The shell command to use in order to run the projen CLI. Can be used to customize in special environments. --- ##### `projenrc_json`^Optional ```python projenrc_json: bool ``` - *Type:* bool - *Default:* false Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. --- ##### `projenrc_json_options`^Optional ```python projenrc_json_options: ProjenrcJsonOptions ``` - *Type:* projen.ProjenrcJsonOptions - *Default:* default options Options for .projenrc.json. --- ##### `renovatebot`^Optional ```python renovatebot: bool ``` - *Type:* bool - *Default:* false Use renovatebot to handle dependency upgrades. --- ##### `renovatebot_options`^Optional ```python renovatebot_options: RenovatebotOptions ``` - *Type:* projen.RenovatebotOptions - *Default:* default options Options for renovatebot. --- ##### `auto_approve_options`^Optional ```python auto_approve_options: AutoApproveOptions ``` - *Type:* projen.github.AutoApproveOptions - *Default:* auto approve is disabled Enable and configure the 'auto approve' workflow. --- ##### `auto_merge`^Optional ```python auto_merge: bool ``` - *Type:* bool - *Default:* true Enable automatic merging on GitHub. Has no effect if `github.mergify` is set to false. --- ##### `auto_merge_options`^Optional ```python auto_merge_options: AutoMergeOptions ``` - *Type:* projen.github.AutoMergeOptions - *Default:* see defaults in `AutoMergeOptions` Configure options for automatic merging on GitHub. Has no effect if `github.mergify` or `autoMerge` is set to false. --- ##### `clobber`^Optional ```python clobber: bool ``` - *Type:* bool - *Default:* true, but false for subprojects Add a `clobber` task which resets the repo to origin. --- ##### `dev_container`^Optional ```python dev_container: bool ``` - *Type:* bool - *Default:* false Add a VSCode development environment (used for GitHub Codespaces). --- ##### `github`^Optional ```python github: bool ``` - *Type:* bool - *Default:* true Enable GitHub integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `github_options`^Optional ```python github_options: GitHubOptions ``` - *Type:* projen.github.GitHubOptions - *Default:* see GitHubOptions Options for GitHub integration. --- ##### `gitpod`^Optional ```python gitpod: bool ``` - *Type:* bool - *Default:* false Add a Gitpod development environment. --- ##### ~~`mergify`~~^Optional - *Deprecated:* use `githubOptions.mergify` instead ```python mergify: bool ``` - *Type:* bool - *Default:* true Whether mergify should be enabled on this repository or not. --- ##### ~~`mergify_options`~~^Optional - *Deprecated:* use `githubOptions.mergifyOptions` instead ```python mergify_options: MergifyOptions ``` - *Type:* projen.github.MergifyOptions - *Default:* default options Options for mergify. --- ##### ~~`project_type`~~^Optional - *Deprecated:* no longer supported at the base project level ```python project_type: ProjectType ``` - *Type:* projen.ProjectType - *Default:* ProjectType.UNKNOWN Which type of project this is (library/app). --- ##### `projen_credentials`^Optional ```python projen_credentials: GithubCredentials ``` - *Type:* projen.github.GithubCredentials - *Default:* use a personal access token named PROJEN_GITHUB_TOKEN Choose a method of providing GitHub API access for projen workflows. --- ##### ~~`projen_token_secret`~~^Optional - *Deprecated:* use `projenCredentials` ```python projen_token_secret: str ``` - *Type:* str - *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 ```python readme: SampleReadmeProps ``` - *Type:* projen.SampleReadmeProps - *Default:* { filename: 'README.md', contents: '# replace this' } The README setup. --- *Example* ```python "{ filename: 'readme.md', contents: '# title' }" ``` ##### `stale`^Optional ```python stale: bool ``` - *Type:* bool - *Default:* false Auto-close of stale issues and pull request. See `staleOptions` for options. --- ##### `stale_options`^Optional ```python stale_options: StaleOptions ``` - *Type:* projen.github.StaleOptions - *Default:* see defaults in `StaleOptions` Auto-close stale issues and pull requests. To disable set `stale` to `false`. --- ##### `vscode`^Optional ```python vscode: bool ``` - *Type:* bool - *Default:* true Enable VSCode integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `allow_library_dependencies`^Optional ```python allow_library_dependencies: bool ``` - *Type:* bool - *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. --- ##### `author_email`^Optional ```python author_email: str ``` - *Type:* str Author's e-mail. --- ##### `author_name`^Optional ```python author_name: str ``` - *Type:* str Author's name. --- ##### `author_organization`^Optional ```python author_organization: bool ``` - *Type:* bool Is the author an organization. --- ##### `author_url`^Optional ```python author_url: str ``` - *Type:* str Author's URL / Website. --- ##### `auto_detect_bin`^Optional ```python auto_detect_bin: bool ``` - *Type:* bool - *Default:* true Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. --- ##### `bin`^Optional ```python bin: typing.Mapping[str] ``` - *Type:* typing.Mapping[str] 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. --- ##### `bugs_email`^Optional ```python bugs_email: str ``` - *Type:* str The email address to which issues should be reported. --- ##### `bugs_url`^Optional ```python bugs_url: str ``` - *Type:* str The url to your project's issue tracker. --- ##### `bundled_deps`^Optional ```python bundled_deps: typing.List[str] ``` - *Type:* typing.List[str] 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. --- ##### `code_artifact_options`^Optional ```python code_artifact_options: CodeArtifactOptions ``` - *Type:* projen.javascript.CodeArtifactOptions - *Default:* undefined Options for npm packages using AWS CodeArtifact. This is required if publishing packages to, or installing scoped packages from AWS CodeArtifact --- ##### `deps`^Optional ```python deps: typing.List[str] ``` - *Type:* typing.List[str] - *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* ```python [ 'express', 'lodash', 'foo@^2' ] ``` ##### `description`^Optional ```python description: str ``` - *Type:* str 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 --- ##### `dev_deps`^Optional ```python dev_deps: typing.List[str] ``` - *Type:* typing.List[str] - *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* ```python [ 'typescript', '@types/express' ] ``` ##### `entrypoint`^Optional ```python entrypoint: str ``` - *Type:* str - *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 ```python homepage: str ``` - *Type:* str Package's Homepage / Website. --- ##### `keywords`^Optional ```python keywords: typing.List[str] ``` - *Type:* typing.List[str] Keywords to include in `package.json`. --- ##### `license`^Optional ```python license: str ``` - *Type:* str - *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 ```python licensed: bool ``` - *Type:* bool - *Default:* true Indicates if a license should be added. --- ##### `max_node_version`^Optional ```python max_node_version: str ``` - *Type:* str - *Default:* no max Minimum node.js version to require via `engines` (inclusive). --- ##### `min_node_version`^Optional ```python min_node_version: str ``` - *Type:* str - *Default:* no "engines" specified Minimum Node.js version to require via package.json `engines` (inclusive). --- ##### `npm_access`^Optional ```python npm_access: NpmAccess ``` - *Type:* projen.javascript.NpmAccess - *Default:* for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`. Access level of the npm package. --- ##### ~~`npm_registry`~~^Optional - *Deprecated:* use `npmRegistryUrl` instead ```python npm_registry: str ``` - *Type:* str The host name of the npm registry to publish to. Cannot be set together with `npmRegistryUrl`. --- ##### `npm_registry_url`^Optional ```python npm_registry_url: str ``` - *Type:* str - *Default:* "https://registry.npmjs.org" The base URL of the npm package registry. Must be a URL (e.g. start with "https://" or "http://") --- ##### `npm_token_secret`^Optional ```python npm_token_secret: str ``` - *Type:* str - *Default:* "NPM_TOKEN" GitHub secret which contains the NPM token to use when publishing packages. --- ##### `package_manager`^Optional ```python package_manager: NodePackageManager ``` - *Type:* projen.javascript.NodePackageManager - *Default:* NodePackageManager.YARN The Node Package Manager used to execute scripts. --- ##### `package_name`^Optional ```python package_name: str ``` - *Type:* str - *Default:* defaults to project name The "name" in package.json. --- ##### `peer_dependency_options`^Optional ```python peer_dependency_options: PeerDependencyOptions ``` - *Type:* projen.javascript.PeerDependencyOptions Options for `peerDeps`. --- ##### `peer_deps`^Optional ```python peer_deps: typing.List[str] ``` - *Type:* typing.List[str] - *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. --- ##### `pnpm_version`^Optional ```python pnpm_version: str ``` - *Type:* str - *Default:* "7" The version of PNPM to use if using PNPM as a package manager. --- ##### `repository`^Optional ```python repository: str ``` - *Type:* str The repository is the location where the actual code for your package lives. See https://classic.yarnpkg.com/en/docs/package-json/#toc-repository --- ##### `repository_directory`^Optional ```python repository_directory: str ``` - *Type:* str 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. --- ##### `scoped_packages_options`^Optional ```python scoped_packages_options: typing.List[ScopedPackagesOptions] ``` - *Type:* typing.List[projen.javascript.ScopedPackagesOptions] - *Default:* fetch all scoped packages from the public npm registry Options for privately hosted scoped packages. --- ##### ~~`scripts`~~^Optional - *Deprecated:* use `project.addTask()` or `package.setScript()` ```python scripts: typing.Mapping[str] ``` - *Type:* typing.Mapping[str] - *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 ```python stability: str ``` - *Type:* str Package's Stability. --- ##### `jsii_release_version`^Optional ```python jsii_release_version: str ``` - *Type:* str - *Default:* "latest" Version requirement of `publib` which is used to publish modules to npm. --- ##### `major_version`^Optional ```python major_version: typing.Union[int, float] ``` - *Type:* typing.Union[int, float] - *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. --- ##### `min_major_version`^Optional ```python min_major_version: typing.Union[int, float] ``` - *Type:* typing.Union[int, float] - *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`. --- ##### `npm_dist_tag`^Optional ```python npm_dist_tag: str ``` - *Type:* str - *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. --- ##### `post_build_steps`^Optional ```python post_build_steps: typing.List[JobStep] ``` - *Type:* typing.List[projen.github.workflows.JobStep] - *Default:* [] Steps to execute after build as part of the release workflow. --- ##### `prerelease`^Optional ```python prerelease: str ``` - *Type:* str - *Default:* normal semantic versions Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). --- ##### `publish_dry_run`^Optional ```python publish_dry_run: bool ``` - *Type:* bool - *Default:* false Instead of actually publishing to package managers, just print the publishing command. --- ##### `publish_tasks`^Optional ```python publish_tasks: bool ``` - *Type:* bool - *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. --- ##### `release_branches`^Optional ```python release_branches: typing.Mapping[BranchOptions] ``` - *Type:* typing.Mapping[projen.release.BranchOptions] - *Default:* no additional branches are used for release. you can use `addBranch()` to add additional branches. Defines additional release branches. A workflow will be created for each release branch which will publish releases from commits in this branch. Each release branch _must_ be assigned a major version number which is used to enforce that versions published from that branch always use that major version. If multiple branches are used, the `majorVersion` field must also be provided for the default branch. --- ##### ~~`release_every_commit`~~^Optional - *Deprecated:* Use `releaseTrigger: ReleaseTrigger.continuous()` instead ```python release_every_commit: bool ``` - *Type:* bool - *Default:* true Automatically release new versions every commit to one of branches in `releaseBranches`. --- ##### `release_failure_issue`^Optional ```python release_failure_issue: bool ``` - *Type:* bool - *Default:* false Create a github issue on every failed publishing task. --- ##### `release_failure_issue_label`^Optional ```python release_failure_issue_label: str ``` - *Type:* str - *Default:* "failed-release" The label to apply to issues indicating publish failures. Only applies if `releaseFailureIssue` is true. --- ##### ~~`release_schedule`~~^Optional - *Deprecated:* Use `releaseTrigger: ReleaseTrigger.scheduled()` instead ```python release_schedule: str ``` - *Type:* str - *Default:* no scheduled releases CRON schedule to trigger new releases. --- ##### `release_tag_prefix`^Optional ```python release_tag_prefix: str ``` - *Type:* str - *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. --- ##### `release_trigger`^Optional ```python release_trigger: ReleaseTrigger ``` - *Type:* projen.release.ReleaseTrigger - *Default:* Continuous releases (`ReleaseTrigger.continuous()`) The release trigger to use. --- ##### `release_workflow_name`^Optional ```python release_workflow_name: str ``` - *Type:* str - *Default:* "Release" The name of the default release workflow. --- ##### `release_workflow_setup_steps`^Optional ```python release_workflow_setup_steps: typing.List[JobStep] ``` - *Type:* typing.List[projen.github.workflows.JobStep] A set of workflow steps to execute in order to setup the workflow container. --- ##### `versionrc_options`^Optional ```python versionrc_options: typing.Mapping[typing.Any] ``` - *Type:* typing.Mapping[typing.Any] - *Default:* standard configuration applicable for GitHub repositories Custom configuration used when creating changelog with standard-version package. Given values either append to default configuration or overwrite values in it. --- ##### `workflow_container_image`^Optional ```python workflow_container_image: str ``` - *Type:* str - *Default:* default image Container image to use for GitHub workflows. --- ##### `workflow_runs_on`^Optional ```python workflow_runs_on: typing.List[str] ``` - *Type:* typing.List[str] - *Default:* ["ubuntu-latest"] Github Runner selection labels. --- ##### `default_release_branch`^Required ```python default_release_branch: str ``` - *Type:* str - *Default:* "main" The name of the main release branch. --- ##### `artifacts_directory`^Optional ```python artifacts_directory: str ``` - *Type:* str - *Default:* "dist" A directory which will contain build artifacts. --- ##### `auto_approve_upgrades`^Optional ```python auto_approve_upgrades: bool ``` - *Type:* bool - *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. --- ##### `build_workflow`^Optional ```python build_workflow: bool ``` - *Type:* bool - *Default:* true if not a subproject Define a GitHub workflow for building PRs. --- ##### `build_workflow_triggers`^Optional ```python build_workflow_triggers: Triggers ``` - *Type:* projen.github.workflows.Triggers - *Default:* "{ pullRequest: {}, workflowDispatch: {} }" Build workflow triggers. --- ##### `bundler_options`^Optional ```python bundler_options: BundlerOptions ``` - *Type:* projen.javascript.BundlerOptions Options for `Bundler`. --- ##### `code_cov`^Optional ```python code_cov: bool ``` - *Type:* bool - *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`. --- ##### `code_cov_token_secret`^Optional ```python code_cov_token_secret: str ``` - *Type:* str - *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. --- ##### `copyright_owner`^Optional ```python copyright_owner: str ``` - *Type:* str - *Default:* defaults to the value of authorName or "" if `authorName` is undefined. License copyright owner. --- ##### `copyright_period`^Optional ```python copyright_period: str ``` - *Type:* str - *Default:* current year The copyright years to put in the LICENSE file. --- ##### `dependabot`^Optional ```python dependabot: bool ``` - *Type:* bool - *Default:* false Use dependabot to handle dependency upgrades. Cannot be used in conjunction with `depsUpgrade`. --- ##### `dependabot_options`^Optional ```python dependabot_options: DependabotOptions ``` - *Type:* projen.github.DependabotOptions - *Default:* default options Options for dependabot. --- ##### `deps_upgrade`^Optional ```python deps_upgrade: bool ``` - *Type:* bool - *Default:* true Use github workflows to handle dependency upgrades. Cannot be used in conjunction with `dependabot`. --- ##### `deps_upgrade_options`^Optional ```python deps_upgrade_options: UpgradeDependenciesOptions ``` - *Type:* projen.javascript.UpgradeDependenciesOptions - *Default:* default options Options for `UpgradeDependencies`. --- ##### `gitignore`^Optional ```python gitignore: typing.List[str] ``` - *Type:* typing.List[str] Additional entries to .gitignore. --- ##### `jest`^Optional ```python jest: bool ``` - *Type:* bool - *Default:* true Setup jest unit tests. --- ##### `jest_options`^Optional ```python jest_options: JestOptions ``` - *Type:* projen.javascript.JestOptions - *Default:* default options Jest options. --- ##### `mutable_build`^Optional ```python mutable_build: bool ``` - *Type:* bool - *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` ```python npmignore: typing.List[str] ``` - *Type:* typing.List[str] Additional entries to .npmignore. --- ##### `npmignore_enabled`^Optional ```python npmignore_enabled: bool ``` - *Type:* bool - *Default:* true Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. --- ##### `npm_ignore_options`^Optional ```python npm_ignore_options: IgnoreFileOptions ``` - *Type:* projen.IgnoreFileOptions Configuration options for .npmignore file. --- ##### `package`^Optional ```python package: bool ``` - *Type:* bool - *Default:* true Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). --- ##### `prettier`^Optional ```python prettier: bool ``` - *Type:* bool - *Default:* false Setup prettier. --- ##### `prettier_options`^Optional ```python prettier_options: PrettierOptions ``` - *Type:* projen.javascript.PrettierOptions - *Default:* default options Prettier options. --- ##### `projen_dev_dependency`^Optional ```python projen_dev_dependency: bool ``` - *Type:* bool - *Default:* true Indicates of "projen" should be installed as a devDependency. --- ##### `projenrc_js`^Optional ```python projenrc_js: bool ``` - *Type:* bool - *Default:* true if projenrcJson is false Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. --- ##### `projenrc_js_options`^Optional ```python projenrc_js_options: ProjenrcOptions ``` - *Type:* projen.javascript.ProjenrcOptions - *Default:* default options Options for .projenrc.js. --- ##### `projen_version`^Optional ```python projen_version: str ``` - *Type:* str - *Default:* Defaults to the latest version. Version of projen to install. --- ##### `pull_request_template`^Optional ```python pull_request_template: bool ``` - *Type:* bool - *Default:* true Include a GitHub pull request template. --- ##### `pull_request_template_contents`^Optional ```python pull_request_template_contents: typing.List[str] ``` - *Type:* typing.List[str] - *Default:* default content The contents of the pull request template. --- ##### `release`^Optional ```python release: bool ``` - *Type:* bool - *Default:* true (false for subprojects) Add release management to this project. --- ##### `release_to_npm`^Optional ```python release_to_npm: bool ``` - *Type:* bool - *Default:* false Automatically release to npm when new versions are introduced. --- ##### ~~`release_workflow`~~^Optional - *Deprecated:* see `release`. ```python release_workflow: bool ``` - *Type:* bool - *Default:* true if not a subproject DEPRECATED: renamed to `release`. --- ##### `workflow_bootstrap_steps`^Optional ```python workflow_bootstrap_steps: typing.List[JobStep] ``` - *Type:* typing.List[projen.github.workflows.JobStep] - *Default:* "yarn install --frozen-lockfile && yarn projen" Workflow steps to use in order to bootstrap this repo. --- ##### `workflow_git_identity`^Optional ```python workflow_git_identity: GitIdentity ``` - *Type:* projen.github.GitIdentity - *Default:* GitHub Actions The git identity to use in workflows. --- ##### `workflow_node_version`^Optional ```python workflow_node_version: str ``` - *Type:* str - *Default:* same as `minNodeVersion` The node version to use in GitHub workflows. --- ##### `workflow_package_cache`^Optional ```python workflow_package_cache: bool ``` - *Type:* bool - *Default:* false Enable Node.js package cache in GitHub workflows. --- ##### `disable_tsconfig`^Optional ```python disable_tsconfig: bool ``` - *Type:* bool - *Default:* false Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). --- ##### `disable_tsconfig_dev`^Optional ```python disable_tsconfig_dev: bool ``` - *Type:* bool - *Default:* false Do not generate a `tsconfig.dev.json` file. --- ##### `docgen`^Optional ```python docgen: bool ``` - *Type:* bool - *Default:* false Docgen by Typedoc. --- ##### `docs_directory`^Optional ```python docs_directory: str ``` - *Type:* str - *Default:* "docs" Docs directory. --- ##### `entrypoint_types`^Optional ```python entrypoint_types: str ``` - *Type:* str - *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 ```python eslint: bool ``` - *Type:* bool - *Default:* true Setup eslint. --- ##### `eslint_options`^Optional ```python eslint_options: EslintOptions ``` - *Type:* projen.javascript.EslintOptions - *Default:* opinionated default options Eslint options. --- ##### `libdir`^Optional ```python libdir: str ``` - *Type:* str - *Default:* "lib" Typescript artifacts output directory. --- ##### `projenrc_ts`^Optional ```python projenrc_ts: bool ``` - *Type:* bool - *Default:* false Use TypeScript for your projenrc file (`.projenrc.ts`). --- ##### `projenrc_ts_options`^Optional ```python projenrc_ts_options: ProjenrcOptions ``` - *Type:* projen.typescript.ProjenrcOptions Options for .projenrc.ts. --- ##### `sample_code`^Optional ```python sample_code: bool ``` - *Type:* bool - *Default:* true Generate one-time sample in `src/` and `test/` if there are no files there. --- ##### `srcdir`^Optional ```python srcdir: str ``` - *Type:* str - *Default:* "src" Typescript sources directory. --- ##### `testdir`^Optional ```python testdir: str ``` - *Type:* str - *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 ```python tsconfig: TypescriptConfigOptions ``` - *Type:* projen.javascript.TypescriptConfigOptions - *Default:* default options Custom TSConfig. --- ##### `tsconfig_dev`^Optional ```python tsconfig_dev: TypescriptConfigOptions ``` - *Type:* projen.javascript.TypescriptConfigOptions - *Default:* use the production tsconfig options Custom tsconfig options for the development tsconfig.json file (used for testing). --- ##### `tsconfig_dev_file`^Optional ```python tsconfig_dev_file: str ``` - *Type:* str - *Default:* "tsconfig.dev.json" The name of the development tsconfig.json file. --- ##### `typescript_version`^Optional ```python typescript_version: str ``` - *Type:* str - *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`). --- ##### `build_command`^Optional ```python build_command: str ``` - *Type:* str - *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 ```python cdkout: str ``` - *Type:* str - *Default:* "cdk.out" cdk.out directory. --- ##### `context`^Optional ```python context: typing.Mapping[typing.Any] ``` - *Type:* typing.Mapping[typing.Any] - *Default:* no additional context Additional context to include in `cdk.json`. --- ##### `feature_flags`^Optional ```python feature_flags: bool ``` - *Type:* bool - *Default:* true Include all feature flags in cdk.json. --- ##### `require_approval`^Optional ```python require_approval: ApprovalLevel ``` - *Type:* projen.awscdk.ApprovalLevel - *Default:* ApprovalLevel.BROADENING To protect you against unintended changes that affect your security posture, the AWS CDK Toolkit prompts you to approve security-related changes before deploying them. --- ##### `watch_excludes`^Optional ```python watch_excludes: typing.List[str] ``` - *Type:* typing.List[str] - *Default:* [] Glob patterns to exclude from `cdk watch`. --- ##### `watch_includes`^Optional ```python watch_includes: typing.List[str] ``` - *Type:* typing.List[str] - *Default:* [] Glob patterns to include in `cdk watch`. --- ##### `cdk_version`^Required ```python cdk_version: str ``` - *Type:* str - *Default:* "2.1.0" Minimum version of the AWS CDK to depend on. --- ##### ~~`cdk_assert`~~^Optional - *Deprecated:* The ```python cdk_assert: bool ``` - *Type:* bool - *Default:* will be included by default for AWS CDK >= 1.0.0 < 2.0.0 Warning: NodeJS only. Install the --- ##### `cdk_assertions`^Optional ```python cdk_assertions: bool ``` - *Type:* bool - *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' --- ##### ~~`cdk_dependencies`~~^Optional - *Deprecated:* For CDK 2.x use "deps" instead. (or "peerDeps" if you're building a library) ```python cdk_dependencies: typing.List[str] ``` - *Type:* typing.List[str] Which AWS CDKv1 modules this project requires. --- ##### ~~`cdk_dependencies_as_deps`~~^Optional - *Deprecated:* Not supported in CDK v2. ```python cdk_dependencies_as_deps: bool ``` - *Type:* bool - *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 --- ##### ~~`cdk_test_dependencies`~~^Optional - *Deprecated:* For CDK 2.x use 'devDeps' (in node.js projects) or 'testDeps' (in java projects) instead ```python cdk_test_dependencies: typing.List[str] ``` - *Type:* typing.List[str] AWS CDK modules required for testing. --- ##### `cdk_version_pinning`^Optional ```python cdk_version_pinning: bool ``` - *Type:* bool 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. --- ##### `constructs_version`^Optional ```python constructs_version: str ``` - *Type:* str - *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. --- ##### `app_entrypoint`^Optional ```python app_entrypoint: str ``` - *Type:* str - *Default:* "main.ts" The CDK app's entrypoint (relative to the source directory, which is "src" by default). --- ##### `edge_lambda_auto_discover`^Optional ```python edge_lambda_auto_discover: bool ``` - *Type:* bool - *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. --- ##### `integration_test_auto_discover`^Optional ```python integration_test_auto_discover: bool ``` - *Type:* bool - *Default:* true Automatically discovers and creates integration tests for each `.integ.ts` file in under your test directory. --- ##### `lambda_auto_discover`^Optional ```python lambda_auto_discover: bool ``` - *Type:* bool - *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. --- ##### `lambda_extension_auto_discover`^Optional ```python lambda_extension_auto_discover: bool ``` - *Type:* bool - *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. --- ##### `lambda_options`^Optional ```python lambda_options: LambdaFunctionCommonOptions ``` - *Type:* projen.awscdk.LambdaFunctionCommonOptions - *Default:* default options Common options for all AWS Lambda functions. --- ### SonarCodeScannerConfig #### Initializer ```python import aws_prototyping_sdk.pipeline aws_prototyping_sdk.pipeline.SonarCodeScannerConfig( sonarqube_authorized_group: str, sonarqube_default_profile_or_gate_name: str, sonarqube_endpoint: str, sonarqube_project_name: str, cdk_out_dir: str = None, cfn_nag_ignore_path: str = None, exclude_globs_for_scan: typing.List[str] = None, include_globs_for_scan: typing.List[str] = None, pre_archive_commands: typing.List[str] = None, sonarqube_specific_profile_or_gate_name: str = None, sonarqube_tags: typing.List[str] = None ) ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | sonarqube_authorized_group | str | Group name in Sonarqube with access to administer this project. | | sonarqube_default_profile_or_gate_name | str | Default profile/gate name i.e: your org profile. | | sonarqube_endpoint | str | endpoint of the sonarqube instance i.e: https://. | | sonarqube_project_name | str | Name of the project to create in Sonarqube. | | cdk_out_dir | str | directory containing the synthesized cdk resources. | | cfn_nag_ignore_path | str | path to a file containing the cfn nag suppression rules. | | exclude_globs_for_scan | typing.List[str] | glob patterns to exclude from sonar scan. | | include_globs_for_scan | typing.List[str] | glob patterns to include from sonar scan. | | pre_archive_commands | typing.List[str] | Hook which allows custom commands to be executed before the process commences the archival process. | | sonarqube_specific_profile_or_gate_name | str | Specific profile/gate name i.e: language specific. | | sonarqube_tags | typing.List[str] | Tags to associate with this project. | --- ##### `sonarqube_authorized_group`^Required ```python sonarqube_authorized_group: str ``` - *Type:* str Group name in Sonarqube with access to administer this project. --- ##### `sonarqube_default_profile_or_gate_name`^Required ```python sonarqube_default_profile_or_gate_name: str ``` - *Type:* str Default profile/gate name i.e: your org profile. Note: These need to be set up in Sonarqube manually. --- ##### `sonarqube_endpoint`^Required ```python sonarqube_endpoint: str ``` - *Type:* str endpoint of the sonarqube instance i.e: https://. Note: Ensure a trailing '/' is not included. --- ##### `sonarqube_project_name`^Required ```python sonarqube_project_name: str ``` - *Type:* str Name of the project to create in Sonarqube. --- ##### `cdk_out_dir`^Optional ```python cdk_out_dir: str ``` - *Type:* str directory containing the synthesized cdk resources. --- ##### `cfn_nag_ignore_path`^Optional ```python cfn_nag_ignore_path: str ``` - *Type:* str path to a file containing the cfn nag suppression rules. --- ##### `exclude_globs_for_scan`^Optional ```python exclude_globs_for_scan: typing.List[str] ``` - *Type:* typing.List[str] glob patterns to exclude from sonar scan. --- ##### `include_globs_for_scan`^Optional ```python include_globs_for_scan: typing.List[str] ``` - *Type:* typing.List[str] glob patterns to include from sonar scan. --- ##### `pre_archive_commands`^Optional ```python pre_archive_commands: typing.List[str] ``` - *Type:* typing.List[str] Hook which allows custom commands to be executed before the process commences the archival process. --- ##### `sonarqube_specific_profile_or_gate_name`^Optional ```python sonarqube_specific_profile_or_gate_name: str ``` - *Type:* str Specific profile/gate name i.e: language specific. Note: These need to be set up in Sonarqube manually. --- ##### `sonarqube_tags`^Optional ```python sonarqube_tags: typing.List[str] ``` - *Type:* typing.List[str] Tags to associate with this project. --- ### SonarCodeScannerProps SonarCodeScanners properties. #### Initializer ```python import aws_prototyping_sdk.pipeline aws_prototyping_sdk.pipeline.SonarCodeScannerProps( sonarqube_authorized_group: str, sonarqube_default_profile_or_gate_name: str, sonarqube_endpoint: str, sonarqube_project_name: str, cdk_out_dir: str = None, cfn_nag_ignore_path: str = None, exclude_globs_for_scan: typing.List[str] = None, include_globs_for_scan: typing.List[str] = None, pre_archive_commands: typing.List[str] = None, sonarqube_specific_profile_or_gate_name: str = None, sonarqube_tags: typing.List[str] = None, artifact_bucket_arn: str, synth_build_arn: str, artifact_bucket_key_arn: str = None ) ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | sonarqube_authorized_group | str | Group name in Sonarqube with access to administer this project. | | sonarqube_default_profile_or_gate_name | str | Default profile/gate name i.e: your org profile. | | sonarqube_endpoint | str | endpoint of the sonarqube instance i.e: https://. | | sonarqube_project_name | str | Name of the project to create in Sonarqube. | | cdk_out_dir | str | directory containing the synthesized cdk resources. | | cfn_nag_ignore_path | str | path to a file containing the cfn nag suppression rules. | | exclude_globs_for_scan | typing.List[str] | glob patterns to exclude from sonar scan. | | include_globs_for_scan | typing.List[str] | glob patterns to include from sonar scan. | | pre_archive_commands | typing.List[str] | Hook which allows custom commands to be executed before the process commences the archival process. | | sonarqube_specific_profile_or_gate_name | str | Specific profile/gate name i.e: language specific. | | sonarqube_tags | typing.List[str] | Tags to associate with this project. | | artifact_bucket_arn | str | S3 bucket ARN containing the built artifacts from the synth build. | | synth_build_arn | str | ARN for the CodeBuild task responsible for executing the synth command. | | artifact_bucket_key_arn | str | Artifact bucket key ARN used to encrypt the artifacts. | --- ##### `sonarqube_authorized_group`^Required ```python sonarqube_authorized_group: str ``` - *Type:* str Group name in Sonarqube with access to administer this project. --- ##### `sonarqube_default_profile_or_gate_name`^Required ```python sonarqube_default_profile_or_gate_name: str ``` - *Type:* str Default profile/gate name i.e: your org profile. Note: These need to be set up in Sonarqube manually. --- ##### `sonarqube_endpoint`^Required ```python sonarqube_endpoint: str ``` - *Type:* str endpoint of the sonarqube instance i.e: https://. Note: Ensure a trailing '/' is not included. --- ##### `sonarqube_project_name`^Required ```python sonarqube_project_name: str ``` - *Type:* str Name of the project to create in Sonarqube. --- ##### `cdk_out_dir`^Optional ```python cdk_out_dir: str ``` - *Type:* str directory containing the synthesized cdk resources. --- ##### `cfn_nag_ignore_path`^Optional ```python cfn_nag_ignore_path: str ``` - *Type:* str path to a file containing the cfn nag suppression rules. --- ##### `exclude_globs_for_scan`^Optional ```python exclude_globs_for_scan: typing.List[str] ``` - *Type:* typing.List[str] glob patterns to exclude from sonar scan. --- ##### `include_globs_for_scan`^Optional ```python include_globs_for_scan: typing.List[str] ``` - *Type:* typing.List[str] glob patterns to include from sonar scan. --- ##### `pre_archive_commands`^Optional ```python pre_archive_commands: typing.List[str] ``` - *Type:* typing.List[str] Hook which allows custom commands to be executed before the process commences the archival process. --- ##### `sonarqube_specific_profile_or_gate_name`^Optional ```python sonarqube_specific_profile_or_gate_name: str ``` - *Type:* str Specific profile/gate name i.e: language specific. Note: These need to be set up in Sonarqube manually. --- ##### `sonarqube_tags`^Optional ```python sonarqube_tags: typing.List[str] ``` - *Type:* typing.List[str] Tags to associate with this project. --- ##### `artifact_bucket_arn`^Required ```python artifact_bucket_arn: str ``` - *Type:* str S3 bucket ARN containing the built artifacts from the synth build. --- ##### `synth_build_arn`^Required ```python synth_build_arn: str ``` - *Type:* str ARN for the CodeBuild task responsible for executing the synth command. --- ##### `artifact_bucket_key_arn`^Optional ```python artifact_bucket_key_arn: str ``` - *Type:* str Artifact bucket key ARN used to encrypt the artifacts. --- ## Classes ### PDKPipelineJavaProject Synthesizes a Java Project with a CI/CD pipeline. #### Initializers ```python import aws_prototyping_sdk.pipeline aws_prototyping_sdk.pipeline.PDKPipelineJavaProject( name: str, commit_generated: bool = None, git_ignore_options: IgnoreFileOptions = None, git_options: GitOptions = None, logging: LoggerOptions = None, outdir: str = None, parent: Project = None, projen_command: str = None, projenrc_json: bool = None, projenrc_json_options: ProjenrcJsonOptions = None, renovatebot: bool = None, renovatebot_options: RenovatebotOptions = None, auto_approve_options: AutoApproveOptions = None, auto_merge: bool = None, auto_merge_options: AutoMergeOptions = None, clobber: bool = None, dev_container: bool = None, github: bool = None, github_options: GitHubOptions = None, gitpod: bool = None, mergify: bool = None, mergify_options: MergifyOptions = None, project_type: ProjectType = None, projen_credentials: GithubCredentials = None, projen_token_secret: str = None, readme: SampleReadmeProps = None, stale: bool = None, stale_options: StaleOptions = None, vscode: bool = None, artifact_id: str, group_id: str, version: str, description: str = None, packaging: str = None, url: str = None, compile_options: MavenCompileOptions = None, deps: typing.List[str] = None, distdir: str = None, junit: bool = None, junit_options: JunitOptions = None, packaging_options: MavenPackagingOptions = None, projenrc_java: bool = None, projenrc_java_options: ProjenrcOptions = None, test_deps: typing.List[str] = None, sample: bool = None, sample_java_package: str = None, build_command: str = None, cdkout: str = None, context: typing.Mapping[typing.Any] = None, feature_flags: bool = None, require_approval: ApprovalLevel = None, watch_excludes: typing.List[str] = None, watch_includes: typing.List[str] = None, cdk_version: str, cdk_assert: bool = None, cdk_assertions: bool = None, cdk_dependencies: typing.List[str] = None, cdk_dependencies_as_deps: bool = None, cdk_test_dependencies: typing.List[str] = None, cdk_version_pinning: bool = None, constructs_version: str = None, main_class: str ) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | name | str | This is the name of your project. | | commit_generated | bool | Whether to commit the managed files by default. | | git_ignore_options | projen.IgnoreFileOptions | Configuration options for .gitignore file. | | git_options | projen.GitOptions | Configuration options for git. | | logging | projen.LoggerOptions | Configure logging options such as verbosity. | | outdir | str | The root directory of the project. | | parent | projen.Project | The parent project, if this project is part of a bigger project. | | projen_command | str | The shell command to use in order to run the projen CLI. | | projenrc_json | bool | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. | | projenrc_json_options | projen.ProjenrcJsonOptions | Options for .projenrc.json. | | renovatebot | bool | Use renovatebot to handle dependency upgrades. | | renovatebot_options | projen.RenovatebotOptions | Options for renovatebot. | | auto_approve_options | projen.github.AutoApproveOptions | Enable and configure the 'auto approve' workflow. | | auto_merge | bool | Enable automatic merging on GitHub. | | auto_merge_options | projen.github.AutoMergeOptions | Configure options for automatic merging on GitHub. | | clobber | bool | Add a `clobber` task which resets the repo to origin. | | dev_container | bool | Add a VSCode development environment (used for GitHub Codespaces). | | github | bool | Enable GitHub integration. | | github_options | projen.github.GitHubOptions | Options for GitHub integration. | | gitpod | bool | Add a Gitpod development environment. | | mergify | bool | Whether mergify should be enabled on this repository or not. | | mergify_options | projen.github.MergifyOptions | Options for mergify. | | project_type | projen.ProjectType | Which type of project this is (library/app). | | projen_credentials | projen.github.GithubCredentials | Choose a method of providing GitHub API access for projen workflows. | | projen_token_secret | str | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. | | readme | projen.SampleReadmeProps | The README setup. | | stale | bool | Auto-close of stale issues and pull request. | | stale_options | projen.github.StaleOptions | Auto-close stale issues and pull requests. | | vscode | bool | Enable VSCode integration. | | artifact_id | str | The artifactId is generally the name that the project is known by. | | group_id | str | This is generally unique amongst an organization or a project. | | version | str | This is the last piece of the naming puzzle. | | description | str | Description of a project is always good. | | packaging | str | Project packaging format. | | url | str | The URL, like the name, is not required. | | compile_options | projen.java.MavenCompileOptions | Compile options. | | deps | typing.List[str] | List of runtime dependencies for this project. | | distdir | str | Final artifact output directory. | | junit | bool | Include junit tests. | | junit_options | projen.java.JunitOptions | junit options. | | packaging_options | projen.java.MavenPackagingOptions | Packaging options. | | projenrc_java | bool | Use projenrc in java. | | projenrc_java_options | projen.java.ProjenrcOptions | Options related to projenrc in java. | | test_deps | typing.List[str] | List of test dependencies for this project. | | sample | bool | Include sample code and test if the relevant directories don't exist. | | sample_java_package | str | The java package to use for the code sample. | | build_command | str | A command to execute before synthesis. | | cdkout | str | cdk.out directory. | | context | typing.Mapping[typing.Any] | Additional context to include in `cdk.json`. | | feature_flags | bool | Include all feature flags in cdk.json. | | require_approval | 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. | | watch_excludes | typing.List[str] | Glob patterns to exclude from `cdk watch`. | | watch_includes | typing.List[str] | Glob patterns to include in `cdk watch`. | | cdk_version | str | Minimum version of the AWS CDK to depend on. | | cdk_assert | bool | Warning: NodeJS only. | | cdk_assertions | bool | Install the assertions library? | | cdk_dependencies | typing.List[str] | Which AWS CDKv1 modules this project requires. | | cdk_dependencies_as_deps | bool | If this is enabled (default), all modules declared in `cdkDependencies` will be also added as normal `dependencies` (as well as `peerDependencies`). | | cdk_test_dependencies | typing.List[str] | AWS CDK modules required for testing. | | cdk_version_pinning | bool | Use pinned version instead of caret version for CDK. | | constructs_version | str | Minimum version of the `constructs` library to depend on. | | main_class | str | The name of the Java class with the static `main()` method. | --- ##### `name`^Required - *Type:* str - *Default:* $BASEDIR This is the name of your project. --- ##### `commit_generated`^Optional - *Type:* bool - *Default:* true Whether to commit the managed files by default. --- ##### `git_ignore_options`^Optional - *Type:* projen.IgnoreFileOptions Configuration options for .gitignore file. --- ##### `git_options`^Optional - *Type:* projen.GitOptions Configuration options for git. --- ##### `logging`^Optional - *Type:* projen.LoggerOptions - *Default:* {} Configure logging options such as verbosity. --- ##### `outdir`^Optional - *Type:* str - *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:* projen.Project The parent project, if this project is part of a bigger project. --- ##### `projen_command`^Optional - *Type:* str - *Default:* "npx projen" The shell command to use in order to run the projen CLI. Can be used to customize in special environments. --- ##### `projenrc_json`^Optional - *Type:* bool - *Default:* false Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. --- ##### `projenrc_json_options`^Optional - *Type:* projen.ProjenrcJsonOptions - *Default:* default options Options for .projenrc.json. --- ##### `renovatebot`^Optional - *Type:* bool - *Default:* false Use renovatebot to handle dependency upgrades. --- ##### `renovatebot_options`^Optional - *Type:* projen.RenovatebotOptions - *Default:* default options Options for renovatebot. --- ##### `auto_approve_options`^Optional - *Type:* projen.github.AutoApproveOptions - *Default:* auto approve is disabled Enable and configure the 'auto approve' workflow. --- ##### `auto_merge`^Optional - *Type:* bool - *Default:* true Enable automatic merging on GitHub. Has no effect if `github.mergify` is set to false. --- ##### `auto_merge_options`^Optional - *Type:* projen.github.AutoMergeOptions - *Default:* see defaults in `AutoMergeOptions` Configure options for automatic merging on GitHub. Has no effect if `github.mergify` or `autoMerge` is set to false. --- ##### `clobber`^Optional - *Type:* bool - *Default:* true, but false for subprojects Add a `clobber` task which resets the repo to origin. --- ##### `dev_container`^Optional - *Type:* bool - *Default:* false Add a VSCode development environment (used for GitHub Codespaces). --- ##### `github`^Optional - *Type:* bool - *Default:* true Enable GitHub integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `github_options`^Optional - *Type:* projen.github.GitHubOptions - *Default:* see GitHubOptions Options for GitHub integration. --- ##### `gitpod`^Optional - *Type:* bool - *Default:* false Add a Gitpod development environment. --- ##### ~~`mergify`~~^Optional - *Deprecated:* use `githubOptions.mergify` instead - *Type:* bool - *Default:* true Whether mergify should be enabled on this repository or not. --- ##### ~~`mergify_options`~~^Optional - *Deprecated:* use `githubOptions.mergifyOptions` instead - *Type:* projen.github.MergifyOptions - *Default:* default options Options for mergify. --- ##### ~~`project_type`~~^Optional - *Deprecated:* no longer supported at the base project level - *Type:* projen.ProjectType - *Default:* ProjectType.UNKNOWN Which type of project this is (library/app). --- ##### `projen_credentials`^Optional - *Type:* projen.github.GithubCredentials - *Default:* use a personal access token named PROJEN_GITHUB_TOKEN Choose a method of providing GitHub API access for projen workflows. --- ##### ~~`projen_token_secret`~~^Optional - *Deprecated:* use `projenCredentials` - *Type:* str - *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:* projen.SampleReadmeProps - *Default:* { filename: 'README.md', contents: '# replace this' } The README setup. --- *Example* ```python "{ filename: 'readme.md', contents: '# title' }" ``` ##### `stale`^Optional - *Type:* bool - *Default:* false Auto-close of stale issues and pull request. See `staleOptions` for options. --- ##### `stale_options`^Optional - *Type:* projen.github.StaleOptions - *Default:* see defaults in `StaleOptions` Auto-close stale issues and pull requests. To disable set `stale` to `false`. --- ##### `vscode`^Optional - *Type:* bool - *Default:* true Enable VSCode integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `artifact_id`^Required - *Type:* str - *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. --- ##### `group_id`^Required - *Type:* str - *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:* str - *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:* str - *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:* str - *Default:* "jar" Project packaging format. --- ##### `url`^Optional - *Type:* str - *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. --- ##### `compile_options`^Optional - *Type:* projen.java.MavenCompileOptions - *Default:* defaults Compile options. --- ##### `deps`^Optional - *Type:* typing.List[str] - *Default:* [] List of runtime dependencies for this project. Dependencies use the format: `/@` Additional dependencies can be added via `project.addDependency()`. --- ##### `distdir`^Optional - *Type:* str - *Default:* "dist/java" Final artifact output directory. --- ##### `junit`^Optional - *Type:* bool - *Default:* true Include junit tests. --- ##### `junit_options`^Optional - *Type:* projen.java.JunitOptions - *Default:* defaults junit options. --- ##### `packaging_options`^Optional - *Type:* projen.java.MavenPackagingOptions - *Default:* defaults Packaging options. --- ##### `projenrc_java`^Optional - *Type:* bool - *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`. --- ##### `projenrc_java_options`^Optional - *Type:* projen.java.ProjenrcOptions - *Default:* default options Options related to projenrc in java. --- ##### `test_deps`^Optional - *Type:* typing.List[str] - *Default:* [] List of test dependencies for this project. Dependencies use the format: `/@` Additional dependencies can be added via `project.addTestDependency()`. --- ##### `sample`^Optional - *Type:* bool - *Default:* true Include sample code and test if the relevant directories don't exist. --- ##### `sample_java_package`^Optional - *Type:* str - *Default:* "org.acme" The java package to use for the code sample. --- ##### `build_command`^Optional - *Type:* str - *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:* str - *Default:* "cdk.out" cdk.out directory. --- ##### `context`^Optional - *Type:* typing.Mapping[typing.Any] - *Default:* no additional context Additional context to include in `cdk.json`. --- ##### `feature_flags`^Optional - *Type:* bool - *Default:* true Include all feature flags in cdk.json. --- ##### `require_approval`^Optional - *Type:* projen.awscdk.ApprovalLevel - *Default:* ApprovalLevel.BROADENING To protect you against unintended changes that affect your security posture, the AWS CDK Toolkit prompts you to approve security-related changes before deploying them. --- ##### `watch_excludes`^Optional - *Type:* typing.List[str] - *Default:* [] Glob patterns to exclude from `cdk watch`. --- ##### `watch_includes`^Optional - *Type:* typing.List[str] - *Default:* [] Glob patterns to include in `cdk watch`. --- ##### `cdk_version`^Required - *Type:* str - *Default:* "2.1.0" Minimum version of the AWS CDK to depend on. --- ##### ~~`cdk_assert`~~^Optional - *Deprecated:* The - *Type:* bool - *Default:* will be included by default for AWS CDK >= 1.0.0 < 2.0.0 Warning: NodeJS only. Install the --- ##### `cdk_assertions`^Optional - *Type:* bool - *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' --- ##### ~~`cdk_dependencies`~~^Optional - *Deprecated:* For CDK 2.x use "deps" instead. (or "peerDeps" if you're building a library) - *Type:* typing.List[str] Which AWS CDKv1 modules this project requires. --- ##### ~~`cdk_dependencies_as_deps`~~^Optional - *Deprecated:* Not supported in CDK v2. - *Type:* bool - *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 --- ##### ~~`cdk_test_dependencies`~~^Optional - *Deprecated:* For CDK 2.x use 'devDeps' (in node.js projects) or 'testDeps' (in java projects) instead - *Type:* typing.List[str] AWS CDK modules required for testing. --- ##### `cdk_version_pinning`^Optional - *Type:* bool 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. --- ##### `constructs_version`^Optional - *Type:* str - *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. --- ##### `main_class`^Required - *Type:* str - *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** | | --- | --- | | add_exclude_from_cleanup | Exclude the matching files from pre-synth cleanup. | | add_git_ignore | Adds a .gitignore pattern. | | add_package_ignore | Exclude these files from the bundled package. | | add_task | Adds a new task to this project. | | add_tip | Prints a "tip" message during synthesis. | | annotate_generated | Marks the provided file(s) as being generated. | | post_synthesize | Called after all components are synthesized. | | pre_synthesize | Called before all components are synthesized. | | remove_task | Removes a task from a project. | | run_task_command | Returns the shell command to execute in order to run a task. | | synth | Synthesize all project files into `outdir`. | | try_find_file | Finds a file at the specified relative path within this project and all its subprojects. | | try_find_json_file | Finds a json file by name. | | try_find_object_file | Finds an object file (like JsonFile, YamlFile, etc.) by name. | | try_remove_file | Finds a file at the specified relative path within this project and removes it. | | add_dependency | Adds a runtime dependency. | | add_plugin | Adds a build plugin to the pom. | | add_test_dependency | Adds a test dependency. | | add_cdk_dependency | Adds an AWS CDK module dependencies. | --- ##### `add_exclude_from_cleanup` ```python def add_exclude_from_cleanup( globs: str ) -> None ``` 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:* str The glob patterns to match. --- ##### `add_git_ignore` ```python def add_git_ignore( pattern: str ) -> None ``` Adds a .gitignore pattern. ###### `pattern`^Required - *Type:* str The glob pattern to ignore. --- ##### `add_package_ignore` ```python def add_package_ignore( _pattern: str ) -> None ``` 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:* str The glob pattern to exclude. --- ##### `add_task` ```python def add_task( name: str, condition: str = None, cwd: str = None, description: str = None, env: typing.Mapping[str] = None, required_env: typing.List[str] = None, args: typing.List[str] = None, exec: str = None, receive_args: bool = None, steps: typing.List[TaskStep] = None ) -> Task ``` Adds a new task to this project. This will fail if the project already has a task with this name. ###### `name`^Required - *Type:* str The task name to add. --- ###### `condition`^Optional - *Type:* str A shell command which determines if the this task should be executed. If the program exits with a zero exit code, steps will be executed. A non-zero code means that task will be skipped. --- ###### `cwd`^Optional - *Type:* str - *Default:* process.cwd() The working directory for all steps in this task (unless overridden by the step). --- ###### `description`^Optional - *Type:* str - *Default:* the task name The description of this build command. --- ###### `env`^Optional - *Type:* typing.Mapping[str] - *Default:* {} Defines environment variables for the execution of this task. Values in this map will be evaluated in a shell, so you can do stuff like `$(echo "foo")`. --- ###### `required_env`^Optional - *Type:* typing.List[str] A set of environment variables that must be defined in order to execute this task. Task execution will fail if one of these is not defined. --- ###### `args`^Optional - *Type:* typing.List[str] - *Default:* no arguments are passed to the step Should the provided `exec` shell command receive fixed args. > [{@link TaskStepOptions.args }]({@link TaskStepOptions.args }) --- ###### `exec`^Optional - *Type:* str - *Default:* add steps using `task.exec(command)` or `task.spawn(subtask)` Shell command to execute as the first command of the task. --- ###### `receive_args`^Optional - *Type:* bool - *Default:* false Should the provided `exec` shell command receive args passed to the task. > [{@link TaskStepOptions.receiveArgs }]({@link TaskStepOptions.receiveArgs }) --- ###### `steps`^Optional - *Type:* typing.List[projen.TaskStep] List of task steps to run. --- ##### ~~`add_tip`~~ ```python def add_tip( message: str ) -> None ``` Prints a "tip" message during synthesis. ###### `message`^Required - *Type:* str The message. --- ##### `annotate_generated` ```python def annotate_generated( glob: str ) -> None ``` 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:* str the glob pattern to match (could be a file path). --- ##### `post_synthesize` ```python def post_synthesize() -> None ``` Called after all components are synthesized. Order is *not* guaranteed. ##### `pre_synthesize` ```python def pre_synthesize() -> None ``` Called before all components are synthesized. ##### `remove_task` ```python def remove_task( name: str ) -> Task ``` Removes a task from a project. ###### `name`^Required - *Type:* str The name of the task to remove. --- ##### `run_task_command` ```python def run_task_command( task: Task ) -> str ``` Returns the shell command to execute in order to run a task. By default, this is `npx projen@ ` ###### `task`^Required - *Type:* projen.Task The task for which the command is required. --- ##### `synth` ```python def synth() -> None ``` 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()" ##### `try_find_file` ```python def try_find_file( file_path: str ) -> FileBase ``` Finds a file at the specified relative path within this project and all its subprojects. ###### `file_path`^Required - *Type:* str The file path. If this path is relative, it will be resolved from the root of _this_ project. --- ##### ~~`try_find_json_file`~~ ```python def try_find_json_file( file_path: str ) -> JsonFile ``` Finds a json file by name. ###### `file_path`^Required - *Type:* str The file path. --- ##### `try_find_object_file` ```python def try_find_object_file( file_path: str ) -> ObjectFile ``` Finds an object file (like JsonFile, YamlFile, etc.) by name. ###### `file_path`^Required - *Type:* str The file path. --- ##### `try_remove_file` ```python def try_remove_file( file_path: str ) -> FileBase ``` Finds a file at the specified relative path within this project and removes it. ###### `file_path`^Required - *Type:* str The file path. If this path is relative, it will be resolved from the root of _this_ project. --- ##### `add_dependency` ```python def add_dependency( spec: str ) -> None ``` Adds a runtime dependency. ###### `spec`^Required - *Type:* str Format `/@`. --- ##### `add_plugin` ```python def add_plugin( spec: str, configuration: typing.Mapping[typing.Any] = None, dependencies: typing.List[str] = None, executions: typing.List[PluginExecution] = None ) -> Dependency ``` Adds a build plugin to the pom. The plug in is also added as a BUILD dep to the project. ###### `spec`^Required - *Type:* str dependency spec (`group/artifact@version`). --- ###### `configuration`^Optional - *Type:* typing.Mapping[typing.Any] - *Default:* {} Plugin key/value configuration. --- ###### `dependencies`^Optional - *Type:* typing.List[str] - *Default:* [] You could configure the dependencies for the plugin. Dependencies are in `/@` format. --- ###### `executions`^Optional - *Type:* typing.List[projen.java.PluginExecution] - *Default:* [] Plugin executions. --- ##### `add_test_dependency` ```python def add_test_dependency( spec: str ) -> None ``` Adds a test dependency. ###### `spec`^Required - *Type:* str Format `/@`. --- ##### ~~`add_cdk_dependency`~~ ```python def add_cdk_dependency( modules: str ) -> None ``` Adds an AWS CDK module dependencies. ###### `modules`^Required - *Type:* str The list of modules to depend on (e.g. "software.amazon.awscdk/aws-lambda", "software.amazon.awscdk/aws-iam", etc). --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | build_task | projen.Task | *No description.* | | commit_generated | bool | Whether to commit the managed files by default. | | compile_task | projen.Task | *No description.* | | components | typing.List[projen.Component] | Returns all the components within this project. | | deps | projen.Dependencies | Project dependencies. | | ejected | bool | Whether or not the project is being ejected. | | files | typing.List[projen.FileBase] | All files in this project. | | gitattributes | projen.GitAttributesFile | The .gitattributes file for this repository. | | gitignore | projen.IgnoreFile | .gitignore. | | logger | projen.Logger | Logging utilities. | | name | str | Project name. | | outdir | str | Absolute output directory of this project. | | package_task | projen.Task | *No description.* | | post_compile_task | projen.Task | *No description.* | | pre_compile_task | projen.Task | *No description.* | | project_build | projen.ProjectBuild | Manages the build process of the project. | | projen_command | str | The command to use in order to run the projen CLI. | | root | projen.Project | The root project. | | subprojects | typing.List[projen.Project] | Returns all the subprojects within this project. | | tasks | projen.Tasks | Project tasks. | | test_task | projen.Task | *No description.* | | default_task | projen.Task | This is the "default" task, the one that executes "projen". | | init_project | projen.InitProject | The options used when this project is bootstrapped via `projen new`. | | parent | projen.Project | A parent project. | | project_type | projen.ProjectType | *No description.* | | auto_approve | projen.github.AutoApprove | Auto approve set up for this project. | | dev_container | projen.vscode.DevContainer | Access for .devcontainer.json (used for GitHub Codespaces). | | github | projen.github.GitHub | Access all github components. | | gitpod | projen.Gitpod | Access for Gitpod. | | vscode | projen.vscode.VsCode | Access all VSCode components. | | compile | projen.java.MavenCompile | Compile component. | | distdir | str | Maven artifact output directory. | | packaging | projen.java.MavenPackaging | Packaging component. | | pom | projen.java.Pom | API for managing `pom.xml`. | | junit | projen.java.Junit | JUnit component. | | projenrc | projen.java.Projenrc | Projenrc component. | | cdk_config | projen.awscdk.CdkConfig | The `cdk.json` file. | | cdk_deps | projen.awscdk.AwsCdkDeps | CDK dependency management helper class. | | cdk_tasks | projen.awscdk.CdkTasks | CDK tasks. | | main_class | str | The full name of the main class of the java app (package.Class). | | main_class_name | str | The name of the Java class with the static `main()` method. | | main_package | str | The name of the Java package that includes the main class. | --- ##### `build_task`^Required ```python build_task: Task ``` - *Type:* projen.Task --- ##### `commit_generated`^Required ```python commit_generated: bool ``` - *Type:* bool Whether to commit the managed files by default. --- ##### `compile_task`^Required ```python compile_task: Task ``` - *Type:* projen.Task --- ##### `components`^Required ```python components: typing.List[Component] ``` - *Type:* typing.List[projen.Component] Returns all the components within this project. --- ##### `deps`^Required ```python deps: Dependencies ``` - *Type:* projen.Dependencies Project dependencies. --- ##### `ejected`^Required ```python ejected: bool ``` - *Type:* bool Whether or not the project is being ejected. --- ##### `files`^Required ```python files: typing.List[FileBase] ``` - *Type:* typing.List[projen.FileBase] All files in this project. --- ##### `gitattributes`^Required ```python gitattributes: GitAttributesFile ``` - *Type:* projen.GitAttributesFile The .gitattributes file for this repository. --- ##### `gitignore`^Required ```python gitignore: IgnoreFile ``` - *Type:* projen.IgnoreFile .gitignore. --- ##### `logger`^Required ```python logger: Logger ``` - *Type:* projen.Logger Logging utilities. --- ##### `name`^Required ```python name: str ``` - *Type:* str Project name. --- ##### `outdir`^Required ```python outdir: str ``` - *Type:* str Absolute output directory of this project. --- ##### `package_task`^Required ```python package_task: Task ``` - *Type:* projen.Task --- ##### `post_compile_task`^Required ```python post_compile_task: Task ``` - *Type:* projen.Task --- ##### `pre_compile_task`^Required ```python pre_compile_task: Task ``` - *Type:* projen.Task --- ##### `project_build`^Required ```python project_build: ProjectBuild ``` - *Type:* projen.ProjectBuild Manages the build process of the project. --- ##### `projen_command`^Required ```python projen_command: str ``` - *Type:* str The command to use in order to run the projen CLI. --- ##### `root`^Required ```python root: Project ``` - *Type:* projen.Project The root project. --- ##### `subprojects`^Required ```python subprojects: typing.List[Project] ``` - *Type:* typing.List[projen.Project] Returns all the subprojects within this project. --- ##### `tasks`^Required ```python tasks: Tasks ``` - *Type:* projen.Tasks Project tasks. --- ##### `test_task`^Required ```python test_task: Task ``` - *Type:* projen.Task --- ##### `default_task`^Optional ```python default_task: Task ``` - *Type:* projen.Task This is the "default" task, the one that executes "projen". Undefined if the project is being ejected. --- ##### `init_project`^Optional ```python init_project: InitProject ``` - *Type:* projen.InitProject The options used when this project is bootstrapped via `projen new`. It includes the original set of options passed to the CLI and also the JSII FQN of the project type. --- ##### `parent`^Optional ```python parent: Project ``` - *Type:* projen.Project A parent project. If undefined, this is the root project. --- ##### `project_type`^Required ```python project_type: ProjectType ``` - *Type:* projen.ProjectType --- ##### `auto_approve`^Optional ```python auto_approve: AutoApprove ``` - *Type:* projen.github.AutoApprove Auto approve set up for this project. --- ##### `dev_container`^Optional ```python dev_container: DevContainer ``` - *Type:* projen.vscode.DevContainer Access for .devcontainer.json (used for GitHub Codespaces). This will be `undefined` if devContainer boolean is false --- ##### `github`^Optional ```python github: GitHub ``` - *Type:* projen.github.GitHub Access all github components. This will be `undefined` for subprojects. --- ##### `gitpod`^Optional ```python gitpod: Gitpod ``` - *Type:* projen.Gitpod Access for Gitpod. This will be `undefined` if gitpod boolean is false --- ##### `vscode`^Optional ```python vscode: VsCode ``` - *Type:* projen.vscode.VsCode Access all VSCode components. This will be `undefined` for subprojects. --- ##### `compile`^Required ```python compile: MavenCompile ``` - *Type:* projen.java.MavenCompile Compile component. --- ##### `distdir`^Required ```python distdir: str ``` - *Type:* str Maven artifact output directory. --- ##### `packaging`^Required ```python packaging: MavenPackaging ``` - *Type:* projen.java.MavenPackaging Packaging component. --- ##### `pom`^Required ```python pom: Pom ``` - *Type:* projen.java.Pom API for managing `pom.xml`. --- ##### `junit`^Optional ```python junit: Junit ``` - *Type:* projen.java.Junit JUnit component. --- ##### `projenrc`^Optional ```python projenrc: Projenrc ``` - *Type:* projen.java.Projenrc Projenrc component. --- ##### `cdk_config`^Required ```python cdk_config: CdkConfig ``` - *Type:* projen.awscdk.CdkConfig The `cdk.json` file. --- ##### `cdk_deps`^Required ```python cdk_deps: AwsCdkDeps ``` - *Type:* projen.awscdk.AwsCdkDeps CDK dependency management helper class. --- ##### `cdk_tasks`^Required ```python cdk_tasks: CdkTasks ``` - *Type:* projen.awscdk.CdkTasks CDK tasks. --- ##### `main_class`^Required ```python main_class: str ``` - *Type:* str The full name of the main class of the java app (package.Class). --- ##### `main_class_name`^Required ```python main_class_name: str ``` - *Type:* str The name of the Java class with the static `main()` method. --- ##### `main_package`^Required ```python main_package: str ``` - *Type:* str The name of the Java package that includes the main class. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | DEFAULT_TASK | str | The name of the default task (the task executed when `projen` is run without arguments). | --- ##### `DEFAULT_TASK`^Required ```python DEFAULT_TASK: str ``` - *Type:* str 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 ```python import aws_prototyping_sdk.pipeline aws_prototyping_sdk.pipeline.PDKPipelinePyProject( name: str, commit_generated: bool = None, git_ignore_options: IgnoreFileOptions = None, git_options: GitOptions = None, logging: LoggerOptions = None, outdir: str = None, parent: Project = None, projen_command: str = None, projenrc_json: bool = None, projenrc_json_options: ProjenrcJsonOptions = None, renovatebot: bool = None, renovatebot_options: RenovatebotOptions = None, auto_approve_options: AutoApproveOptions = None, auto_merge: bool = None, auto_merge_options: AutoMergeOptions = None, clobber: bool = None, dev_container: bool = None, github: bool = None, github_options: GitHubOptions = None, gitpod: bool = None, mergify: bool = None, mergify_options: MergifyOptions = None, project_type: ProjectType = None, projen_credentials: GithubCredentials = None, projen_token_secret: str = None, readme: SampleReadmeProps = None, stale: bool = None, stale_options: StaleOptions = None, vscode: bool = None, author_email: str, author_name: str, version: str, classifiers: typing.List[str] = None, description: str = None, homepage: str = None, license: str = None, package_name: str = None, poetry_options: PoetryPyprojectOptionsWithoutDeps = None, setup_config: typing.Mapping[typing.Any] = None, module_name: str, deps: typing.List[str] = None, dev_deps: typing.List[str] = None, pip: bool = None, poetry: bool = None, projenrc_js: bool = None, projenrc_js_options: ProjenrcOptions = None, projenrc_python: bool = None, projenrc_python_options: ProjenrcOptions = None, projenrc_ts: bool = None, projenrc_ts_options: ProjenrcTsOptions = None, pytest: bool = None, pytest_options: PytestOptions = None, python_exec: str = None, sample: bool = None, setuptools: bool = None, venv: bool = None, venv_options: VenvOptions = None, build_command: str = None, cdkout: str = None, context: typing.Mapping[typing.Any] = None, feature_flags: bool = None, require_approval: ApprovalLevel = None, watch_excludes: typing.List[str] = None, watch_includes: typing.List[str] = None, cdk_version: str, cdk_assert: bool = None, cdk_assertions: bool = None, cdk_dependencies: typing.List[str] = None, cdk_dependencies_as_deps: bool = None, cdk_test_dependencies: typing.List[str] = None, cdk_version_pinning: bool = None, constructs_version: str = None, app_entrypoint: str = None, testdir: str = None ) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | name | str | This is the name of your project. | | commit_generated | bool | Whether to commit the managed files by default. | | git_ignore_options | projen.IgnoreFileOptions | Configuration options for .gitignore file. | | git_options | projen.GitOptions | Configuration options for git. | | logging | projen.LoggerOptions | Configure logging options such as verbosity. | | outdir | str | The root directory of the project. | | parent | projen.Project | The parent project, if this project is part of a bigger project. | | projen_command | str | The shell command to use in order to run the projen CLI. | | projenrc_json | bool | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. | | projenrc_json_options | projen.ProjenrcJsonOptions | Options for .projenrc.json. | | renovatebot | bool | Use renovatebot to handle dependency upgrades. | | renovatebot_options | projen.RenovatebotOptions | Options for renovatebot. | | auto_approve_options | projen.github.AutoApproveOptions | Enable and configure the 'auto approve' workflow. | | auto_merge | bool | Enable automatic merging on GitHub. | | auto_merge_options | projen.github.AutoMergeOptions | Configure options for automatic merging on GitHub. | | clobber | bool | Add a `clobber` task which resets the repo to origin. | | dev_container | bool | Add a VSCode development environment (used for GitHub Codespaces). | | github | bool | Enable GitHub integration. | | github_options | projen.github.GitHubOptions | Options for GitHub integration. | | gitpod | bool | Add a Gitpod development environment. | | mergify | bool | Whether mergify should be enabled on this repository or not. | | mergify_options | projen.github.MergifyOptions | Options for mergify. | | project_type | projen.ProjectType | Which type of project this is (library/app). | | projen_credentials | projen.github.GithubCredentials | Choose a method of providing GitHub API access for projen workflows. | | projen_token_secret | str | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. | | readme | projen.SampleReadmeProps | The README setup. | | stale | bool | Auto-close of stale issues and pull request. | | stale_options | projen.github.StaleOptions | Auto-close stale issues and pull requests. | | vscode | bool | Enable VSCode integration. | | author_email | str | Author's e-mail. | | author_name | str | Author's name. | | version | str | Version of the package. | | classifiers | typing.List[str] | A list of PyPI trove classifiers that describe the project. | | description | str | A short description of the package. | | homepage | str | A URL to the website of the project. | | license | str | License of this package as an SPDX identifier. | | package_name | str | Package name. | | poetry_options | projen.python.PoetryPyprojectOptionsWithoutDeps | Additional options to set for poetry if using poetry. | | setup_config | typing.Mapping[typing.Any] | Additional fields to pass in the setup() function if using setuptools. | | module_name | str | Name of the python package as used in imports and filenames. | | deps | typing.List[str] | List of runtime dependencies for this project. | | dev_deps | typing.List[str] | List of dev dependencies for this project. | | pip | bool | Use pip with a requirements.txt file to track project dependencies. | | poetry | bool | Use poetry to manage your project dependencies, virtual environment, and (optional) packaging/publishing. | | projenrc_js | bool | Use projenrc in javascript. | | projenrc_js_options | projen.javascript.ProjenrcOptions | Options related to projenrc in JavaScript. | | projenrc_python | bool | Use projenrc in Python. | | projenrc_python_options | projen.python.ProjenrcOptions | Options related to projenrc in python. | | projenrc_ts | bool | Use projenrc in TypeScript. | | projenrc_ts_options | projen.typescript.ProjenrcTsOptions | Options related to projenrc in TypeScript. | | pytest | bool | Include pytest tests. | | pytest_options | projen.python.PytestOptions | pytest options. | | python_exec | str | Path to the python executable to use. | | sample | bool | Include sample code and test if the relevant directories don't exist. | | setuptools | bool | Use setuptools with a setup.py script for packaging and publishing. | | venv | bool | Use venv to manage a virtual environment for installing dependencies inside. | | venv_options | projen.python.VenvOptions | Venv options. | | build_command | str | A command to execute before synthesis. | | cdkout | str | cdk.out directory. | | context | typing.Mapping[typing.Any] | Additional context to include in `cdk.json`. | | feature_flags | bool | Include all feature flags in cdk.json. | | require_approval | 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. | | watch_excludes | typing.List[str] | Glob patterns to exclude from `cdk watch`. | | watch_includes | typing.List[str] | Glob patterns to include in `cdk watch`. | | cdk_version | str | Minimum version of the AWS CDK to depend on. | | cdk_assert | bool | Warning: NodeJS only. | | cdk_assertions | bool | Install the assertions library? | | cdk_dependencies | typing.List[str] | Which AWS CDKv1 modules this project requires. | | cdk_dependencies_as_deps | bool | If this is enabled (default), all modules declared in `cdkDependencies` will be also added as normal `dependencies` (as well as `peerDependencies`). | | cdk_test_dependencies | typing.List[str] | AWS CDK modules required for testing. | | cdk_version_pinning | bool | Use pinned version instead of caret version for CDK. | | constructs_version | str | Minimum version of the `constructs` library to depend on. | | app_entrypoint | str | The CDK app's entrypoint (relative to the source directory, which is "src" by default). | | testdir | str | Python sources directory. | --- ##### `name`^Required - *Type:* str - *Default:* $BASEDIR This is the name of your project. --- ##### `commit_generated`^Optional - *Type:* bool - *Default:* true Whether to commit the managed files by default. --- ##### `git_ignore_options`^Optional - *Type:* projen.IgnoreFileOptions Configuration options for .gitignore file. --- ##### `git_options`^Optional - *Type:* projen.GitOptions Configuration options for git. --- ##### `logging`^Optional - *Type:* projen.LoggerOptions - *Default:* {} Configure logging options such as verbosity. --- ##### `outdir`^Optional - *Type:* str - *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:* projen.Project The parent project, if this project is part of a bigger project. --- ##### `projen_command`^Optional - *Type:* str - *Default:* "npx projen" The shell command to use in order to run the projen CLI. Can be used to customize in special environments. --- ##### `projenrc_json`^Optional - *Type:* bool - *Default:* false Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. --- ##### `projenrc_json_options`^Optional - *Type:* projen.ProjenrcJsonOptions - *Default:* default options Options for .projenrc.json. --- ##### `renovatebot`^Optional - *Type:* bool - *Default:* false Use renovatebot to handle dependency upgrades. --- ##### `renovatebot_options`^Optional - *Type:* projen.RenovatebotOptions - *Default:* default options Options for renovatebot. --- ##### `auto_approve_options`^Optional - *Type:* projen.github.AutoApproveOptions - *Default:* auto approve is disabled Enable and configure the 'auto approve' workflow. --- ##### `auto_merge`^Optional - *Type:* bool - *Default:* true Enable automatic merging on GitHub. Has no effect if `github.mergify` is set to false. --- ##### `auto_merge_options`^Optional - *Type:* projen.github.AutoMergeOptions - *Default:* see defaults in `AutoMergeOptions` Configure options for automatic merging on GitHub. Has no effect if `github.mergify` or `autoMerge` is set to false. --- ##### `clobber`^Optional - *Type:* bool - *Default:* true, but false for subprojects Add a `clobber` task which resets the repo to origin. --- ##### `dev_container`^Optional - *Type:* bool - *Default:* false Add a VSCode development environment (used for GitHub Codespaces). --- ##### `github`^Optional - *Type:* bool - *Default:* true Enable GitHub integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `github_options`^Optional - *Type:* projen.github.GitHubOptions - *Default:* see GitHubOptions Options for GitHub integration. --- ##### `gitpod`^Optional - *Type:* bool - *Default:* false Add a Gitpod development environment. --- ##### ~~`mergify`~~^Optional - *Deprecated:* use `githubOptions.mergify` instead - *Type:* bool - *Default:* true Whether mergify should be enabled on this repository or not. --- ##### ~~`mergify_options`~~^Optional - *Deprecated:* use `githubOptions.mergifyOptions` instead - *Type:* projen.github.MergifyOptions - *Default:* default options Options for mergify. --- ##### ~~`project_type`~~^Optional - *Deprecated:* no longer supported at the base project level - *Type:* projen.ProjectType - *Default:* ProjectType.UNKNOWN Which type of project this is (library/app). --- ##### `projen_credentials`^Optional - *Type:* projen.github.GithubCredentials - *Default:* use a personal access token named PROJEN_GITHUB_TOKEN Choose a method of providing GitHub API access for projen workflows. --- ##### ~~`projen_token_secret`~~^Optional - *Deprecated:* use `projenCredentials` - *Type:* str - *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:* projen.SampleReadmeProps - *Default:* { filename: 'README.md', contents: '# replace this' } The README setup. --- *Example* ```python "{ filename: 'readme.md', contents: '# title' }" ``` ##### `stale`^Optional - *Type:* bool - *Default:* false Auto-close of stale issues and pull request. See `staleOptions` for options. --- ##### `stale_options`^Optional - *Type:* projen.github.StaleOptions - *Default:* see defaults in `StaleOptions` Auto-close stale issues and pull requests. To disable set `stale` to `false`. --- ##### `vscode`^Optional - *Type:* bool - *Default:* true Enable VSCode integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `author_email`^Required - *Type:* str - *Default:* $GIT_USER_EMAIL Author's e-mail. --- ##### `author_name`^Required - *Type:* str - *Default:* $GIT_USER_NAME Author's name. --- ##### `version`^Required - *Type:* str - *Default:* "0.1.0" Version of the package. --- ##### `classifiers`^Optional - *Type:* typing.List[str] A list of PyPI trove classifiers that describe the project. > [https://pypi.org/classifiers/](https://pypi.org/classifiers/) --- ##### `description`^Optional - *Type:* str A short description of the package. --- ##### `homepage`^Optional - *Type:* str A URL to the website of the project. --- ##### `license`^Optional - *Type:* str License of this package as an SPDX identifier. --- ##### `package_name`^Optional - *Type:* str Package name. --- ##### `poetry_options`^Optional - *Type:* projen.python.PoetryPyprojectOptionsWithoutDeps Additional options to set for poetry if using poetry. --- ##### `setup_config`^Optional - *Type:* typing.Mapping[typing.Any] Additional fields to pass in the setup() function if using setuptools. --- ##### `module_name`^Required - *Type:* str - *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:* typing.List[str] - *Default:* [] List of runtime dependencies for this project. Dependencies use the format: `@` Additional dependencies can be added via `project.addDependency()`. --- ##### `dev_deps`^Optional - *Type:* typing.List[str] - *Default:* [] List of dev dependencies for this project. Dependencies use the format: `@` Additional dependencies can be added via `project.addDevDependency()`. --- ##### `pip`^Optional - *Type:* bool - *Default:* true, unless poetry is true, then false Use pip with a requirements.txt file to track project dependencies. --- ##### `poetry`^Optional - *Type:* bool - *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`. --- ##### `projenrc_js`^Optional - *Type:* bool - *Default:* false Use projenrc in javascript. This will install `projen` as a JavaScript dependency and add a `synth` task which will run `.projenrc.js`. --- ##### `projenrc_js_options`^Optional - *Type:* projen.javascript.ProjenrcOptions - *Default:* default options Options related to projenrc in JavaScript. --- ##### `projenrc_python`^Optional - *Type:* bool - *Default:* true Use projenrc in Python. This will install `projen` as a Python dependency and add a `synth` task which will run `.projenrc.py`. --- ##### `projenrc_python_options`^Optional - *Type:* projen.python.ProjenrcOptions - *Default:* default options Options related to projenrc in python. --- ##### `projenrc_ts`^Optional - *Type:* bool - *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. --- ##### `projenrc_ts_options`^Optional - *Type:* projen.typescript.ProjenrcTsOptions - *Default:* default options Options related to projenrc in TypeScript. --- ##### `pytest`^Optional - *Type:* bool - *Default:* true Include pytest tests. --- ##### `pytest_options`^Optional - *Type:* projen.python.PytestOptions - *Default:* defaults pytest options. --- ##### `python_exec`^Optional - *Type:* str - *Default:* "python" Path to the python executable to use. --- ##### `sample`^Optional - *Type:* bool - *Default:* true Include sample code and test if the relevant directories don't exist. --- ##### `setuptools`^Optional - *Type:* bool - *Default:* true, unless poetry is true, then false Use setuptools with a setup.py script for packaging and publishing. --- ##### `venv`^Optional - *Type:* bool - *Default:* true, unless poetry is true, then false Use venv to manage a virtual environment for installing dependencies inside. --- ##### `venv_options`^Optional - *Type:* projen.python.VenvOptions - *Default:* defaults Venv options. --- ##### `build_command`^Optional - *Type:* str - *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:* str - *Default:* "cdk.out" cdk.out directory. --- ##### `context`^Optional - *Type:* typing.Mapping[typing.Any] - *Default:* no additional context Additional context to include in `cdk.json`. --- ##### `feature_flags`^Optional - *Type:* bool - *Default:* true Include all feature flags in cdk.json. --- ##### `require_approval`^Optional - *Type:* projen.awscdk.ApprovalLevel - *Default:* ApprovalLevel.BROADENING To protect you against unintended changes that affect your security posture, the AWS CDK Toolkit prompts you to approve security-related changes before deploying them. --- ##### `watch_excludes`^Optional - *Type:* typing.List[str] - *Default:* [] Glob patterns to exclude from `cdk watch`. --- ##### `watch_includes`^Optional - *Type:* typing.List[str] - *Default:* [] Glob patterns to include in `cdk watch`. --- ##### `cdk_version`^Required - *Type:* str - *Default:* "2.1.0" Minimum version of the AWS CDK to depend on. --- ##### ~~`cdk_assert`~~^Optional - *Deprecated:* The - *Type:* bool - *Default:* will be included by default for AWS CDK >= 1.0.0 < 2.0.0 Warning: NodeJS only. Install the --- ##### `cdk_assertions`^Optional - *Type:* bool - *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' --- ##### ~~`cdk_dependencies`~~^Optional - *Deprecated:* For CDK 2.x use "deps" instead. (or "peerDeps" if you're building a library) - *Type:* typing.List[str] Which AWS CDKv1 modules this project requires. --- ##### ~~`cdk_dependencies_as_deps`~~^Optional - *Deprecated:* Not supported in CDK v2. - *Type:* bool - *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 --- ##### ~~`cdk_test_dependencies`~~^Optional - *Deprecated:* For CDK 2.x use 'devDeps' (in node.js projects) or 'testDeps' (in java projects) instead - *Type:* typing.List[str] AWS CDK modules required for testing. --- ##### `cdk_version_pinning`^Optional - *Type:* bool 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. --- ##### `constructs_version`^Optional - *Type:* str - *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. --- ##### `app_entrypoint`^Optional - *Type:* str - *Default:* "app.py" The CDK app's entrypoint (relative to the source directory, which is "src" by default). --- ##### `testdir`^Optional - *Type:* str - *Default:* "tests" Python sources directory. --- #### Methods | **Name** | **Description** | | --- | --- | | add_exclude_from_cleanup | Exclude the matching files from pre-synth cleanup. | | add_git_ignore | Adds a .gitignore pattern. | | add_package_ignore | Exclude these files from the bundled package. | | add_task | Adds a new task to this project. | | add_tip | Prints a "tip" message during synthesis. | | annotate_generated | Marks the provided file(s) as being generated. | | post_synthesize | Called after all components are synthesized. | | pre_synthesize | Called before all components are synthesized. | | remove_task | Removes a task from a project. | | run_task_command | Returns the shell command to execute in order to run a task. | | synth | Synthesize all project files into `outdir`. | | try_find_file | Finds a file at the specified relative path within this project and all its subprojects. | | try_find_json_file | Finds a json file by name. | | try_find_object_file | Finds an object file (like JsonFile, YamlFile, etc.) by name. | | try_remove_file | Finds a file at the specified relative path within this project and removes it. | | add_dependency | Adds a runtime dependency. | | add_dev_dependency | Adds a dev dependency. | --- ##### `add_exclude_from_cleanup` ```python def add_exclude_from_cleanup( globs: str ) -> None ``` 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:* str The glob patterns to match. --- ##### `add_git_ignore` ```python def add_git_ignore( pattern: str ) -> None ``` Adds a .gitignore pattern. ###### `pattern`^Required - *Type:* str The glob pattern to ignore. --- ##### `add_package_ignore` ```python def add_package_ignore( _pattern: str ) -> None ``` 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:* str The glob pattern to exclude. --- ##### `add_task` ```python def add_task( name: str, condition: str = None, cwd: str = None, description: str = None, env: typing.Mapping[str] = None, required_env: typing.List[str] = None, args: typing.List[str] = None, exec: str = None, receive_args: bool = None, steps: typing.List[TaskStep] = None ) -> Task ``` Adds a new task to this project. This will fail if the project already has a task with this name. ###### `name`^Required - *Type:* str The task name to add. --- ###### `condition`^Optional - *Type:* str A shell command which determines if the this task should be executed. If the program exits with a zero exit code, steps will be executed. A non-zero code means that task will be skipped. --- ###### `cwd`^Optional - *Type:* str - *Default:* process.cwd() The working directory for all steps in this task (unless overridden by the step). --- ###### `description`^Optional - *Type:* str - *Default:* the task name The description of this build command. --- ###### `env`^Optional - *Type:* typing.Mapping[str] - *Default:* {} Defines environment variables for the execution of this task. Values in this map will be evaluated in a shell, so you can do stuff like `$(echo "foo")`. --- ###### `required_env`^Optional - *Type:* typing.List[str] A set of environment variables that must be defined in order to execute this task. Task execution will fail if one of these is not defined. --- ###### `args`^Optional - *Type:* typing.List[str] - *Default:* no arguments are passed to the step Should the provided `exec` shell command receive fixed args. > [{@link TaskStepOptions.args }]({@link TaskStepOptions.args }) --- ###### `exec`^Optional - *Type:* str - *Default:* add steps using `task.exec(command)` or `task.spawn(subtask)` Shell command to execute as the first command of the task. --- ###### `receive_args`^Optional - *Type:* bool - *Default:* false Should the provided `exec` shell command receive args passed to the task. > [{@link TaskStepOptions.receiveArgs }]({@link TaskStepOptions.receiveArgs }) --- ###### `steps`^Optional - *Type:* typing.List[projen.TaskStep] List of task steps to run. --- ##### ~~`add_tip`~~ ```python def add_tip( message: str ) -> None ``` Prints a "tip" message during synthesis. ###### `message`^Required - *Type:* str The message. --- ##### `annotate_generated` ```python def annotate_generated( glob: str ) -> None ``` 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:* str the glob pattern to match (could be a file path). --- ##### `post_synthesize` ```python def post_synthesize() -> None ``` Called after all components are synthesized. Order is *not* guaranteed. ##### `pre_synthesize` ```python def pre_synthesize() -> None ``` Called before all components are synthesized. ##### `remove_task` ```python def remove_task( name: str ) -> Task ``` Removes a task from a project. ###### `name`^Required - *Type:* str The name of the task to remove. --- ##### `run_task_command` ```python def run_task_command( task: Task ) -> str ``` Returns the shell command to execute in order to run a task. By default, this is `npx projen@ ` ###### `task`^Required - *Type:* projen.Task The task for which the command is required. --- ##### `synth` ```python def synth() -> None ``` 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()" ##### `try_find_file` ```python def try_find_file( file_path: str ) -> FileBase ``` Finds a file at the specified relative path within this project and all its subprojects. ###### `file_path`^Required - *Type:* str The file path. If this path is relative, it will be resolved from the root of _this_ project. --- ##### ~~`try_find_json_file`~~ ```python def try_find_json_file( file_path: str ) -> JsonFile ``` Finds a json file by name. ###### `file_path`^Required - *Type:* str The file path. --- ##### `try_find_object_file` ```python def try_find_object_file( file_path: str ) -> ObjectFile ``` Finds an object file (like JsonFile, YamlFile, etc.) by name. ###### `file_path`^Required - *Type:* str The file path. --- ##### `try_remove_file` ```python def try_remove_file( file_path: str ) -> FileBase ``` Finds a file at the specified relative path within this project and removes it. ###### `file_path`^Required - *Type:* str The file path. If this path is relative, it will be resolved from the root of _this_ project. --- ##### `add_dependency` ```python def add_dependency( spec: str ) -> None ``` Adds a runtime dependency. ###### `spec`^Required - *Type:* str Format `@`. --- ##### `add_dev_dependency` ```python def add_dev_dependency( spec: str ) -> None ``` Adds a dev dependency. ###### `spec`^Required - *Type:* str Format `@`. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | build_task | projen.Task | *No description.* | | commit_generated | bool | Whether to commit the managed files by default. | | compile_task | projen.Task | *No description.* | | components | typing.List[projen.Component] | Returns all the components within this project. | | deps | projen.Dependencies | Project dependencies. | | ejected | bool | Whether or not the project is being ejected. | | files | typing.List[projen.FileBase] | All files in this project. | | gitattributes | projen.GitAttributesFile | The .gitattributes file for this repository. | | gitignore | projen.IgnoreFile | .gitignore. | | logger | projen.Logger | Logging utilities. | | name | str | Project name. | | outdir | str | Absolute output directory of this project. | | package_task | projen.Task | *No description.* | | post_compile_task | projen.Task | *No description.* | | pre_compile_task | projen.Task | *No description.* | | project_build | projen.ProjectBuild | Manages the build process of the project. | | projen_command | str | The command to use in order to run the projen CLI. | | root | projen.Project | The root project. | | subprojects | typing.List[projen.Project] | Returns all the subprojects within this project. | | tasks | projen.Tasks | Project tasks. | | test_task | projen.Task | *No description.* | | default_task | projen.Task | This is the "default" task, the one that executes "projen". | | init_project | projen.InitProject | The options used when this project is bootstrapped via `projen new`. | | parent | projen.Project | A parent project. | | project_type | projen.ProjectType | *No description.* | | auto_approve | projen.github.AutoApprove | Auto approve set up for this project. | | dev_container | projen.vscode.DevContainer | Access for .devcontainer.json (used for GitHub Codespaces). | | github | projen.github.GitHub | Access all github components. | | gitpod | projen.Gitpod | Access for Gitpod. | | vscode | projen.vscode.VsCode | Access all VSCode components. | | deps_manager | projen.python.IPythonDeps | API for managing dependencies. | | env_manager | projen.python.IPythonEnv | API for mangaging the Python runtime environment. | | module_name | str | Python module name (the project name, with any hyphens or periods replaced with underscores). | | version | str | Version of the package for distribution (should follow semver). | | packaging_manager | projen.python.IPythonPackaging | API for managing packaging the project as a library. | | pytest | projen.python.Pytest | Pytest component. | | app_entrypoint | str | The CDK app entrypoint. | | cdk_config | projen.awscdk.CdkConfig | cdk.json configuration. | | cdk_deps | projen.awscdk.AwsCdkDeps | *No description.* | | cdk_tasks | projen.awscdk.CdkTasks | Common CDK tasks. | | cdk_version | str | The CDK version this app is using. | | testdir | str | The directory in which the python tests reside. | --- ##### `build_task`^Required ```python build_task: Task ``` - *Type:* projen.Task --- ##### `commit_generated`^Required ```python commit_generated: bool ``` - *Type:* bool Whether to commit the managed files by default. --- ##### `compile_task`^Required ```python compile_task: Task ``` - *Type:* projen.Task --- ##### `components`^Required ```python components: typing.List[Component] ``` - *Type:* typing.List[projen.Component] Returns all the components within this project. --- ##### `deps`^Required ```python deps: Dependencies ``` - *Type:* projen.Dependencies Project dependencies. --- ##### `ejected`^Required ```python ejected: bool ``` - *Type:* bool Whether or not the project is being ejected. --- ##### `files`^Required ```python files: typing.List[FileBase] ``` - *Type:* typing.List[projen.FileBase] All files in this project. --- ##### `gitattributes`^Required ```python gitattributes: GitAttributesFile ``` - *Type:* projen.GitAttributesFile The .gitattributes file for this repository. --- ##### `gitignore`^Required ```python gitignore: IgnoreFile ``` - *Type:* projen.IgnoreFile .gitignore. --- ##### `logger`^Required ```python logger: Logger ``` - *Type:* projen.Logger Logging utilities. --- ##### `name`^Required ```python name: str ``` - *Type:* str Project name. --- ##### `outdir`^Required ```python outdir: str ``` - *Type:* str Absolute output directory of this project. --- ##### `package_task`^Required ```python package_task: Task ``` - *Type:* projen.Task --- ##### `post_compile_task`^Required ```python post_compile_task: Task ``` - *Type:* projen.Task --- ##### `pre_compile_task`^Required ```python pre_compile_task: Task ``` - *Type:* projen.Task --- ##### `project_build`^Required ```python project_build: ProjectBuild ``` - *Type:* projen.ProjectBuild Manages the build process of the project. --- ##### `projen_command`^Required ```python projen_command: str ``` - *Type:* str The command to use in order to run the projen CLI. --- ##### `root`^Required ```python root: Project ``` - *Type:* projen.Project The root project. --- ##### `subprojects`^Required ```python subprojects: typing.List[Project] ``` - *Type:* typing.List[projen.Project] Returns all the subprojects within this project. --- ##### `tasks`^Required ```python tasks: Tasks ``` - *Type:* projen.Tasks Project tasks. --- ##### `test_task`^Required ```python test_task: Task ``` - *Type:* projen.Task --- ##### `default_task`^Optional ```python default_task: Task ``` - *Type:* projen.Task This is the "default" task, the one that executes "projen". Undefined if the project is being ejected. --- ##### `init_project`^Optional ```python init_project: InitProject ``` - *Type:* projen.InitProject The options used when this project is bootstrapped via `projen new`. It includes the original set of options passed to the CLI and also the JSII FQN of the project type. --- ##### `parent`^Optional ```python parent: Project ``` - *Type:* projen.Project A parent project. If undefined, this is the root project. --- ##### `project_type`^Required ```python project_type: ProjectType ``` - *Type:* projen.ProjectType --- ##### `auto_approve`^Optional ```python auto_approve: AutoApprove ``` - *Type:* projen.github.AutoApprove Auto approve set up for this project. --- ##### `dev_container`^Optional ```python dev_container: DevContainer ``` - *Type:* projen.vscode.DevContainer Access for .devcontainer.json (used for GitHub Codespaces). This will be `undefined` if devContainer boolean is false --- ##### `github`^Optional ```python github: GitHub ``` - *Type:* projen.github.GitHub Access all github components. This will be `undefined` for subprojects. --- ##### `gitpod`^Optional ```python gitpod: Gitpod ``` - *Type:* projen.Gitpod Access for Gitpod. This will be `undefined` if gitpod boolean is false --- ##### `vscode`^Optional ```python vscode: VsCode ``` - *Type:* projen.vscode.VsCode Access all VSCode components. This will be `undefined` for subprojects. --- ##### `deps_manager`^Required ```python deps_manager: IPythonDeps ``` - *Type:* projen.python.IPythonDeps API for managing dependencies. --- ##### `env_manager`^Required ```python env_manager: IPythonEnv ``` - *Type:* projen.python.IPythonEnv API for mangaging the Python runtime environment. --- ##### `module_name`^Required ```python module_name: str ``` - *Type:* str Python module name (the project name, with any hyphens or periods replaced with underscores). --- ##### `version`^Required ```python version: str ``` - *Type:* str Version of the package for distribution (should follow semver). --- ##### `packaging_manager`^Optional ```python packaging_manager: IPythonPackaging ``` - *Type:* projen.python.IPythonPackaging API for managing packaging the project as a library. Only applies when the `projectType` is LIB. --- ##### `pytest`^Optional ```python pytest: Pytest ``` - *Type:* projen.python.Pytest Pytest component. --- ##### `app_entrypoint`^Required ```python app_entrypoint: str ``` - *Type:* str The CDK app entrypoint. --- ##### `cdk_config`^Required ```python cdk_config: CdkConfig ``` - *Type:* projen.awscdk.CdkConfig cdk.json configuration. --- ##### `cdk_deps`^Required ```python cdk_deps: AwsCdkDeps ``` - *Type:* projen.awscdk.AwsCdkDeps --- ##### `cdk_tasks`^Required ```python cdk_tasks: CdkTasks ``` - *Type:* projen.awscdk.CdkTasks Common CDK tasks. --- ##### `cdk_version`^Required ```python cdk_version: str ``` - *Type:* str The CDK version this app is using. --- ##### `testdir`^Required ```python testdir: str ``` - *Type:* str The directory in which the python tests reside. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | DEFAULT_TASK | str | The name of the default task (the task executed when `projen` is run without arguments). | --- ##### `DEFAULT_TASK`^Required ```python DEFAULT_TASK: str ``` - *Type:* str 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 ```python import aws_prototyping_sdk.pipeline aws_prototyping_sdk.pipeline.PDKPipelineTsProject( name: str, commit_generated: bool = None, git_ignore_options: IgnoreFileOptions = None, git_options: GitOptions = None, logging: LoggerOptions = None, outdir: str = None, parent: Project = None, projen_command: str = None, projenrc_json: bool = None, projenrc_json_options: ProjenrcJsonOptions = None, renovatebot: bool = None, renovatebot_options: RenovatebotOptions = None, auto_approve_options: AutoApproveOptions = None, auto_merge: bool = None, auto_merge_options: AutoMergeOptions = None, clobber: bool = None, dev_container: bool = None, github: bool = None, github_options: GitHubOptions = None, gitpod: bool = None, mergify: bool = None, mergify_options: MergifyOptions = None, project_type: ProjectType = None, projen_credentials: GithubCredentials = None, projen_token_secret: str = None, readme: SampleReadmeProps = None, stale: bool = None, stale_options: StaleOptions = None, vscode: bool = None, allow_library_dependencies: bool = None, author_email: str = None, author_name: str = None, author_organization: bool = None, author_url: str = None, auto_detect_bin: bool = None, bin: typing.Mapping[str] = None, bugs_email: str = None, bugs_url: str = None, bundled_deps: typing.List[str] = None, code_artifact_options: CodeArtifactOptions = None, deps: typing.List[str] = None, description: str = None, dev_deps: typing.List[str] = None, entrypoint: str = None, homepage: str = None, keywords: typing.List[str] = None, license: str = None, licensed: bool = None, max_node_version: str = None, min_node_version: str = None, npm_access: NpmAccess = None, npm_registry: str = None, npm_registry_url: str = None, npm_token_secret: str = None, package_manager: NodePackageManager = None, package_name: str = None, peer_dependency_options: PeerDependencyOptions = None, peer_deps: typing.List[str] = None, pnpm_version: str = None, repository: str = None, repository_directory: str = None, scoped_packages_options: typing.List[ScopedPackagesOptions] = None, scripts: typing.Mapping[str] = None, stability: str = None, jsii_release_version: str = None, major_version: typing.Union[int, float] = None, min_major_version: typing.Union[int, float] = None, npm_dist_tag: str = None, post_build_steps: typing.List[JobStep] = None, prerelease: str = None, publish_dry_run: bool = None, publish_tasks: bool = None, release_branches: typing.Mapping[BranchOptions] = None, release_every_commit: bool = None, release_failure_issue: bool = None, release_failure_issue_label: str = None, release_schedule: str = None, release_tag_prefix: str = None, release_trigger: ReleaseTrigger = None, release_workflow_name: str = None, release_workflow_setup_steps: typing.List[JobStep] = None, versionrc_options: typing.Mapping[typing.Any] = None, workflow_container_image: str = None, workflow_runs_on: typing.List[str] = None, default_release_branch: str, artifacts_directory: str = None, auto_approve_upgrades: bool = None, build_workflow: bool = None, build_workflow_triggers: Triggers = None, bundler_options: BundlerOptions = None, code_cov: bool = None, code_cov_token_secret: str = None, copyright_owner: str = None, copyright_period: str = None, dependabot: bool = None, dependabot_options: DependabotOptions = None, deps_upgrade: bool = None, deps_upgrade_options: UpgradeDependenciesOptions = None, gitignore: typing.List[str] = None, jest: bool = None, jest_options: JestOptions = None, mutable_build: bool = None, npmignore: typing.List[str] = None, npmignore_enabled: bool = None, npm_ignore_options: IgnoreFileOptions = None, package: bool = None, prettier: bool = None, prettier_options: PrettierOptions = None, projen_dev_dependency: bool = None, projenrc_js: bool = None, projenrc_js_options: ProjenrcOptions = None, projen_version: str = None, pull_request_template: bool = None, pull_request_template_contents: typing.List[str] = None, release: bool = None, release_to_npm: bool = None, release_workflow: bool = None, workflow_bootstrap_steps: typing.List[JobStep] = None, workflow_git_identity: GitIdentity = None, workflow_node_version: str = None, workflow_package_cache: bool = None, disable_tsconfig: bool = None, disable_tsconfig_dev: bool = None, docgen: bool = None, docs_directory: str = None, entrypoint_types: str = None, eslint: bool = None, eslint_options: EslintOptions = None, libdir: str = None, projenrc_ts: bool = None, projenrc_ts_options: ProjenrcOptions = None, sample_code: bool = None, srcdir: str = None, testdir: str = None, tsconfig: TypescriptConfigOptions = None, tsconfig_dev: TypescriptConfigOptions = None, tsconfig_dev_file: str = None, typescript_version: str = None, build_command: str = None, cdkout: str = None, context: typing.Mapping[typing.Any] = None, feature_flags: bool = None, require_approval: ApprovalLevel = None, watch_excludes: typing.List[str] = None, watch_includes: typing.List[str] = None, cdk_version: str, cdk_assert: bool = None, cdk_assertions: bool = None, cdk_dependencies: typing.List[str] = None, cdk_dependencies_as_deps: bool = None, cdk_test_dependencies: typing.List[str] = None, cdk_version_pinning: bool = None, constructs_version: str = None, app_entrypoint: str = None, edge_lambda_auto_discover: bool = None, integration_test_auto_discover: bool = None, lambda_auto_discover: bool = None, lambda_extension_auto_discover: bool = None, lambda_options: LambdaFunctionCommonOptions = None ) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | name | str | This is the name of your project. | | commit_generated | bool | Whether to commit the managed files by default. | | git_ignore_options | projen.IgnoreFileOptions | Configuration options for .gitignore file. | | git_options | projen.GitOptions | Configuration options for git. | | logging | projen.LoggerOptions | Configure logging options such as verbosity. | | outdir | str | The root directory of the project. | | parent | projen.Project | The parent project, if this project is part of a bigger project. | | projen_command | str | The shell command to use in order to run the projen CLI. | | projenrc_json | bool | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. | | projenrc_json_options | projen.ProjenrcJsonOptions | Options for .projenrc.json. | | renovatebot | bool | Use renovatebot to handle dependency upgrades. | | renovatebot_options | projen.RenovatebotOptions | Options for renovatebot. | | auto_approve_options | projen.github.AutoApproveOptions | Enable and configure the 'auto approve' workflow. | | auto_merge | bool | Enable automatic merging on GitHub. | | auto_merge_options | projen.github.AutoMergeOptions | Configure options for automatic merging on GitHub. | | clobber | bool | Add a `clobber` task which resets the repo to origin. | | dev_container | bool | Add a VSCode development environment (used for GitHub Codespaces). | | github | bool | Enable GitHub integration. | | github_options | projen.github.GitHubOptions | Options for GitHub integration. | | gitpod | bool | Add a Gitpod development environment. | | mergify | bool | Whether mergify should be enabled on this repository or not. | | mergify_options | projen.github.MergifyOptions | Options for mergify. | | project_type | projen.ProjectType | Which type of project this is (library/app). | | projen_credentials | projen.github.GithubCredentials | Choose a method of providing GitHub API access for projen workflows. | | projen_token_secret | str | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. | | readme | projen.SampleReadmeProps | The README setup. | | stale | bool | Auto-close of stale issues and pull request. | | stale_options | projen.github.StaleOptions | Auto-close stale issues and pull requests. | | vscode | bool | Enable VSCode integration. | | allow_library_dependencies | bool | Allow the project to include `peerDependencies` and `bundledDependencies`. | | author_email | str | Author's e-mail. | | author_name | str | Author's name. | | author_organization | bool | Is the author an organization. | | author_url | str | Author's URL / Website. | | auto_detect_bin | bool | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. | | bin | typing.Mapping[str] | Binary programs vended with your module. | | bugs_email | str | The email address to which issues should be reported. | | bugs_url | str | The url to your project's issue tracker. | | bundled_deps | typing.List[str] | List of dependencies to bundle into this module. | | code_artifact_options | projen.javascript.CodeArtifactOptions | Options for npm packages using AWS CodeArtifact. | | deps | typing.List[str] | Runtime dependencies of this module. | | description | str | The description is just a string that helps people understand the purpose of the package. | | dev_deps | typing.List[str] | Build dependencies for this module. | | entrypoint | str | Module entrypoint (`main` in `package.json`). | | homepage | str | Package's Homepage / Website. | | keywords | typing.List[str] | Keywords to include in `package.json`. | | license | str | License's SPDX identifier. | | licensed | bool | Indicates if a license should be added. | | max_node_version | str | Minimum node.js version to require via `engines` (inclusive). | | min_node_version | str | Minimum Node.js version to require via package.json `engines` (inclusive). | | npm_access | projen.javascript.NpmAccess | Access level of the npm package. | | npm_registry | str | The host name of the npm registry to publish to. | | npm_registry_url | str | The base URL of the npm package registry. | | npm_token_secret | str | GitHub secret which contains the NPM token to use when publishing packages. | | package_manager | projen.javascript.NodePackageManager | The Node Package Manager used to execute scripts. | | package_name | str | The "name" in package.json. | | peer_dependency_options | projen.javascript.PeerDependencyOptions | Options for `peerDeps`. | | peer_deps | typing.List[str] | Peer dependencies for this module. | | pnpm_version | str | The version of PNPM to use if using PNPM as a package manager. | | repository | str | The repository is the location where the actual code for your package lives. | | repository_directory | str | 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. | | scoped_packages_options | typing.List[projen.javascript.ScopedPackagesOptions] | Options for privately hosted scoped packages. | | scripts | typing.Mapping[str] | npm scripts to include. | | stability | str | Package's Stability. | | jsii_release_version | str | Version requirement of `publib` which is used to publish modules to npm. | | major_version | typing.Union[int, float] | Major version to release from the default branch. | | min_major_version | typing.Union[int, float] | Minimal Major version to release. | | npm_dist_tag | str | The npmDistTag to use when publishing from the default branch. | | post_build_steps | typing.List[projen.github.workflows.JobStep] | Steps to execute after build as part of the release workflow. | | prerelease | str | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). | | publish_dry_run | bool | Instead of actually publishing to package managers, just print the publishing command. | | publish_tasks | bool | Define publishing tasks that can be executed manually as well as workflows. | | release_branches | typing.Mapping[projen.release.BranchOptions] | Defines additional release branches. | | release_every_commit | bool | Automatically release new versions every commit to one of branches in `releaseBranches`. | | release_failure_issue | bool | Create a github issue on every failed publishing task. | | release_failure_issue_label | str | The label to apply to issues indicating publish failures. | | release_schedule | str | CRON schedule to trigger new releases. | | release_tag_prefix | str | Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. | | release_trigger | projen.release.ReleaseTrigger | The release trigger to use. | | release_workflow_name | str | The name of the default release workflow. | | release_workflow_setup_steps | typing.List[projen.github.workflows.JobStep] | A set of workflow steps to execute in order to setup the workflow container. | | versionrc_options | typing.Mapping[typing.Any] | Custom configuration used when creating changelog with standard-version package. | | workflow_container_image | str | Container image to use for GitHub workflows. | | workflow_runs_on | typing.List[str] | Github Runner selection labels. | | default_release_branch | str | The name of the main release branch. | | artifacts_directory | str | A directory which will contain build artifacts. | | auto_approve_upgrades | bool | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). | | build_workflow | bool | Define a GitHub workflow for building PRs. | | build_workflow_triggers | projen.github.workflows.Triggers | Build workflow triggers. | | bundler_options | projen.javascript.BundlerOptions | Options for `Bundler`. | | code_cov | bool | 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`. | | code_cov_token_secret | str | Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. | | copyright_owner | str | License copyright owner. | | copyright_period | str | The copyright years to put in the LICENSE file. | | dependabot | bool | Use dependabot to handle dependency upgrades. | | dependabot_options | projen.github.DependabotOptions | Options for dependabot. | | deps_upgrade | bool | Use github workflows to handle dependency upgrades. | | deps_upgrade_options | projen.javascript.UpgradeDependenciesOptions | Options for `UpgradeDependencies`. | | gitignore | typing.List[str] | Additional entries to .gitignore. | | jest | bool | Setup jest unit tests. | | jest_options | projen.javascript.JestOptions | Jest options. | | mutable_build | bool | Automatically update files modified during builds to pull-request branches. | | npmignore | typing.List[str] | Additional entries to .npmignore. | | npmignore_enabled | bool | Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. | | npm_ignore_options | projen.IgnoreFileOptions | Configuration options for .npmignore file. | | package | bool | Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). | | prettier | bool | Setup prettier. | | prettier_options | projen.javascript.PrettierOptions | Prettier options. | | projen_dev_dependency | bool | Indicates of "projen" should be installed as a devDependency. | | projenrc_js | bool | Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. | | projenrc_js_options | projen.javascript.ProjenrcOptions | Options for .projenrc.js. | | projen_version | str | Version of projen to install. | | pull_request_template | bool | Include a GitHub pull request template. | | pull_request_template_contents | typing.List[str] | The contents of the pull request template. | | release | bool | Add release management to this project. | | release_to_npm | bool | Automatically release to npm when new versions are introduced. | | release_workflow | bool | DEPRECATED: renamed to `release`. | | workflow_bootstrap_steps | typing.List[projen.github.workflows.JobStep] | Workflow steps to use in order to bootstrap this repo. | | workflow_git_identity | projen.github.GitIdentity | The git identity to use in workflows. | | workflow_node_version | str | The node version to use in GitHub workflows. | | workflow_package_cache | bool | Enable Node.js package cache in GitHub workflows. | | disable_tsconfig | bool | Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). | | disable_tsconfig_dev | bool | Do not generate a `tsconfig.dev.json` file. | | docgen | bool | Docgen by Typedoc. | | docs_directory | str | Docs directory. | | entrypoint_types | str | The .d.ts file that includes the type declarations for this module. | | eslint | bool | Setup eslint. | | eslint_options | projen.javascript.EslintOptions | Eslint options. | | libdir | str | Typescript artifacts output directory. | | projenrc_ts | bool | Use TypeScript for your projenrc file (`.projenrc.ts`). | | projenrc_ts_options | projen.typescript.ProjenrcOptions | Options for .projenrc.ts. | | sample_code | bool | Generate one-time sample in `src/` and `test/` if there are no files there. | | srcdir | str | Typescript sources directory. | | testdir | str | Jest tests directory. Tests files should be named `xxx.test.ts`. | | tsconfig | projen.javascript.TypescriptConfigOptions | Custom TSConfig. | | tsconfig_dev | projen.javascript.TypescriptConfigOptions | Custom tsconfig options for the development tsconfig.json file (used for testing). | | tsconfig_dev_file | str | The name of the development tsconfig.json file. | | typescript_version | str | TypeScript version to use. | | build_command | str | A command to execute before synthesis. | | cdkout | str | cdk.out directory. | | context | typing.Mapping[typing.Any] | Additional context to include in `cdk.json`. | | feature_flags | bool | Include all feature flags in cdk.json. | | require_approval | 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. | | watch_excludes | typing.List[str] | Glob patterns to exclude from `cdk watch`. | | watch_includes | typing.List[str] | Glob patterns to include in `cdk watch`. | | cdk_version | str | Minimum version of the AWS CDK to depend on. | | cdk_assert | bool | Warning: NodeJS only. | | cdk_assertions | bool | Install the assertions library? | | cdk_dependencies | typing.List[str] | Which AWS CDKv1 modules this project requires. | | cdk_dependencies_as_deps | bool | If this is enabled (default), all modules declared in `cdkDependencies` will be also added as normal `dependencies` (as well as `peerDependencies`). | | cdk_test_dependencies | typing.List[str] | AWS CDK modules required for testing. | | cdk_version_pinning | bool | Use pinned version instead of caret version for CDK. | | constructs_version | str | Minimum version of the `constructs` library to depend on. | | app_entrypoint | str | The CDK app's entrypoint (relative to the source directory, which is "src" by default). | | edge_lambda_auto_discover | bool | 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. | | integration_test_auto_discover | bool | Automatically discovers and creates integration tests for each `.integ.ts` file in under your test directory. | | lambda_auto_discover | bool | 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. | | lambda_extension_auto_discover | bool | 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. | | lambda_options | projen.awscdk.LambdaFunctionCommonOptions | Common options for all AWS Lambda functions. | --- ##### `name`^Required - *Type:* str - *Default:* $BASEDIR This is the name of your project. --- ##### `commit_generated`^Optional - *Type:* bool - *Default:* true Whether to commit the managed files by default. --- ##### `git_ignore_options`^Optional - *Type:* projen.IgnoreFileOptions Configuration options for .gitignore file. --- ##### `git_options`^Optional - *Type:* projen.GitOptions Configuration options for git. --- ##### `logging`^Optional - *Type:* projen.LoggerOptions - *Default:* {} Configure logging options such as verbosity. --- ##### `outdir`^Optional - *Type:* str - *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:* projen.Project The parent project, if this project is part of a bigger project. --- ##### `projen_command`^Optional - *Type:* str - *Default:* "npx projen" The shell command to use in order to run the projen CLI. Can be used to customize in special environments. --- ##### `projenrc_json`^Optional - *Type:* bool - *Default:* false Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. --- ##### `projenrc_json_options`^Optional - *Type:* projen.ProjenrcJsonOptions - *Default:* default options Options for .projenrc.json. --- ##### `renovatebot`^Optional - *Type:* bool - *Default:* false Use renovatebot to handle dependency upgrades. --- ##### `renovatebot_options`^Optional - *Type:* projen.RenovatebotOptions - *Default:* default options Options for renovatebot. --- ##### `auto_approve_options`^Optional - *Type:* projen.github.AutoApproveOptions - *Default:* auto approve is disabled Enable and configure the 'auto approve' workflow. --- ##### `auto_merge`^Optional - *Type:* bool - *Default:* true Enable automatic merging on GitHub. Has no effect if `github.mergify` is set to false. --- ##### `auto_merge_options`^Optional - *Type:* projen.github.AutoMergeOptions - *Default:* see defaults in `AutoMergeOptions` Configure options for automatic merging on GitHub. Has no effect if `github.mergify` or `autoMerge` is set to false. --- ##### `clobber`^Optional - *Type:* bool - *Default:* true, but false for subprojects Add a `clobber` task which resets the repo to origin. --- ##### `dev_container`^Optional - *Type:* bool - *Default:* false Add a VSCode development environment (used for GitHub Codespaces). --- ##### `github`^Optional - *Type:* bool - *Default:* true Enable GitHub integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `github_options`^Optional - *Type:* projen.github.GitHubOptions - *Default:* see GitHubOptions Options for GitHub integration. --- ##### `gitpod`^Optional - *Type:* bool - *Default:* false Add a Gitpod development environment. --- ##### ~~`mergify`~~^Optional - *Deprecated:* use `githubOptions.mergify` instead - *Type:* bool - *Default:* true Whether mergify should be enabled on this repository or not. --- ##### ~~`mergify_options`~~^Optional - *Deprecated:* use `githubOptions.mergifyOptions` instead - *Type:* projen.github.MergifyOptions - *Default:* default options Options for mergify. --- ##### ~~`project_type`~~^Optional - *Deprecated:* no longer supported at the base project level - *Type:* projen.ProjectType - *Default:* ProjectType.UNKNOWN Which type of project this is (library/app). --- ##### `projen_credentials`^Optional - *Type:* projen.github.GithubCredentials - *Default:* use a personal access token named PROJEN_GITHUB_TOKEN Choose a method of providing GitHub API access for projen workflows. --- ##### ~~`projen_token_secret`~~^Optional - *Deprecated:* use `projenCredentials` - *Type:* str - *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:* projen.SampleReadmeProps - *Default:* { filename: 'README.md', contents: '# replace this' } The README setup. --- *Example* ```python "{ filename: 'readme.md', contents: '# title' }" ``` ##### `stale`^Optional - *Type:* bool - *Default:* false Auto-close of stale issues and pull request. See `staleOptions` for options. --- ##### `stale_options`^Optional - *Type:* projen.github.StaleOptions - *Default:* see defaults in `StaleOptions` Auto-close stale issues and pull requests. To disable set `stale` to `false`. --- ##### `vscode`^Optional - *Type:* bool - *Default:* true Enable VSCode integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `allow_library_dependencies`^Optional - *Type:* bool - *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. --- ##### `author_email`^Optional - *Type:* str Author's e-mail. --- ##### `author_name`^Optional - *Type:* str Author's name. --- ##### `author_organization`^Optional - *Type:* bool Is the author an organization. --- ##### `author_url`^Optional - *Type:* str Author's URL / Website. --- ##### `auto_detect_bin`^Optional - *Type:* bool - *Default:* true Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. --- ##### `bin`^Optional - *Type:* typing.Mapping[str] 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. --- ##### `bugs_email`^Optional - *Type:* str The email address to which issues should be reported. --- ##### `bugs_url`^Optional - *Type:* str The url to your project's issue tracker. --- ##### `bundled_deps`^Optional - *Type:* typing.List[str] 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. --- ##### `code_artifact_options`^Optional - *Type:* projen.javascript.CodeArtifactOptions - *Default:* undefined Options for npm packages using AWS CodeArtifact. This is required if publishing packages to, or installing scoped packages from AWS CodeArtifact --- ##### `deps`^Optional - *Type:* typing.List[str] - *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* ```python [ 'express', 'lodash', 'foo@^2' ] ``` ##### `description`^Optional - *Type:* str 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 --- ##### `dev_deps`^Optional - *Type:* typing.List[str] - *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* ```python [ 'typescript', '@types/express' ] ``` ##### `entrypoint`^Optional - *Type:* str - *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:* str Package's Homepage / Website. --- ##### `keywords`^Optional - *Type:* typing.List[str] Keywords to include in `package.json`. --- ##### `license`^Optional - *Type:* str - *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:* bool - *Default:* true Indicates if a license should be added. --- ##### `max_node_version`^Optional - *Type:* str - *Default:* no max Minimum node.js version to require via `engines` (inclusive). --- ##### `min_node_version`^Optional - *Type:* str - *Default:* no "engines" specified Minimum Node.js version to require via package.json `engines` (inclusive). --- ##### `npm_access`^Optional - *Type:* projen.javascript.NpmAccess - *Default:* for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`. Access level of the npm package. --- ##### ~~`npm_registry`~~^Optional - *Deprecated:* use `npmRegistryUrl` instead - *Type:* str The host name of the npm registry to publish to. Cannot be set together with `npmRegistryUrl`. --- ##### `npm_registry_url`^Optional - *Type:* str - *Default:* "https://registry.npmjs.org" The base URL of the npm package registry. Must be a URL (e.g. start with "https://" or "http://") --- ##### `npm_token_secret`^Optional - *Type:* str - *Default:* "NPM_TOKEN" GitHub secret which contains the NPM token to use when publishing packages. --- ##### `package_manager`^Optional - *Type:* projen.javascript.NodePackageManager - *Default:* NodePackageManager.YARN The Node Package Manager used to execute scripts. --- ##### `package_name`^Optional - *Type:* str - *Default:* defaults to project name The "name" in package.json. --- ##### `peer_dependency_options`^Optional - *Type:* projen.javascript.PeerDependencyOptions Options for `peerDeps`. --- ##### `peer_deps`^Optional - *Type:* typing.List[str] - *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. --- ##### `pnpm_version`^Optional - *Type:* str - *Default:* "7" The version of PNPM to use if using PNPM as a package manager. --- ##### `repository`^Optional - *Type:* str The repository is the location where the actual code for your package lives. See https://classic.yarnpkg.com/en/docs/package-json/#toc-repository --- ##### `repository_directory`^Optional - *Type:* str 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. --- ##### `scoped_packages_options`^Optional - *Type:* typing.List[projen.javascript.ScopedPackagesOptions] - *Default:* fetch all scoped packages from the public npm registry Options for privately hosted scoped packages. --- ##### ~~`scripts`~~^Optional - *Deprecated:* use `project.addTask()` or `package.setScript()` - *Type:* typing.Mapping[str] - *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:* str Package's Stability. --- ##### `jsii_release_version`^Optional - *Type:* str - *Default:* "latest" Version requirement of `publib` which is used to publish modules to npm. --- ##### `major_version`^Optional - *Type:* typing.Union[int, float] - *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. --- ##### `min_major_version`^Optional - *Type:* typing.Union[int, float] - *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`. --- ##### `npm_dist_tag`^Optional - *Type:* str - *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. --- ##### `post_build_steps`^Optional - *Type:* typing.List[projen.github.workflows.JobStep] - *Default:* [] Steps to execute after build as part of the release workflow. --- ##### `prerelease`^Optional - *Type:* str - *Default:* normal semantic versions Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). --- ##### `publish_dry_run`^Optional - *Type:* bool - *Default:* false Instead of actually publishing to package managers, just print the publishing command. --- ##### `publish_tasks`^Optional - *Type:* bool - *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. --- ##### `release_branches`^Optional - *Type:* typing.Mapping[projen.release.BranchOptions] - *Default:* no additional branches are used for release. you can use `addBranch()` to add additional branches. Defines additional release branches. A workflow will be created for each release branch which will publish releases from commits in this branch. Each release branch _must_ be assigned a major version number which is used to enforce that versions published from that branch always use that major version. If multiple branches are used, the `majorVersion` field must also be provided for the default branch. --- ##### ~~`release_every_commit`~~^Optional - *Deprecated:* Use `releaseTrigger: ReleaseTrigger.continuous()` instead - *Type:* bool - *Default:* true Automatically release new versions every commit to one of branches in `releaseBranches`. --- ##### `release_failure_issue`^Optional - *Type:* bool - *Default:* false Create a github issue on every failed publishing task. --- ##### `release_failure_issue_label`^Optional - *Type:* str - *Default:* "failed-release" The label to apply to issues indicating publish failures. Only applies if `releaseFailureIssue` is true. --- ##### ~~`release_schedule`~~^Optional - *Deprecated:* Use `releaseTrigger: ReleaseTrigger.scheduled()` instead - *Type:* str - *Default:* no scheduled releases CRON schedule to trigger new releases. --- ##### `release_tag_prefix`^Optional - *Type:* str - *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. --- ##### `release_trigger`^Optional - *Type:* projen.release.ReleaseTrigger - *Default:* Continuous releases (`ReleaseTrigger.continuous()`) The release trigger to use. --- ##### `release_workflow_name`^Optional - *Type:* str - *Default:* "Release" The name of the default release workflow. --- ##### `release_workflow_setup_steps`^Optional - *Type:* typing.List[projen.github.workflows.JobStep] A set of workflow steps to execute in order to setup the workflow container. --- ##### `versionrc_options`^Optional - *Type:* typing.Mapping[typing.Any] - *Default:* standard configuration applicable for GitHub repositories Custom configuration used when creating changelog with standard-version package. Given values either append to default configuration or overwrite values in it. --- ##### `workflow_container_image`^Optional - *Type:* str - *Default:* default image Container image to use for GitHub workflows. --- ##### `workflow_runs_on`^Optional - *Type:* typing.List[str] - *Default:* ["ubuntu-latest"] Github Runner selection labels. --- ##### `default_release_branch`^Required - *Type:* str - *Default:* "main" The name of the main release branch. --- ##### `artifacts_directory`^Optional - *Type:* str - *Default:* "dist" A directory which will contain build artifacts. --- ##### `auto_approve_upgrades`^Optional - *Type:* bool - *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. --- ##### `build_workflow`^Optional - *Type:* bool - *Default:* true if not a subproject Define a GitHub workflow for building PRs. --- ##### `build_workflow_triggers`^Optional - *Type:* projen.github.workflows.Triggers - *Default:* "{ pullRequest: {}, workflowDispatch: {} }" Build workflow triggers. --- ##### `bundler_options`^Optional - *Type:* projen.javascript.BundlerOptions Options for `Bundler`. --- ##### `code_cov`^Optional - *Type:* bool - *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`. --- ##### `code_cov_token_secret`^Optional - *Type:* str - *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. --- ##### `copyright_owner`^Optional - *Type:* str - *Default:* defaults to the value of authorName or "" if `authorName` is undefined. License copyright owner. --- ##### `copyright_period`^Optional - *Type:* str - *Default:* current year The copyright years to put in the LICENSE file. --- ##### `dependabot`^Optional - *Type:* bool - *Default:* false Use dependabot to handle dependency upgrades. Cannot be used in conjunction with `depsUpgrade`. --- ##### `dependabot_options`^Optional - *Type:* projen.github.DependabotOptions - *Default:* default options Options for dependabot. --- ##### `deps_upgrade`^Optional - *Type:* bool - *Default:* true Use github workflows to handle dependency upgrades. Cannot be used in conjunction with `dependabot`. --- ##### `deps_upgrade_options`^Optional - *Type:* projen.javascript.UpgradeDependenciesOptions - *Default:* default options Options for `UpgradeDependencies`. --- ##### `gitignore`^Optional - *Type:* typing.List[str] Additional entries to .gitignore. --- ##### `jest`^Optional - *Type:* bool - *Default:* true Setup jest unit tests. --- ##### `jest_options`^Optional - *Type:* projen.javascript.JestOptions - *Default:* default options Jest options. --- ##### `mutable_build`^Optional - *Type:* bool - *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:* typing.List[str] Additional entries to .npmignore. --- ##### `npmignore_enabled`^Optional - *Type:* bool - *Default:* true Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. --- ##### `npm_ignore_options`^Optional - *Type:* projen.IgnoreFileOptions Configuration options for .npmignore file. --- ##### `package`^Optional - *Type:* bool - *Default:* true Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). --- ##### `prettier`^Optional - *Type:* bool - *Default:* false Setup prettier. --- ##### `prettier_options`^Optional - *Type:* projen.javascript.PrettierOptions - *Default:* default options Prettier options. --- ##### `projen_dev_dependency`^Optional - *Type:* bool - *Default:* true Indicates of "projen" should be installed as a devDependency. --- ##### `projenrc_js`^Optional - *Type:* bool - *Default:* true if projenrcJson is false Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. --- ##### `projenrc_js_options`^Optional - *Type:* projen.javascript.ProjenrcOptions - *Default:* default options Options for .projenrc.js. --- ##### `projen_version`^Optional - *Type:* str - *Default:* Defaults to the latest version. Version of projen to install. --- ##### `pull_request_template`^Optional - *Type:* bool - *Default:* true Include a GitHub pull request template. --- ##### `pull_request_template_contents`^Optional - *Type:* typing.List[str] - *Default:* default content The contents of the pull request template. --- ##### `release`^Optional - *Type:* bool - *Default:* true (false for subprojects) Add release management to this project. --- ##### `release_to_npm`^Optional - *Type:* bool - *Default:* false Automatically release to npm when new versions are introduced. --- ##### ~~`release_workflow`~~^Optional - *Deprecated:* see `release`. - *Type:* bool - *Default:* true if not a subproject DEPRECATED: renamed to `release`. --- ##### `workflow_bootstrap_steps`^Optional - *Type:* typing.List[projen.github.workflows.JobStep] - *Default:* "yarn install --frozen-lockfile && yarn projen" Workflow steps to use in order to bootstrap this repo. --- ##### `workflow_git_identity`^Optional - *Type:* projen.github.GitIdentity - *Default:* GitHub Actions The git identity to use in workflows. --- ##### `workflow_node_version`^Optional - *Type:* str - *Default:* same as `minNodeVersion` The node version to use in GitHub workflows. --- ##### `workflow_package_cache`^Optional - *Type:* bool - *Default:* false Enable Node.js package cache in GitHub workflows. --- ##### `disable_tsconfig`^Optional - *Type:* bool - *Default:* false Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). --- ##### `disable_tsconfig_dev`^Optional - *Type:* bool - *Default:* false Do not generate a `tsconfig.dev.json` file. --- ##### `docgen`^Optional - *Type:* bool - *Default:* false Docgen by Typedoc. --- ##### `docs_directory`^Optional - *Type:* str - *Default:* "docs" Docs directory. --- ##### `entrypoint_types`^Optional - *Type:* str - *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:* bool - *Default:* true Setup eslint. --- ##### `eslint_options`^Optional - *Type:* projen.javascript.EslintOptions - *Default:* opinionated default options Eslint options. --- ##### `libdir`^Optional - *Type:* str - *Default:* "lib" Typescript artifacts output directory. --- ##### `projenrc_ts`^Optional - *Type:* bool - *Default:* false Use TypeScript for your projenrc file (`.projenrc.ts`). --- ##### `projenrc_ts_options`^Optional - *Type:* projen.typescript.ProjenrcOptions Options for .projenrc.ts. --- ##### `sample_code`^Optional - *Type:* bool - *Default:* true Generate one-time sample in `src/` and `test/` if there are no files there. --- ##### `srcdir`^Optional - *Type:* str - *Default:* "src" Typescript sources directory. --- ##### `testdir`^Optional - *Type:* str - *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:* projen.javascript.TypescriptConfigOptions - *Default:* default options Custom TSConfig. --- ##### `tsconfig_dev`^Optional - *Type:* projen.javascript.TypescriptConfigOptions - *Default:* use the production tsconfig options Custom tsconfig options for the development tsconfig.json file (used for testing). --- ##### `tsconfig_dev_file`^Optional - *Type:* str - *Default:* "tsconfig.dev.json" The name of the development tsconfig.json file. --- ##### `typescript_version`^Optional - *Type:* str - *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`). --- ##### `build_command`^Optional - *Type:* str - *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:* str - *Default:* "cdk.out" cdk.out directory. --- ##### `context`^Optional - *Type:* typing.Mapping[typing.Any] - *Default:* no additional context Additional context to include in `cdk.json`. --- ##### `feature_flags`^Optional - *Type:* bool - *Default:* true Include all feature flags in cdk.json. --- ##### `require_approval`^Optional - *Type:* projen.awscdk.ApprovalLevel - *Default:* ApprovalLevel.BROADENING To protect you against unintended changes that affect your security posture, the AWS CDK Toolkit prompts you to approve security-related changes before deploying them. --- ##### `watch_excludes`^Optional - *Type:* typing.List[str] - *Default:* [] Glob patterns to exclude from `cdk watch`. --- ##### `watch_includes`^Optional - *Type:* typing.List[str] - *Default:* [] Glob patterns to include in `cdk watch`. --- ##### `cdk_version`^Required - *Type:* str - *Default:* "2.1.0" Minimum version of the AWS CDK to depend on. --- ##### ~~`cdk_assert`~~^Optional - *Deprecated:* The - *Type:* bool - *Default:* will be included by default for AWS CDK >= 1.0.0 < 2.0.0 Warning: NodeJS only. Install the --- ##### `cdk_assertions`^Optional - *Type:* bool - *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' --- ##### ~~`cdk_dependencies`~~^Optional - *Deprecated:* For CDK 2.x use "deps" instead. (or "peerDeps" if you're building a library) - *Type:* typing.List[str] Which AWS CDKv1 modules this project requires. --- ##### ~~`cdk_dependencies_as_deps`~~^Optional - *Deprecated:* Not supported in CDK v2. - *Type:* bool - *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 --- ##### ~~`cdk_test_dependencies`~~^Optional - *Deprecated:* For CDK 2.x use 'devDeps' (in node.js projects) or 'testDeps' (in java projects) instead - *Type:* typing.List[str] AWS CDK modules required for testing. --- ##### `cdk_version_pinning`^Optional - *Type:* bool 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. --- ##### `constructs_version`^Optional - *Type:* str - *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. --- ##### `app_entrypoint`^Optional - *Type:* str - *Default:* "main.ts" The CDK app's entrypoint (relative to the source directory, which is "src" by default). --- ##### `edge_lambda_auto_discover`^Optional - *Type:* bool - *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. --- ##### `integration_test_auto_discover`^Optional - *Type:* bool - *Default:* true Automatically discovers and creates integration tests for each `.integ.ts` file in under your test directory. --- ##### `lambda_auto_discover`^Optional - *Type:* bool - *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. --- ##### `lambda_extension_auto_discover`^Optional - *Type:* bool - *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. --- ##### `lambda_options`^Optional - *Type:* projen.awscdk.LambdaFunctionCommonOptions - *Default:* default options Common options for all AWS Lambda functions. --- #### Methods | **Name** | **Description** | | --- | --- | | add_exclude_from_cleanup | Exclude the matching files from pre-synth cleanup. | | add_git_ignore | Adds a .gitignore pattern. | | add_package_ignore | Exclude these files from the bundled package. | | add_task | Adds a new task to this project. | | add_tip | Prints a "tip" message during synthesis. | | annotate_generated | Marks the provided file(s) as being generated. | | post_synthesize | Called after all components are synthesized. | | pre_synthesize | Called before all components are synthesized. | | remove_task | Removes a task from a project. | | run_task_command | Returns the shell command to execute in order to run a task. | | synth | Synthesize all project files into `outdir`. | | try_find_file | Finds a file at the specified relative path within this project and all its subprojects. | | try_find_json_file | Finds a json file by name. | | try_find_object_file | Finds an object file (like JsonFile, YamlFile, etc.) by name. | | try_remove_file | Finds a file at the specified relative path within this project and removes it. | | add_bins | *No description.* | | add_bundled_deps | Defines bundled dependencies. | | add_compile_command | DEPRECATED. | | add_deps | Defines normal dependencies. | | add_dev_deps | Defines development/test dependencies. | | add_fields | Directly set fields in `package.json`. | | add_keywords | Adds keywords to package.json (deduplicated). | | add_peer_deps | Defines peer dependencies. | | add_scripts | Replaces the contents of multiple npm package.json scripts. | | add_test_command | DEPRECATED. | | has_script | Indicates if a script by the name name is defined. | | remove_script | Removes the npm script (always successful). | | render_workflow_setup | Returns the set of workflow steps which should be executed to bootstrap a workflow. | | set_script | Replaces the contents of an npm package.json script. | | add_cdk_dependency | Adds an AWS CDK module dependencies. | --- ##### `add_exclude_from_cleanup` ```python def add_exclude_from_cleanup( globs: str ) -> None ``` 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:* str The glob patterns to match. --- ##### `add_git_ignore` ```python def add_git_ignore( pattern: str ) -> None ``` Adds a .gitignore pattern. ###### `pattern`^Required - *Type:* str The glob pattern to ignore. --- ##### `add_package_ignore` ```python def add_package_ignore( pattern: str ) -> None ``` 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:* str --- ##### `add_task` ```python def add_task( name: str, condition: str = None, cwd: str = None, description: str = None, env: typing.Mapping[str] = None, required_env: typing.List[str] = None, args: typing.List[str] = None, exec: str = None, receive_args: bool = None, steps: typing.List[TaskStep] = None ) -> Task ``` Adds a new task to this project. This will fail if the project already has a task with this name. ###### `name`^Required - *Type:* str The task name to add. --- ###### `condition`^Optional - *Type:* str A shell command which determines if the this task should be executed. If the program exits with a zero exit code, steps will be executed. A non-zero code means that task will be skipped. --- ###### `cwd`^Optional - *Type:* str - *Default:* process.cwd() The working directory for all steps in this task (unless overridden by the step). --- ###### `description`^Optional - *Type:* str - *Default:* the task name The description of this build command. --- ###### `env`^Optional - *Type:* typing.Mapping[str] - *Default:* {} Defines environment variables for the execution of this task. Values in this map will be evaluated in a shell, so you can do stuff like `$(echo "foo")`. --- ###### `required_env`^Optional - *Type:* typing.List[str] A set of environment variables that must be defined in order to execute this task. Task execution will fail if one of these is not defined. --- ###### `args`^Optional - *Type:* typing.List[str] - *Default:* no arguments are passed to the step Should the provided `exec` shell command receive fixed args. > [{@link TaskStepOptions.args }]({@link TaskStepOptions.args }) --- ###### `exec`^Optional - *Type:* str - *Default:* add steps using `task.exec(command)` or `task.spawn(subtask)` Shell command to execute as the first command of the task. --- ###### `receive_args`^Optional - *Type:* bool - *Default:* false Should the provided `exec` shell command receive args passed to the task. > [{@link TaskStepOptions.receiveArgs }]({@link TaskStepOptions.receiveArgs }) --- ###### `steps`^Optional - *Type:* typing.List[projen.TaskStep] List of task steps to run. --- ##### ~~`add_tip`~~ ```python def add_tip( message: str ) -> None ``` Prints a "tip" message during synthesis. ###### `message`^Required - *Type:* str The message. --- ##### `annotate_generated` ```python def annotate_generated( glob: str ) -> None ``` 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:* str the glob pattern to match (could be a file path). --- ##### `post_synthesize` ```python def post_synthesize() -> None ``` Called after all components are synthesized. Order is *not* guaranteed. ##### `pre_synthesize` ```python def pre_synthesize() -> None ``` Called before all components are synthesized. ##### `remove_task` ```python def remove_task( name: str ) -> Task ``` Removes a task from a project. ###### `name`^Required - *Type:* str The name of the task to remove. --- ##### `run_task_command` ```python def run_task_command( task: Task ) -> str ``` Returns the shell command to execute in order to run a task. This will typically be `npx projen TASK`. ###### `task`^Required - *Type:* projen.Task The task for which the command is required. --- ##### `synth` ```python def synth() -> None ``` 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()" ##### `try_find_file` ```python def try_find_file( file_path: str ) -> FileBase ``` Finds a file at the specified relative path within this project and all its subprojects. ###### `file_path`^Required - *Type:* str The file path. If this path is relative, it will be resolved from the root of _this_ project. --- ##### ~~`try_find_json_file`~~ ```python def try_find_json_file( file_path: str ) -> JsonFile ``` Finds a json file by name. ###### `file_path`^Required - *Type:* str The file path. --- ##### `try_find_object_file` ```python def try_find_object_file( file_path: str ) -> ObjectFile ``` Finds an object file (like JsonFile, YamlFile, etc.) by name. ###### `file_path`^Required - *Type:* str The file path. --- ##### `try_remove_file` ```python def try_remove_file( file_path: str ) -> FileBase ``` Finds a file at the specified relative path within this project and removes it. ###### `file_path`^Required - *Type:* str The file path. If this path is relative, it will be resolved from the root of _this_ project. --- ##### `add_bins` ```python def add_bins( bins: typing.Mapping[str] ) -> None ``` ###### `bins`^Required - *Type:* typing.Mapping[str] --- ##### `add_bundled_deps` ```python def add_bundled_deps( deps: str ) -> None ``` 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:* str 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`. --- ##### ~~`add_compile_command`~~ ```python def add_compile_command( commands: str ) -> None ``` DEPRECATED. ###### `commands`^Required - *Type:* str --- ##### `add_deps` ```python def add_deps( deps: str ) -> None ``` Defines normal dependencies. ###### `deps`^Required - *Type:* str 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`. --- ##### `add_dev_deps` ```python def add_dev_deps( deps: str ) -> None ``` Defines development/test dependencies. ###### `deps`^Required - *Type:* str 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`. --- ##### `add_fields` ```python def add_fields( fields: typing.Mapping[typing.Any] ) -> None ``` Directly set fields in `package.json`. ###### `fields`^Required - *Type:* typing.Mapping[typing.Any] The fields to set. --- ##### `add_keywords` ```python def add_keywords( keywords: str ) -> None ``` Adds keywords to package.json (deduplicated). ###### `keywords`^Required - *Type:* str The keywords to add. --- ##### `add_peer_deps` ```python def add_peer_deps( deps: str ) -> None ``` 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:* str 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`. --- ##### `add_scripts` ```python def add_scripts( scripts: typing.Mapping[str] ) -> None ``` Replaces the contents of multiple npm package.json scripts. ###### `scripts`^Required - *Type:* typing.Mapping[str] The scripts to set. --- ##### ~~`add_test_command`~~ ```python def add_test_command( commands: str ) -> None ``` DEPRECATED. ###### `commands`^Required - *Type:* str --- ##### ~~`has_script`~~ ```python def has_script( name: str ) -> bool ``` Indicates if a script by the name name is defined. ###### `name`^Required - *Type:* str The name of the script. --- ##### `remove_script` ```python def remove_script( name: str ) -> None ``` Removes the npm script (always successful). ###### `name`^Required - *Type:* str The name of the script. --- ##### `render_workflow_setup` ```python def render_workflow_setup( mutable: bool = None ) -> typing.List[JobStep] ``` Returns the set of workflow steps which should be executed to bootstrap a workflow. ###### `mutable`^Optional - *Type:* bool - *Default:* false Should the pacakge lockfile be updated? --- ##### `set_script` ```python def set_script( name: str, command: str ) -> None ``` Replaces the contents of an npm package.json script. ###### `name`^Required - *Type:* str The script name. --- ###### `command`^Required - *Type:* str The command to execute. --- ##### `add_cdk_dependency` ```python def add_cdk_dependency( modules: str ) -> None ``` Adds an AWS CDK module dependencies. ###### `modules`^Required - *Type:* str The list of modules to depend on. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | build_task | projen.Task | *No description.* | | commit_generated | bool | Whether to commit the managed files by default. | | compile_task | projen.Task | *No description.* | | components | typing.List[projen.Component] | Returns all the components within this project. | | deps | projen.Dependencies | Project dependencies. | | ejected | bool | Whether or not the project is being ejected. | | files | typing.List[projen.FileBase] | All files in this project. | | gitattributes | projen.GitAttributesFile | The .gitattributes file for this repository. | | gitignore | projen.IgnoreFile | .gitignore. | | logger | projen.Logger | Logging utilities. | | name | str | Project name. | | outdir | str | Absolute output directory of this project. | | package_task | projen.Task | *No description.* | | post_compile_task | projen.Task | *No description.* | | pre_compile_task | projen.Task | *No description.* | | project_build | projen.ProjectBuild | Manages the build process of the project. | | projen_command | str | The command to use in order to run the projen CLI. | | root | projen.Project | The root project. | | subprojects | typing.List[projen.Project] | Returns all the subprojects within this project. | | tasks | projen.Tasks | Project tasks. | | test_task | projen.Task | *No description.* | | default_task | projen.Task | This is the "default" task, the one that executes "projen". | | init_project | projen.InitProject | The options used when this project is bootstrapped via `projen new`. | | parent | projen.Project | A parent project. | | project_type | projen.ProjectType | *No description.* | | auto_approve | projen.github.AutoApprove | Auto approve set up for this project. | | dev_container | projen.vscode.DevContainer | Access for .devcontainer.json (used for GitHub Codespaces). | | github | projen.github.GitHub | Access all github components. | | gitpod | projen.Gitpod | Access for Gitpod. | | vscode | projen.vscode.VsCode | Access all VSCode components. | | allow_library_dependencies | bool | *No description.* | | artifacts_directory | str | The build output directory. | | artifacts_javascript_directory | str | The location of the npm tarball after build (`${artifactsDirectory}/js`). | | bundler | projen.javascript.Bundler | *No description.* | | entrypoint | str | *No description.* | | manifest | typing.Any | *No description.* | | npmrc | projen.javascript.NpmConfig | The .npmrc file. | | package | projen.javascript.NodePackage | API for managing the node package. | | package_manager | projen.javascript.NodePackageManager | The package manager to use. | | run_script_command | str | The command to use to run scripts (e.g. `yarn run` or `npm run` depends on the package manager). | | auto_merge | projen.github.AutoMerge | Component that sets up mergify for merging approved pull requests. | | build_workflow | projen.build.BuildWorkflow | The PR build GitHub workflow. | | build_workflow_job_id | str | The job ID of the build workflow. | | jest | projen.javascript.Jest | The Jest configuration (if enabled). | | max_node_version | str | Maximum node version required by this package. | | min_node_version | str | Minimum node.js version required by this package. | | npmignore | projen.IgnoreFile | The .npmignore file. | | prettier | projen.javascript.Prettier | *No description.* | | publisher | projen.release.Publisher | Package publisher. | | release | projen.release.Release | Release management. | | upgrade_workflow | projen.javascript.UpgradeDependencies | The upgrade workflow. | | docs_directory | str | *No description.* | | libdir | str | The directory in which compiled .js files reside. | | srcdir | str | The directory in which the .ts sources reside. | | testdir | str | The directory in which tests reside. | | tsconfig_dev | projen.javascript.TypescriptConfig | A typescript configuration file which covers all files (sources, tests, projen). | | watch_task | projen.Task | The "watch" task. | | docgen | bool | *No description.* | | eslint | projen.javascript.Eslint | *No description.* | | tsconfig | projen.javascript.TypescriptConfig | *No description.* | | tsconfig_eslint | projen.javascript.TypescriptConfig | *No description.* | | app_entrypoint | str | The CDK app entrypoint. | | cdk_config | projen.awscdk.CdkConfig | cdk.json configuration. | | cdk_deps | projen.awscdk.AwsCdkDeps | *No description.* | | cdk_tasks | projen.awscdk.CdkTasks | Common CDK tasks. | | cdk_version | str | The CDK version this app is using. | --- ##### `build_task`^Required ```python build_task: Task ``` - *Type:* projen.Task --- ##### `commit_generated`^Required ```python commit_generated: bool ``` - *Type:* bool Whether to commit the managed files by default. --- ##### `compile_task`^Required ```python compile_task: Task ``` - *Type:* projen.Task --- ##### `components`^Required ```python components: typing.List[Component] ``` - *Type:* typing.List[projen.Component] Returns all the components within this project. --- ##### `deps`^Required ```python deps: Dependencies ``` - *Type:* projen.Dependencies Project dependencies. --- ##### `ejected`^Required ```python ejected: bool ``` - *Type:* bool Whether or not the project is being ejected. --- ##### `files`^Required ```python files: typing.List[FileBase] ``` - *Type:* typing.List[projen.FileBase] All files in this project. --- ##### `gitattributes`^Required ```python gitattributes: GitAttributesFile ``` - *Type:* projen.GitAttributesFile The .gitattributes file for this repository. --- ##### `gitignore`^Required ```python gitignore: IgnoreFile ``` - *Type:* projen.IgnoreFile .gitignore. --- ##### `logger`^Required ```python logger: Logger ``` - *Type:* projen.Logger Logging utilities. --- ##### `name`^Required ```python name: str ``` - *Type:* str Project name. --- ##### `outdir`^Required ```python outdir: str ``` - *Type:* str Absolute output directory of this project. --- ##### `package_task`^Required ```python package_task: Task ``` - *Type:* projen.Task --- ##### `post_compile_task`^Required ```python post_compile_task: Task ``` - *Type:* projen.Task --- ##### `pre_compile_task`^Required ```python pre_compile_task: Task ``` - *Type:* projen.Task --- ##### `project_build`^Required ```python project_build: ProjectBuild ``` - *Type:* projen.ProjectBuild Manages the build process of the project. --- ##### `projen_command`^Required ```python projen_command: str ``` - *Type:* str The command to use in order to run the projen CLI. --- ##### `root`^Required ```python root: Project ``` - *Type:* projen.Project The root project. --- ##### `subprojects`^Required ```python subprojects: typing.List[Project] ``` - *Type:* typing.List[projen.Project] Returns all the subprojects within this project. --- ##### `tasks`^Required ```python tasks: Tasks ``` - *Type:* projen.Tasks Project tasks. --- ##### `test_task`^Required ```python test_task: Task ``` - *Type:* projen.Task --- ##### `default_task`^Optional ```python default_task: Task ``` - *Type:* projen.Task This is the "default" task, the one that executes "projen". Undefined if the project is being ejected. --- ##### `init_project`^Optional ```python init_project: InitProject ``` - *Type:* projen.InitProject The options used when this project is bootstrapped via `projen new`. It includes the original set of options passed to the CLI and also the JSII FQN of the project type. --- ##### `parent`^Optional ```python parent: Project ``` - *Type:* projen.Project A parent project. If undefined, this is the root project. --- ##### `project_type`^Required ```python project_type: ProjectType ``` - *Type:* projen.ProjectType --- ##### `auto_approve`^Optional ```python auto_approve: AutoApprove ``` - *Type:* projen.github.AutoApprove Auto approve set up for this project. --- ##### `dev_container`^Optional ```python dev_container: DevContainer ``` - *Type:* projen.vscode.DevContainer Access for .devcontainer.json (used for GitHub Codespaces). This will be `undefined` if devContainer boolean is false --- ##### `github`^Optional ```python github: GitHub ``` - *Type:* projen.github.GitHub Access all github components. This will be `undefined` for subprojects. --- ##### `gitpod`^Optional ```python gitpod: Gitpod ``` - *Type:* projen.Gitpod Access for Gitpod. This will be `undefined` if gitpod boolean is false --- ##### `vscode`^Optional ```python vscode: VsCode ``` - *Type:* projen.vscode.VsCode Access all VSCode components. This will be `undefined` for subprojects. --- ##### ~~`allow_library_dependencies`~~^Required - *Deprecated:* use `package.allowLibraryDependencies` ```python allow_library_dependencies: bool ``` - *Type:* bool --- ##### `artifacts_directory`^Required ```python artifacts_directory: str ``` - *Type:* str 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`. --- ##### `artifacts_javascript_directory`^Required ```python artifacts_javascript_directory: str ``` - *Type:* str The location of the npm tarball after build (`${artifactsDirectory}/js`). --- ##### `bundler`^Required ```python bundler: Bundler ``` - *Type:* projen.javascript.Bundler --- ##### ~~`entrypoint`~~^Required - *Deprecated:* use `package.entrypoint` ```python entrypoint: str ``` - *Type:* str --- ##### ~~`manifest`~~^Required - *Deprecated:* use `package.addField(x, y)` ```python manifest: typing.Any ``` - *Type:* typing.Any --- ##### `npmrc`^Required ```python npmrc: NpmConfig ``` - *Type:* projen.javascript.NpmConfig The .npmrc file. --- ##### `package`^Required ```python package: NodePackage ``` - *Type:* projen.javascript.NodePackage API for managing the node package. --- ##### ~~`package_manager`~~^Required - *Deprecated:* use `package.packageManager` ```python package_manager: NodePackageManager ``` - *Type:* projen.javascript.NodePackageManager The package manager to use. --- ##### `run_script_command`^Required ```python run_script_command: str ``` - *Type:* str The command to use to run scripts (e.g. `yarn run` or `npm run` depends on the package manager). --- ##### `auto_merge`^Optional ```python auto_merge: AutoMerge ``` - *Type:* projen.github.AutoMerge Component that sets up mergify for merging approved pull requests. --- ##### `build_workflow`^Optional ```python build_workflow: BuildWorkflow ``` - *Type:* projen.build.BuildWorkflow The PR build GitHub workflow. `undefined` if `buildWorkflow` is disabled. --- ##### `build_workflow_job_id`^Optional ```python build_workflow_job_id: str ``` - *Type:* str The job ID of the build workflow. --- ##### `jest`^Optional ```python jest: Jest ``` - *Type:* projen.javascript.Jest The Jest configuration (if enabled). --- ##### `max_node_version`^Optional ```python max_node_version: str ``` - *Type:* str Maximum node version required by this package. --- ##### `min_node_version`^Optional ```python min_node_version: str ``` - *Type:* str Minimum node.js version required by this package. --- ##### `npmignore`^Optional ```python npmignore: IgnoreFile ``` - *Type:* projen.IgnoreFile The .npmignore file. --- ##### `prettier`^Optional ```python prettier: Prettier ``` - *Type:* projen.javascript.Prettier --- ##### ~~`publisher`~~^Optional - *Deprecated:* use `release.publisher`. ```python publisher: Publisher ``` - *Type:* projen.release.Publisher Package publisher. This will be `undefined` if the project does not have a release workflow. --- ##### `release`^Optional ```python release: Release ``` - *Type:* projen.release.Release Release management. --- ##### `upgrade_workflow`^Optional ```python upgrade_workflow: UpgradeDependencies ``` - *Type:* projen.javascript.UpgradeDependencies The upgrade workflow. --- ##### `docs_directory`^Required ```python docs_directory: str ``` - *Type:* str --- ##### `libdir`^Required ```python libdir: str ``` - *Type:* str The directory in which compiled .js files reside. --- ##### `srcdir`^Required ```python srcdir: str ``` - *Type:* str The directory in which the .ts sources reside. --- ##### `testdir`^Required ```python testdir: str ``` - *Type:* str The directory in which tests reside. --- ##### `tsconfig_dev`^Required ```python tsconfig_dev: TypescriptConfig ``` - *Type:* projen.javascript.TypescriptConfig A typescript configuration file which covers all files (sources, tests, projen). --- ##### `watch_task`^Required ```python watch_task: Task ``` - *Type:* projen.Task The "watch" task. --- ##### `docgen`^Optional ```python docgen: bool ``` - *Type:* bool --- ##### `eslint`^Optional ```python eslint: Eslint ``` - *Type:* projen.javascript.Eslint --- ##### `tsconfig`^Optional ```python tsconfig: TypescriptConfig ``` - *Type:* projen.javascript.TypescriptConfig --- ##### `tsconfig_eslint`^Optional ```python tsconfig_eslint: TypescriptConfig ``` - *Type:* projen.javascript.TypescriptConfig --- ##### `app_entrypoint`^Required ```python app_entrypoint: str ``` - *Type:* str The CDK app entrypoint. --- ##### `cdk_config`^Required ```python cdk_config: CdkConfig ``` - *Type:* projen.awscdk.CdkConfig cdk.json configuration. --- ##### `cdk_deps`^Required ```python cdk_deps: AwsCdkDeps ``` - *Type:* projen.awscdk.AwsCdkDeps --- ##### `cdk_tasks`^Required ```python cdk_tasks: CdkTasks ``` - *Type:* projen.awscdk.CdkTasks Common CDK tasks. --- ##### `cdk_version`^Required ```python cdk_version: str ``` - *Type:* str The CDK version this app is using. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | DEFAULT_TASK | str | The name of the default task (the task executed when `projen` is run without arguments). | --- ##### `DEFAULT_TASK`^Required ```python DEFAULT_TASK: str ``` - *Type:* str The name of the default task (the task executed when `projen` is run without arguments). Normally this task should synthesize the project files. ---