Package software.amazon.awscdk.services.opensearchservice

Interface CustomEndpointOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CustomEndpointOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.126.0 (build 206d44b)",
           date="2026-02-09T14:39:15.098Z")
@Stability(Stable)
public interface CustomEndpointOptions
extends software.amazon.jsii.JsiiSerializable

Configures a custom domain endpoint for the Amazon OpenSearch Service domain.

Example:

 Domain.Builder.create(this, "Domain")
         .version(EngineVersion.OPENSEARCH_1_0)
         .customEndpoint(CustomEndpointOptions.builder()
                 .domainName("search.example.com")
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CustomEndpointOptions.Builder	builder()
default ICertificateRef	getCertificate()	The certificate to use.
String	getDomainName()	The custom domain name to assign.
default IHostedZone	getHostedZone()	The hosted zone in Route53 to create the CNAME record in.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDomainName

@Stability(Stable)
@NotNull
String getDomainName()

The custom domain name to assign.

getCertificate

@Stability(Stable)
@Nullable
default ICertificateRef getCertificate()

The certificate to use.

Default: - create a new one

getHostedZone

@Stability(Stable)
@Nullable
default IHostedZone getHostedZone()

The hosted zone in Route53 to create the CNAME record in.

Default: - do not create a CNAME

builder

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

Returns:

a CustomEndpointOptions.Builder of CustomEndpointOptions