Package software.amazon.awscdk.services.opensearchservice

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.

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.opensearchservice.*;
 DomainEndpointOptionsProperty domainEndpointOptionsProperty = DomainEndpointOptionsProperty.builder()
         .customEndpoint("customEndpoint")
         .customEndpointCertificateArn("customEndpointCertificateArn")
         .customEndpointEnabled(false)
         .enforceHttps(false)
         .tlsSecurityPolicy("tlsSecurityPolicy")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-domainendpointoptions.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDomain.DomainEndpointOptionsProperty.Builder	builder()
default String	getCustomEndpoint()	The fully qualified URL for your custom endpoint.
default String	getCustomEndpointCertificateArn()	The AWS Certificate Manager ARN for your domain's SSL/TLS certificate.
default Object	getCustomEndpointEnabled()	True to enable a custom endpoint for the domain.
default Object	getEnforceHttps()	True to require that all traffic to the domain arrive over HTTPS.
default String	getTlsSecurityPolicy()	The minimum TLS version required for traffic to the domain.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-domainendpointoptions.html#cfn-opensearchservice-domain-domainendpointoptions-customendpoint

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-domainendpointoptions.html#cfn-opensearchservice-domain-domainendpointoptions-customendpointcertificatearn

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-domainendpointoptions.html#cfn-opensearchservice-domain-domainendpointoptions-customendpointenabled

getEnforceHttps

@Stability(Stable)
@Nullable
default Object getEnforceHttps()

True to require that all traffic to the domain arrive over HTTPS.

Required if you enable fine-grained access control in AdvancedSecurityOptions .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-domainendpointoptions.html#cfn-opensearchservice-domain-domainendpointoptions-enforcehttps

getTlsSecurityPolicy

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

The minimum TLS version required for traffic to the domain. The policy can be one of the following values:.

• Policy-Min-TLS-1-0-2019-07: TLS security policy that supports TLS version 1.0 to TLS version 1.2
• Policy-Min-TLS-1-2-2019-07: TLS security policy that supports only TLS version 1.2
• Policy-Min-TLS-1-2-PFS-2023-10: TLS security policy that supports TLS version 1.2 to TLS version 1.3 with perfect forward secrecy cipher suites

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-domainendpointoptions.html#cfn-opensearchservice-domain-domainendpointoptions-tlssecuritypolicy

builder

@Stability(Stable)
static CfnDomain.DomainEndpointOptionsProperty.Builder builder()

Returns:

a CfnDomain.DomainEndpointOptionsProperty.Builder of CfnDomain.DomainEndpointOptionsProperty