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

Interface CfnBasePathMappingV2MixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnBasePathMappingV2MixinProps.Jsii$Proxy

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

Properties for CfnBasePathMappingV2PropsMixin.

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.*;
 CfnBasePathMappingV2MixinProps cfnBasePathMappingV2MixinProps = CfnBasePathMappingV2MixinProps.builder()
         .basePath("basePath")
         .domainNameArn("domainNameArn")
         .restApiId("restApiId")
         .stage("stage")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnBasePathMappingV2MixinProps.Builder	builder()
default String	getBasePath()	The base path name that callers of the private API must provide as part of the URL after the domain name.
default String	getDomainNameArn()	The ARN of the domain name for the BasePathMappingV2 resource to be described.
default String	getRestApiId()	The private API's identifier.
default String	getStage()	Represents a unique identifier for a version of a deployed private RestApi that is callable by users.

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 private 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-basepathmappingv2.html#cfn-apigateway-basepathmappingv2-basepath

getDomainNameArn

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

The ARN of the domain name for the BasePathMappingV2 resource to be described.

See Also:

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

getRestApiId

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

The private API's identifier.

This identifier is unique across all of your APIs in API Gateway.

See Also:

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

getStage

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

Represents a unique identifier for a version of a deployed private RestApi that is callable by users.

The Stage must depend on the RestApi 's stage. To create a dependency, add a DependsOn attribute to the BasePathMappingV2 resource.

See Also:

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

builder

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

Returns:

a CfnBasePathMappingV2MixinProps.Builder of CfnBasePathMappingV2MixinProps