Class AwsElasticsearchDomainDetails
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<AwsElasticsearchDomainDetails.Builder,
AwsElasticsearchDomainDetails>
Information about an Elasticsearch domain.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
IAM policy document specifying the access policies for the new Elasticsearch domain.builder()
Additional options for the domain endpoint.final String
domainId()
Unique identifier for an Elasticsearch domain.final String
Name of an Elasticsearch domain.Information about an OpenSearch cluster configuration.final String
OpenSearch version.Details about the configuration for encryption at rest.final String
endpoint()
Domain-specific endpoint used to submit index, search, and data upload requests to an Elasticsearch domain.The key-value pair that exists if the Elasticsearch domain uses VPC endpoints.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 boolean
For responses, this returns true if the service returned a value for the Endpoints property.final int
hashCode()
Configures the CloudWatch Logs to publish for the Elasticsearch domain.Details about the configuration for node-to-node encryption.static Class
<? extends AwsElasticsearchDomainDetails.Builder> Information about the status of a domain relative to the latest service software.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.Information that OpenSearch derives based onVPCOptions
for the domain.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
accessPolicies
IAM policy document specifying the access policies for the new Elasticsearch domain.
- Returns:
- IAM policy document specifying the access policies for the new Elasticsearch domain.
-
domainEndpointOptions
Additional options for the domain endpoint.
- Returns:
- Additional options for the domain endpoint.
-
domainId
Unique identifier for an Elasticsearch domain.
- Returns:
- Unique identifier for an Elasticsearch domain.
-
domainName
Name of an Elasticsearch domain.
Domain names are unique across all domains owned by the same account within an Amazon Web Services Region.
Domain names must start with a lowercase letter and must be between 3 and 28 characters.
Valid characters are a-z (lowercase only), 0-9, and – (hyphen).
- Returns:
- Name of an Elasticsearch domain.
Domain names are unique across all domains owned by the same account within an Amazon Web Services Region.
Domain names must start with a lowercase letter and must be between 3 and 28 characters.
Valid characters are a-z (lowercase only), 0-9, and – (hyphen).
-
endpoint
Domain-specific endpoint used to submit index, search, and data upload requests to an Elasticsearch domain.
The endpoint is a service URL.
- Returns:
- Domain-specific endpoint used to submit index, search, and data upload requests to an Elasticsearch
domain.
The endpoint is a service URL.
-
hasEndpoints
public final boolean hasEndpoints()For responses, this returns true if the service returned a value for the Endpoints property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
endpoints
The key-value pair that exists if the Elasticsearch domain uses VPC endpoints.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasEndpoints()
method.- Returns:
- The key-value pair that exists if the Elasticsearch domain uses VPC endpoints.
-
elasticsearchVersion
OpenSearch version.
- Returns:
- OpenSearch version.
-
elasticsearchClusterConfig
Information about an OpenSearch cluster configuration.
- Returns:
- Information about an OpenSearch cluster configuration.
-
encryptionAtRestOptions
Details about the configuration for encryption at rest.
- Returns:
- Details about the configuration for encryption at rest.
-
logPublishingOptions
Configures the CloudWatch Logs to publish for the Elasticsearch domain.
- Returns:
- Configures the CloudWatch Logs to publish for the Elasticsearch domain.
-
nodeToNodeEncryptionOptions
Details about the configuration for node-to-node encryption.
- Returns:
- Details about the configuration for node-to-node encryption.
-
serviceSoftwareOptions
Information about the status of a domain relative to the latest service software.
- Returns:
- Information about the status of a domain relative to the latest service software.
-
vpcOptions
Information that OpenSearch derives based on
VPCOptions
for the domain.- Returns:
- Information that OpenSearch derives based on
VPCOptions
for the domain.
-
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<AwsElasticsearchDomainDetails.Builder,
AwsElasticsearchDomainDetails> - 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
-