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 -
Method Summary
Modifier and TypeMethodDescriptionattachToStage
(Boolean attachToStage) Sets the value ofBasePathMappingOptions.getAttachToStage()
Sets the value ofBasePathMappingOptions.getBasePath()
build()
Builds the configured instance.Sets the value ofBasePathMappingOptions.getStage()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
attachToStage
Sets the value ofBasePathMappingOptions.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 ifstage
is provided.- Returns:
this
-
basePath
Sets the value ofBasePathMappingOptions.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
Sets the value ofBasePathMappingOptions.getStage()
- Parameters:
stage
- The Deployment stage of API [disable-awslint:ref-via-interface].- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<BasePathMappingOptions>
- Returns:
- a new instance of
BasePathMappingOptions
- Throws:
NullPointerException
- if any required attribute was not provided
-