Package software.amazon.awscdk.services.apigateway

Interface ApiMappingOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ApiMappingOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)",
           date="2025-12-18T18:20:04.067Z")
@Stability(Stable)
public interface ApiMappingOptions
extends software.amazon.jsii.JsiiSerializable

Options for creating an api mapping.

Example:

 Object acmCertificateForExampleCom;
 RestApi restApi;
 RestApi secondRestApi;
 DomainName domain = DomainName.Builder.create(this, "custom-domain")
         .domainName("example.com")
         .certificate(acmCertificateForExampleCom)
         .mapping(restApi)
         .build();
 domain.addApiMapping(secondRestApi.getDeploymentStage(), ApiMappingOptions.builder()
         .basePath("orders/v2/api")
         .build());
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ApiMappingOptions.Builder	builder()
default String	getBasePath()	The api path name that callers of the API must provide in the URL after the domain name (e.g.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBasePath

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

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.

Default: - map requests from the domain root (e.g. `example.com`).

builder

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

Returns:

a ApiMappingOptions.Builder of ApiMappingOptions