io.github.cdklabs.projen.awscdk

Interface AwsCdkTypeScriptAppOptions

All Superinterfaces:

AwsCdkDepsCommonOptions, CdkConfigCommonOptions, GitHubProjectOptions, software.amazon.jsii.JsiiSerializable, NodePackageOptions, NodeProjectOptions, ProjectOptions, ReleaseProjectOptions, TypeScriptProjectOptions

All Known Implementing Classes:

AwsCdkTypeScriptAppOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-20T00:39:28.553Z")
 @Stability(value=Experimental)
public interface AwsCdkTypeScriptAppOptions
extends software.amazon.jsii.JsiiSerializable, TypeScriptProjectOptions, CdkConfigCommonOptions, AwsCdkDepsCommonOptions

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	AwsCdkTypeScriptAppOptions.Builder A builder for AwsCdkTypeScriptAppOptions
static class	AwsCdkTypeScriptAppOptions.Jsii$Proxy An implementation for AwsCdkTypeScriptAppOptions

Method Summary

Modifier and Type	Method and Description
static AwsCdkTypeScriptAppOptions.Builder	builder()
default String	getAppEntrypoint() (experimental) The CDK app's entrypoint (relative to the source directory, which is "src" by default).
default Boolean	getLambdaAutoDiscover() (experimental) Automatically adds an `awscdk.LambdaFunction` for each `.lambda.ts` handler in your source tree.
default LambdaFunctionCommonOptions	getLambdaOptions() (experimental) Common options for all AWS Lambda functions.

Methods inherited from interface io.github.cdklabs.projen.typescript.TypeScriptProjectOptions

getDisableTsconfig, getDocgen, getDocsDirectory, getEntrypointTypes, getEslint, getEslintOptions, getLibdir, getPackageValue, getProjenrcTs, getProjenrcTsOptions, getSampleCode, getSrcdir, getTestdir, getTsconfig, getTsconfigDev, getTsconfigDevFile, getTypescriptVersion

Methods inherited from interface io.github.cdklabs.projen.javascript.NodeProjectOptions

getAutoApproveProjenUpgrades, getAutoApproveUpgrades, getBuildWorkflow, getBundlerOptions, getCodeCov, getCodeCovTokenSecret, getCopyrightOwner, getCopyrightPeriod, getDefaultReleaseBranch, getDependabot, getDependabotOptions, getDepsUpgrade, getDepsUpgradeOptions, getGitignore, getJest, getJestOptions, getMutableBuild, getNpmignore, getNpmignoreEnabled, getProjenDevDependency, getProjenrcJs, getProjenrcJsOptions, getProjenUpgradeAutoMerge, getProjenUpgradeSchedule, getProjenUpgradeSecret, getProjenVersion, getPullRequestTemplate, getPullRequestTemplateContents, getRelease, getReleaseToNpm, getReleaseWorkflow, getWorkflowBootstrapSteps, getWorkflowGitIdentity, getWorkflowNodeVersion

Methods inherited from interface io.github.cdklabs.projen.github.GitHubProjectOptions

getAutoApproveOptions, getAutoMergeOptions, getClobber, getDevContainer, getGithub, getGithubOptions, getGitpod, getMergify, getMergifyOptions, getProjectType, getReadme, getStale, getStaleOptions, getVscode

Methods inherited from interface io.github.cdklabs.projen.ProjectOptions

getLogging, getName, getOutdir, getParent, getProjenCommand, getProjenrcJson, getProjenrcJsonOptions

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface io.github.cdklabs.projen.javascript.NodePackageOptions

getAllowLibraryDependencies, getAuthorEmail, getAuthorName, getAuthorOrganization, getAuthorUrl, getAutoDetectBin, getBin, getBundledDeps, getCodeArtifactOptions, getDeps, getDescription, getDevDeps, getEntrypoint, getHomepage, getKeywords, getLicense, getLicensed, getMaxNodeVersion, getMinNodeVersion, getNpmAccess, getNpmRegistry, getNpmRegistryUrl, getNpmTokenSecret, getPackageManager, getPackageName, getPeerDependencyOptions, getPeerDeps, getRepository, getRepositoryDirectory, getScripts, getStability

Methods inherited from interface io.github.cdklabs.projen.release.ReleaseProjectOptions

getAntitamper, getArtifactsDirectory, getJsiiReleaseVersion, getMajorVersion, getNpmDistTag, getPostBuildSteps, getPrerelease, getPublishTasks, getReleaseBranches, getReleaseEveryCommit, getReleaseFailureIssue, getReleaseFailureIssueLabel, getReleaseSchedule, getReleaseTagPrefix, getReleaseTrigger, getReleaseWorkflowName, getReleaseWorkflowSetupSteps, getVersionrcOptions, getWorkflowContainerImage, getWorkflowRunsOn

Methods inherited from interface io.github.cdklabs.projen.awscdk.CdkConfigCommonOptions

getBuildCommand, getCdkout, getContext, getFeatureFlags, getRequireApproval, getWatchExcludes, getWatchIncludes

Methods inherited from interface io.github.cdklabs.projen.awscdk.AwsCdkDepsCommonOptions

getCdkAssert, getCdkAssertions, getCdkDependencies, getCdkDependenciesAsDeps, getCdkTestDependencies, getCdkVersion, getCdkVersionPinning, getConstructsVersion

Method Detail

getAppEntrypoint

@Stability(value=Experimental)
 @Nullable
default String getAppEntrypoint()

(experimental) The CDK app's entrypoint (relative to the source directory, which is "src" by default).

Default: "main.ts"

getLambdaAutoDiscover

@Stability(value=Experimental)
 @Nullable
default Boolean getLambdaAutoDiscover()

(experimental) Automatically adds an `awscdk.LambdaFunction` for each `.lambda.ts` handler in your source tree. If this is disabled, you can manually add an `awscdk.AutoDiscover` component to your project.

Default: true

getLambdaOptions

@Stability(value=Experimental)
 @Nullable
default LambdaFunctionCommonOptions getLambdaOptions()

(experimental) Common options for all AWS Lambda functions.

Default: - default options

builder

@Stability(value=Experimental)
static AwsCdkTypeScriptAppOptions.Builder builder()

Specified by:

builder in interface AwsCdkDepsCommonOptions

Specified by:

builder in interface CdkConfigCommonOptions

Specified by:

builder in interface GitHubProjectOptions

Specified by:

builder in interface NodePackageOptions

Specified by:

builder in interface NodeProjectOptions

Specified by:

builder in interface ProjectOptions

Specified by:

builder in interface ReleaseProjectOptions

Specified by:

builder in interface TypeScriptProjectOptions

Returns:

a AwsCdkTypeScriptAppOptions.Builder of AwsCdkTypeScriptAppOptions