Package software.amazon.awscdk.services.apigateway

Class BasePathMappingOptions.Builder

java.lang.Object

software.amazon.awscdk.services.apigateway.BasePathMappingOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<BasePathMappingOptions>

Enclosing interface:

BasePathMappingOptions

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

A builder for BasePathMappingOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
BasePathMappingOptions.Builder	attachToStage(Boolean attachToStage)	Sets the value of BasePathMappingOptions.getAttachToStage()
BasePathMappingOptions.Builder	basePath(String basePath)	Sets the value of BasePathMappingOptions.getBasePath()
BasePathMappingOptions	build()	Builds the configured instance.
BasePathMappingOptions.Builder	stage(Stage stage)	Sets the value of BasePathMappingOptions.getStage()

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

attachToStage

@Stability(Stable)
public BasePathMappingOptions.Builder attachToStage(Boolean attachToStage)

Sets the value of BasePathMappingOptions.getAttachToStage()

Parameters:

attachToStage - Whether to attach the base path mapping to a stage. Use this property to create a base path mapping without attaching it to the Rest API default stage. This property is ignored if stage is provided.

Returns:

this

basePath

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

Sets the value of BasePathMappingOptions.getBasePath()

Parameters:

basePath - The base 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.

Returns:

this

stage

@Stability(Stable)
public BasePathMappingOptions.Builder stage(Stage stage)

Sets the value of BasePathMappingOptions.getStage()

Parameters:

stage - The Deployment stage of API [disable-awslint:ref-via-interface].

Returns:

this

build

@Stability(Stable)
public BasePathMappingOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of BasePathMappingOptions

Throws:

NullPointerException - if any required attribute was not provided