Package software.aws.awsprototypingsdk.openapigateway

Class SmithyApiGatewayPythonProject.Builder

    • Method Detail

      • name

        @Stability(Experimental)
public SmithyApiGatewayPythonProject.Builder name​(String name)
        (experimental) This is the name of your project.

        Default: $BASEDIR

        Parameters:
        name - This is the name of your project. This parameter is required.
        Returns:
        this

      • commitGenerated

        @Stability(Experimental)
public SmithyApiGatewayPythonProject.Builder commitGenerated​(Boolean commitGenerated)
        (experimental) Whether to commit the managed files by default.

        Default: true

        Parameters:
        commitGenerated - Whether to commit the managed files by default. This parameter is required.
        Returns:
        this

      • logging

        @Stability(Experimental)
public SmithyApiGatewayPythonProject.Builder logging​(io.github.cdklabs.projen.LoggerOptions logging)
        (experimental) Configure logging options such as verbosity.

        Default: {}

        Parameters:
        logging - Configure logging options such as verbosity. This parameter is required.
        Returns:
        this

      • outdir

        @Stability(Experimental)
public SmithyApiGatewayPythonProject.Builder outdir​(String outdir)
        (experimental) The root directory of the project.

        Relative to this directory, all files are synthesized.

        If this project has a parent, this directory is relative to the parent directory and it cannot be the same as the parent or any of it's other sub-projects.

        Default: "."

        Parameters:
        outdir - The root directory of the project. This parameter is required.
        Returns:
        this

      • parent

        @Stability(Experimental)
public SmithyApiGatewayPythonProject.Builder parent​(io.github.cdklabs.projen.Project parent)
        (experimental) The parent project, if this project is part of a bigger project.

        Parameters:
        parent - The parent project, if this project is part of a bigger project. This parameter is required.
        Returns:
        this

      • projenCommand

        @Stability(Experimental)
public SmithyApiGatewayPythonProject.Builder projenCommand​(String projenCommand)
        (experimental) The shell command to use in order to run the projen CLI.

        Can be used to customize in special environments.

        Default: "npx projen"

        Parameters:
        projenCommand - The shell command to use in order to run the projen CLI. This parameter is required.
        Returns:
        this

      • projenrcJson

        @Stability(Experimental)
public SmithyApiGatewayPythonProject.Builder projenrcJson​(Boolean projenrcJson)
        (experimental) Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.

        Default: false

        Parameters:
        projenrcJson - Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. This parameter is required.
        Returns:
        this

      • projenrcJsonOptions

        @Stability(Experimental)
public SmithyApiGatewayPythonProject.Builder projenrcJsonOptions​(io.github.cdklabs.projen.ProjenrcOptions projenrcJsonOptions)
        (experimental) Options for .projenrc.json.

        Default: - default options

        Parameters:
        projenrcJsonOptions - Options for .projenrc.json. This parameter is required.
        Returns:
        this

      • renovatebot

        @Stability(Experimental)
public SmithyApiGatewayPythonProject.Builder renovatebot​(Boolean renovatebot)
        (experimental) Use renovatebot to handle dependency upgrades.

        Default: false

        Parameters:
        renovatebot - Use renovatebot to handle dependency upgrades. This parameter is required.
        Returns:
        this

      • renovatebotOptions

        @Stability(Experimental)
public SmithyApiGatewayPythonProject.Builder renovatebotOptions​(io.github.cdklabs.projen.RenovatebotOptions renovatebotOptions)
        (experimental) Options for renovatebot.

        Default: - default options

        Parameters:
        renovatebotOptions - Options for renovatebot. This parameter is required.
        Returns:
        this

      • autoApproveOptions

        @Stability(Experimental)
public SmithyApiGatewayPythonProject.Builder autoApproveOptions​(io.github.cdklabs.projen.github.AutoApproveOptions autoApproveOptions)
        (experimental) Enable and configure the 'auto approve' workflow.

        Default: - auto approve is disabled

        Parameters:
        autoApproveOptions - Enable and configure the 'auto approve' workflow. This parameter is required.
        Returns:
        this

      • autoMerge

        @Stability(Experimental)
