Class: Aws::ElasticsearchService::Types::ElasticsearchClusterConfig

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-elasticsearchservice/types.rb

Overview

Specifies the configuration for the domain cluster, such as the type and number of instances.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#cold_storage_optionsTypes::ColdStorageOptions

Specifies the ‘ColdStorageOptions` config for Elasticsearch Domain



2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
# File 'lib/aws-sdk-elasticsearchservice/types.rb', line 2019

class ElasticsearchClusterConfig < Struct.new(
  :instance_type,
  :instance_count,
  :dedicated_master_enabled,
  :zone_awareness_enabled,
  :zone_awareness_config,
  :dedicated_master_type,
  :dedicated_master_count,
  :warm_enabled,
  :warm_type,
  :warm_count,
  :cold_storage_options)
  SENSITIVE = []
  include Aws::Structure
end

#dedicated_master_countInteger

Total number of dedicated master nodes, active and on standby, for the cluster.

Returns:

  • (Integer)


2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
# File 'lib/aws-sdk-elasticsearchservice/types.rb', line 2019

class ElasticsearchClusterConfig < Struct.new(
  :instance_type,
  :instance_count,
  :dedicated_master_enabled,
  :zone_awareness_enabled,
  :zone_awareness_config,
  :dedicated_master_type,
  :dedicated_master_count,
  :warm_enabled,
  :warm_type,
  :warm_count,
  :cold_storage_options)
  SENSITIVE = []
  include Aws::Structure
end

#dedicated_master_enabledBoolean

A boolean value to indicate whether a dedicated master node is enabled. See [About Dedicated Master Nodes] for more information.

[1]: docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-managedomains.html#es-managedomains-dedicatedmasternodes

Returns:

  • (Boolean)


2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
# File 'lib/aws-sdk-elasticsearchservice/types.rb', line 2019

class ElasticsearchClusterConfig < Struct.new(
  :instance_type,
  :instance_count,
  :dedicated_master_enabled,
  :zone_awareness_enabled,
  :zone_awareness_config,
  :dedicated_master_type,
  :dedicated_master_count,
  :warm_enabled,
  :warm_type,
  :warm_count,
  :cold_storage_options)
  SENSITIVE = []
  include Aws::Structure
end

#dedicated_master_typeString

The instance type for a dedicated master node.

Returns:

  • (String)


2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
# File 'lib/aws-sdk-elasticsearchservice/types.rb', line 2019

class ElasticsearchClusterConfig < Struct.new(
  :instance_type,
  :instance_count,
  :dedicated_master_enabled,
  :zone_awareness_enabled,
  :zone_awareness_config,
  :dedicated_master_type,
  :dedicated_master_count,
  :warm_enabled,
  :warm_type,
  :warm_count,
  :cold_storage_options)
  SENSITIVE = []
  include Aws::Structure
end

#instance_countInteger

The number of instances in the specified domain cluster.

Returns:

  • (Integer)


2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
# File 'lib/aws-sdk-elasticsearchservice/types.rb', line 2019

class ElasticsearchClusterConfig < Struct.new(
  :instance_type,
  :instance_count,
  :dedicated_master_enabled,
  :zone_awareness_enabled,
  :zone_awareness_config,
  :dedicated_master_type,
  :dedicated_master_count,
  :warm_enabled,
  :warm_type,
  :warm_count,
  :cold_storage_options)
  SENSITIVE = []
  include Aws::Structure
end

#instance_typeString

The instance type for an Elasticsearch cluster. UltraWarm instance types are not supported for data instances.

Returns:

  • (String)


2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
# File 'lib/aws-sdk-elasticsearchservice/types.rb', line 2019

class ElasticsearchClusterConfig < Struct.new(
  :instance_type,
  :instance_count,
  :dedicated_master_enabled,
  :zone_awareness_enabled,
  :zone_awareness_config,
  :dedicated_master_type,
  :dedicated_master_count,
  :warm_enabled,
  :warm_type,
  :warm_count,
  :cold_storage_options)
  SENSITIVE = []
  include Aws::Structure
end

#warm_countInteger

The number of warm nodes in the cluster.

Returns:

  • (Integer)


2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
# File 'lib/aws-sdk-elasticsearchservice/types.rb', line 2019

class ElasticsearchClusterConfig < Struct.new(
  :instance_type,
  :instance_count,
  :dedicated_master_enabled,
  :zone_awareness_enabled,
  :zone_awareness_config,
  :dedicated_master_type,
  :dedicated_master_count,
  :warm_enabled,
  :warm_type,
  :warm_count,
  :cold_storage_options)
  SENSITIVE = []
  include Aws::Structure
end

#warm_enabledBoolean

True to enable warm storage.

Returns:

  • (Boolean)


2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
# File 'lib/aws-sdk-elasticsearchservice/types.rb', line 2019

class ElasticsearchClusterConfig < Struct.new(
  :instance_type,
  :instance_count,
  :dedicated_master_enabled,
  :zone_awareness_enabled,
  :zone_awareness_config,
  :dedicated_master_type,
  :dedicated_master_count,
  :warm_enabled,
  :warm_type,
  :warm_count,
  :cold_storage_options)
  SENSITIVE = []
  include Aws::Structure
end

#warm_typeString

The instance type for the Elasticsearch cluster’s warm nodes.

Returns:

  • (String)


2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
# File 'lib/aws-sdk-elasticsearchservice/types.rb', line 2019

class ElasticsearchClusterConfig < Struct.new(
  :instance_type,
  :instance_count,
  :dedicated_master_enabled,
  :zone_awareness_enabled,
  :zone_awareness_config,
  :dedicated_master_type,
  :dedicated_master_count,
  :warm_enabled,
  :warm_type,
  :warm_count,
  :cold_storage_options)
  SENSITIVE = []
  include Aws::Structure
end

#zone_awareness_configTypes::ZoneAwarenessConfig

Specifies the zone awareness configuration for a domain when zone awareness is enabled.



2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
# File 'lib/aws-sdk-elasticsearchservice/types.rb', line 2019

class ElasticsearchClusterConfig < Struct.new(
  :instance_type,
  :instance_count,
  :dedicated_master_enabled,
  :zone_awareness_enabled,
  :zone_awareness_config,
  :dedicated_master_type,
  :dedicated_master_count,
  :warm_enabled,
  :warm_type,
  :warm_count,
  :cold_storage_options)
  SENSITIVE = []
  include Aws::Structure
end

#zone_awareness_enabledBoolean

A boolean value to indicate whether zone awareness is enabled. See

About Zone Awareness][1

for more information.

[1]: docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-managedomains.html#es-managedomains-zoneawareness

Returns:

  • (Boolean)


2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
# File 'lib/aws-sdk-elasticsearchservice/types.rb', line 2019

class ElasticsearchClusterConfig < Struct.new(
  :instance_type,
  :instance_count,
  :dedicated_master_enabled,
  :zone_awareness_enabled,
  :zone_awareness_config,
  :dedicated_master_type,
  :dedicated_master_count,
  :warm_enabled,
  :warm_type,
  :warm_count,
  :cold_storage_options)
  SENSITIVE = []
  include Aws::Structure
end