Class: AWSCDK::Elasticsearch::CfnDomain::EncryptionAtRestOptionsProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Elasticsearch::CfnDomain::EncryptionAtRestOptionsProperty

Defined in:

elasticsearch/cfn_domain.rb

Overview

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

The AWS::Elasticsearch::Domain resource is being replaced by the AWS::OpenSearchService::Domain resource. While the legacy Elasticsearch resource and options are still supported, we recommend modifying your existing Cloudformation templates to use the new OpenSearch Service resource, which supports both OpenSearch and Elasticsearch. For more information about the service rename, see New resource types in the Amazon OpenSearch Service Developer Guide .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-encryptionatrestoptions.html

Instance Attribute Summary

• #enabled ⇒ Boolean, ... readonly

  Specify true to enable encryption at rest.

• #kms_key_id ⇒ String^? readonly

  The KMS key ID.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(enabled: nil, kms_key_id: nil) ⇒ EncryptionAtRestOptionsProperty constructor

  A new instance of EncryptionAtRestOptionsProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(enabled: nil, kms_key_id: nil) ⇒ EncryptionAtRestOptionsProperty

Returns a new instance of EncryptionAtRestOptionsProperty.

Parameters:

• enabled (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

  Specify true to enable encryption at rest.

• kms_key_id (String, nil) (defaults to: nil) —

  The KMS key ID.

# File 'elasticsearch/cfn_domain.rb', line 1247

def initialize(enabled: nil, kms_key_id: nil)
  @enabled = enabled
  Jsii::Type.check_type(@enabled, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "enabled") unless @enabled.nil?
  @kms_key_id = kms_key_id
  Jsii::Type.check_type(@kms_key_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "kmsKeyId") unless @kms_key_id.nil?
end

Instance Attribute Details

#enabled ⇒ Boolean, ... (readonly)

Specify true to enable encryption at rest.

Returns:

• (Boolean, AWSCDK::IResolvable, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-encryptionatrestoptions.html#cfn-elasticsearch-domain-encryptionatrestoptions-enabled

# File 'elasticsearch/cfn_domain.rb', line 1258

def enabled
  @enabled
end

#kms_key_id ⇒ String^? (readonly)

The KMS key ID.

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

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-encryptionatrestoptions.html#cfn-elasticsearch-domain-encryptionatrestoptions-kmskeyid

# File 'elasticsearch/cfn_domain.rb', line 1265

def kms_key_id
  @kms_key_id
end

Class Method Details

.jsii_properties ⇒ Object

# File 'elasticsearch/cfn_domain.rb', line 1267

def self.jsii_properties
  {
    :enabled => "enabled",
    :kms_key_id => "kmsKeyId",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'elasticsearch/cfn_domain.rb', line 1274

def to_jsii
  result = {}
  result.merge!({
    "enabled" => @enabled,
    "kmsKeyId" => @kms_key_id,
  })
  result.compact
end