Interface EncryptionAtRestOptions.Builder

All Superinterfaces:

Buildable, CopyableBuilder<EncryptionAtRestOptions.Builder,EncryptionAtRestOptions>, SdkBuilder<EncryptionAtRestOptions.Builder,EncryptionAtRestOptions>, SdkPojo

Enclosing class:

EncryptionAtRestOptions

@Mutable
@NotThreadSafe
public static interface EncryptionAtRestOptions.Builder
extends SdkPojo, CopyableBuilder<EncryptionAtRestOptions.Builder,EncryptionAtRestOptions>

Method Summary

Modifier and Type	Method	Description
EncryptionAtRestOptions.Builder	enabled(Boolean enabled)	True to enable encryption at rest.
EncryptionAtRestOptions.Builder	encryptionMode(String encryptionMode)	The type of encryption at rest applied to the domain's data.
EncryptionAtRestOptions.Builder	encryptionMode(EncryptionMode encryptionMode)	The type of encryption at rest applied to the domain's data.
EncryptionAtRestOptions.Builder	kmsKeyId(String kmsKeyId)	The KMS key ID.

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

enabled

EncryptionAtRestOptions.Builder enabled(Boolean enabled)

True to enable encryption at rest.

Parameters:

enabled - True to enable encryption at rest.

Returns:

Returns a reference to this object so that method calls can be chained together.

kmsKeyId

EncryptionAtRestOptions.Builder kmsKeyId(String kmsKeyId)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

encryptionMode

EncryptionAtRestOptions.Builder encryptionMode(String encryptionMode)

The type of encryption at rest applied to the domain's data. Valid values are DISK and NATIVE. DISK is the default and uses volume-level encryption. NATIVE uses engine-native, index-level encryption and requires encryption at rest to be enabled and OpenSearch version 3.3 or later. After the mode is set to NATIVE, it can't be changed back to DISK.

Parameters:

encryptionMode - The type of encryption at rest applied to the domain's data. Valid values are DISK and NATIVE. DISK is the default and uses volume-level encryption. NATIVE uses engine-native, index-level encryption and requires encryption at rest to be enabled and OpenSearch version 3.3 or later. After the mode is set to NATIVE, it can't be changed back to DISK.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• EncryptionMode
• EncryptionMode

encryptionMode

EncryptionAtRestOptions.Builder encryptionMode(EncryptionMode encryptionMode)

The type of encryption at rest applied to the domain's data. Valid values are DISK and NATIVE. DISK is the default and uses volume-level encryption. NATIVE uses engine-native, index-level encryption and requires encryption at rest to be enabled and OpenSearch version 3.3 or later. After the mode is set to NATIVE, it can't be changed back to DISK.

Parameters:

encryptionMode - The type of encryption at rest applied to the domain's data. Valid values are DISK and NATIVE. DISK is the default and uses volume-level encryption. NATIVE uses engine-native, index-level encryption and requires encryption at rest to be enabled and OpenSearch version 3.3 or later. After the mode is set to NATIVE, it can't be changed back to DISK.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• EncryptionMode
• EncryptionMode