Package io.github.cdklabs.projen.awscdk

Class AwsCdkConstructLibrary

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.cdk.JsiiProject

io.github.cdklabs.projen.cdk.ConstructLibrary

io.github.cdklabs.projen.awscdk.AwsCdkConstructLibrary

All Implemented Interfaces:

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

Direct Known Subclasses:

ConstructLibraryAws

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

(experimental) AWS CDK construct library project.

A multi-language (jsii) construct library which vends constructs designed to use within the AWS CDK with a friendly workflow and automatic publishing to the construct catalog.

Nested Class Summary

Nested Classes

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

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

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
	AwsCdkConstructLibrary(AwsCdkConstructLibraryOptions options)
protected	AwsCdkConstructLibrary(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	AwsCdkConstructLibrary(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	addCdkDependencies(@NotNull String... deps)	Deprecated. Not supported in v2.
void	addCdkTestDependencies(@NotNull String... deps)	Deprecated. Not supported in v2.
AwsCdkDeps	getCdkDeps()
String	getCdkVersion()	(experimental) The target CDK version for this library.
String	getVersion()	Deprecated. use cdkVersion

Methods inherited from class io.github.cdklabs.projen.cdk.JsiiProject

getEslint

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

getDocgen, getDocsDirectory, 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

AwsCdkConstructLibrary

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

AwsCdkConstructLibrary

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

AwsCdkConstructLibrary

@Stability(Experimental)
public AwsCdkConstructLibrary(@NotNull
                              AwsCdkConstructLibraryOptions options)

Parameters:

options - This parameter is required.

Method Detail

addCdkDependencies

@Stability(Deprecated)
@Deprecated
public void addCdkDependencies(@NotNull
                               @NotNull String... deps)

Deprecated.

Not supported in v2. For v1, use project.cdkDeps.addV1Dependencies()

(deprecated) Adds dependencies to AWS CDK modules.

Since this is a library project, dependencies will be added as peer dependencies.

Parameters:

deps - names of cdk modules (e.g. @aws-cdk/aws-lambda). This parameter is required.

addCdkTestDependencies

@Stability(Deprecated)
@Deprecated
public void addCdkTestDependencies(@NotNull
                                   @NotNull String... deps)

Deprecated.

Not supported in v2. For v1, use project.cdkDeps.addV1DevDependencies()

(deprecated) Adds AWS CDK modules as dev dependencies.

Parameters:

deps - names of cdk modules (e.g. @aws-cdk/aws-lambda). This parameter is required.

getCdkDeps

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

getCdkVersion

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

(experimental) The target CDK version for this library.

getVersion

@Stability(Deprecated)
@Deprecated
@NotNull
public String getVersion()

Deprecated.

use cdkVersion