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(value="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 and Description
static interface	DomainConfig.Builder

Method Summary

Modifier and Type	Method and 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.
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 an OpenSearch Service 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()
LogPublishingOptionsStatus	logPublishingOptions() Key-value pairs to configure slow log publishing.
NodeToNodeEncryptionOptionsStatus	nodeToNodeEncryptionOptions() Whether node-to-node encryption is enabled or disabled.
List<SdkField<?>>	sdkFields()
static Class<? extends DomainConfig.Builder>	serializableBuilderClass()
SnapshotOptionsStatus	snapshotOptions() DEPRECATED.
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 an OpenSearch Service domain.

Returns:

Container for EBS options configured for an OpenSearch Service domain.

accessPolicies

public final AccessPoliciesStatus accessPolicies()

Specifies the access policies for the domain.

Returns:

Specifies the access policies 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 slow log publishing.

Returns:

Key-value pairs to configure slow 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.

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