Class DomainEndpointOptions
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<DomainEndpointOptions.Builder,
DomainEndpointOptions>
Options to configure a custom endpoint for an OpenSearch Service domain.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
The fully qualified URL for the custom endpoint.final String
The ARN for your security certificate, managed in Amazon Web Services Certificate Manager (ACM).final Boolean
Whether to enable a custom endpoint for the domain.final Boolean
True to require that all traffic to the domain arrive over HTTPS.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
static Class
<? extends DomainEndpointOptions.Builder> final TLSSecurityPolicy
Specify the TLS security policy to apply to the HTTPS endpoint of the domain.final String
Specify the TLS security policy to apply to the HTTPS endpoint of the domain.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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 returnTLSSecurityPolicy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtlsSecurityPolicyAsString()
.- 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:
-
-
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 returnTLSSecurityPolicy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtlsSecurityPolicyAsString()
.- 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:
-
-
customEndpointEnabled
Whether to enable a custom endpoint for the domain.
- Returns:
- Whether to enable a custom endpoint for the domain.
-
customEndpoint
The fully qualified URL for the custom endpoint.
- Returns:
- The fully qualified URL for the custom endpoint.
-
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<DomainEndpointOptions.Builder,
DomainEndpointOptions> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-