Package software.amazon.awscdk.cfnpropertymixins.services.apigateway

Interface CfnBasePathMappingMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnBasePathMappingMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:55.427Z")
@Stability(Stable)
public interface CfnBasePathMappingMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnBasePathMappingPropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.apigateway.*;
 CfnBasePathMappingMixinProps cfnBasePathMappingMixinProps = CfnBasePathMappingMixinProps.builder()
         .basePath("basePath")
         .domainName("domainName")
         .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	CfnBasePathMappingMixinProps.Builder	A builder for CfnBasePathMappingMixinProps
static final class	CfnBasePathMappingMixinProps.Jsii$Proxy	An implementation for CfnBasePathMappingMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnBasePathMappingMixinProps.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.
default 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

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

getDomainName

@Stability(Stable)
@Nullable
default 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

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 CfnBasePathMappingMixinProps.Builder builder()

Returns:

a CfnBasePathMappingMixinProps.Builder of CfnBasePathMappingMixinProps