Class: Aws::OpenSearchService::Types::EncryptionAtRestOptions

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb

Overview

Specifies whether the domain should encrypt data at rest, and if so, the Key Management Service (KMS) key to use. Can only be used when creating a new domain or enabling encryption at rest for the first time on an existing domain. You can't modify this parameter after it's already been specified.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#enabled ⇒ Boolean

True to enable encryption at rest.

Returns:

  • (Boolean) 


4762
4763
4764
4765
4766
4767
4768
 
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 4762

class EncryptionAtRestOptions < Struct.new(
  :enabled,
  :kms_key_id,
  :encryption_mode)
  SENSITIVE = []
  include Aws::Structure
end

#encryption_mode ⇒ String

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.

Returns:

  • (String) 


4762
4763
4764
4765
4766
4767
4768
 
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 4762

class EncryptionAtRestOptions < Struct.new(
  :enabled,
  :kms_key_id,
  :encryption_mode)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_id ⇒ String

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

Returns:

  • (String) 


4762
4763
4764
4765
4766
4767
4768
 
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 4762

class EncryptionAtRestOptions < Struct.new(
  :enabled,
  :kms_key_id,
  :encryption_mode)
  SENSITIVE = []
  include Aws::Structure
end