Package software.amazon.awscdk.services.apigatewayv2

Interface DomainNameProps

All Superinterfaces:

EndpointOptions, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

DomainNameProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-17T14:40:44.536Z")
@Stability(Stable)
public interface DomainNameProps
extends software.amazon.jsii.JsiiSerializable, EndpointOptions

properties used for creating the DomainName.

Example:

 import software.amazon.awscdk.services.s3.*;
 import software.amazon.awscdk.services.certificatemanager.*;
 Bucket bucket;
 String certArn = "arn:aws:acm:us-east-1:111111111111:certificate";
 String domainName = "example.com";
 DomainName.Builder.create(this, "DomainName")
         .domainName(domainName)
         .certificate(Certificate.fromCertificateArn(this, "cert", certArn))
         .mtls(MTLSConfig.builder()
                 .bucket(bucket)
                 .key("someca.pem")
                 .version("version")
                 .build())
         .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()
String	getDomainName()	The custom domain name.
default MTLSConfig	getMtls()	The mutual TLS authentication configuration for a custom domain name.

Methods inherited from interface software.amazon.awscdk.services.apigatewayv2.EndpointOptions

getCertificate, getCertificateName, getEndpointType, getIpAddressType, getOwnershipCertificate, getSecurityPolicy

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDomainName

@Stability(Stable)
@NotNull
String getDomainName()

The custom domain name.

getMtls

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

The mutual TLS authentication configuration for a custom domain name.

Default: - mTLS is not configured.

builder

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

Returns:

a DomainNameProps.Builder of DomainNameProps