java.lang.Object
- software.amazon.awssdk.services.opensearch.model.DomainEndpointOptions

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<DomainEndpointOptions.Builder,DomainEndpointOptions>
```
@Generated("software.amazon.awssdk:codegen")
public final class DomainEndpointOptions
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DomainEndpointOptions.Builder,DomainEndpointOptions>
```
Options to configure a custom endpoint for an OpenSearch Service domain.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface DomainEndpointOptions.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static DomainEndpointOptions.Builder`	`builder()`
`String`	`customEndpoint()`	The fully qualified URL for the custom endpoint.
`String`	`customEndpointCertificateArn()`	The ARN for your security certificate, managed in Amazon Web Services Certificate Manager (ACM).
`Boolean`	`customEndpointEnabled()`	Whether to enable a custom endpoint for the domain.
`Boolean`	`enforceHTTPS()`	True to require that all traffic to the domain arrive over HTTPS.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DomainEndpointOptions.Builder>`	`serializableBuilderClass()`
`TLSSecurityPolicy`	`tlsSecurityPolicy()`	Specify the TLS security policy to apply to the HTTPS endpoint of the domain.
`String`	`tlsSecurityPolicyAsString()`	Specify the TLS security policy to apply to the HTTPS endpoint of the domain.
`DomainEndpointOptions.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - enforceHTTPS
```
public final Boolean enforceHTTPS()
```
    True to require that all traffic to the domain arrive over HTTPS.
    
    Returns:
    
    True to require that all traffic to the domain arrive over HTTPS.
  - tlsSecurityPolicy
```
public final TLSSecurityPolicy tlsSecurityPolicy()
```
    Specify the TLS security policy to apply to the HTTPS endpoint of 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
    
    If the service returns an enum value that is not available in the current SDK version, tlsSecurityPolicy will return TLSSecurityPolicy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from tlsSecurityPolicyAsString().
    Returns:
    
    Specify the TLS security policy to apply to the HTTPS endpoint of 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:
    
    TLSSecurityPolicy
  - tlsSecurityPolicyAsString
```
public final String tlsSecurityPolicyAsString()
```
    Specify the TLS security policy to apply to the HTTPS endpoint of 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
    
    If the service returns an enum value that is not available in the current SDK version, tlsSecurityPolicy will return TLSSecurityPolicy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from tlsSecurityPolicyAsString().
    Returns:
    
    Specify the TLS security policy to apply to the HTTPS endpoint of 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:
    
    TLSSecurityPolicy
  - customEndpointEnabled
```
public final Boolean customEndpointEnabled()
```
    Whether to enable a custom endpoint for the domain.
    
    Returns:
    
    Whether to enable a custom endpoint for the domain.
  - customEndpoint
```
public final String customEndpoint()
```
    The fully qualified URL for the custom endpoint.
    
    Returns:
    
    The fully qualified URL for the custom endpoint.
  - customEndpointCertificateArn
```
public final String customEndpointCertificateArn()
```
    The ARN for your security certificate, managed in Amazon Web Services Certificate Manager (ACM).
    
    Returns:
    
    The ARN for your security certificate, managed in Amazon Web Services Certificate Manager (ACM).
  - toBuilder
```
public DomainEndpointOptions.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DomainEndpointOptions.Builder,DomainEndpointOptions>
  - builder
```
public static DomainEndpointOptions.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DomainEndpointOptions.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class DomainEndpointOptions

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

enforceHTTPS

tlsSecurityPolicy

tlsSecurityPolicyAsString

customEndpointEnabled

customEndpoint

customEndpointCertificateArn

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField