Package software.aws.awsprototypingsdk.openapigateway

Class SmithyApiGatewayTsProject

  • All Implemented Interfaces:
    software.amazon.jsii.JsiiSerializable
    @Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-01T04:12:25.198Z")
@Stability(Experimental)
public class SmithyApiGatewayTsProject
extends OpenApiGatewayTsProject
    (experimental) Synthesizes a Typescript Project with a Smithy model, generated clients, a CDK construct for deploying the API with API Gateway, and generated lambda handler wrappers for type-safe handling of requests.

    • Nested Class Summary

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

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

        software.amazon.jsii.JsiiObject.InitializationMode

    • Field Summary

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

        DEFAULT_TASK

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      String getModelDir()
      (experimental) The directory in which the smithy model files reside.
      protected OpenApiGatewayTsProjectOptions preConstruct​(OpenApiGatewayTsProjectOptions options)
      (experimental) This method provides inheritors a chance to synthesize extra resources prior to those created by this project.

      • 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, addTestCommand, getAllowLibraryDependencies, getArtifactsDirectory, getArtifactsJavascriptDirectory, getAutoMerge, getBuildWorkflow, getBuildWorkflowJobId, getBundler, getEntrypoint, getJest, getManifest, getMaxNodeVersion, getMinNodeVersion, getNodeVersion, getNpmignore, getPackageManager, getPackageValue, getPrettier, getPublisher, getRelease, getRunScriptCommand, getUpgradeWorkflow, 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, getTasks, getTestTask, removeTask, synth, tryFindFile, tryFindJsonFile, tryFindObjectFile, tryRemoveFile

      • Methods inherited from class software.amazon.jsii.JsiiObject

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

      • Methods inherited from interface software.amazon.jsii.JsiiSerializable

        $jsii$toJson

    • Constructor Detail

      • SmithyApiGatewayTsProject

        protected SmithyApiGatewayTsProject​(software.amazon.jsii.JsiiObjectRef objRef)

      • SmithyApiGatewayTsProject

        protected SmithyApiGatewayTsProject​(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

      • SmithyApiGatewayTsProject

        @Stability(Experimental)
public SmithyApiGatewayTsProject​(@NotNull
                                 SmithyApiGatewayTsProjectOptions options)
        Parameters:
        options - This parameter is required.

    • Method Detail

      • getModelDir

        @Stability(Experimental)
@NotNull
public String getModelDir()
        (experimental) The directory in which the smithy model files reside.