public SmithyApiGatewayPythonProject.Builder autoMerge​(Boolean autoMerge)
        (experimental) Enable automatic merging on GitHub.

        Has no effect if github.mergify is set to false.

        Default: true

        Parameters:
        autoMerge - Enable automatic merging on GitHub. This parameter is required.
        Returns:
        this

      • autoMergeOptions

        @Stability(Experimental)
public SmithyApiGatewayPythonProject.Builder autoMergeOptions​(io.github.cdklabs.projen.github.AutoMergeOptions autoMergeOptions)
        (experimental) Configure options for automatic merging on GitHub.

        Has no effect if github.mergify or autoMerge is set to false.

        Default: - see defaults in `AutoMergeOptions`

        Parameters:
        autoMergeOptions - Configure options for automatic merging on GitHub. This parameter is required.
        Returns:
        this

      • clobber

        @Stability(Experimental)
public SmithyApiGatewayPythonProject.Builder clobber​(Boolean clobber)
        (experimental) Add a `clobber` task which resets the repo to origin.

        Default: true

        Parameters:
        clobber - Add a `clobber` task which resets the repo to origin. This parameter is required.
        Returns:
        this

      • devContainer

        @Stability(Experimental)
public SmithyApiGatewayPythonProject.Builder devContainer​(Boolean devContainer)
        (experimental) Add a VSCode development environment (used for GitHub Codespaces).

        Default: false

        Parameters:
        devContainer - Add a VSCode development environment (used for GitHub Codespaces). This parameter is required.
        Returns:
        this

      • github

        @Stability(Experimental)
public SmithyApiGatewayPythonProject.Builder github​(Boolean github)
        (experimental) Enable GitHub integration.

        Enabled by default for root projects. Disabled for non-root projects.

        Default: true

        Parameters:
        github - Enable GitHub integration. This parameter is required.
        Returns:
        this

      • githubOptions

        @Stability(Experimental)
public SmithyApiGatewayPythonProject.Builder githubOptions​(io.github.cdklabs.projen.github.GitHubOptions githubOptions)
        (experimental) Options for GitHub integration.

        Default: - see GitHubOptions

        Parameters:
        githubOptions - Options for GitHub integration. This parameter is required.
        Returns:
        this

      • gitpod

        @Stability(Experimental)
public SmithyApiGatewayPythonProject.Builder gitpod​(Boolean gitpod)
        (experimental) Add a Gitpod development environment.

        Default: false

        Parameters:
        gitpod - Add a Gitpod development environment. This parameter is required.
        Returns:
        this

      • mergify

        @Stability(Deprecated)
@Deprecated
public SmithyApiGatewayPythonProject.Builder mergify​(Boolean mergify)
        Deprecated.
        use `githubOptions.mergify` instead
        (deprecated) Whether mergify should be enabled on this repository or not.

        Default: true

        Parameters:
        mergify - Whether mergify should be enabled on this repository or not. This parameter is required.
        Returns:
        this

      • mergifyOptions

        @Stability(Deprecated)
@Deprecated
public SmithyApiGatewayPythonProject.Builder mergifyOptions​(io.github.cdklabs.projen.github.MergifyOptions mergifyOptions)
        Deprecated.
        use `githubOptions.mergifyOptions` instead
        (deprecated) Options for mergify.

        Default: - default options

        Parameters:
        mergifyOptions - Options for mergify. This parameter is required.
        Returns:
        this

      • projectType

        @Stability(Deprecated)
@Deprecated
public SmithyApiGatewayPythonProject.Builder projectType​(io.github.cdklabs.projen.ProjectType projectType)
        Deprecated.
        no longer supported at the base project level
        (deprecated) Which type of project this is (library/app).

        Default: ProjectType.UNKNOWN

        Parameters:
        projectType - Which type of project this is (library/app). This parameter is required.
        Returns:
        this

      • projenCredentials

        @Stability(Experimental)
