Package software.amazon.awssdk.services.opensearch.model

Class DomainEndpointOptions

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:

  • Method Details

    • 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

      • Policy-Min-TLS-1-2-RFC9151-FIPS-2024-08: TLS security policy that supports TLS version 1.3 with FIPS

      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

      • Policy-Min-TLS-1-2-RFC9151-FIPS-2024-08: TLS security policy that supports TLS version 1.3 with FIPS

      See Also:

    • 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

      • Policy-Min-TLS-1-2-RFC9151-FIPS-2024-08: TLS security policy that supports TLS version 1.3 with FIPS

      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

      • Policy-Min-TLS-1-2-RFC9151-FIPS-2024-08: TLS security policy that supports TLS version 1.3 with FIPS

      See Also:

    • 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