Package software.amazon.awscdk.services.apigateway

Interface DomainNameProps

All Superinterfaces:

DomainNameOptions, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

DomainNameProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)",
           date="2025-10-14T12:28:04.113Z")
@Stability(Stable)
public interface DomainNameProps
extends software.amazon.jsii.JsiiSerializable, DomainNameOptions

Example:

 Object acmCertificateForExampleCom;
 RestApi restApi;
 DomainName.Builder.create(this, "custom-domain")
         .domainName("example.com")
         .certificate(acmCertificateForExampleCom)
         .mapping(restApi)
         .basePath("orders/v1/api")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static DomainNameProps.Builder	builder()
default IRestApi	getMapping()	If specified, all requests to this domain will be mapped to the production deployment of this API.

Methods inherited from interface software.amazon.awscdk.services.apigateway.DomainNameOptions

getBasePath, getCertificate, getDomainName, getEndpointType, getMtls, getSecurityPolicy

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getMapping

@Stability(Stable)
@Nullable
default IRestApi getMapping()

If specified, all requests to this domain will be mapped to the production deployment of this API.

If you wish to map this domain to multiple APIs with different base paths, use addBasePathMapping or addApiMapping.

Default: - you will have to call `addBasePathMapping` to map this domain to API endpoints.

builder

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

Returns:

a DomainNameProps.Builder of DomainNameProps