public SmithyApiGatewayPythonProject.Builder projenCredentials​(io.github.cdklabs.projen.github.GithubCredentials projenCredentials)
        (experimental) Choose a method of providing GitHub API access for projen workflows.

        Default: - use a personal access token named PROJEN_GITHUB_TOKEN

        Parameters:
        projenCredentials - Choose a method of providing GitHub API access for projen workflows. This parameter is required.
        Returns:
        this

      • projenTokenSecret

        @Stability(Deprecated)
@Deprecated
public SmithyApiGatewayPythonProject.Builder projenTokenSecret​(String projenTokenSecret)
        Deprecated.
        use `projenCredentials`
        (deprecated) The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.

        This token needs to have the repo, workflows and packages scope.

        Default: "PROJEN_GITHUB_TOKEN"

        Parameters:
        projenTokenSecret - The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. This parameter is required.
        Returns:
        this

      • readme

        @Stability(Experimental)
public SmithyApiGatewayPythonProject.Builder readme​(io.github.cdklabs.projen.SampleReadmeProps readme)
        (experimental) The README setup.

        Default: - { filename: 'README.md', contents: '# replace this' }

        Example: 

         "{ filename: 'readme.md', contents: '# title' }"

        Parameters:
        readme - The README setup. This parameter is required.
        Returns:
        this

      • stale

        @Stability(Experimental)
public SmithyApiGatewayPythonProject.Builder stale​(Boolean stale)
        (experimental) Auto-close of stale issues and pull request.

        See staleOptions for options.

        Default: false

        Parameters:
        stale - Auto-close of stale issues and pull request. This parameter is required.
        Returns:
        this

      • staleOptions

        @Stability(Experimental)
public SmithyApiGatewayPythonProject.Builder staleOptions​(io.github.cdklabs.projen.github.StaleOptions staleOptions)
        (experimental) Auto-close stale issues and pull requests.

        To disable set stale to false.

        Default: - see defaults in `StaleOptions`

        Parameters:
        staleOptions - Auto-close stale issues and pull requests. This parameter is required.
        Returns:
        this

      • vscode

        @Stability(Experimental)
public SmithyApiGatewayPythonProject.Builder vscode​(Boolean vscode)
        (experimental) Enable VSCode integration.

        Enabled by default for root projects. Disabled for non-root projects.

        Default: true

        Parameters:
        vscode - Enable VSCode integration. This parameter is required.
        Returns:
        this

      • authorEmail

        @Stability(Experimental)
public SmithyApiGatewayPythonProject.Builder authorEmail​(String authorEmail)
        (experimental) Author's e-mail.

        Default: $GIT_USER_EMAIL

        Parameters:
        authorEmail - Author's e-mail. This parameter is required.
        Returns:
        this

      • authorName

        @Stability(Experimental)
public SmithyApiGatewayPythonProject.Builder authorName​(String authorName)
        (experimental) Author's name.

        Default: $GIT_USER_NAME

        Parameters:
        authorName - Author's name. This parameter is required.
        Returns:
        this

      • version

        @Stability(Experimental)
public SmithyApiGatewayPythonProject.Builder version​(String version)
        (experimental) Version of the package.

        Default: "0.1.0"

        Parameters:
        version - Version of the package. This parameter is required.
        Returns:
        this

      • description

        @Stability(Experimental)
public SmithyApiGatewayPythonProject.Builder description​(String description)
        (experimental) A short description of the package.

        Parameters:
        description - A short description of the package. This parameter is required.
        Returns:
        this

      • homepage

        @Stability(Experimental)
public SmithyApiGatewayPythonProject.Builder homepage​(String homepage)
        (experimental) A URL to the website of the project.

        Parameters:
        homepage - A URL to the website of the project. This parameter is required.
        Returns:
        this

      • license

        @Stability(Experimental)
public SmithyApiGatewayPythonProject.Builder license​(String license)
        (experimental) License of this package as an SPDX identifier.

        Parameters:
        license - License of this package as an SPDX identifier. This parameter is required.
        Returns:
        this

      • packageName

        @Stability(Experimental)
