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

Class EncryptionAtRestOptions

java.lang.Object

software.amazon.awssdk.services.opensearch.model.EncryptionAtRestOptions

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<EncryptionAtRestOptions.Builder,EncryptionAtRestOptions>

@Generated("software.amazon.awssdk:codegen")
public final class EncryptionAtRestOptions
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<EncryptionAtRestOptions.Builder,EncryptionAtRestOptions>

Specifies whether the domain should encrypt data at rest, and if so, the Key Management Service (KMS) key to use. Can only be used when creating a new domain or enabling encryption at rest for the first time on an existing domain. You can't modify this parameter after it's already been specified.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	EncryptionAtRestOptions.Builder

Method Summary

Modifier and Type	Method	Description
static EncryptionAtRestOptions.Builder	builder()
final Boolean	enabled()	True to enable encryption at rest.
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final String	kmsKeyId()	The KMS key ID.
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends EncryptionAtRestOptions.Builder>	serializableBuilderClass()
EncryptionAtRestOptions.Builder	toBuilder()
final String	toString()	Returns a string representation of this object.

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 Details

enabled

public final Boolean enabled()

True to enable encryption at rest.

Returns:

True to enable encryption at rest.

kmsKeyId

public final String kmsKeyId()

The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a.

Returns:

The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a.

toBuilder

public EncryptionAtRestOptions.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<EncryptionAtRestOptions.Builder,EncryptionAtRestOptions>

builder

public static EncryptionAtRestOptions.Builder builder()

serializableBuilderClass

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