Class CfnDomain.EncryptionAtRestOptionsProperty
Whether the domain should encrypt data at rest, and if so, the AWS Key Management Service key to use.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.OpenSearchService
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class EncryptionAtRestOptionsProperty : Object, CfnDomain.IEncryptionAtRestOptionsProperty
Syntax (vb)
Public Class EncryptionAtRestOptionsProperty
Inherits Object
Implements CfnDomain.IEncryptionAtRestOptionsProperty
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.OpenSearchService;
var encryptionAtRestOptionsProperty = new EncryptionAtRestOptionsProperty {
Enabled = false,
KmsKeyId = "kmsKeyId"
};
Synopsis
Constructors
EncryptionAtRestOptionsProperty() |
Properties
Enabled | Specify |
KmsKeyId | The KMS key ID. Takes the form |
Constructors
EncryptionAtRestOptionsProperty()
public EncryptionAtRestOptionsProperty()
Properties
Enabled
Specify true
to enable encryption at rest. Required if you enable fine-grained access control in AdvancedSecurityOptionsInput .
public object Enabled { get; set; }
Property Value
System.Object
Remarks
If no encryption at rest options were initially specified in the template, updating this property by adding it causes no interruption. However, if you change this property after it's already been set within a template, the domain is deleted and recreated in order to modify the property.
KmsKeyId
The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a
. Required if you enable encryption at rest.
public string KmsKeyId { get; set; }
Property Value
System.String
Remarks
You can also use keyAlias
as a value.
If no encryption at rest options were initially specified in the template, updating this property by adding it causes no interruption. However, if you change this property after it's already been set within a template, the domain is deleted and recreated in order to modify the property.