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.67.0 (build 2c027f5)",
           date="2022-09-07T23:46:59.797Z")
 @Stability(value=Experimental)
public interface DomainMappingOptions
extends software.amazon.jsii.JsiiSerializable

(experimental) Options for DomainMapping.

Example:

 import software.amazon.awscdk.services.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 and Description
static class	DomainMappingOptions.Builder A builder for DomainMappingOptions
static class	DomainMappingOptions.Jsii$Proxy An implementation for DomainMappingOptions

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getDomainName

@Stability(value=Experimental)
 @NotNull
IDomainName getDomainName()

(experimental) The domain name for the mapping.

getMappingKey

@Stability(value=Experimental)
 @Nullable
default String getMappingKey()

(experimental) The API mapping key.

Leave it undefined for the root path mapping.

Default: - empty key for the root path mapping

builder

@Stability(value=Experimental)
static DomainMappingOptions.Builder builder()

Returns:

a DomainMappingOptions.Builder of DomainMappingOptions