Class: AWSCDK::Elasticsearch::EbsOptions Deprecated

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
elasticsearch/ebs_options.rb

Overview

Deprecated.

use opensearchservice module instead

The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the Amazon ES domain.

For more information, see Configuring EBS-based Storage in the Amazon Elasticsearch Service Developer Guide.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(enabled: nil, iops: nil, volume_size: nil, volume_type: nil) ⇒ EbsOptions

Returns a new instance of EbsOptions.

Parameters:

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

    Specifies whether Amazon EBS volumes are attached to data nodes in the Amazon ES domain.

  • iops (Numeric, nil) (defaults to: nil) —

    The number of I/O operations per second (IOPS) that the volume supports.

  • volume_size (Numeric, nil) (defaults to: nil) —

    The size (in GiB) of the EBS volume for each data node.

  • volume_type (AWSCDK::EC2::EbsDeviceVolumeType, nil) (defaults to: nil) —

    The EBS volume type to use with the Amazon ES domain, such as standard, gp2, io1.



18
19
20
21
22
23
24
25
26
27
 
# File 'elasticsearch/ebs_options.rb', line 18

def initialize(enabled: nil, iops: nil, volume_size: nil, volume_type: nil)
  @enabled = enabled
  Jsii::Type.check_type(@enabled, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "enabled") unless @enabled.nil?
  @iops = iops
  Jsii::Type.check_type(@iops, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "iops") unless @iops.nil?
  @volume_size = volume_size
  Jsii::Type.check_type(@volume_size, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "volumeSize") unless @volume_size.nil?
  @volume_type = volume_type
  Jsii::Type.check_type(@volume_type, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLkVic0RldmljZVZvbHVtZVR5cGUifQ==")), "volumeType") unless @volume_type.nil?
end

Instance Attribute Details

#enabled ⇒ Boolean? (readonly)

Deprecated.

use opensearchservice module instead

Note:

Default: - true

Specifies whether Amazon EBS volumes are attached to data nodes in the Amazon ES domain.

Returns:

  • (Boolean, nil) 


34
35
36
 
# File 'elasticsearch/ebs_options.rb', line 34

def enabled
  @enabled
end

#iops ⇒ Numeric? (readonly)

Deprecated.

use opensearchservice module instead

Note:

Default: - iops are not set.

The number of I/O operations per second (IOPS) that the volume supports.

This property applies only to the Provisioned IOPS (SSD) EBS volume type.

Returns:

  • (Numeric, nil) 


43
44
45
 
# File 'elasticsearch/ebs_options.rb', line 43

def iops
  @iops
end

#volume_size ⇒ Numeric? (readonly)

Deprecated.

use opensearchservice module instead

Note:

Default: 10

The size (in GiB) of the EBS volume for each data node.

The minimum and maximum size of an EBS volume depends on the EBS volume type and the instance type to which it is attached. For more information, see Configuring EBS-based Storage in the Amazon Elasticsearch Service Developer Guide.

Returns:

  • (Numeric, nil) 


56
57
58
 
# File 'elasticsearch/ebs_options.rb', line 56

def volume_size
  @volume_size
end

#volume_type ⇒ AWSCDK::EC2::EbsDeviceVolumeType? (readonly)

Deprecated.

use opensearchservice module instead

Note:

Default: gp2

The EBS volume type to use with the Amazon ES domain, such as standard, gp2, io1.

For more information, seeConfiguring EBS-based Storage in the Amazon Elasticsearch Service Developer Guide.

Returns:



66
67
68
 
# File 'elasticsearch/ebs_options.rb', line 66

def volume_type
  @volume_type
end

Class Method Details

.jsii_properties ⇒ Object 



68
69
70
71
72
73
74
75
 
# File 'elasticsearch/ebs_options.rb', line 68

def self.jsii_properties
  {
    :enabled => "enabled",
    :iops => "iops",
    :volume_size => "volumeSize",
    :volume_type => "volumeType",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



77
78
79
80
81
82
83
84
85
86
 
# File 'elasticsearch/ebs_options.rb', line 77

def to_jsii
  result = {}
  result.merge!({
    "enabled" => @enabled,
    "iops" => @iops,
    "volumeSize" => @volume_size,
    "volumeType" => @volume_type,
  })
  result.compact
end