Classes
| Name | Description |
|---|---|
| AwsCdkAppSyncApp | AWS CDK AppSync Transformer App in TypeScript. |
Structs
| Name | Description |
|---|---|
| AwsCdkAppSyncAppOptions | No description |
AWS CDK AppSync Transformer App in TypeScript.
Extends: AwsCdkTypeScriptApp
new AwsCdkAppSyncApp(options: AwsCdkAppSyncAppOptions)- options (
AwsCdkAppSyncAppOptions) No description- mergify (
boolean) Whether mergify should be enabled on this repository or not. Default: true - name (
string) This is the name of your project. - clobber (
boolean) Add aclobbertask which resets the repo to origin. Default: true - devContainer (
boolean) Add a VSCode development environment (used for GitHub Codespaces). Default: false - gitpod (
boolean) Add a Gitpod development environment. Default: false - logging (
LoggerOptions) Configure logging options such as verbosity. Default: {} - outdir (
string) The root directory of the project. Default: "." - parent (
Project) The parent project, if this project is part of a bigger project. Optional - projectType (
ProjectType) Which type of project this is (library/app). Default: ProjectType.UNKNOWN - readme (
SampleReadmeProps) The README setup. Default: { filename: 'README.md', contents: '# replace this' } - allowLibraryDependencies (
boolean) Allow the project to includepeerDependenciesandbundledDependencies. Default: true - authorEmail (
string) Author's e-mail. Optional - authorName (
string) Author's name. Optional - authorOrganization (
boolean) Author's Organization. Optional - authorUrl (
string) Author's URL / Website. Optional - autoDetectBin (
boolean) Automatically add all executables under thebindirectory to yourpackage.jsonfile under thebinsection. Default: true - bin (
Map<string, string>) Binary programs vended with your module. Optional - bundledDeps (
Array) List of dependencies to bundle into this module. Optional - deps (
Array) Runtime dependencies of this module. Default: [] - description (
string) The description is just a string that helps people understand the purpose of the package. Optional - devDeps (
Array) Build dependencies for this module. Default: [] - entrypoint (
string) Module entrypoint (maininpackage.json). Default: "lib/index.js" - homepage (
string) Package's Homepage / Website. Optional - keywords (
Array) Keywords to include inpackage.json. Optional - license (
string) License's SPDX identifier. Default: "Apache-2.0" - licensed (
boolean) Indicates if a license should be added. Default: true - maxNodeVersion (
string) Minimum node.js version to require viaengines(inclusive). Default: no max - minNodeVersion (
string) Minimum Node.js version to require via package.jsonengines(inclusive). Default: no "engines" specified - npmAccess (
NpmAccess) Access level of the npm package. Default: for scoped packages (e.g.foo@bar), the default isNpmAccess.RESTRICTED, for non-scoped packages, the default isNpmAccess.PUBLIC. - npmDistTag (
string) Tags can be used to provide an alias instead of version numbers. Default: "latest" - npmRegistry (
string) The host name of the npm registry to publish to. Optional - npmRegistryUrl (
string) The base URL of the npm package registry. Default: "https://registry.npmjs.org" - npmTaskExecution (
NpmTaskExecution) Determines how tasks are executed when invoked as npm scripts (yarn/npm run xyz). Default: NpmTaskExecution.PROJEN - npmTokenSecret (
string) GitHub secret which contains the NPM token to use when publishing packages. Default: "NPM_TOKEN" - packageManager (
NodePackageManager) The Node Package Manager used to execute scripts. Default: NodePackageManager.YARN - packageName (
string) The "name" in package.json. Default: defaults to project name - peerDependencyOptions (
PeerDependencyOptions) Options forpeerDeps. Optional - peerDeps (
Array) Peer dependencies for this module. Default: [] - projenCommand (
string) The shell command to use in order to run the projen CLI. Default: "npx projen" - repository (
string) The repository is the location where the actual code for your package lives. Optional - repositoryDirectory (
string) If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives. Optional - scripts (
Map<string, string>) npm scripts to include. Default: {} - stability (
string) Package's Stability. Optional - defaultReleaseBranch (
string) The name of the main release branch. - antitamper (
boolean) Checks that after build there are no modified files on git. Default: true - artifactsDirectory (
string) A directory which will contain artifacts to be published to npm. Default: "dist" - buildWorkflow (
boolean) Define a GitHub workflow for building PRs. Default: true if not a subproject - codeCov (
boolean) Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v1 A secret is required for private repos. Configured with @codeCovTokenSecret. Default: false - codeCovTokenSecret (
string) Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. Default: if this option is not specified, only public repositories are supported - copyrightOwner (
string) License copyright owner. Default: defaults to the value of authorName or "" ifauthorNameis undefined. - copyrightPeriod (
string) The copyright years to put in the LICENSE file. Default: current year - dependabot (
boolean) Include dependabot configuration. Default: true - dependabotOptions (
DependabotOptions) Options for dependabot. Default: default options - gitignore (
Array) Additional entries to .gitignore. Optional - jest (
boolean) Setup jest unit tests. Default: true - jestOptions (
JestOptions) Jest options. Default: default options - jsiiReleaseVersion (
string) Version requirement ofjsii-releasewhich is used to publish modules to npm. Default: "latest" - mergifyAutoMergeLabel (
string) Automatically merge PRs that build successfully and have this label. Default: "auto-merge" - mergifyOptions (
MergifyOptions) Options for mergify. Default: default options - mutableBuild (
boolean) Automatically update files modified during builds to pull-request branches. Default: true - npmignore (
Array) Additional entries to .npmignore. Optional - npmignoreEnabled (
boolean) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. Default: true - projenDevDependency (
boolean) Indicates of "projen" should be installed as a devDependency. Default: true - projenDuringBuild (
boolean) Executeprojenas the first step of thebuildtask to synthesize project files. Default: true - projenrcJs (
boolean) Generate (once) .projenrc.js (in JavaScript). Set tofalsein order to disable .projenrc.js generation. Default: true - projenrcJsOptions (
ProjenrcOptions) Options for .projenrc.js. Default: default options - projenUpgradeAutoMerge (
boolean) Automatically merge projen upgrade PRs when build passes. Default: "true" if mergify auto-merge is enabled (default) - projenUpgradeSchedule (
Array) Customize the projenUpgrade schedule in cron expression. Default: [ "0 6 * * *" ] - projenUpgradeSecret (
string) Periodically submits a pull request for projen upgrades (executesyarn projen:upgrade). Default: no automatic projen upgrade pull requests - projenVersion (
string) Version of projen to install. Default: Defaults to the latest version. - pullRequestTemplate (
boolean) Include a GitHub pull request template. Default: true - pullRequestTemplateContents (
string) The contents of the pull request template. Default: default content - releaseBranches (
Array) Branches which trigger a release. Default: [ "main" ] - releaseEveryCommit (
boolean) Automatically release new versions every commit to one of branches inreleaseBranches. Default: true - releaseSchedule (
string) CRON schedule to trigger new releases. Default: no scheduled releases - releaseToNpm (
boolean) Automatically release to npm when new versions are introduced. Default: false - releaseWorkflow (
boolean) Define a GitHub workflow for releasing from "main" when new versions are bumped. Default: true if not a subproject - releaseWorkflowSetupSteps (
Array) A set of workflow steps to execute in order to setup the workflow container. Optional - workflowBootstrapSteps (
Array) Workflow steps to use in order to bootstrap this repo. Default: "yarn install --frozen-lockfile && yarn projen" - workflowContainerImage (
string) Container image to use for GitHub workflows. Default: default image - workflowNodeVersion (
string) The node version to use in GitHub workflows. Default: same asminNodeVersion - compileBeforeTest (
boolean) Compile the code before running tests. Default: iftestdiris undersrc/**, the default istrue, otherwise the default is `false. - disableTsconfig (
boolean) Do not generate atsconfig.jsonfile (used by jsii projects since tsconfig.json is generated by the jsii compiler). Default: false - docgen (
boolean) Docgen by Typedoc. Default: false - docsDirectory (
string) Docs directory. Default: "docs" - entrypointTypes (
string) The .d.ts file that includes the type declarations for this module. Default: .d.ts file derived from the project's entrypoint (usually lib/index.d.ts) - eslint (
boolean) Setup eslint. Default: true - eslintOptions (
EslintOptions) Eslint options. Default: opinionated default options - libdir (
string) Typescript artifacts output directory. Default: "lib" - package (
boolean) Defines ayarn packagecommand that will produce a tarball and place it underdist/js. Default: true - projenrcTs (
boolean) Use TypeScript for your projenrc file (.projenrc.ts). Default: false - projenrcTsOptions (
ProjenrcOptions) Options for .projenrc.ts. Optional - sampleCode (
boolean) Generate one-time sample insrc/andtest/if there are no files there. Default: true - srcdir (
string) Typescript sources directory. Default: "src" - testdir (
string) Jest tests directory. Tests files should be namedxxx.test.ts. Default: "test" - tsconfig (
TypescriptConfigOptions) Custom TSConfig. Optional - typescriptVersion (
string) TypeScript version to use. Default: "latest" - cdkVersion (
string) AWS CDK version to use. - appEntrypoint (
string) The CDK app's entrypoint (relative to the source directory, which is "src" by default). Default: "main.ts" - cdkDependencies (
Array) Which AWS CDK modules (those that start with "@aws-cdk/") this app uses. Optional - cdkVersionPinning (
boolean) Use pinned version instead of caret version for CDK. Default: false - context (
Map<string, string>) Additional context to include incdk.json. Optional - requireApproval (
CdkApprovalLevel) To protect you against unintended changes that affect your security posture, the AWS CDK Toolkit prompts you to approve security-related changes before deploying them. Default: CdkApprovalLevel.BROADENING - transformerVersion (
string) cdk-appsync-transformer version to use.
- mergify (
| Name | Type | Description |
|---|---|---|
| cdkVersion🔹 | string |
AWS CDK version to use. |
| defaultReleaseBranch🔹 | string |
The name of the main release branch. |
| name🔹 | string |
This is the name of your project. |
| transformerVersion🔹 | string |
cdk-appsync-transformer version to use. |
| allowLibraryDependencies?🔹 | boolean |
Allow the project to include peerDependencies and bundledDependencies.Default: true |
| antitamper?🔹 | boolean |
Checks that after build there are no modified files on git. Default: true |
| appEntrypoint?🔹 | string |
The CDK app's entrypoint (relative to the source directory, which is "src" by default). Default: "main.ts" |
| artifactsDirectory?🔹 | string |
A directory which will contain artifacts to be published to npm. Default: "dist" |
| authorEmail?🔹 | string |
Author's e-mail. Optional |
| authorName?🔹 | string |
Author's name. Optional |
| authorOrganization?🔹 | boolean |
Author's Organization. Optional |
| authorUrl?🔹 | string |
Author's URL / Website. Optional |
| autoDetectBin?🔹 | boolean |
Automatically add all executables under the bin directory to your package.json file under the bin section.Default: true |
| bin?🔹 | Map<string, string> |
Binary programs vended with your module. Optional |
| buildWorkflow?🔹 | boolean |
Define a GitHub workflow for building PRs. Default: true if not a subproject |
| bundledDeps?🔹 | Array |
List of dependencies to bundle into this module. Optional |
| cdkDependencies?🔹 | Array |
Which AWS CDK modules (those that start with "@aws-cdk/") this app uses. Optional |
| cdkVersionPinning?🔹 | boolean |
Use pinned version instead of caret version for CDK. Default: false |
| clobber?🔹 | boolean |
Add a clobber task which resets the repo to origin.Default: true |
| codeCov?🔹 | boolean |
Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v1 A secret is required for private repos. Configured with @codeCovTokenSecret. Default: false |
| codeCovTokenSecret?🔹 | string |
Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. Default: if this option is not specified, only public repositories are supported |
| compileBeforeTest?🔹 | boolean |
Compile the code before running tests. Default: if testdir is under src/**, the default is true, otherwise the default is `false. |
| context?🔹 | Map<string, string> |
Additional context to include in cdk.json.Optional |
| copyrightOwner?🔹 | string |
License copyright owner. Default: defaults to the value of authorName or "" if authorName is undefined. |
| copyrightPeriod?🔹 | string |
The copyright years to put in the LICENSE file. Default: current year |
| dependabot?🔹 | boolean |
Include dependabot configuration. Default: true |
| dependabotOptions?🔹 | DependabotOptions |
Options for dependabot. Default: default options |
| deps?🔹 | Array |
Runtime dependencies of this module. Default: [] |
| description?🔹 | string |
The description is just a string that helps people understand the purpose of the package. Optional |
| devContainer?🔹 | boolean |
Add a VSCode development environment (used for GitHub Codespaces). Default: false |
| devDeps?🔹 | Array |
Build dependencies for this module. Default: [] |
| disableTsconfig?🔹 | boolean |
Do not generate a tsconfig.json file (used by jsii projects since tsconfig.json is generated by the jsii compiler).Default: false |
| docgen?🔹 | boolean |
Docgen by Typedoc. Default: false |
| docsDirectory?🔹 | string |
Docs directory. Default: "docs" |
| entrypoint?🔹 | string |
Module entrypoint (main in package.json).Default: "lib/index.js" |
| entrypointTypes?🔹 | string |
The .d.ts file that includes the type declarations for this module. Default: .d.ts file derived from the project's entrypoint (usually lib/index.d.ts) |
| eslint?🔹 | boolean |
Setup eslint. Default: true |
| eslintOptions?🔹 | EslintOptions |
Eslint options. Default: opinionated default options |
| gitignore?🔹 | Array |
Additional entries to .gitignore. Optional |
| gitpod?🔹 | boolean |
Add a Gitpod development environment. Default: false |
| homepage?🔹 | string |
Package's Homepage / Website. Optional |
| jest?🔹 | boolean |
Setup jest unit tests. Default: true |
| jestOptions?🔹 | JestOptions |
Jest options. Default: default options |
| jsiiReleaseVersion?🔹 | string |
Version requirement of jsii-release which is used to publish modules to npm.Default: "latest" |
| keywords?🔹 | Array |
Keywords to include in package.json.Optional |
| libdir?🔹 | string |
Typescript artifacts output directory. Default: "lib" |
| license?🔹 | string |
License's SPDX identifier. Default: "Apache-2.0" |
| licensed?🔹 | boolean |
Indicates if a license should be added. Default: true |
| logging?🔹 | LoggerOptions |
Configure logging options such as verbosity. Default: {} |
| maxNodeVersion?🔹 | string |
Minimum node.js version to require via engines (inclusive).Default: no max |
| mergify?🔹 | boolean |
Whether mergify should be enabled on this repository or not. Default: true |
| mergifyAutoMergeLabel?🔹 | string |
Automatically merge PRs that build successfully and have this label. Default: "auto-merge" |
| mergifyOptions?🔹 | MergifyOptions |
Options for mergify. Default: default options |
| minNodeVersion?🔹 | string |
Minimum Node.js version to require via package.json engines (inclusive).Default: no "engines" specified |
| mutableBuild?🔹 | boolean |
Automatically update files modified during builds to pull-request branches. Default: true |
| npmAccess?🔹 | NpmAccess |
Access level of the npm package. Default: for scoped packages (e.g. foo@bar), the default is NpmAccess.RESTRICTED, for non-scoped packages, the default is NpmAccess.PUBLIC. |
| npmDistTag?🔹 | string |
Tags can be used to provide an alias instead of version numbers. Default: "latest" |
| npmRegistry? |
string |
The host name of the npm registry to publish to. Optional |
| npmRegistryUrl?🔹 | string |
The base URL of the npm package registry. Default: "https://registry.npmjs.org" |
| npmTaskExecution?🔹 | NpmTaskExecution |
Determines how tasks are executed when invoked as npm scripts (yarn/npm run xyz). Default: NpmTaskExecution.PROJEN |
| npmTokenSecret?🔹 | string |
GitHub secret which contains the NPM token to use when publishing packages. Default: "NPM_TOKEN" |
| npmignore?🔹 | Array |
Additional entries to .npmignore. Optional |
| npmignoreEnabled?🔹 | boolean |
Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. Default: true |
| outdir?🔹 | string |
The root directory of the project. Default: "." |
| package?🔹 | boolean |
Defines a yarn package command that will produce a tarball and place it under dist/js.Default: true |
| packageManager?🔹 | NodePackageManager |
The Node Package Manager used to execute scripts. Default: NodePackageManager.YARN |
| packageName?🔹 | string |
The "name" in package.json. Default: defaults to project name |
| parent?🔹 | Project |
The parent project, if this project is part of a bigger project. Optional |
| peerDependencyOptions?🔹 | PeerDependencyOptions |
Options for peerDeps.Optional |
| peerDeps?🔹 | Array |
Peer dependencies for this module. Default: [] |
| projectType?🔹 | ProjectType |
Which type of project this is (library/app). Default: ProjectType.UNKNOWN |
| projenCommand?🔹 | string |
The shell command to use in order to run the projen CLI. Default: "npx projen" |
| projenDevDependency?🔹 | boolean |
Indicates of "projen" should be installed as a devDependency. Default: true |
| projenDuringBuild?🔹 | boolean |
Execute projen as the first step of the build task to synthesize project files.Default: true |
| projenUpgradeAutoMerge?🔹 | boolean |
Automatically merge projen upgrade PRs when build passes. Default: "true" if mergify auto-merge is enabled (default) |
| projenUpgradeSchedule?🔹 | Array |
Customize the projenUpgrade schedule in cron expression. Default: [ "0 6 * * *" ] |
| projenUpgradeSecret?🔹 | string |
Periodically submits a pull request for projen upgrades (executes yarn projen:upgrade).Default: no automatic projen upgrade pull requests |
| projenVersion?🔹 | string |
Version of projen to install. Default: Defaults to the latest version. |
| projenrcJs?🔹 | boolean |
Generate (once) .projenrc.js (in JavaScript). Set to false in order to disable .projenrc.js generation.Default: true |
| projenrcJsOptions?🔹 | ProjenrcOptions |
Options for .projenrc.js. Default: default options |
| projenrcTs?🔹 | boolean |
Use TypeScript for your projenrc file (.projenrc.ts).Default: false |
| projenrcTsOptions?🔹 | ProjenrcOptions |
Options for .projenrc.ts. Optional |
| pullRequestTemplate?🔹 | boolean |
Include a GitHub pull request template. Default: true |
| pullRequestTemplateContents?🔹 | string |
The contents of the pull request template. Default: default content |
| readme?🔹 | SampleReadmeProps |
The README setup. Default: { filename: 'README.md', contents: '# replace this' } |
| releaseBranches?🔹 | Array |
Branches which trigger a release. Default: [ "main" ] |
| releaseEveryCommit?🔹 | boolean |
Automatically release new versions every commit to one of branches in releaseBranches.Default: true |
| releaseSchedule?🔹 | string |
CRON schedule to trigger new releases. Default: no scheduled releases |
| releaseToNpm?🔹 | boolean |
Automatically release to npm when new versions are introduced. Default: false |
| releaseWorkflow?🔹 | boolean |
Define a GitHub workflow for releasing from "main" when new versions are bumped. Default: true if not a subproject |
| releaseWorkflowSetupSteps?🔹 | Array |
A set of workflow steps to execute in order to setup the workflow container. Optional |
| repository?🔹 | string |
The repository is the location where the actual code for your package lives. Optional |
| repositoryDirectory?🔹 | string |
If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives. Optional |
| requireApproval?🔹 | CdkApprovalLevel |
To protect you against unintended changes that affect your security posture, the AWS CDK Toolkit prompts you to approve security-related changes before deploying them. Default: CdkApprovalLevel.BROADENING |
| sampleCode?🔹 | boolean |
Generate one-time sample in src/ and test/ if there are no files there.Default: true |
| scripts?🔹 | Map<string, string> |
npm scripts to include. Default: {} |
| srcdir?🔹 | string |
Typescript sources directory. Default: "src" |
| stability?🔹 | string |
Package's Stability. Optional |
| testdir?🔹 | string |
Jest tests directory. Tests files should be named xxx.test.ts.Default: "test" |
| tsconfig?🔹 | TypescriptConfigOptions |
Custom TSConfig. Optional |
| typescriptVersion?🔹 | string |
TypeScript version to use. Default: "latest" |
| workflowBootstrapSteps?🔹 | Array |
Workflow steps to use in order to bootstrap this repo. Default: "yarn install --frozen-lockfile && yarn projen" |
| workflowContainerImage?🔹 | string |
Container image to use for GitHub workflows. Default: default image |
| workflowNodeVersion?🔹 | string |
The node version to use in GitHub workflows. Default: same as minNodeVersion |