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.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.095Z")
 @Stability(value=Stable)
public interface CfnBasePathMappingProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `CfnBasePathMapping`.

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")
         .id("id")
         .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() The base path name that callers of the API must provide in the URL after the domain name.
String	getDomainName() The `DomainName` of an [AWS::ApiGateway::DomainName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html) resource.
default String	getId() `AWS::ApiGateway::BasePathMapping.Id`.
default String	getRestApiId() The ID of the API.
default String	getStage() The name of the API's stage.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getDomainName

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

The `DomainName` of an [AWS::ApiGateway::DomainName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html) resource.

getBasePath

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

The base path name that callers of the API must provide in the URL after the domain name.

getId

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

`AWS::ApiGateway::BasePathMapping.Id`.

getRestApiId

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

The ID of the API.

getStage

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

The name of the API's stage.

builder

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

Returns:

a CfnBasePathMappingProps.Builder of CfnBasePathMappingProps