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.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:44.708Z")
@Stability(Stable)
public interface BasePathMappingProps
extends software.amazon.jsii.JsiiSerializable, BasePathMappingOptions

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.apigateway.*;
 DomainName domainName;
 RestApi restApi;
 Stage stage;
 BasePathMappingProps basePathMappingProps = BasePathMappingProps.builder()
         .domainName(domainName)
         .restApi(restApi)
         // the properties below are optional
         .basePath("basePath")
         .stage(stage)
         .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()
IDomainName	getDomainName()	The DomainName to associate with this base path mapping.
IRestApi	getRestApi()	The RestApi resource to target.

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

getBasePath, getStage

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDomainName

@Stability(Stable)
@NotNull
IDomainName getDomainName()

The DomainName to associate with this base path mapping.

getRestApi

@Stability(Stable)
@NotNull
IRestApi getRestApi()

The RestApi resource to target.

builder

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

Returns:

a BasePathMappingProps.Builder of BasePathMappingProps