Package software.amazon.awscdk.services.apigateway

Interface DomainNameOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

DomainNameProps

All Known Implementing Classes:

DomainNameOptions.Jsii$Proxy, DomainNameProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-04-02T21:55:03.637Z")
@Stability(Stable)
public interface DomainNameOptions
extends software.amazon.jsii.JsiiSerializable

Example:

 Object acmCertificateForExampleCom;
 RestApi api = RestApi.Builder.create(this, "MyDomain")
         .domainName(DomainNameOptions.builder()
                 .domainName("example.com")
                 .certificate(acmCertificateForExampleCom)
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static DomainNameOptions.Builder	builder()
default String	getBasePath()	The base path name that callers of the API must provide in the URL after the domain name (e.g.
ICertificateRef	getCertificate()	The reference to an AWS-managed certificate for use by the edge-optimized endpoint for the domain name.
String	getDomainName()	The custom domain name for your API.
default EndpointAccessMode	getEndpointAccessMode()	The endpoint access mode for this domain name.
default EndpointType	getEndpointType()	The type of endpoint for this DomainName.
default MTLSConfig	getMtls()	The mutual TLS authentication configuration for a custom domain name.
default SecurityPolicy	getSecurityPolicy()	The Transport Layer Security (TLS) version + cipher suite for this domain name.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCertificate

@Stability(Stable)
@NotNull
ICertificateRef getCertificate()

The reference to an AWS-managed certificate for use by the edge-optimized endpoint for the domain name.

For "EDGE" domain names, the certificate needs to be in the US East (N. Virginia) region.

getDomainName

@Stability(Stable)
@NotNull
String getDomainName()

The custom domain name for your API.

Uppercase letters are not supported.

getBasePath

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

The base path name that callers of the API must provide in the URL after the domain name (e.g. example.com/base-path). If you specify this property, it can't be an empty string.

Default: - map requests from the domain root (e.g. `example.com`).

getEndpointAccessMode

@Stability(Stable)
@Nullable
default EndpointAccessMode getEndpointAccessMode()

The endpoint access mode for this domain name.

When using enhanced security policies (those starting with SecurityPolicy_), you must specify this property. STRICT is recommended for production workloads, but BASIC may be needed during migration or for certain application architectures.

Default: - No endpoint access mode is configured. Required for enhanced security policies.

See Also:

• https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-security-policies.html#apigateway-security-policies-endpoint-access-mode

getEndpointType

@Stability(Stable)
@Nullable
default EndpointType getEndpointType()

The type of endpoint for this DomainName.

Default: REGIONAL

getMtls

@Stability(Stable)
@Nullable
default MTLSConfig getMtls()

The mutual TLS authentication configuration for a custom domain name.

Default: - mTLS is not configured.

getSecurityPolicy

@Stability(Stable)
@Nullable
default SecurityPolicy getSecurityPolicy()

The Transport Layer Security (TLS) version + cipher suite for this domain name.

Default: SecurityPolicy.TLS_1_2

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html

builder

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

Returns:

a DomainNameOptions.Builder of DomainNameOptions