Package software.amazon.awscdk.services.apigateway

Class ApiMappingOptions.Builder

java.lang.Object

software.amazon.awscdk.services.apigateway.ApiMappingOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ApiMappingOptions>

Enclosing interface:

ApiMappingOptions

@Stability(Stable)
public static final class ApiMappingOptions.Builder
extends Object
implements software.amazon.jsii.Builder<ApiMappingOptions>

A builder for ApiMappingOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ApiMappingOptions.Builder	basePath(String basePath)	Sets the value of ApiMappingOptions.getBasePath()
ApiMappingOptions	build()	Builds the configured instance.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

basePath

@Stability(Stable)
public ApiMappingOptions.Builder basePath(String basePath)

Sets the value of ApiMappingOptions.getBasePath()

Parameters:

basePath - The api path name that callers of the API must provide in the URL after the domain name (e.g. example.com/base-path). If you specify this property, it can't be an empty string. If this is undefined, a mapping will be added for the empty path. Any request that does not match a mapping will get sent to the API that has been mapped to the empty path.

Returns:

this

build

@Stability(Stable)
public ApiMappingOptions build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<ApiMappingOptions>

Returns:

a new instance of ApiMappingOptions

Throws:

NullPointerException - if any required attribute was not provided