Package software.amazon.awscdk.services.apigatewayv2

Interface ApiMappingProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ApiMappingProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)",
           date="2025-12-18T18:20:04.292Z")
@Stability(Stable)
public interface ApiMappingProps
extends software.amazon.jsii.JsiiSerializable

Properties used to create the ApiMapping resource.

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.apigatewayv2.*;
 IApi api;
 DomainName domainName;
 IStage stage;
 ApiMappingProps apiMappingProps = ApiMappingProps.builder()
         .api(api)
         .domainName(domainName)
         // the properties below are optional
         .apiMappingKey("apiMappingKey")
         .stage(stage)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ApiMappingProps.Builder	builder()
IApi	getApi()	The Api to which this mapping is applied.
default String	getApiMappingKey()	Api mapping key.
IDomainName	getDomainName()	custom domain name of the mapping target.
default IStage	getStage()	stage for the ApiMapping resource required for WebSocket API defaults to default stage of an HTTP API.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApi

@Stability(Stable)
@NotNull
IApi getApi()

The Api to which this mapping is applied.

getDomainName

@Stability(Stable)
@NotNull
IDomainName getDomainName()

custom domain name of the mapping target.

getApiMappingKey

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

Api mapping key.

The path where this stage should be mapped to on the domain

Default: - undefined for the root path mapping.

getStage

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

stage for the ApiMapping resource required for WebSocket API defaults to default stage of an HTTP API.

Default: - Default stage of the passed API for HTTP API, required for WebSocket API

builder

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

Returns:

a ApiMappingProps.Builder of ApiMappingProps