Package io.github.cdklabs.projen.awscdk

Class AwsCdkTypeScriptApp

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

io.github.cdklabs.projen.Project

io.github.cdklabs.projen.github.GitHubProject

io.github.cdklabs.projen.javascript.NodeProject

io.github.cdklabs.projen.typescript.TypeScriptProject

io.github.cdklabs.projen.typescript.TypeScriptAppProject

io.github.cdklabs.projen.awscdk.AwsCdkTypeScriptApp

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:42.892Z")
@Stability(Experimental)
public class AwsCdkTypeScriptApp
extends TypeScriptAppProject

(experimental) AWS CDK app in TypeScript.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AwsCdkTypeScriptApp.Builder	(experimental) A fluent builder for AwsCdkTypeScriptApp.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

Field Summary

Fields inherited from class io.github.cdklabs.projen.typescript.TypeScriptProject

DEFAULT_TS_JEST_TRANFORM_PATTERN

Fields inherited from class io.github.cdklabs.projen.Project

DEFAULT_TASK

Constructor Summary

Constructors

Modifier	Constructor	Description
	AwsCdkTypeScriptApp(AwsCdkTypeScriptAppOptions options)
protected	AwsCdkTypeScriptApp(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	AwsCdkTypeScriptApp(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	addCdkDependency(@NotNull String... modules)	(experimental) Adds an AWS CDK module dependencies.
String	getAppEntrypoint()	(experimental) The CDK app entrypoint.
CdkConfig	getCdkConfig()	(experimental) cdk.json configuration.
AwsCdkDeps	getCdkDeps()
CdkTasks	getCdkTasks()	(experimental) Common CDK tasks.
String	getCdkVersion()	(experimental) The CDK version this app is using.

Methods inherited from class io.github.cdklabs.projen.typescript.TypeScriptProject

getDocgen, getDocsDirectory, getEslint, getLibdir, getSrcdir, getTestdir, getTsconfig, getTsconfigDev, getTsconfigEslint, getWatchTask

Methods inherited from class io.github.cdklabs.projen.javascript.NodeProject

addBins, addBundledDeps, addCompileCommand, addDeps, addDevDeps, addFields, addKeywords, addPackageIgnore, addPeerDeps, addScripts, addTestCommand, getAllowLibraryDependencies, getArtifactsDirectory, getArtifactsJavascriptDirectory, getAutoMerge, getBuildWorkflow, getBuildWorkflowJobId, getBundler, getEntrypoint, getJest, getManifest, getMaxNodeVersion, getMinNodeVersion, getNodeVersion, getNpmignore, getNpmrc, getPackageManager, getPackageValue, getPrettier, getPublisher, getRelease, getRunScriptCommand, getUpgradeWorkflow, getWorkflowBootstrapSteps, getWorkflowPackageCache, hasScript, removeScript, renderWorkflowSetup, renderWorkflowSetup, runTaskCommand, setScript

Methods inherited from class io.github.cdklabs.projen.github.GitHubProject

annotateGenerated, getAutoApprove, getDevContainer, getGithub, getGitpod, getProjectType, getVscode

Methods inherited from class io.github.cdklabs.projen.Project

addExcludeFromCleanup, addGitIgnore, addTask, addTask, addTip, getBuildTask, getCommitGenerated, getCompileTask, getComponents, getDefaultTask, getDeps, getEjected, getFiles, getGitattributes, getGitignore, getInitProject, getLogger, getName, getOutdir, getPackageTask, getParent, getPostCompileTask, getPreCompileTask, getProjectBuild, getProjenCommand, getRoot, getSubprojects, getTasks, getTestTask, isProject, of, postSynthesize, preSynthesize, removeTask, synth, tryFindFile, tryFindJsonFile, tryFindObjectFile, tryRemoveFile

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

AwsCdkTypeScriptApp

protected AwsCdkTypeScriptApp(software.amazon.jsii.JsiiObjectRef objRef)

AwsCdkTypeScriptApp

protected AwsCdkTypeScriptApp(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

AwsCdkTypeScriptApp

@Stability(Experimental)
public AwsCdkTypeScriptApp(@NotNull
                           AwsCdkTypeScriptAppOptions options)

Parameters:

options - This parameter is required.

Method Detail

addCdkDependency

@Stability(Experimental)
public void addCdkDependency(@NotNull
                             @NotNull String... modules)

(experimental) Adds an AWS CDK module dependencies.

Parameters:

modules - The list of modules to depend on. This parameter is required.

getAppEntrypoint

@Stability(Experimental)
@NotNull
public String getAppEntrypoint()

(experimental) The CDK app entrypoint.

getCdkConfig

@Stability(Experimental)
@NotNull
public CdkConfig getCdkConfig()

(experimental) cdk.json configuration.

getCdkDeps

@Stability(Experimental)
@NotNull
public AwsCdkDeps getCdkDeps()

getCdkTasks

@Stability(Experimental)
@NotNull
public CdkTasks getCdkTasks()

(experimental) Common CDK tasks.

getCdkVersion

@Stability(Experimental)
@NotNull
public String getCdkVersion()

(experimental) The CDK version this app is using.