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

Class CfnBasePathMappingPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.apigateway.CfnBasePathMappingPropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:55.427Z")
@Stability(Stable)
public class CfnBasePathMappingPropsMixin
extends Mixin
implements software.constructs.IMixin

The AWS::ApiGateway::BasePathMapping resource creates a base path that clients who call your API must use in the invocation URL.

Supported only for public custom domain names.

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.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnBasePathMappingPropsMixin cfnBasePathMappingPropsMixin = CfnBasePathMappingPropsMixin.Builder.create(CfnBasePathMappingMixinProps.builder()
         .basePath("basePath")
         .domainName("domainName")
         .id("id")
         .restApiId("restApiId")
         .stage("stage")
         .build())
 .strategy(mergeStrategy)
 .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnBasePathMappingPropsMixin.Builder	A fluent builder for CfnBasePathMappingPropsMixin.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnBasePathMappingPropsMixin(CfnBasePathMappingMixinProps props)	Create a mixin to apply properties to AWS::ApiGateway::BasePathMapping.
	CfnBasePathMappingPropsMixin(CfnBasePathMappingMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::ApiGateway::BasePathMapping.
protected	CfnBasePathMappingPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnBasePathMappingPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnBasePathMappingMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnBasePathMappingPropsMixin

protected CfnBasePathMappingPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

CfnBasePathMappingPropsMixin

protected CfnBasePathMappingPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnBasePathMappingPropsMixin

@Stability(Stable)
public CfnBasePathMappingPropsMixin(@NotNull
 CfnBasePathMappingMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::ApiGateway::BasePathMapping.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnBasePathMappingPropsMixin

@Stability(Stable)
public CfnBasePathMappingPropsMixin(@NotNull
 CfnBasePathMappingMixinProps props)

Create a mixin to apply properties to AWS::ApiGateway::BasePathMapping.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnBasePathMappingMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()