Skip to content

EncryptionAtRestOptions

Used by
Source code in docs_src/capo_opensearch/types/encryption_at_rest_options.py 
13
14
15
16
17
18
19
class EncryptionAtRestOptions(TypedDict, closed=True):
    enabled: NotRequired["capo_opensearch.types.boolean.Boolean"]
    """<p>True to enable encryption at rest.</p>"""
    kms_key_id: NotRequired["capo_opensearch.types.kms_key_id.KmsKeyId"]
    """<p>The KMS key ID. Takes the form <code>1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a</code>.</p>"""
    encryption_mode: NotRequired["capo_opensearch.types.encryption_mode.EncryptionMode"]
    """<p>The type of encryption at rest applied to the domain's data. Valid values are <code>DISK</code> and <code>NATIVE</code>. <code>DISK</code> is the default and uses volume-level encryption. <code>NATIVE</code> 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 <code>NATIVE</code>, it can't be changed back to <code>DISK</code>.</p>"""

enabled instance-attribute 

enabled: NotRequired[Boolean]

True to enable encryption at rest.

encryption_mode instance-attribute 

encryption_mode: NotRequired[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.

kms_key_id instance-attribute 

kms_key_id: NotRequired[KmsKeyId]

The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a.