Class ElasticsearchDomainConfig

java.lang.Object
software.amazon.awssdk.services.elasticsearch.model.ElasticsearchDomainConfig
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ElasticsearchDomainConfig.Builder,ElasticsearchDomainConfig>
@Generated("software.amazon.awssdk:codegen") public final class ElasticsearchDomainConfig extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ElasticsearchDomainConfig.Builder,ElasticsearchDomainConfig>

The configuration of an Elasticsearch domain.

See Also:

  • Method Details

    • elasticsearchVersion

      public final ElasticsearchVersionStatus elasticsearchVersion()

      String of format X.Y to specify version for the Elasticsearch domain.

      Returns:
      String of format X.Y to specify version for the Elasticsearch domain.

    • elasticsearchClusterConfig

      public final ElasticsearchClusterConfigStatus elasticsearchClusterConfig()

      Specifies the ElasticsearchClusterConfig for the Elasticsearch domain.

      Returns:
      Specifies the ElasticsearchClusterConfig for the Elasticsearch domain.

    • ebsOptions

      public final EBSOptionsStatus ebsOptions()

      Specifies the EBSOptions for the Elasticsearch domain.

      Returns:
      Specifies the EBSOptions for the Elasticsearch domain.

    • accessPolicies

      public final AccessPoliciesStatus accessPolicies()

      IAM access policy as a JSON-formatted string.

      Returns:
      IAM access policy as a JSON-formatted string.

    • snapshotOptions

      public final SnapshotOptionsStatus snapshotOptions()

      Specifies the SnapshotOptions for the Elasticsearch domain.

      Returns:
      Specifies the SnapshotOptions for the Elasticsearch domain.

    • vpcOptions

      public final VPCDerivedInfoStatus vpcOptions()

      The VPCOptions for the specified domain. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains.

      Returns:
      The VPCOptions for the specified domain. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains.

    • cognitoOptions

      public final CognitoOptionsStatus cognitoOptions()

      The CognitoOptions for the specified domain. For more information, see Amazon Cognito Authentication for Kibana.

      Returns:
      The CognitoOptions for the specified domain. For more information, see Amazon Cognito Authentication for Kibana.

    • encryptionAtRestOptions

      public final EncryptionAtRestOptionsStatus encryptionAtRestOptions()

      Specifies the EncryptionAtRestOptions for the Elasticsearch domain.

      Returns:
      Specifies the EncryptionAtRestOptions for the Elasticsearch domain.

    • nodeToNodeEncryptionOptions

      public final NodeToNodeEncryptionOptionsStatus nodeToNodeEncryptionOptions()

      Specifies the NodeToNodeEncryptionOptions for the Elasticsearch domain.

      Returns:
      Specifies the NodeToNodeEncryptionOptions for the Elasticsearch domain.

    • advancedOptions

      public final AdvancedOptionsStatus advancedOptions()

      Specifies the AdvancedOptions for the domain. See Configuring Advanced Options for more information.

      Returns:
      Specifies the AdvancedOptions for the domain. See Configuring Advanced Options for more information.

    • logPublishingOptions

      public final LogPublishingOptionsStatus logPublishingOptions()

      Log publishing options for the given domain.

      Returns:
      Log publishing options for the given domain.

    • domainEndpointOptions

      public final DomainEndpointOptionsStatus domainEndpointOptions()

      Specifies the DomainEndpointOptions for the Elasticsearch domain.

      Returns:
      Specifies the DomainEndpointOptions for the Elasticsearch domain.

    • advancedSecurityOptions

      public final AdvancedSecurityOptionsStatus advancedSecurityOptions()

      Specifies AdvancedSecurityOptions for the domain.

      Returns:
      Specifies AdvancedSecurityOptions for the domain.

    • autoTuneOptions

      public final AutoTuneOptionsStatus autoTuneOptions()

      Specifies AutoTuneOptions for the domain.

      Returns:
      Specifies AutoTuneOptions for the domain.

    • changeProgressDetails

      public final ChangeProgressDetails changeProgressDetails()

      Specifies change details of the domain configuration change.

      Returns:
      Specifies change details of the domain configuration change.

    • hasModifyingProperties

      public final boolean hasModifyingProperties()
      For responses, this returns true if the service returned a value for the ModifyingProperties property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

    • modifyingProperties

      public final List<ModifyingProperties> modifyingProperties()

      Information about the domain properties that are currently being modified.

      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 hasModifyingProperties() method.

      Returns:
      Information about the domain properties that are currently being modified.

    • toBuilder

      public ElasticsearchDomainConfig.Builder 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 interface ToCopyableBuilder<ElasticsearchDomainConfig.Builder,ElasticsearchDomainConfig>
      Returns:
      a builder for type T

    • builder

      public static ElasticsearchDomainConfig.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ElasticsearchDomainConfig.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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.