public SmithyApiGatewayPythonProject.Builder packageName​(String packageName)
        (experimental) Package name.

        Parameters:
        packageName - Package name. This parameter is required.
        Returns:
        this

      • poetryOptions

        @Stability(Experimental)
public SmithyApiGatewayPythonProject.Builder poetryOptions​(io.github.cdklabs.projen.python.PoetryPyprojectOptionsWithoutDeps poetryOptions)
        (experimental) Additional options to set for poetry if using poetry.

        Parameters:
        poetryOptions - Additional options to set for poetry if using poetry. This parameter is required.
        Returns:
        this

      • setupConfig

        @Stability(Experimental)
public SmithyApiGatewayPythonProject.Builder setupConfig​(Map<String,​? extends Object> setupConfig)
        (experimental) Additional fields to pass in the setup() function if using setuptools.

        Parameters:
        setupConfig - Additional fields to pass in the setup() function if using setuptools. This parameter is required.
        Returns:
        this

      • moduleName

        @Stability(Experimental)
public SmithyApiGatewayPythonProject.Builder moduleName​(String moduleName)
        (experimental) Name of the python package as used in imports and filenames.

        Must only consist of alphanumeric characters and underscores.

        Default: $PYTHON_MODULE_NAME

        Parameters:
        moduleName - Name of the python package as used in imports and filenames. This parameter is required.
        Returns:
        this

      • deps

        @Stability(Experimental)
public SmithyApiGatewayPythonProject.Builder deps​(List<String> deps)
        (experimental) List of runtime dependencies for this project.

        Dependencies use the format: <module>@<semver>

        Additional dependencies can be added via project.addDependency().

        Default: []

        Parameters:
        deps - List of runtime dependencies for this project. This parameter is required.
        Returns:
        this

      • devDeps

        @Stability(Experimental)
public SmithyApiGatewayPythonProject.Builder devDeps​(List<String> devDeps)
        (experimental) List of dev dependencies for this project.

        Dependencies use the format: <module>@<semver>

        Additional dependencies can be added via project.addDevDependency().

        Default: []

        Parameters:
        devDeps - List of dev dependencies for this project. This parameter is required.
        Returns:
        this

      • pip

        @Stability(Experimental)
public SmithyApiGatewayPythonProject.Builder pip​(Boolean pip)
        (experimental) Use pip with a requirements.txt file to track project dependencies.

        Default: true

        Parameters:
        pip - Use pip with a requirements.txt file to track project dependencies. This parameter is required.
        Returns:
        this

      • poetry

        @Stability(Experimental)
public SmithyApiGatewayPythonProject.Builder poetry​(Boolean poetry)
        (experimental) Use poetry to manage your project dependencies, virtual environment, and (optional) packaging/publishing.

        Default: false

        Parameters:
        poetry - Use poetry to manage your project dependencies, virtual environment, and (optional) packaging/publishing. This parameter is required.
        Returns:
        this

      • projenrcJs

        @Stability(Experimental)
public SmithyApiGatewayPythonProject.Builder projenrcJs​(Boolean projenrcJs)
        (experimental) Use projenrc in javascript.

        This will install projen as a JavaScript dependency and add a synth task which will run .projenrc.js.

        Default: false

        Parameters:
        projenrcJs - Use projenrc in javascript. This parameter is required.
        Returns:
        this

      • projenrcJsOptions

        @Stability(Experimental)
public SmithyApiGatewayPythonProject.Builder projenrcJsOptions​(io.github.cdklabs.projen.javascript.ProjenrcOptions projenrcJsOptions)
        (experimental) Options related to projenrc in JavaScript.

        Default: - default options

        Parameters:
        projenrcJsOptions - Options related to projenrc in JavaScript. This parameter is required.
        Returns:
        this

      • projenrcPython

        @Stability(Experimental)
