Package software.aws.awsprototypingsdk.openapigateway

Interface SmithyApiGatewayProjectOptions

All Superinterfaces:

CommonApiProjectOptions, software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

SmithyApiGatewayJavaProjectOptions, SmithyApiGatewayPythonProjectOptions, SmithyApiGatewayTsProjectOptions

All Known Implementing Classes:

SmithyApiGatewayJavaProjectOptions.Jsii$Proxy, SmithyApiGatewayProjectOptions.Jsii$Proxy, SmithyApiGatewayPythonProjectOptions.Jsii$Proxy, SmithyApiGatewayTsProjectOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-01T04:12:25.153Z")
@Stability(Experimental)
public interface SmithyApiGatewayProjectOptions
extends software.amazon.jsii.JsiiSerializable, CommonApiProjectOptions

(experimental) Options common to all smithy api gateway projects.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static SmithyApiGatewayProjectOptions.Builder	builder()
default String	getGradleWrapperPath()	(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.
default Boolean	getIgnoreSmithyBuildOutput()	(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 String	getModelDir()	(experimental) The path to the Smithy model directory, relative to the project source directory (srcdir).
SmithyServiceName	getServiceName()	(experimental) The name of the Smithy service from your model which will be targeted for deployment and client generation.
default SmithyBuildOptions	getSmithyBuildOptions()	(experimental) Any additional properties you'd like to add your smithy-build.json.

Methods inherited from interface software.aws.awsprototypingsdk.openapigateway.CommonApiProjectOptions

getApiSrcDir, getClientLanguages, getDocumentationFormats, getForceGenerateCodeAndDocs, getGeneratedCodeDir, getJavaClientOptions, getParsedSpecFileName, getPythonClientOptions, getTypescriptClientOptions

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getServiceName

@Stability(Experimental)
@NotNull
SmithyServiceName getServiceName()

(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"

getGradleWrapperPath

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

(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.

getIgnoreSmithyBuildOutput

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

(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

getModelDir

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

(experimental) The path to the Smithy model directory, relative to the project source directory (srcdir).

Default: "model"

getSmithyBuildOptions

@Stability(Experimental)
@Nullable
default SmithyBuildOptions getSmithyBuildOptions()

(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.

See Also:

https://awslabs.github.io/smithy/2.0/guides/converting-to-openapi.html#openapi-configuration-settings

builder

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

Returns:

a SmithyApiGatewayProjectOptions.Builder of SmithyApiGatewayProjectOptions