Class SmithyApiGatewayTsProjectOptions.Jsii$Proxy
- java.lang.Object
-
- software.amazon.jsii.JsiiObject
-
- software.aws.awsprototypingsdk.openapigateway.SmithyApiGatewayTsProjectOptions.Jsii$Proxy
-
- All Implemented Interfaces:
io.github.cdklabs.projen.github.GitHubProjectOptions,io.github.cdklabs.projen.javascript.NodePackageOptions,io.github.cdklabs.projen.javascript.NodeProjectOptions,io.github.cdklabs.projen.ProjectOptions,io.github.cdklabs.projen.release.ReleaseProjectOptions,io.github.cdklabs.projen.typescript.TypeScriptProjectOptions,software.amazon.jsii.JsiiSerializable,CommonApiProjectOptions,SmithyApiGatewayProjectOptions,SmithyApiGatewayTsProjectOptions
- Enclosing interface:
- SmithyApiGatewayTsProjectOptions
@Stability(Experimental) @Internal public static final class SmithyApiGatewayTsProjectOptions.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements SmithyApiGatewayTsProjectOptions
An implementation forSmithyApiGatewayTsProjectOptions
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
-
Nested classes/interfaces inherited from interface software.aws.awsprototypingsdk.openapigateway.SmithyApiGatewayTsProjectOptions
SmithyApiGatewayTsProjectOptions.Builder, SmithyApiGatewayTsProjectOptions.Jsii$Proxy
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedJsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)Constructor that initializes the object based on values retrieved from the JsiiObject.protectedJsii$Proxy(SmithyApiGatewayTsProjectOptions.Builder builder)Constructor that initializes the object based on literal property values passed by theSmithyApiGatewayTsProjectOptions.Builder.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description com.fasterxml.jackson.databind.JsonNode$jsii$toJson()booleanequals(Object o)BooleangetAllowLibraryDependencies()StringgetApiSrcDir()(experimental) The directory in which the api generated code will reside, relative to the project srcdir.StringgetArtifactsDirectory()StringgetAuthorEmail()StringgetAuthorName()BooleangetAuthorOrganization()StringgetAuthorUrl()io.github.cdklabs.projen.github.AutoApproveOptionsgetAutoApproveOptions()BooleangetAutoApproveUpgrades()BooleangetAutoDetectBin()BooleangetAutoMerge()io.github.cdklabs.projen.github.AutoMergeOptionsgetAutoMergeOptions()Map<String,String>getBin()StringgetBugsEmail()StringgetBugsUrl()BooleangetBuildWorkflow()io.github.cdklabs.projen.github.workflows.TriggersgetBuildWorkflowTriggers()List<String>getBundledDeps()io.github.cdklabs.projen.javascript.BundlerOptionsgetBundlerOptions()List<ClientLanguage>getClientLanguages()(experimental) The list of languages for which clients will be generated.BooleangetClobber()io.github.cdklabs.projen.javascript.CodeArtifactOptionsgetCodeArtifactOptions()BooleangetCodeCov()StringgetCodeCovTokenSecret()BooleangetCommitGenerated()StringgetCopyrightOwner()StringgetCopyrightPeriod()StringgetDefaultReleaseBranch()BooleangetDependabot()io.github.cdklabs.projen.github.DependabotOptionsgetDependabotOptions()List<String>getDeps()BooleangetDepsUpgrade()io.github.cdklabs.projen.javascript.UpgradeDependenciesOptionsgetDepsUpgradeOptions()StringgetDescription()BooleangetDevContainer()List<String>getDevDeps()BooleangetDisableTsconfig()BooleangetDocgen()StringgetDocsDirectory()List<DocumentationFormat>getDocumentationFormats()(experimental) Formats to generate documentation in.StringgetEntrypoint()StringgetEntrypointTypes()BooleangetEslint()io.github.cdklabs.projen.javascript.EslintOptionsgetEslintOptions()BooleangetForceGenerateCodeAndDocs()(experimental) Force to generate code and docs even if there were no changes in spec.StringgetGeneratedCodeDir()(experimental) The directory in which generated client code will be generated, relative to the outdir of this project.BooleangetGithub()io.github.cdklabs.projen.github.GitHubOptionsgetGithubOptions()List<String>getGitignore()BooleangetGitpod()StringgetGradleWrapperPath()(experimental) Path to a directory containing a custom gradle wrapper (gradlew) to use instead of the one provided by the PDK, relative to the project outdir.StringgetHomepage()BooleangetIgnoreSmithyBuildOutput()(experimental) Set to false if you would like to check in your smithy build output or have more fine-grained control over what is checked in, eg if you add other projections to the smithy-build.json file.io.github.cdklabs.projen.java.JavaProjectOptionsgetJavaClientOptions()(experimental) Options for the generated java client (if specified in clientLanguages).BooleangetJest()io.github.cdklabs.projen.javascript.JestOptionsgetJestOptions()StringgetJsiiReleaseVersion()List<String>getKeywords()StringgetLibdir()StringgetLicense()BooleangetLicensed()io.github.cdklabs.projen.LoggerOptionsgetLogging()NumbergetMajorVersion()StringgetMaxNodeVersion()BooleangetMergify()io.github.cdklabs.projen.github.MergifyOptionsgetMergifyOptions()NumbergetMinMajorVersion()StringgetMinNodeVersion()StringgetModelDir()(experimental) The path to the Smithy model directory, relative to the project source directory (srcdir).BooleangetMutableBuild()StringgetName()io.github.cdklabs.projen.javascript.NpmAccessgetNpmAccess()StringgetNpmDistTag()List<String>getNpmignore()BooleangetNpmignoreEnabled()StringgetNpmRegistry()StringgetNpmRegistryUrl()StringgetNpmTokenSecret()StringgetOutdir()io.github.cdklabs.projen.javascript.NodePackageManagergetPackageManager()StringgetPackageName()BooleangetPackageValue()io.github.cdklabs.projen.ProjectgetParent()StringgetParsedSpecFileName()(experimental) The name of the output parsed OpenAPI specification file.io.github.cdklabs.projen.javascript.PeerDependencyOptionsgetPeerDependencyOptions()List<String>getPeerDeps()List<io.github.cdklabs.projen.github.workflows.JobStep>getPostBuildSteps()StringgetPrerelease()BooleangetPrettier()io.github.cdklabs.projen.javascript.PrettierOptionsgetPrettierOptions()io.github.cdklabs.projen.ProjectTypegetProjectType()StringgetProjenCommand()io.github.cdklabs.projen.github.GithubCredentialsgetProjenCredentials()BooleangetProjenDevDependency()BooleangetProjenrcJs()BooleangetProjenrcJson()io.github.cdklabs.projen.ProjenrcOptionsgetProjenrcJsonOptions()io.github.cdklabs.projen.javascript.ProjenrcOptionsgetProjenrcJsOptions()BooleangetProjenrcTs()io.github.cdklabs.projen.typescript.ProjenrcOptionsgetProjenrcTsOptions()StringgetProjenTokenSecret()StringgetProjenVersion()BooleangetPublishDryRun()BooleangetPublishTasks()BooleangetPullRequestTemplate()List<String>getPullRequestTemplateContents()io.github.cdklabs.projen.python.PythonProjectOptionsgetPythonClientOptions()(experimental) Options for the generated python client (if specified in clientLanguages).io.github.cdklabs.projen.SampleReadmePropsgetReadme()BooleangetRelease()Map<String,io.github.cdklabs.projen.release.BranchOptions>getReleaseBranches()BooleangetReleaseEveryCommit()BooleangetReleaseFailureIssue()StringgetReleaseFailureIssueLabel()StringgetReleaseSchedule()StringgetReleaseTagPrefix()BooleangetReleaseToNpm()io.github.cdklabs.projen.release.ReleaseTriggergetReleaseTrigger()BooleangetReleaseWorkflow()StringgetReleaseWorkflowName()List<io.github.cdklabs.projen.github.workflows.JobStep>getReleaseWorkflowSetupSteps()BooleangetRenovatebot()io.github.cdklabs.projen.RenovatebotOptionsgetRenovatebotOptions()StringgetRepository()StringgetRepositoryDirectory()BooleangetSampleCode()List<io.github.cdklabs.projen.javascript.ScopedPackagesOptions>getScopedPackagesOptions()Map<String,String>getScripts()SmithyServiceNamegetServiceName()(experimental) The name of the Smithy service from your model which will be targeted for deployment and client generation.SmithyBuildOptionsgetSmithyBuildOptions()(experimental) Any additional properties you'd like to add your smithy-build.json.StringgetSrcdir()StringgetStability()BooleangetStale()io.github.cdklabs.projen.github.StaleOptionsgetStaleOptions()StringgetTestdir()io.github.cdklabs.projen.javascript.TypescriptConfigOptionsgetTsconfig()io.github.cdklabs.projen.javascript.TypescriptConfigOptionsgetTsconfigDev()StringgetTsconfigDevFile()io.github.cdklabs.projen.typescript.TypeScriptProjectOptionsgetTypescriptClientOptions()(experimental) Options for the generated typescript client.StringgetTypescriptVersion()Map<String,Object>getVersionrcOptions()BooleangetVscode()List<io.github.cdklabs.projen.github.workflows.JobStep>getWorkflowBootstrapSteps()StringgetWorkflowContainerImage()io.github.cdklabs.projen.github.GitIdentitygetWorkflowGitIdentity()StringgetWorkflowNodeVersion()List<String>getWorkflowRunsOn()inthashCode()
-
-
-
Constructor Detail
-
Jsii$Proxy
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
Constructor that initializes the object based on values retrieved from the JsiiObject.- Parameters:
objRef- Reference to the JSII managed object.
-
Jsii$Proxy
protected Jsii$Proxy(SmithyApiGatewayTsProjectOptions.Builder builder)
Constructor that initializes the object based on literal property values passed by theSmithyApiGatewayTsProjectOptions.Builder.
-
-
Method Detail
-
getDisableTsconfig
public final Boolean getDisableTsconfig()
- Specified by:
getDisableTsconfigin interfaceio.github.cdklabs.projen.typescript.TypeScriptProjectOptions
-
getDocgen
public final Boolean getDocgen()
- Specified by:
getDocgenin interfaceio.github.cdklabs.projen.typescript.TypeScriptProjectOptions
-
getDocsDirectory
public final String getDocsDirectory()
- Specified by:
getDocsDirectoryin interfaceio.github.cdklabs.projen.typescript.TypeScriptProjectOptions
-
getEntrypointTypes
public final String getEntrypointTypes()
- Specified by:
getEntrypointTypesin interfaceio.github.cdklabs.projen.typescript.TypeScriptProjectOptions
-
getEslint
public final Boolean getEslint()
- Specified by:
getEslintin interfaceio.github.cdklabs.projen.typescript.TypeScriptProjectOptions
-
getEslintOptions
public final io.github.cdklabs.projen.javascript.EslintOptions getEslintOptions()
- Specified by:
getEslintOptionsin interfaceio.github.cdklabs.projen.typescript.TypeScriptProjectOptions
-
getLibdir
public final String getLibdir()
- Specified by:
getLibdirin interfaceio.github.cdklabs.projen.typescript.TypeScriptProjectOptions
-
getProjenrcTs
public final Boolean getProjenrcTs()
- Specified by:
getProjenrcTsin interfaceio.github.cdklabs.projen.typescript.TypeScriptProjectOptions
-
getProjenrcTsOptions
public final io.github.cdklabs.projen.typescript.ProjenrcOptions getProjenrcTsOptions()
- Specified by:
getProjenrcTsOptionsin interfaceio.github.cdklabs.projen.typescript.TypeScriptProjectOptions
-
getSampleCode
public final Boolean getSampleCode()
- Specified by:
getSampleCodein interfaceio.github.cdklabs.projen.typescript.TypeScriptProjectOptions
-
getSrcdir
public final String getSrcdir()
- Specified by:
getSrcdirin interfaceio.github.cdklabs.projen.typescript.TypeScriptProjectOptions
-
getTestdir
public final String getTestdir()
- Specified by:
getTestdirin interfaceio.github.cdklabs.projen.typescript.TypeScriptProjectOptions
-
getTsconfig
public final io.github.cdklabs.projen.javascript.TypescriptConfigOptions getTsconfig()
- Specified by:
getTsconfigin interfaceio.github.cdklabs.projen.typescript.TypeScriptProjectOptions
-
getTsconfigDev
public final io.github.cdklabs.projen.javascript.TypescriptConfigOptions getTsconfigDev()
- Specified by:
getTsconfigDevin interfaceio.github.cdklabs.projen.typescript.TypeScriptProjectOptions
-
getTsconfigDevFile
public final String getTsconfigDevFile()
- Specified by:
getTsconfigDevFilein interfaceio.github.cdklabs.projen.typescript.TypeScriptProjectOptions
-
getTypescriptVersion
public final String getTypescriptVersion()
- Specified by:
getTypescriptVersionin interfaceio.github.cdklabs.projen.typescript.TypeScriptProjectOptions
-
getDefaultReleaseBranch
public final String getDefaultReleaseBranch()
- Specified by:
getDefaultReleaseBranchin interfaceio.github.cdklabs.projen.javascript.NodeProjectOptions
-
getArtifactsDirectory
public final String getArtifactsDirectory()
- Specified by:
getArtifactsDirectoryin interfaceio.github.cdklabs.projen.javascript.NodeProjectOptions
-
getAutoApproveUpgrades
public final Boolean getAutoApproveUpgrades()
- Specified by:
getAutoApproveUpgradesin interfaceio.github.cdklabs.projen.javascript.NodeProjectOptions
-
getBuildWorkflow
public final Boolean getBuildWorkflow()
- Specified by:
getBuildWorkflowin interfaceio.github.cdklabs.projen.javascript.NodeProjectOptions
-
getBuildWorkflowTriggers
public final io.github.cdklabs.projen.github.workflows.Triggers getBuildWorkflowTriggers()
- Specified by:
getBuildWorkflowTriggersin interfaceio.github.cdklabs.projen.javascript.NodeProjectOptions
-
getBundlerOptions
public final io.github.cdklabs.projen.javascript.BundlerOptions getBundlerOptions()
- Specified by:
getBundlerOptionsin interfaceio.github.cdklabs.projen.javascript.NodeProjectOptions
-
getCodeCov
public final Boolean getCodeCov()
- Specified by:
getCodeCovin interfaceio.github.cdklabs.projen.javascript.NodeProjectOptions
-
getCodeCovTokenSecret
public final String getCodeCovTokenSecret()
- Specified by:
getCodeCovTokenSecretin interfaceio.github.cdklabs.projen.javascript.NodeProjectOptions
-
getCopyrightOwner
public final String getCopyrightOwner()
- Specified by:
getCopyrightOwnerin interfaceio.github.cdklabs.projen.javascript.NodeProjectOptions
-
getCopyrightPeriod
public final String getCopyrightPeriod()
- Specified by:
getCopyrightPeriodin interfaceio.github.cdklabs.projen.javascript.NodeProjectOptions
-
getDependabot
public final Boolean getDependabot()
- Specified by:
getDependabotin interfaceio.github.cdklabs.projen.javascript.NodeProjectOptions
-
getDependabotOptions
public final io.github.cdklabs.projen.github.DependabotOptions getDependabotOptions()
- Specified by:
getDependabotOptionsin interfaceio.github.cdklabs.projen.javascript.NodeProjectOptions
-
getDepsUpgrade
public final Boolean getDepsUpgrade()
- Specified by:
getDepsUpgradein interfaceio.github.cdklabs.projen.javascript.NodeProjectOptions
-
getDepsUpgradeOptions
public final io.github.cdklabs.projen.javascript.UpgradeDependenciesOptions getDepsUpgradeOptions()
- Specified by:
getDepsUpgradeOptionsin interfaceio.github.cdklabs.projen.javascript.NodeProjectOptions
-
getGitignore
public final List<String> getGitignore()
- Specified by:
getGitignorein interfaceio.github.cdklabs.projen.javascript.NodeProjectOptions
-
getJest
public final Boolean getJest()
- Specified by:
getJestin interfaceio.github.cdklabs.projen.javascript.NodeProjectOptions
-
getJestOptions
public final io.github.cdklabs.projen.javascript.JestOptions getJestOptions()
- Specified by:
getJestOptionsin interfaceio.github.cdklabs.projen.javascript.NodeProjectOptions
-
getMutableBuild
public final Boolean getMutableBuild()
- Specified by:
getMutableBuildin interfaceio.github.cdklabs.projen.javascript.NodeProjectOptions
-
getNpmignore
public final List<String> getNpmignore()
- Specified by:
getNpmignorein interfaceio.github.cdklabs.projen.javascript.NodeProjectOptions
-
getNpmignoreEnabled
public final Boolean getNpmignoreEnabled()
- Specified by:
getNpmignoreEnabledin interfaceio.github.cdklabs.projen.javascript.NodeProjectOptions
-
getPackageValue
public final Boolean getPackageValue()
- Specified by:
getPackageValuein interfaceio.github.cdklabs.projen.javascript.NodeProjectOptions
-
getPrettier
public final Boolean getPrettier()
- Specified by:
getPrettierin interfaceio.github.cdklabs.projen.javascript.NodeProjectOptions
-
getPrettierOptions
public final io.github.cdklabs.projen.javascript.PrettierOptions getPrettierOptions()
- Specified by:
getPrettierOptionsin interfaceio.github.cdklabs.projen.javascript.NodeProjectOptions
-
getProjenDevDependency
public final Boolean getProjenDevDependency()
- Specified by:
getProjenDevDependencyin interfaceio.github.cdklabs.projen.javascript.NodeProjectOptions
-
getProjenrcJs
public final Boolean getProjenrcJs()
- Specified by:
getProjenrcJsin interfaceio.github.cdklabs.projen.javascript.NodeProjectOptions
-
getProjenrcJsOptions
public final io.github.cdklabs.projen.javascript.ProjenrcOptions getProjenrcJsOptions()
- Specified by:
getProjenrcJsOptionsin interfaceio.github.cdklabs.projen.javascript.NodeProjectOptions
-
getProjenVersion
public final String getProjenVersion()
- Specified by:
getProjenVersionin interfaceio.github.cdklabs.projen.javascript.NodeProjectOptions
-
getPullRequestTemplate
public final Boolean getPullRequestTemplate()
- Specified by:
getPullRequestTemplatein interfaceio.github.cdklabs.projen.javascript.NodeProjectOptions
-
getPullRequestTemplateContents
public final List<String> getPullRequestTemplateContents()
- Specified by:
getPullRequestTemplateContentsin interfaceio.github.cdklabs.projen.javascript.NodeProjectOptions
-
getRelease
public final Boolean getRelease()
- Specified by:
getReleasein interfaceio.github.cdklabs.projen.javascript.NodeProjectOptions
-
getReleaseToNpm
public final Boolean getReleaseToNpm()
- Specified by:
getReleaseToNpmin interfaceio.github.cdklabs.projen.javascript.NodeProjectOptions
-
getReleaseWorkflow
public final Boolean getReleaseWorkflow()
- Specified by:
getReleaseWorkflowin interfaceio.github.cdklabs.projen.javascript.NodeProjectOptions
-
getWorkflowBootstrapSteps
public final List<io.github.cdklabs.projen.github.workflows.JobStep> getWorkflowBootstrapSteps()
- Specified by:
getWorkflowBootstrapStepsin interfaceio.github.cdklabs.projen.javascript.NodeProjectOptions
-
getWorkflowGitIdentity
public final io.github.cdklabs.projen.github.GitIdentity getWorkflowGitIdentity()
- Specified by:
getWorkflowGitIdentityin interfaceio.github.cdklabs.projen.javascript.NodeProjectOptions
-
getWorkflowNodeVersion
public final String getWorkflowNodeVersion()
- Specified by:
getWorkflowNodeVersionin interfaceio.github.cdklabs.projen.javascript.NodeProjectOptions
-
getAutoApproveOptions
public final io.github.cdklabs.projen.github.AutoApproveOptions getAutoApproveOptions()
- Specified by:
getAutoApproveOptionsin interfaceio.github.cdklabs.projen.github.GitHubProjectOptions
-
getAutoMerge
public final Boolean getAutoMerge()
- Specified by:
getAutoMergein interfaceio.github.cdklabs.projen.github.GitHubProjectOptions
-
getAutoMergeOptions
public final io.github.cdklabs.projen.github.AutoMergeOptions getAutoMergeOptions()
- Specified by:
getAutoMergeOptionsin interfaceio.github.cdklabs.projen.github.GitHubProjectOptions
-
getClobber
public final Boolean getClobber()
- Specified by:
getClobberin interfaceio.github.cdklabs.projen.github.GitHubProjectOptions
-
getDevContainer
public final Boolean getDevContainer()
- Specified by:
getDevContainerin interfaceio.github.cdklabs.projen.github.GitHubProjectOptions
-
getGithub
public final Boolean getGithub()
- Specified by:
getGithubin interfaceio.github.cdklabs.projen.github.GitHubProjectOptions
-
getGithubOptions
public final io.github.cdklabs.projen.github.GitHubOptions getGithubOptions()
- Specified by:
getGithubOptionsin interfaceio.github.cdklabs.projen.github.GitHubProjectOptions
-
getGitpod
public final Boolean getGitpod()
- Specified by:
getGitpodin interfaceio.github.cdklabs.projen.github.GitHubProjectOptions
-
getMergify
public final Boolean getMergify()
- Specified by:
getMergifyin interfaceio.github.cdklabs.projen.github.GitHubProjectOptions
-
getMergifyOptions
public final io.github.cdklabs.projen.github.MergifyOptions getMergifyOptions()
- Specified by:
getMergifyOptionsin interfaceio.github.cdklabs.projen.github.GitHubProjectOptions
-
getProjectType
public final io.github.cdklabs.projen.ProjectType getProjectType()
- Specified by:
getProjectTypein interfaceio.github.cdklabs.projen.github.GitHubProjectOptions
-
getProjenCredentials
public final io.github.cdklabs.projen.github.GithubCredentials getProjenCredentials()
- Specified by:
getProjenCredentialsin interfaceio.github.cdklabs.projen.github.GitHubProjectOptions
-
getProjenTokenSecret
public final String getProjenTokenSecret()
- Specified by:
getProjenTokenSecretin interfaceio.github.cdklabs.projen.github.GitHubProjectOptions
-
getReadme
public final io.github.cdklabs.projen.SampleReadmeProps getReadme()
- Specified by:
getReadmein interfaceio.github.cdklabs.projen.github.GitHubProjectOptions
-
getStale
public final Boolean getStale()
- Specified by:
getStalein interfaceio.github.cdklabs.projen.github.GitHubProjectOptions
-
getStaleOptions
public final io.github.cdklabs.projen.github.StaleOptions getStaleOptions()
- Specified by:
getStaleOptionsin interfaceio.github.cdklabs.projen.github.GitHubProjectOptions
-
getVscode
public final Boolean getVscode()
- Specified by:
getVscodein interfaceio.github.cdklabs.projen.github.GitHubProjectOptions
-
getName
public final String getName()
- Specified by:
getNamein interfaceio.github.cdklabs.projen.ProjectOptions
-
getCommitGenerated
public final Boolean getCommitGenerated()
- Specified by:
getCommitGeneratedin interfaceio.github.cdklabs.projen.ProjectOptions
-
getLogging
public final io.github.cdklabs.projen.LoggerOptions getLogging()
- Specified by:
getLoggingin interfaceio.github.cdklabs.projen.ProjectOptions
-
getOutdir
public final String getOutdir()
- Specified by:
getOutdirin interfaceio.github.cdklabs.projen.ProjectOptions
-
getParent
public final io.github.cdklabs.projen.Project getParent()
- Specified by:
getParentin interfaceio.github.cdklabs.projen.ProjectOptions
-
getProjenCommand
public final String getProjenCommand()
- Specified by:
getProjenCommandin interfaceio.github.cdklabs.projen.ProjectOptions
-
getProjenrcJson
public final Boolean getProjenrcJson()
- Specified by:
getProjenrcJsonin interfaceio.github.cdklabs.projen.ProjectOptions
-
getProjenrcJsonOptions
public final io.github.cdklabs.projen.ProjenrcOptions getProjenrcJsonOptions()
- Specified by:
getProjenrcJsonOptionsin interfaceio.github.cdklabs.projen.ProjectOptions
-
getRenovatebot
public final Boolean getRenovatebot()
- Specified by:
getRenovatebotin interfaceio.github.cdklabs.projen.ProjectOptions
-
getRenovatebotOptions
public final io.github.cdklabs.projen.RenovatebotOptions getRenovatebotOptions()
- Specified by:
getRenovatebotOptionsin interfaceio.github.cdklabs.projen.ProjectOptions
-
getAllowLibraryDependencies
public final Boolean getAllowLibraryDependencies()
- Specified by:
getAllowLibraryDependenciesin interfaceio.github.cdklabs.projen.javascript.NodePackageOptions
-
getAuthorEmail
public final String getAuthorEmail()
- Specified by:
getAuthorEmailin interfaceio.github.cdklabs.projen.javascript.NodePackageOptions
-
getAuthorName
public final String getAuthorName()
- Specified by:
getAuthorNamein interfaceio.github.cdklabs.projen.javascript.NodePackageOptions
-
getAuthorOrganization
public final Boolean getAuthorOrganization()
- Specified by:
getAuthorOrganizationin interfaceio.github.cdklabs.projen.javascript.NodePackageOptions
-
getAuthorUrl
public final String getAuthorUrl()
- Specified by:
getAuthorUrlin interfaceio.github.cdklabs.projen.javascript.NodePackageOptions
-
getAutoDetectBin
public final Boolean getAutoDetectBin()
- Specified by:
getAutoDetectBinin interfaceio.github.cdklabs.projen.javascript.NodePackageOptions
-
getBin
public final Map<String,String> getBin()
- Specified by:
getBinin interfaceio.github.cdklabs.projen.javascript.NodePackageOptions
-
getBugsEmail
public final String getBugsEmail()
- Specified by:
getBugsEmailin interfaceio.github.cdklabs.projen.javascript.NodePackageOptions
-
getBugsUrl
public final String getBugsUrl()
- Specified by:
getBugsUrlin interfaceio.github.cdklabs.projen.javascript.NodePackageOptions
-
getBundledDeps
public final List<String> getBundledDeps()
- Specified by:
getBundledDepsin interfaceio.github.cdklabs.projen.javascript.NodePackageOptions
-
getCodeArtifactOptions
public final io.github.cdklabs.projen.javascript.CodeArtifactOptions getCodeArtifactOptions()
- Specified by:
getCodeArtifactOptionsin interfaceio.github.cdklabs.projen.javascript.NodePackageOptions
-
getDeps
public final List<String> getDeps()
- Specified by:
getDepsin interfaceio.github.cdklabs.projen.javascript.NodePackageOptions
-
getDescription
public final String getDescription()
- Specified by:
getDescriptionin interfaceio.github.cdklabs.projen.javascript.NodePackageOptions
-
getDevDeps
public final List<String> getDevDeps()
- Specified by:
getDevDepsin interfaceio.github.cdklabs.projen.javascript.NodePackageOptions
-
getEntrypoint
public final String getEntrypoint()
- Specified by:
getEntrypointin interfaceio.github.cdklabs.projen.javascript.NodePackageOptions
-
getHomepage
public final String getHomepage()
- Specified by:
getHomepagein interfaceio.github.cdklabs.projen.javascript.NodePackageOptions
-
getKeywords
public final List<String> getKeywords()
- Specified by:
getKeywordsin interfaceio.github.cdklabs.projen.javascript.NodePackageOptions
-
getLicense
public final String getLicense()
- Specified by:
getLicensein interfaceio.github.cdklabs.projen.javascript.NodePackageOptions
-
getLicensed
public final Boolean getLicensed()
- Specified by:
getLicensedin interfaceio.github.cdklabs.projen.javascript.NodePackageOptions
-
getMaxNodeVersion
public final String getMaxNodeVersion()
- Specified by:
getMaxNodeVersionin interfaceio.github.cdklabs.projen.javascript.NodePackageOptions
-
getMinNodeVersion
public final String getMinNodeVersion()
- Specified by:
getMinNodeVersionin interfaceio.github.cdklabs.projen.javascript.NodePackageOptions
-
getNpmAccess
public final io.github.cdklabs.projen.javascript.NpmAccess getNpmAccess()
- Specified by:
getNpmAccessin interfaceio.github.cdklabs.projen.javascript.NodePackageOptions
-
getNpmRegistry
public final String getNpmRegistry()
- Specified by:
getNpmRegistryin interfaceio.github.cdklabs.projen.javascript.NodePackageOptions
-
getNpmRegistryUrl
public final String getNpmRegistryUrl()
- Specified by:
getNpmRegistryUrlin interfaceio.github.cdklabs.projen.javascript.NodePackageOptions
-
getNpmTokenSecret
public final String getNpmTokenSecret()
- Specified by:
getNpmTokenSecretin interfaceio.github.cdklabs.projen.javascript.NodePackageOptions
-
getPackageManager
public final io.github.cdklabs.projen.javascript.NodePackageManager getPackageManager()
- Specified by:
getPackageManagerin interfaceio.github.cdklabs.projen.javascript.NodePackageOptions
-
getPackageName
public final String getPackageName()
- Specified by:
getPackageNamein interfaceio.github.cdklabs.projen.javascript.NodePackageOptions
-
getPeerDependencyOptions
public final io.github.cdklabs.projen.javascript.PeerDependencyOptions getPeerDependencyOptions()
- Specified by:
getPeerDependencyOptionsin interfaceio.github.cdklabs.projen.javascript.NodePackageOptions
-
getPeerDeps
public final List<String> getPeerDeps()
- Specified by:
getPeerDepsin interfaceio.github.cdklabs.projen.javascript.NodePackageOptions
-
getRepository
public final String getRepository()
- Specified by:
getRepositoryin interfaceio.github.cdklabs.projen.javascript.NodePackageOptions
-
getRepositoryDirectory
public final String getRepositoryDirectory()
- Specified by:
getRepositoryDirectoryin interfaceio.github.cdklabs.projen.javascript.NodePackageOptions
-
getScopedPackagesOptions
public final List<io.github.cdklabs.projen.javascript.ScopedPackagesOptions> getScopedPackagesOptions()
- Specified by:
getScopedPackagesOptionsin interfaceio.github.cdklabs.projen.javascript.NodePackageOptions
-
getScripts
public final Map<String,String> getScripts()
- Specified by:
getScriptsin interfaceio.github.cdklabs.projen.javascript.NodePackageOptions
-
getStability
public final String getStability()
- Specified by:
getStabilityin interfaceio.github.cdklabs.projen.javascript.NodePackageOptions
-
getJsiiReleaseVersion
public final String getJsiiReleaseVersion()
- Specified by:
getJsiiReleaseVersionin interfaceio.github.cdklabs.projen.release.ReleaseProjectOptions
-
getMajorVersion
public final Number getMajorVersion()
- Specified by:
getMajorVersionin interfaceio.github.cdklabs.projen.release.ReleaseProjectOptions
-
getMinMajorVersion
public final Number getMinMajorVersion()
- Specified by:
getMinMajorVersionin interfaceio.github.cdklabs.projen.release.ReleaseProjectOptions
-
getNpmDistTag
public final String getNpmDistTag()
- Specified by:
getNpmDistTagin interfaceio.github.cdklabs.projen.release.ReleaseProjectOptions
-
getPostBuildSteps
public final List<io.github.cdklabs.projen.github.workflows.JobStep> getPostBuildSteps()
- Specified by:
getPostBuildStepsin interfaceio.github.cdklabs.projen.release.ReleaseProjectOptions
-
getPrerelease
public final String getPrerelease()
- Specified by:
getPrereleasein interfaceio.github.cdklabs.projen.release.ReleaseProjectOptions
-
getPublishDryRun
public final Boolean getPublishDryRun()
- Specified by:
getPublishDryRunin interfaceio.github.cdklabs.projen.release.ReleaseProjectOptions
-
getPublishTasks
public final Boolean getPublishTasks()
- Specified by:
getPublishTasksin interfaceio.github.cdklabs.projen.release.ReleaseProjectOptions
-
getReleaseBranches
public final Map<String,io.github.cdklabs.projen.release.BranchOptions> getReleaseBranches()
- Specified by:
getReleaseBranchesin interfaceio.github.cdklabs.projen.release.ReleaseProjectOptions
-
getReleaseEveryCommit
public final Boolean getReleaseEveryCommit()
- Specified by:
getReleaseEveryCommitin interfaceio.github.cdklabs.projen.release.ReleaseProjectOptions
-
getReleaseFailureIssue
public final Boolean getReleaseFailureIssue()
- Specified by:
getReleaseFailureIssuein interfaceio.github.cdklabs.projen.release.ReleaseProjectOptions
-
getReleaseFailureIssueLabel
public final String getReleaseFailureIssueLabel()
- Specified by:
getReleaseFailureIssueLabelin interfaceio.github.cdklabs.projen.release.ReleaseProjectOptions
-
getReleaseSchedule
public final String getReleaseSchedule()
- Specified by:
getReleaseSchedulein interfaceio.github.cdklabs.projen.release.ReleaseProjectOptions
-
getReleaseTagPrefix
public final String getReleaseTagPrefix()
- Specified by:
getReleaseTagPrefixin interfaceio.github.cdklabs.projen.release.ReleaseProjectOptions
-
getReleaseTrigger
public final io.github.cdklabs.projen.release.ReleaseTrigger getReleaseTrigger()
- Specified by:
getReleaseTriggerin interfaceio.github.cdklabs.projen.release.ReleaseProjectOptions
-
getReleaseWorkflowName
public final String getReleaseWorkflowName()
- Specified by:
getReleaseWorkflowNamein interfaceio.github.cdklabs.projen.release.ReleaseProjectOptions
-
getReleaseWorkflowSetupSteps
public final List<io.github.cdklabs.projen.github.workflows.JobStep> getReleaseWorkflowSetupSteps()
- Specified by:
getReleaseWorkflowSetupStepsin interfaceio.github.cdklabs.projen.release.ReleaseProjectOptions
-
getVersionrcOptions
public final Map<String,Object> getVersionrcOptions()
- Specified by:
getVersionrcOptionsin interfaceio.github.cdklabs.projen.release.ReleaseProjectOptions
-
getWorkflowContainerImage
public final String getWorkflowContainerImage()
- Specified by:
getWorkflowContainerImagein interfaceio.github.cdklabs.projen.release.ReleaseProjectOptions
-
getWorkflowRunsOn
public final List<String> getWorkflowRunsOn()
- Specified by:
getWorkflowRunsOnin interfaceio.github.cdklabs.projen.release.ReleaseProjectOptions
-
getServiceName
public final SmithyServiceName getServiceName()
Description copied from interface:SmithyApiGatewayProjectOptions(experimental) The name of the Smithy service from your model which will be targeted for deployment and client generation.On initial project synthesis this service name will be written to the sample "hello world" model. If you change this value after initial synthesis you will need to manually update your Smithy models to match, unless you delete the "model" directory. Likewise, if you change the namespace or service name in your Smithy models you will need to update this value to ensure your service can be found.
Default: "example.hello#Hello"
- Specified by:
getServiceNamein interfaceSmithyApiGatewayProjectOptions
-
getGradleWrapperPath
public final String getGradleWrapperPath()
Description copied from interface:SmithyApiGatewayProjectOptions(experimental) Path to a directory containing a custom gradle wrapper (gradlew) to use instead of the one provided by the PDK, relative to the project outdir.Use this if you would like to own and check in the gradle wrapper instead of using the provided one.
- Specified by:
getGradleWrapperPathin interfaceSmithyApiGatewayProjectOptions
-
getIgnoreSmithyBuildOutput
public final Boolean getIgnoreSmithyBuildOutput()
Description copied from interface:SmithyApiGatewayProjectOptions(experimental) Set to false if you would like to check in your smithy build output or have more fine-grained control over what is checked in, eg if you add other projections to the smithy-build.json file.Default: true
- Specified by:
getIgnoreSmithyBuildOutputin interfaceSmithyApiGatewayProjectOptions
-
getModelDir
public final String getModelDir()
Description copied from interface:SmithyApiGatewayProjectOptions(experimental) The path to the Smithy model directory, relative to the project source directory (srcdir).Default: "model"
- Specified by:
getModelDirin interfaceSmithyApiGatewayProjectOptions
-
getSmithyBuildOptions
public final SmithyBuildOptions getSmithyBuildOptions()
Description copied from interface:SmithyApiGatewayProjectOptions(experimental) Any additional properties you'd like to add your smithy-build.json. The smithy-build.json will automatically include the "openapi" plugin, but you can add extra configuration for that via this option if you like.- Specified by:
getSmithyBuildOptionsin interfaceSmithyApiGatewayProjectOptions- See Also:
- https://awslabs.github.io/smithy/2.0/guides/converting-to-openapi.html#openapi-configuration-settings
-
getClientLanguages
public final List<ClientLanguage> getClientLanguages()
Description copied from interface:CommonApiProjectOptions(experimental) The list of languages for which clients will be generated.A typescript client will always be generated.
- Specified by:
getClientLanguagesin interfaceCommonApiProjectOptions
-
getApiSrcDir
public final String getApiSrcDir()
Description copied from interface:CommonApiProjectOptions(experimental) The directory in which the api generated code will reside, relative to the project srcdir.- Specified by:
getApiSrcDirin interfaceCommonApiProjectOptions
-
getDocumentationFormats
public final List<DocumentationFormat> getDocumentationFormats()
Description copied from interface:CommonApiProjectOptions(experimental) Formats to generate documentation in.- Specified by:
getDocumentationFormatsin interfaceCommonApiProjectOptions
-
getForceGenerateCodeAndDocs
public final Boolean getForceGenerateCodeAndDocs()
Description copied from interface:CommonApiProjectOptions(experimental) Force to generate code and docs even if there were no changes in spec.Default: "false"
- Specified by:
getForceGenerateCodeAndDocsin interfaceCommonApiProjectOptions
-
getGeneratedCodeDir
public final String getGeneratedCodeDir()
Description copied from interface:CommonApiProjectOptions(experimental) The directory in which generated client code will be generated, relative to the outdir of this project.Default: "generated"
- Specified by:
getGeneratedCodeDirin interfaceCommonApiProjectOptions
-
getJavaClientOptions
public final io.github.cdklabs.projen.java.JavaProjectOptions getJavaClientOptions()
Description copied from interface:CommonApiProjectOptions(experimental) Options for the generated java client (if specified in clientLanguages).These override the default inferred options.
- Specified by:
getJavaClientOptionsin interfaceCommonApiProjectOptions
-
getParsedSpecFileName
public final String getParsedSpecFileName()
Description copied from interface:CommonApiProjectOptions(experimental) The name of the output parsed OpenAPI specification file.Must end with .json.
Default: ".parsed-spec.json"
- Specified by:
getParsedSpecFileNamein interfaceCommonApiProjectOptions
-
getPythonClientOptions
public final io.github.cdklabs.projen.python.PythonProjectOptions getPythonClientOptions()
Description copied from interface:CommonApiProjectOptions(experimental) Options for the generated python client (if specified in clientLanguages).These override the default inferred options.
- Specified by:
getPythonClientOptionsin interfaceCommonApiProjectOptions
-
getTypescriptClientOptions
public final io.github.cdklabs.projen.typescript.TypeScriptProjectOptions getTypescriptClientOptions()
Description copied from interface:CommonApiProjectOptions(experimental) Options for the generated typescript client.These override the default inferred options.
- Specified by:
getTypescriptClientOptionsin interfaceCommonApiProjectOptions
-
$jsii$toJson
@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
- Specified by:
$jsii$toJsonin interfacesoftware.amazon.jsii.JsiiSerializable
-
-