public SmithyApiGatewayPythonProject.Builder projenrcPython​(Boolean projenrcPython)
        (experimental) Use projenrc in Python.

        This will install projen as a Python dependency and add a synth task which will run .projenrc.py.

        Default: true

        Parameters:
        projenrcPython - Use projenrc in Python. This parameter is required.
        Returns:
        this

      • projenrcPythonOptions

        @Stability(Experimental)
public SmithyApiGatewayPythonProject.Builder projenrcPythonOptions​(io.github.cdklabs.projen.python.ProjenrcOptions projenrcPythonOptions)
        (experimental) Options related to projenrc in python.

        Default: - default options

        Parameters:
        projenrcPythonOptions - Options related to projenrc in python. This parameter is required.
        Returns:
        this

      • pytest

        @Stability(Experimental)
public SmithyApiGatewayPythonProject.Builder pytest​(Boolean pytest)
        (experimental) Include pytest tests.

        Default: true

        Parameters:
        pytest - Include pytest tests. This parameter is required.
        Returns:
        this

      • pytestOptions

        @Stability(Experimental)
public SmithyApiGatewayPythonProject.Builder pytestOptions​(io.github.cdklabs.projen.python.PytestOptions pytestOptions)
        (experimental) pytest options.

        Default: - defaults

        Parameters:
        pytestOptions - pytest options. This parameter is required.
        Returns:
        this

      • sample

        @Stability(Experimental)
public SmithyApiGatewayPythonProject.Builder sample​(Boolean sample)
        (experimental) Include sample code and test if the relevant directories don't exist.

        Default: true

        Parameters:
        sample - Include sample code and test if the relevant directories don't exist. This parameter is required.
        Returns:
        this

      • setuptools

        @Stability(Experimental)
public SmithyApiGatewayPythonProject.Builder setuptools​(Boolean setuptools)
        (experimental) Use setuptools with a setup.py script for packaging and publishing.

        Default: - true if the project type is library

        Parameters:
        setuptools - Use setuptools with a setup.py script for packaging and publishing. This parameter is required.
        Returns:
        this

      • venv

        @Stability(Experimental)
public SmithyApiGatewayPythonProject.Builder venv​(Boolean venv)
        (experimental) Use venv to manage a virtual environment for installing dependencies inside.

        Default: true

        Parameters:
        venv - Use venv to manage a virtual environment for installing dependencies inside. This parameter is required.
        Returns:
        this

      • venvOptions

        @Stability(Experimental)
public SmithyApiGatewayPythonProject.Builder venvOptions​(io.github.cdklabs.projen.python.VenvOptions venvOptions)
        (experimental) Venv options.

        Default: - defaults

        Parameters:
        venvOptions - Venv options. This parameter is required.
        Returns:
        this

      • clientLanguages

        @Stability(Experimental)
public SmithyApiGatewayPythonProject.Builder clientLanguages​(List<? extends ClientLanguage> clientLanguages)
        (experimental) The list of languages for which clients will be generated.

        A typescript client will always be generated.

        Parameters:
        clientLanguages - The list of languages for which clients will be generated. This parameter is required.
        Returns:
        this

      • apiSrcDir

        @Stability(Experimental)
public SmithyApiGatewayPythonProject.Builder apiSrcDir​(String apiSrcDir)
        (experimental) The directory in which the api generated code will reside, relative to the project srcdir.

        Parameters:
        apiSrcDir - The directory in which the api generated code will reside, relative to the project srcdir. This parameter is required.
        Returns:
        this

      • documentationFormats

        @Stability(Experimental)
public SmithyApiGatewayPythonProject.Builder documentationFormats​(List<? extends DocumentationFormat> documentationFormats)
        (experimental) Formats to generate documentation in.

        Parameters:
        documentationFormats - Formats to generate documentation in. This parameter is required.
        Returns:
        this

      • forceGenerateCodeAndDocs

        @Stability(Experimental)
public SmithyApiGatewayPythonProject.Builder forceGenerateCodeAndDocs​(Boolean forceGenerateCodeAndDocs)
        (experimental) Force to generate code and docs even if there were no changes in spec.

        Default: "false"

        Parameters:
        forceGenerateCodeAndDocs - Force to generate code and docs even if there were no changes in spec. This parameter is required.
        Returns:
        this

      • generatedCodeDir

        @Stability(Experimental)
