Show / Hide Table of Contents

Interface IEncryptionAtRestOptions

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

Namespace: Amazon.CDK.AWS.Elasticsearch
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
[Obsolete("use opensearchservice module instead")]
public interface IEncryptionAtRestOptions
Syntax (vb)
<Obsolete("use opensearchservice module instead")>
Public Interface IEncryptionAtRestOptions
Remarks

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

Stability: Deprecated

ExampleMetadata: infused

Examples
var domain = new Domain(this, "Domain", new DomainProps {
                 Version = ElasticsearchVersion.V7_1,
                 EnforceHttps = true,
                 NodeToNodeEncryption = true,
                 EncryptionAtRest = new EncryptionAtRestOptions {
                     Enabled = true
                 },
                 FineGrainedAccessControl = new AdvancedSecurityOptions {
                     MasterUserName = "master-user"
                 }
             });

             var masterUserPassword = domain.MasterUserPassword;

Synopsis

Properties

Enabled

(deprecated) Specify true to enable encryption at rest.

KmsKey

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

Properties

Enabled

(deprecated) Specify true to enable encryption at rest.

[Obsolete("use opensearchservice module instead")]
bool? Enabled { get; }
Property Value

bool?

Remarks

Default: - encryption at rest is disabled.

Stability: Deprecated

KmsKey

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

[Obsolete("use opensearchservice module instead")]
IKeyRef? KmsKey { get; }
Property Value

IKeyRef

Remarks

Default: - uses default aws/es KMS key.

Stability: Deprecated

Back to top Generated by DocFX