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:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface DomainConfig.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`AccessPoliciesStatus`	`accessPolicies()`	Specifies the access policies for the domain.
`AdvancedOptionsStatus`	`advancedOptions()`	Key-value pairs to specify advanced configuration options.
`AdvancedSecurityOptionsStatus`	`advancedSecurityOptions()`	Container for fine-grained access control settings for the domain.
`AIMLOptionsStatus`	`aimlOptions()`	Container for parameters required to enable all machine learning features.
`AutoTuneOptionsStatus`	`autoTuneOptions()`	Container for Auto-Tune settings for the domain.
`static DomainConfig.Builder`	`builder()`
`ChangeProgressDetails`	`changeProgressDetails()`	Container for information about the progress of an existing configuration change.
`ClusterConfigStatus`	`clusterConfig()`	Container for the cluster configuration of a the domain.
`CognitoOptionsStatus`	`cognitoOptions()`	Container for Amazon Cognito options for the domain.
`DomainEndpointOptionsStatus`	`domainEndpointOptions()`	Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.
`EBSOptionsStatus`	`ebsOptions()`	Container for EBS options configured for the domain.
`EncryptionAtRestOptionsStatus`	`encryptionAtRestOptions()`	Key-value pairs to enable encryption at rest.
`VersionStatus`	`engineVersion()`	The OpenSearch or Elasticsearch version that the domain is running.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasModifyingProperties()`	For responses, this returns true if the service returned a value for the ModifyingProperties property.
`IdentityCenterOptionsStatus`	`identityCenterOptions()`	Configuration options for enabling and managing IAM Identity Center integration within a domain.
`IPAddressTypeStatus`	`ipAddressType()`	Choose either dual stack or IPv4 as your IP address type.
`LogPublishingOptionsStatus`	`logPublishingOptions()`	Key-value pairs to configure log publishing.
`List<ModifyingProperties>`	`modifyingProperties()`	Information about the domain properties that are currently being modified.
`NodeToNodeEncryptionOptionsStatus`	`nodeToNodeEncryptionOptions()`	Whether node-to-node encryption is enabled or disabled.
`OffPeakWindowOptionsStatus`	`offPeakWindowOptions()`	Container for off-peak window options for the domain.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DomainConfig.Builder>`	`serializableBuilderClass()`
`SnapshotOptionsStatus`	`snapshotOptions()`	DEPRECATED.
`SoftwareUpdateOptionsStatus`	`softwareUpdateOptions()`	Software update options for the domain.
`DomainConfig.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`VPCDerivedInfoStatus`	`vpcOptions()`	The current VPC options for the domain and the status of any updates to their configuration.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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()
```
    Choose either dual stack or IPv4 as your IP address type. Dual stack allows you to share domain resources across IPv4 and IPv6 address types, and is the recommended option. If you set your IP address type to dual stack, you can't change your address type later.
    
    Returns:
    
    Choose either dual stack or IPv4 as your IP address type. Dual stack allows you to share domain resources across IPv4 and IPv6 address types, and is the recommended option. If you set your IP address type to dual stack, you can't change your address type later.
  - 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.
  - identityCenterOptions
```
public final IdentityCenterOptionsStatus identityCenterOptions()
```
    Configuration options for enabling and managing IAM Identity Center integration within a domain.
    
    Returns:
    
    Configuration options for enabling and managing IAM Identity Center integration within a 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.
  - 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.
  - aimlOptions
```
public final AIMLOptionsStatus aimlOptions()
```
    Container for parameters required to enable all machine learning features.
    
    Returns:
    
    Container for parameters required to enable all machine learning features.
  - toBuilder
```
public DomainConfig.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DomainConfig.Builder,DomainConfig>
  - 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)
```
    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

Class DomainConfig

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

engineVersion

clusterConfig

ebsOptions

accessPolicies

ipAddressType

snapshotOptions

vpcOptions

cognitoOptions

encryptionAtRestOptions

nodeToNodeEncryptionOptions

advancedOptions

logPublishingOptions

domainEndpointOptions

advancedSecurityOptions

identityCenterOptions

autoTuneOptions

changeProgressDetails

offPeakWindowOptions

softwareUpdateOptions

hasModifyingProperties

modifyingProperties

aimlOptions

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField