software.amazon.awscdk.services.elasticsearch

Interface CfnDomain.EncryptionAtRestOptionsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDomain.EncryptionAtRestOptionsProperty.Jsii$Proxy

Enclosing class:

CfnDomain

@Stability(value=Stable)
public static interface CfnDomain.EncryptionAtRestOptionsProperty
extends software.amazon.jsii.JsiiSerializable

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

The AWS::Elasticsearch::Domain resource is being replaced by the AWS::OpenSearchService::Domain resource. While the legacy Elasticsearch resource and options are still supported, we recommend modifying your existing Cloudformation templates to use the new OpenSearch Service resource, which supports both OpenSearch and Elasticsearch. For more information about the service rename, see New resource types in the Amazon OpenSearch Service Developer Guide .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.elasticsearch.*;
 EncryptionAtRestOptionsProperty encryptionAtRestOptionsProperty = EncryptionAtRestOptionsProperty.builder()
         .enabled(false)
         .kmsKeyId("kmsKeyId")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnDomain.EncryptionAtRestOptionsProperty.Builder	builder()
default Object	getEnabled() Specify `true` to enable encryption at rest.
default String	getKmsKeyId() The KMS key ID.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getEnabled

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

Specify `true` to enable encryption at rest.

getKmsKeyId

@Stability(value=Stable)
 @Nullable
default String getKmsKeyId()

The KMS key ID.

Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a . Required if you enable encryption at rest.

builder

@Stability(value=Stable)
static CfnDomain.EncryptionAtRestOptionsProperty.Builder builder()

Returns:

a CfnDomain.EncryptionAtRestOptionsProperty.Builder of CfnDomain.EncryptionAtRestOptionsProperty