Class EncryptionAtRestOptions

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

Inheritance

object

EncryptionAtRestOptions

Implements

IEncryptionAtRestOptions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.Elasticsearch

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class EncryptionAtRestOptions : IEncryptionAtRestOptions

Syntax (vb)

Public Class EncryptionAtRestOptions Implements 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

Constructors

EncryptionAtRestOptions()

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

Properties

Enabled	(deprecated) Specify true to enable encryption at rest.
KmsKey	(deprecated) Supply if using KMS key for encryption at rest.

Constructors

EncryptionAtRestOptions()

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

public EncryptionAtRestOptions()

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;

Properties

Enabled

(deprecated) Specify true to enable encryption at rest.

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

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")]
public IKey? KmsKey { get; set; }

Property Value

IKey

Remarks

Default: - uses default aws/es KMS key.

Stability: Deprecated

Implements

IEncryptionAtRestOptions