public SmithyApiGatewayPythonProject.Builder generatedCodeDir​(String generatedCodeDir)
        (experimental) The directory in which generated client code will be generated, relative to the outdir of this project.

        Default: "generated"

        Parameters:
        generatedCodeDir - The directory in which generated client code will be generated, relative to the outdir of this project. This parameter is required.
        Returns:
        this

      • javaClientOptions

        @Stability(Experimental)
public SmithyApiGatewayPythonProject.Builder javaClientOptions​(io.github.cdklabs.projen.java.JavaProjectOptions javaClientOptions)
        (experimental) Options for the generated java client (if specified in clientLanguages).

        These override the default inferred options.

        Parameters:
        javaClientOptions - Options for the generated java client (if specified in clientLanguages). This parameter is required.
        Returns:
        this

      • parsedSpecFileName

        @Stability(Experimental)
public SmithyApiGatewayPythonProject.Builder parsedSpecFileName​(String parsedSpecFileName)
        (experimental) The name of the output parsed OpenAPI specification file.

        Must end with .json.

        Default: ".parsed-spec.json"

        Parameters:
        parsedSpecFileName - The name of the output parsed OpenAPI specification file. This parameter is required.
        Returns:
        this

      • pythonClientOptions

        @Stability(Experimental)
public SmithyApiGatewayPythonProject.Builder pythonClientOptions​(io.github.cdklabs.projen.python.PythonProjectOptions pythonClientOptions)
        (experimental) Options for the generated python client (if specified in clientLanguages).

        These override the default inferred options.

        Parameters:
        pythonClientOptions - Options for the generated python client (if specified in clientLanguages). This parameter is required.
        Returns:
        this

      • typescriptClientOptions

        @Stability(Experimental)
public SmithyApiGatewayPythonProject.Builder typescriptClientOptions​(io.github.cdklabs.projen.typescript.TypeScriptProjectOptions typescriptClientOptions)
        (experimental) Options for the generated typescript client.

        These override the default inferred options.

        Parameters:
        typescriptClientOptions - Options for the generated typescript client. This parameter is required.
        Returns:
        this

      • serviceName

        @Stability(Experimental)
public SmithyApiGatewayPythonProject.Builder serviceName​(SmithyServiceName serviceName)
        (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"

        Parameters:
        serviceName - The name of the Smithy service from your model which will be targeted for deployment and client generation. This parameter is required.
        Returns:
        this

      • gradleWrapperPath

        @Stability(Experimental)
public SmithyApiGatewayPythonProject.Builder gradleWrapperPath​(String gradleWrapperPath)
        (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.

        Parameters:
        gradleWrapperPath - 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. This parameter is required.
        Returns:
        this

      • ignoreSmithyBuildOutput

        @Stability(Experimental)
public SmithyApiGatewayPythonProject.Builder ignoreSmithyBuildOutput​(Boolean ignoreSmithyBuildOutput)
        (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

        Parameters:
        ignoreSmithyBuildOutput - 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. This parameter is required.
        Returns:
        this

      • modelDir

        @Stability(Experimental)
public SmithyApiGatewayPythonProject.Builder modelDir​(String modelDir)
        (experimental) The path to the Smithy model directory, relative to the project source directory (srcdir).

        Default: "model"

        Parameters:
        modelDir - The path to the Smithy model directory, relative to the project source directory (srcdir). This parameter is required.
        Returns:
        this

      • smithyBuildOptions

        @Stability(Experimental)
public SmithyApiGatewayPythonProject.Builder smithyBuildOptions​(SmithyBuildOptions smithyBuildOptions)
        (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.

        Parameters:
        smithyBuildOptions - 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. This parameter is required.
        Returns:
        this
        See Also:
        https://awslabs.github.io/smithy/2.0/guides/converting-to-openapi.html#openapi-configuration-settings