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

Class DomainConfig

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

Container for the configuration of an OpenSearch Service domain.

See Also:

  • Method Details

    • engineVersion

      public final VersionStatus engineVersion()

      The OpenSearch or Elasticsearch version that the domain is running.

      Returns:
      The OpenSearch or Elasticsearch version that the domain is running.

    • clusterConfig

      public final ClusterConfigStatus clusterConfig()

      Container for the cluster configuration of a the domain.

      Returns:
      Container for the cluster configuration of a the domain.

    • ebsOptions

      public final EBSOptionsStatus ebsOptions()

      Container for EBS options configured for the domain.

      Returns:
      Container for EBS options configured for the domain.

    • accessPolicies

      public final AccessPoliciesStatus accessPolicies()

      Specifies the access policies for the domain.

      Returns:
      Specifies the access policies for the domain.

    • ipAddressType

      public final IPAddressTypeStatus ipAddressType()

      The type of IP addresses supported by the endpoint for the domain.

      Returns:
      The type of IP addresses supported by the endpoint for the domain.

    • snapshotOptions

      public final SnapshotOptionsStatus snapshotOptions()

      DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.

      Returns:
      DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.

    • vpcOptions

      public final VPCDerivedInfoStatus vpcOptions()

      The current VPC options for the domain and the status of any updates to their configuration.

      Returns:
      The current VPC options for the domain and the status of any updates to their configuration.

    • cognitoOptions

      public final CognitoOptionsStatus cognitoOptions()

      Container for Amazon Cognito options for the domain.

      Returns:
      Container for Amazon Cognito options for the domain.

    • encryptionAtRestOptions

      public final EncryptionAtRestOptionsStatus encryptionAtRestOptions()

      Key-value pairs to enable encryption at rest.

      Returns:
      Key-value pairs to enable encryption at rest.

    • nodeToNodeEncryptionOptions

      public final NodeToNodeEncryptionOptionsStatus nodeToNodeEncryptionOptions()

      Whether node-to-node encryption is enabled or disabled.

      Returns:
      Whether node-to-node encryption is enabled or disabled.

    • advancedOptions

      public final AdvancedOptionsStatus advancedOptions()

      Key-value pairs to specify advanced configuration options. For more information, see Advanced options.

      Returns:
      Key-value pairs to specify advanced configuration options. For more information, see Advanced options.

    • logPublishingOptions

      public final LogPublishingOptionsStatus logPublishingOptions()

      Key-value pairs to configure log publishing.

      Returns:
      Key-value pairs to configure log publishing.

    • domainEndpointOptions

      public final DomainEndpointOptionsStatus domainEndpointOptions()

      Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.

      Returns:
      Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.

    • advancedSecurityOptions

      public final AdvancedSecurityOptionsStatus advancedSecurityOptions()

      Container for fine-grained access control settings for the domain.

      Returns:
      Container for fine-grained access control settings for the domain.

    • autoTuneOptions

      public final AutoTuneOptionsStatus autoTuneOptions()

      Container for Auto-Tune settings for the domain.

      Returns:
      Container for Auto-Tune settings for the domain.

    • changeProgressDetails

      public final ChangeProgressDetails changeProgressDetails()

      Container for information about the progress of an existing configuration change.

      Returns:
      Container for information about the progress of an existing configuration change.

    • offPeakWindowOptions

      public final OffPeakWindowOptionsStatus offPeakWindowOptions()

      Container for off-peak window options for the domain.

      Returns:
      Container for off-peak window options for the domain.

    • softwareUpdateOptions

      public final SoftwareUpdateOptionsStatus softwareUpdateOptions()

      Software update options for the domain.

      Returns:
      Software update options for the domain.

    • toBuilder

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

    • builder

      public static DomainConfig.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DomainConfig.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.