Package software.amazon.awscdk.services.apigatewayv2

Class ApiMapping

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.apigatewayv2.ApiMapping

All Implemented Interfaces:

IApiMappingRef, IEnvironmentAware, IResource, IApiMapping, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.126.0 (build 206d44b)",
           date="2026-02-09T14:39:02.474Z")
@Stability(Stable)
public class ApiMapping
extends Resource
implements IApiMapping

Create a new API mapping for API Gateway API endpoint.

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.*;
 import software.amazon.awscdk.interfaces.apigatewayv2.*;
 IApiRef apiRef;
 IDomainNameRef domainNameRef;
 IStage stage;
 ApiMapping apiMapping = ApiMapping.Builder.create(this, "MyApiMapping")
         .api(apiRef)
         .domainName(domainNameRef)
         // the properties below are optional
         .apiMappingKey("apiMappingKey")
         .stage(stage)
         .build();
 

Nested Class Summary

Nested Classes

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

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.apigatewayv2.IApiMapping

IApiMapping.Jsii$Default, IApiMapping.Jsii$Proxy

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

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROPERTY_INJECTION_ID	Uniquely identifies this class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ApiMapping(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	ApiMapping(software.amazon.jsii.JsiiObjectRef objRef)
	ApiMapping(software.constructs.Construct scope, String id, ApiMappingProps props)

Method Summary

Modifier and Type	Method	Description
static IApiMapping	fromApiMappingAttributes(software.constructs.Construct scope, String id, ApiMappingAttributes attrs)	import from API ID.
String	getApiMappingId()	ID of the API Mapping.
ApiMappingReference	getApiMappingRef()	A reference to a ApiMapping resource.
IDomainName	getDomainName()	API domain name.
String	getDomainUrl()	Return the domain for this API Mapping.
String	getMappingKey()	API Mapping key.

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

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, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

PROPERTY_INJECTION_ID

@Stability(Stable)
public static final String PROPERTY_INJECTION_ID

Uniquely identifies this class.

Constructor Details

ApiMapping

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

ApiMapping

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

ApiMapping

@Stability(Stable)
public ApiMapping(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 ApiMappingProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Details

fromApiMappingAttributes

@Stability(Stable)
@NotNull
public static IApiMapping fromApiMappingAttributes(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 ApiMappingAttributes attrs)

import from API ID.

Parameters:

scope - This parameter is required.

id - This parameter is required.

attrs - This parameter is required.

getApiMappingId

@Stability(Stable)
@NotNull
public String getApiMappingId()

ID of the API Mapping.

Specified by:

getApiMappingId in interface IApiMapping

getApiMappingRef

@Stability(Stable)
@NotNull
public ApiMappingReference getApiMappingRef()

A reference to a ApiMapping resource.

Specified by:

getApiMappingRef in interface IApiMappingRef

getDomainName

@Stability(Stable)
@NotNull
public IDomainName getDomainName()

API domain name.

getDomainUrl

@Stability(Stable)
@NotNull
public String getDomainUrl()

Return the domain for this API Mapping.

getMappingKey

@Stability(Stable)
@Nullable
public String getMappingKey()

API Mapping key.