AWS::OpenSearchService::Domain EncryptionAtRestOptions

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

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON


{
  "Enabled" : Boolean,
  "EncryptionMode" : String,
  "KmsKeyId" : String
}

YAML


  Enabled: Boolean
  EncryptionMode: String
  KmsKeyId: String

Properties

Enabled

Specify true to enable encryption at rest. Required if you enable fine-grained access control in AdvancedSecurityOptionsInput.

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.

Required: Conditional

Type: Boolean

Update requires: Some interruptions

EncryptionMode

The type of encryption at rest applied to the domain's data. Valid values are DISK and NATIVE. DISK is the default and uses volume-level encryption. NATIVE uses engine-native, index-level encryption and requires encryption at rest to be enabled and OpenSearch version 3.3 or later. After the mode is set to NATIVE, it can't be changed back to DISK.

Required: No

Type: String

Allowed values: DISK | NATIVE

Update requires: No interruption

KmsKeyId

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

You can also use keyAlias as a value.

Required: Conditional

Type: String

Pattern: .*

Minimum: 1

Maximum: 500