Package software.amazon.awscdk.services.elasticsearch

Interface CfnDomain.DomainEndpointOptionsProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnDomain.DomainEndpointOptionsProperty.Jsii$Proxy
Enclosing class:
CfnDomain
@Stability(Stable) public static interface CfnDomain.DomainEndpointOptionsProperty extends software.amazon.jsii.JsiiSerializable
Specifies additional options for the domain endpoint, such as whether to require HTTPS for all traffic or whether to use a custom endpoint rather than the default endpoint.

The AWS::Elasticsearch::Domain resource is being replaced by the AWS::OpenSearchService::Domain resource. While the legacy Elasticsearch resource and options are still supported, we recommend modifying your existing Cloudformation templates to use the new OpenSearch Service resource, which supports both OpenSearch and Elasticsearch. For more information about the service rename, see New resource types in the Amazon OpenSearch Service Developer Guide .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.elasticsearch.*;
 DomainEndpointOptionsProperty domainEndpointOptionsProperty = DomainEndpointOptionsProperty.builder()
         .customEndpoint("customEndpoint")
         .customEndpointCertificateArn("customEndpointCertificateArn")
         .customEndpointEnabled(false)
         .enforceHttps(false)
         .tlsSecurityPolicy("tlsSecurityPolicy")
         .build();

  • Method Details

    • getCustomEndpoint

      @Stability(Stable) @Nullable default String getCustomEndpoint()
      The fully qualified URL for your custom endpoint.

      Required if you enabled a custom endpoint for the domain.

    • getCustomEndpointCertificateArn

      @Stability(Stable) @Nullable default String getCustomEndpointCertificateArn()
      The AWS Certificate Manager ARN for your domain's SSL/TLS certificate.

      Required if you enabled a custom endpoint for the domain.

    • getCustomEndpointEnabled

      @Stability(Stable) @Nullable default Object getCustomEndpointEnabled()
      True to enable a custom endpoint for the domain.

      If enabled, you must also provide values for CustomEndpoint and CustomEndpointCertificateArn .

    • getEnforceHttps

      @Stability(Stable) @Nullable default Object getEnforceHttps()
      True to require that all traffic to the domain arrive over HTTPS.

    • getTlsSecurityPolicy

      @Stability(Stable) @Nullable default String getTlsSecurityPolicy()
      The minimum TLS version required for traffic to the domain. Valid values are TLS 1.0 (default) or 1.2:.

      • Policy-Min-TLS-1-0-2019-07
      • Policy-Min-TLS-1-2-2019-07

    • builder

      @Stability(Stable) static CfnDomain.DomainEndpointOptionsProperty.Builder builder()
      Returns:
      a CfnDomain.DomainEndpointOptionsProperty.Builder of CfnDomain.DomainEndpointOptionsProperty