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.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.104Z")
 @Stability(value=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 and Description
static class	CustomEndpointOptions.Builder A builder for CustomEndpointOptions
static class	CustomEndpointOptions.Jsii$Proxy An implementation for CustomEndpointOptions

Method Summary

Modifier and Type	Method and Description
static CustomEndpointOptions.Builder	builder()
default ICertificate	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 Detail

getDomainName

@Stability(value=Stable)
 @NotNull
String getDomainName()

The custom domain name to assign.

getCertificate

@Stability(value=Stable)
 @Nullable
default ICertificate getCertificate()

The certificate to use.

Default: - create a new one

getHostedZone

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

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

Default: - do not create a CNAME

builder

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

Returns:

a CustomEndpointOptions.Builder of CustomEndpointOptions