Package software.amazon.awscdk.services.apigateway

Interface BasePathMappingProps

All Superinterfaces:

BasePathMappingOptions, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

BasePathMappingProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.128.0 (build 749b9a9)",
           date="2026-05-08T13:04:58.787Z")
@Stability(Stable)
public interface BasePathMappingProps
extends software.amazon.jsii.JsiiSerializable, BasePathMappingOptions

Example:

 RestApi api;
 IDomainName domainName = DomainName.fromDomainNameAttributes(this, "DomainName", DomainNameAttributes.builder()
         .domainName("domainName")
         .domainNameAliasHostedZoneId("domainNameAliasHostedZoneId")
         .domainNameAliasTarget("domainNameAliasTarget")
         .build());
 BasePathMapping.Builder.create(this, "BasePathMapping")
         .domainName(domainName)
         .restApi(api)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static BasePathMappingProps.Builder	builder()
IDomainNameRef	getDomainName()	The DomainName to associate with this base path mapping.
IRestApiRef	getRestApi()	The RestApi resource to target.

Methods inherited from interface software.amazon.awscdk.services.apigateway.BasePathMappingOptions

getAttachToStage, getBasePath, getStage

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDomainName

@Stability(Stable)
@NotNull
IDomainNameRef getDomainName()

The DomainName to associate with this base path mapping.

getRestApi

@Stability(Stable)
@NotNull
IRestApiRef getRestApi()

The RestApi resource to target.

builder

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

Returns:

a BasePathMappingProps.Builder of BasePathMappingProps