Package software.amazon.awscdk.services.elasticsearch

Interface EncryptionAtRestOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

EncryptionAtRestOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-09-18T22:16:56.531Z")
@Stability(Deprecated)
@Deprecated
public interface EncryptionAtRestOptions
extends software.amazon.jsii.JsiiSerializable

Deprecated.

use opensearchservice module instead

(deprecated) Whether the domain should encrypt data at rest, and if so, the AWS Key Management Service (KMS) key to use.

Can only be used to create a new domain, not update an existing one. Requires Elasticsearch version 5.1 or later.

Example:

 Domain domain = Domain.Builder.create(this, "Domain")
         .version(ElasticsearchVersion.V7_1)
         .enforceHttps(true)
         .nodeToNodeEncryption(true)
         .encryptionAtRest(EncryptionAtRestOptions.builder()
                 .enabled(true)
                 .build())
         .fineGrainedAccessControl(AdvancedSecurityOptions.builder()
                 .masterUserName("master-user")
                 .build())
         .build();
 SecretValue masterUserPassword = domain.getMasterUserPassword();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	EncryptionAtRestOptions.Builder	Deprecated.
static final class	EncryptionAtRestOptions.Jsii$Proxy	Deprecated.

Method Summary

Modifier and Type	Method	Description
static EncryptionAtRestOptions.Builder	builder()	Deprecated.
default Boolean	getEnabled()	Deprecated. use opensearchservice module instead
default IKey	getKmsKey()	Deprecated. use opensearchservice module instead

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEnabled

@Stability(Deprecated)
@Deprecated
@Nullable
default Boolean getEnabled()

Deprecated.

use opensearchservice module instead

(deprecated) Specify true to enable encryption at rest.

Default: - encryption at rest is disabled.

getKmsKey

@Stability(Deprecated)
@Deprecated
@Nullable
default IKey getKmsKey()

Deprecated.

use opensearchservice module instead

(deprecated) Supply if using KMS key for encryption at rest.

Default: - uses default aws/es KMS key.

builder

@Stability(Deprecated)
@Deprecated
static EncryptionAtRestOptions.Builder builder()

Deprecated.

Returns:

a EncryptionAtRestOptions.Builder of EncryptionAtRestOptions