software.amazon.awscdk.services.apigatewayv2

Interface DomainMappingOptions

All Known Implementing Classes:

DomainMappingOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:56.680Z")
public interface DomainMappingOptions

(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 java.lang.String	getMappingKey() (experimental) The API mapping key.

Method Detail

getDomainName

IDomainName getDomainName()

(experimental) The domain name for the mapping.

getMappingKey

default java.lang.String getMappingKey()

(experimental) The API mapping key.

Leave it undefined for the root path mapping.

Default: - empty key for the root path mapping

builder

static DomainMappingOptions.Builder builder()

Returns:

a DomainMappingOptions.Builder of DomainMappingOptions