software.amazon.awscdk.services.apigateway

Interface CfnBasePathMappingProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnBasePathMappingProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.46.0 (build cd08c55)",
           date="2021-11-25T20:11:04.743Z")
 @Stability(value=Stable)
public interface CfnBasePathMappingProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `AWS::ApiGateway::BasePathMapping`.

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.*;
 CfnBasePathMappingProps cfnBasePathMappingProps = CfnBasePathMappingProps.builder()
         .domainName("domainName")
         // the properties below are optional
         .basePath("basePath")
         .restApiId("restApiId")
         .stage("stage")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnBasePathMappingProps.Builder	builder()
default String	getBasePath() `AWS::ApiGateway::BasePathMapping.BasePath`.
String	getDomainName() `AWS::ApiGateway::BasePathMapping.DomainName`.
default String	getRestApiId() `AWS::ApiGateway::BasePathMapping.RestApiId`.
default String	getStage() `AWS::ApiGateway::BasePathMapping.Stage`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getBasePath

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

`AWS::ApiGateway::BasePathMapping.BasePath`.

getDomainName

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

`AWS::ApiGateway::BasePathMapping.DomainName`.

getRestApiId

@Stability(value=Stable)
 @Nullable
default String getRestApiId()

`AWS::ApiGateway::BasePathMapping.RestApiId`.

getStage

@Stability(value=Stable)
 @Nullable
default String getStage()

`AWS::ApiGateway::BasePathMapping.Stage`.

builder

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

Returns:

a CfnBasePathMappingProps.Builder of CfnBasePathMappingProps