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.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.088Z")
 @Stability(value=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 and Description
static class	BasePathMappingProps.Builder A builder for BasePathMappingProps
static class	BasePathMappingProps.Jsii$Proxy An implementation for BasePathMappingProps

Method Summary

Modifier and Type	Method and 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 Detail

getDomainName

@Stability(value=Stable)
 @NotNull
IDomainName getDomainName()

The DomainName to associate with this base path mapping.

getRestApi

@Stability(value=Stable)
 @NotNull
IRestApi getRestApi()

The RestApi resource to target.

builder

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

Specified by:

builder in interface BasePathMappingOptions

Returns:

a BasePathMappingProps.Builder of BasePathMappingProps