Package software.amazon.awscdk.services.apigatewayv2

Interface DomainMappingOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

DomainMappingOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-13T16:09:58.048Z")
@Stability(Stable)
public interface DomainMappingOptions
extends software.amazon.jsii.JsiiSerializable

Options for DomainMapping.

Example:

 import software.amazon.awscdk.aws_apigatewayv2_integrations.HttpLambdaIntegration;
 Function handler;
 DomainName dn;
 HttpApi apiDemo = HttpApi.Builder.create(this, "DemoApi")
         .defaultIntegration(new HttpLambdaIntegration("DefaultIntegration", handler))
         // https://${dn.domainName}/demo goes to apiDemo $default stage
         .defaultDomainMapping(DomainMappingOptions.builder()
                 .domainName(dn)
                 .mappingKey("demo")
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static DomainMappingOptions.Builder	builder()
IDomainName	getDomainName()	The domain name for the mapping.
default String	getMappingKey()	The API mapping key.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDomainName

@Stability(Stable)
@NotNull
IDomainName getDomainName()

The domain name for the mapping.

getMappingKey

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

The API mapping key.

Leave it undefined for the root path mapping.

Default: - empty key for the root path mapping

builder

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

Returns:

a DomainMappingOptions.Builder of DomainMappingOptions