Package io.github.cdklabs.projen.cdk8s

Interface Cdk8sTypeScriptAppOptions

All Superinterfaces:

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

All Known Implementing Classes:

Cdk8sTypeScriptAppOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:43.016Z")
@Stability(Experimental)
public interface Cdk8sTypeScriptAppOptions
extends software.amazon.jsii.JsiiSerializable, TypeScriptProjectOptions, Cdk8sDepsCommonOptions

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static Cdk8sTypeScriptAppOptions.Builder	builder()
default String	getAppEntrypoint()	(experimental) The CDK8s app's entrypoint (relative to the source directory, which is "src" by default).
default List<String>	getCdk8sImports()	(experimental) Import additional specs.
default Boolean	getIntegrationTestAutoDiscover()	(experimental) Automatically adds an cdk8s.IntegrationTest for each .integ.ts app in your test directory.
default String	getK8sSpecVersion()	(experimental) Import a specific Kubernetes spec version.

Methods inherited from interface io.github.cdklabs.projen.cdk8s.Cdk8sDepsCommonOptions

getCdk8sCliVersion, getCdk8sCliVersionPinning, getCdk8sPlus, getCdk8sPlusVersion, getCdk8sPlusVersionPinning, getCdk8sVersion, getCdk8sVersionPinning, getConstructsVersion, getConstructsVersionPinning, getK8sMinorVersion

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

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

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, getBugsEmail, getBugsUrl, getBundledDeps, getCodeArtifactOptions, getDeps, getDescription, getDevDeps, getEntrypoint, getHomepage, getKeywords, getLicense, getLicensed, getMaxNodeVersion, getMinNodeVersion, getNpmAccess, getNpmProvenance, getNpmRegistry, getNpmRegistryUrl, getNpmTokenSecret, getPackageManager, getPackageName, getPeerDependencyOptions, getPeerDeps, getPnpmVersion, getRepository, getRepositoryDirectory, getScopedPackagesOptions, getScripts, getStability, getYarnBerryOptions

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

getArtifactsDirectory, getAutoApproveUpgrades, getBuildWorkflow, getBuildWorkflowTriggers, getBundlerOptions, getCheckLicenses, getCodeCov, getCodeCovTokenSecret, getCopyrightOwner, getCopyrightPeriod, getDefaultReleaseBranch, getDependabot, getDependabotOptions, getDepsUpgrade, getDepsUpgradeOptions, getGitignore, getJest, getJestOptions, getMutableBuild, getNpmignore, getNpmignoreEnabled, getNpmIgnoreOptions, getPackageValue, getPrettier, getPrettierOptions, getProjenDevDependency, getProjenrcJs, getProjenrcJsOptions, getProjenVersion, getPullRequestTemplate, getPullRequestTemplateContents, getRelease, getReleaseToNpm, getReleaseWorkflow, getWorkflowBootstrapSteps, getWorkflowGitIdentity, getWorkflowNodeVersion, getWorkflowPackageCache

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

getCommitGenerated, getGitIgnoreOptions, getGitOptions, getLogging, getName, getOutdir, getParent, getProjenCommand, getProjenrcJson, getProjenrcJsonOptions, getRenovatebot, getRenovatebotOptions

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

getJsiiReleaseVersion, getMajorVersion, getMinMajorVersion, getNpmDistTag, getPostBuildSteps, getPrerelease, getPublishDryRun, getPublishTasks, getReleasableCommits, getReleaseBranches, getReleaseEveryCommit, getReleaseFailureIssue, getReleaseFailureIssueLabel, getReleaseSchedule, getReleaseTagPrefix, getReleaseTrigger, getReleaseWorkflowName, getReleaseWorkflowSetupSteps, getVersionrcOptions, getWorkflowContainerImage, getWorkflowRunsOn, getWorkflowRunsOnGroup

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

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

Method Detail

getAppEntrypoint

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

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

Default: "main.ts"

getCdk8sImports

@Stability(Experimental)
@Nullable
default List<String> getCdk8sImports()

(experimental) Import additional specs.

Default: - no additional specs imported

getIntegrationTestAutoDiscover

@Stability(Experimental)
@Nullable
default Boolean getIntegrationTestAutoDiscover()

(experimental) Automatically adds an cdk8s.IntegrationTest for each .integ.ts app in your test directory. If this is disabled, you can manually add an cdk8s.AutoDiscover component to your project.

Default: true

getK8sSpecVersion

@Stability(Experimental)
@Nullable
default String getK8sSpecVersion()

(experimental) Import a specific Kubernetes spec version.

Default: - Use the cdk8s default

builder

@Stability(Experimental)
static Cdk8sTypeScriptAppOptions.Builder builder()

Returns:

a Cdk8sTypeScriptAppOptions.Builder of Cdk8sTypeScriptAppOptions