software.amazon.awscdk.services.opensearchservice

Interface EncryptionAtRestOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

EncryptionAtRestOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.108Z")
 @Stability(value=Stable)
public interface EncryptionAtRestOptions
extends software.amazon.jsii.JsiiSerializable

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 or OpenSearch version 1.0 or later.

Example:

 Domain domain = Domain.Builder.create(this, "Domain")
         .version(EngineVersion.OPENSEARCH_1_0)
         .enforceHttps(true)
         .nodeToNodeEncryption(true)
         .encryptionAtRest(EncryptionAtRestOptions.builder()
                 .enabled(true)
                 .build())
         .fineGrainedAccessControl(AdvancedSecurityOptions.builder()
                 .masterUserName("master-user")
                 .build())
         .logging(LoggingOptions.builder()
                 .auditLogEnabled(true)
                 .slowSearchLogEnabled(true)
                 .appLogEnabled(true)
                 .slowIndexLogEnabled(true)
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	EncryptionAtRestOptions.Builder A builder for EncryptionAtRestOptions
static class	EncryptionAtRestOptions.Jsii$Proxy An implementation for EncryptionAtRestOptions

Method Summary

Modifier and Type	Method and Description
static EncryptionAtRestOptions.Builder	builder()
default Boolean	getEnabled() Specify true to enable encryption at rest.
default IKey	getKmsKey() Supply if using KMS key for encryption at rest.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getEnabled

@Stability(value=Stable)
 @Nullable
default Boolean getEnabled()

Specify true to enable encryption at rest.

Default: - encryption at rest is disabled.

getKmsKey

@Stability(value=Stable)
 @Nullable
default IKey getKmsKey()

Supply if using KMS key for encryption at rest.

Default: - uses default aws/es KMS key.

builder

@Stability(value=Stable)
static EncryptionAtRestOptions.Builder builder()

Returns:

a EncryptionAtRestOptions.Builder of EncryptionAtRestOptions