Class: AWSCDK::Elasticsearch::CapacityConfig Deprecated

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

Overview

Deprecated.

use opensearchservice module instead

Configures the capacity of the cluster such as the instance type and the number of instances.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(data_node_instance_type: nil, data_nodes: nil, master_node_instance_type: nil, master_nodes: nil, warm_instance_type: nil, warm_nodes: nil) ⇒ CapacityConfig

Returns a new instance of CapacityConfig.

Parameters:

  • data_node_instance_type (String, nil) (defaults to: nil)

    The instance type for your data nodes, such as m3.medium.elasticsearch. For valid values, see Supported Instance Types in the Amazon Elasticsearch Service Developer Guide.

  • data_nodes (Numeric, nil) (defaults to: nil)

    The number of data nodes (instances) to use in the Amazon ES domain.

  • master_node_instance_type (String, nil) (defaults to: nil)

    The hardware configuration of the computer that hosts the dedicated master node, such as m3.medium.elasticsearch. For valid values, see Supported Instance Types in the Amazon Elasticsearch Service Developer Guide.

  • master_nodes (Numeric, nil) (defaults to: nil)

    The number of instances to use for the master node.

  • warm_instance_type (String, nil) (defaults to: nil)

    The instance type for your UltraWarm node, such as ultrawarm1.medium.elasticsearch. For valid values, see UltraWarm Storage Limits in the Amazon Elasticsearch Service Developer Guide.

  • warm_nodes (Numeric, nil) (defaults to: nil)

    The number of UltraWarm nodes (instances) to use in the Amazon ES domain.



15
16
17
18
19
20
21
22
23
24
25
26
27
28
# File 'elasticsearch/capacity_config.rb', line 15

def initialize(data_node_instance_type: nil, data_nodes: nil, master_node_instance_type: nil, master_nodes: nil, warm_instance_type: nil, warm_nodes: nil)
  @data_node_instance_type = data_node_instance_type
  Jsii::Type.check_type(@data_node_instance_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dataNodeInstanceType") unless @data_node_instance_type.nil?
  @data_nodes = data_nodes
  Jsii::Type.check_type(@data_nodes, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "dataNodes") unless @data_nodes.nil?
  @master_node_instance_type = master_node_instance_type
  Jsii::Type.check_type(@master_node_instance_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "masterNodeInstanceType") unless @master_node_instance_type.nil?
  @master_nodes = master_nodes
  Jsii::Type.check_type(@master_nodes, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "masterNodes") unless @master_nodes.nil?
  @warm_instance_type = warm_instance_type
  Jsii::Type.check_type(@warm_instance_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "warmInstanceType") unless @warm_instance_type.nil?
  @warm_nodes = warm_nodes
  Jsii::Type.check_type(@warm_nodes, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "warmNodes") unless @warm_nodes.nil?
end

Instance Attribute Details

#data_node_instance_typeString? (readonly)

Deprecated.

use opensearchservice module instead

Note:

Default: - r5.large.elasticsearch

The instance type for your data nodes, such as m3.medium.elasticsearch. For valid values, see Supported Instance Types in the Amazon Elasticsearch Service Developer Guide.

Returns:

  • (String, nil)


35
36
37
# File 'elasticsearch/capacity_config.rb', line 35

def data_node_instance_type
  @data_node_instance_type
end

#data_nodesNumeric? (readonly)

Deprecated.

use opensearchservice module instead

Note:

Default: - 1

The number of data nodes (instances) to use in the Amazon ES domain.

Returns:

  • (Numeric, nil)


41
42
43
# File 'elasticsearch/capacity_config.rb', line 41

def data_nodes
  @data_nodes
end

#master_node_instance_typeString? (readonly)

Deprecated.

use opensearchservice module instead

Note:

Default: - r5.large.elasticsearch

The hardware configuration of the computer that hosts the dedicated master node, such as m3.medium.elasticsearch. For valid values, see Supported Instance Types in the Amazon Elasticsearch Service Developer Guide.

Returns:

  • (String, nil)


47
48
49
# File 'elasticsearch/capacity_config.rb', line 47

def master_node_instance_type
  @master_node_instance_type
end

#master_nodesNumeric? (readonly)

Deprecated.

use opensearchservice module instead

Note:

Default: - no dedicated master nodes

The number of instances to use for the master node.

Returns:

  • (Numeric, nil)


53
54
55
# File 'elasticsearch/capacity_config.rb', line 53

def master_nodes
  @master_nodes
end

#warm_instance_typeString? (readonly)

Deprecated.

use opensearchservice module instead

Note:

Default: - ultrawarm1.medium.elasticsearch

The instance type for your UltraWarm node, such as ultrawarm1.medium.elasticsearch. For valid values, see UltraWarm Storage Limits in the Amazon Elasticsearch Service Developer Guide.

Returns:

  • (String, nil)


59
60
61
# File 'elasticsearch/capacity_config.rb', line 59

def warm_instance_type
  @warm_instance_type
end

#warm_nodesNumeric? (readonly)

Deprecated.

use opensearchservice module instead

Note:

Default: - no UltraWarm nodes

The number of UltraWarm nodes (instances) to use in the Amazon ES domain.

Returns:

  • (Numeric, nil)


65
66
67
# File 'elasticsearch/capacity_config.rb', line 65

def warm_nodes
  @warm_nodes
end

Class Method Details

.jsii_propertiesObject



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

def self.jsii_properties
  {
    :data_node_instance_type => "dataNodeInstanceType",
    :data_nodes => "dataNodes",
    :master_node_instance_type => "masterNodeInstanceType",
    :master_nodes => "masterNodes",
    :warm_instance_type => "warmInstanceType",
    :warm_nodes => "warmNodes",
  }
end

Instance Method Details

#to_jsiiObject



78
79
80
81
82
83
84
85
86
87
88
89
# File 'elasticsearch/capacity_config.rb', line 78

def to_jsii
  result = {}
  result.merge!({
    "dataNodeInstanceType" => @data_node_instance_type,
    "dataNodes" => @data_nodes,
    "masterNodeInstanceType" => @master_node_instance_type,
    "masterNodes" => @master_nodes,
    "warmInstanceType" => @warm_instance_type,
    "warmNodes" => @warm_nodes,
  })
  result.compact
end