Package 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.119.0 (build 1634eac)",
           date="2025-11-20T23:37:13.530Z")
@Stability(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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnBasePathMappingProps.Builder	builder()
default String	getBasePath()	The base path name that callers of the API must provide as part of the URL after the domain name.
Object	getDomainName()	The domain name of the BasePathMapping resource to be described.
default String	getId()
default Object	getRestApiId()	The string identifier of the associated RestApi.
default Object	getStage()	The name of the associated stage.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDomainName

@Stability(Stable)
@NotNull
Object getDomainName()

The domain name of the BasePathMapping resource to be described.

Returns union: either String or IDomainNameRef

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html#cfn-apigateway-basepathmapping-domainname

getBasePath

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html#cfn-apigateway-basepathmapping-basepath

getId

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html#cfn-apigateway-basepathmapping-id

getRestApiId

@Stability(Stable)
@Nullable
default Object getRestApiId()

The string identifier of the associated RestApi.

Returns union: either String or IRestApiRef

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html#cfn-apigateway-basepathmapping-restapiid

getStage

@Stability(Stable)
@Nullable
default Object getStage()

The name of the associated stage.

Returns union: either String or IStageRef

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html#cfn-apigateway-basepathmapping-stage

builder

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

Returns:

a CfnBasePathMappingProps.Builder of CfnBasePathMappingProps