Package software.amazon.awscdk.services.apigateway

Interface BasePathMappingOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

BasePathMappingProps

All Known Implementing Classes:

BasePathMappingOptions.Jsii$Proxy, BasePathMappingProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:44.707Z")
@Stability(Stable)
public interface BasePathMappingOptions
extends software.amazon.jsii.JsiiSerializable

Example:

 DomainName domain;
 RestApi api1;
 RestApi api2;
 domain.addBasePathMapping(api1, BasePathMappingOptions.builder().basePath("go-to-api1").build());
 domain.addBasePathMapping(api2, BasePathMappingOptions.builder().basePath("boom").build());
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static BasePathMappingOptions.Builder	builder()
default String	getBasePath()	The base path name that callers of the API must provide in the URL after the domain name (e.g.
default Stage	getStage()	The Deployment stage of API [disable-awslint:ref-via-interface].

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBasePath

@Stability(Stable)
@Nullable
default String getBasePath()

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.

Default: - map requests from the domain root (e.g. `example.com`). If this is undefined, no additional mappings will be allowed on this domain name.

getStage

@Stability(Stable)
@Nullable
default Stage getStage()

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

Default: - map to deploymentStage of restApi otherwise stage needs to pass in URL

builder

@Stability(Stable)
static BasePathMappingOptions.Builder builder()

Returns:

a BasePathMappingOptions.Builder of BasePathMappingOptions