AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ElasticsearchClusterConfig as input to an Aws::Client method, you can use a vanilla Hash:

{
  instance_type: "m3.medium.elasticsearch", # accepts m3.medium.elasticsearch, m3.large.elasticsearch, m3.xlarge.elasticsearch, m3.2xlarge.elasticsearch, m4.large.elasticsearch, m4.xlarge.elasticsearch, m4.2xlarge.elasticsearch, m4.4xlarge.elasticsearch, m4.10xlarge.elasticsearch, m5.large.elasticsearch, m5.xlarge.elasticsearch, m5.2xlarge.elasticsearch, m5.4xlarge.elasticsearch, m5.12xlarge.elasticsearch, r5.large.elasticsearch, r5.xlarge.elasticsearch, r5.2xlarge.elasticsearch, r5.4xlarge.elasticsearch, r5.12xlarge.elasticsearch, c5.large.elasticsearch, c5.xlarge.elasticsearch, c5.2xlarge.elasticsearch, c5.4xlarge.elasticsearch, c5.9xlarge.elasticsearch, c5.18xlarge.elasticsearch, ultrawarm1.medium.elasticsearch, ultrawarm1.large.elasticsearch, t2.micro.elasticsearch, t2.small.elasticsearch, t2.medium.elasticsearch, r3.large.elasticsearch, r3.xlarge.elasticsearch, r3.2xlarge.elasticsearch, r3.4xlarge.elasticsearch, r3.8xlarge.elasticsearch, i2.xlarge.elasticsearch, i2.2xlarge.elasticsearch, d2.xlarge.elasticsearch, d2.2xlarge.elasticsearch, d2.4xlarge.elasticsearch, d2.8xlarge.elasticsearch, c4.large.elasticsearch, c4.xlarge.elasticsearch, c4.2xlarge.elasticsearch, c4.4xlarge.elasticsearch, c4.8xlarge.elasticsearch, r4.large.elasticsearch, r4.xlarge.elasticsearch, r4.2xlarge.elasticsearch, r4.4xlarge.elasticsearch, r4.8xlarge.elasticsearch, r4.16xlarge.elasticsearch, i3.large.elasticsearch, i3.xlarge.elasticsearch, i3.2xlarge.elasticsearch, i3.4xlarge.elasticsearch, i3.8xlarge.elasticsearch, i3.16xlarge.elasticsearch
  instance_count: 1,
  dedicated_master_enabled: false,
  zone_awareness_enabled: false,
  zone_awareness_config: {
    availability_zone_count: 1,
  },
  dedicated_master_type: "m3.medium.elasticsearch", # accepts m3.medium.elasticsearch, m3.large.elasticsearch, m3.xlarge.elasticsearch, m3.2xlarge.elasticsearch, m4.large.elasticsearch, m4.xlarge.elasticsearch, m4.2xlarge.elasticsearch, m4.4xlarge.elasticsearch, m4.10xlarge.elasticsearch, m5.large.elasticsearch, m5.xlarge.elasticsearch, m5.2xlarge.elasticsearch, m5.4xlarge.elasticsearch, m5.12xlarge.elasticsearch, r5.large.elasticsearch, r5.xlarge.elasticsearch, r5.2xlarge.elasticsearch, r5.4xlarge.elasticsearch, r5.12xlarge.elasticsearch, c5.large.elasticsearch, c5.xlarge.elasticsearch, c5.2xlarge.elasticsearch, c5.4xlarge.elasticsearch, c5.9xlarge.elasticsearch, c5.18xlarge.elasticsearch, ultrawarm1.medium.elasticsearch, ultrawarm1.large.elasticsearch, t2.micro.elasticsearch, t2.small.elasticsearch, t2.medium.elasticsearch, r3.large.elasticsearch, r3.xlarge.elasticsearch, r3.2xlarge.elasticsearch, r3.4xlarge.elasticsearch, r3.8xlarge.elasticsearch, i2.xlarge.elasticsearch, i2.2xlarge.elasticsearch, d2.xlarge.elasticsearch, d2.2xlarge.elasticsearch, d2.4xlarge.elasticsearch, d2.8xlarge.elasticsearch, c4.large.elasticsearch, c4.xlarge.elasticsearch, c4.2xlarge.elasticsearch, c4.4xlarge.elasticsearch, c4.8xlarge.elasticsearch, r4.large.elasticsearch, r4.xlarge.elasticsearch, r4.2xlarge.elasticsearch, r4.4xlarge.elasticsearch, r4.8xlarge.elasticsearch, r4.16xlarge.elasticsearch, i3.large.elasticsearch, i3.xlarge.elasticsearch, i3.2xlarge.elasticsearch, i3.4xlarge.elasticsearch, i3.8xlarge.elasticsearch, i3.16xlarge.elasticsearch
  dedicated_master_count: 1,
  warm_enabled: false,
  warm_type: "ultrawarm1.medium.elasticsearch", # accepts ultrawarm1.medium.elasticsearch, ultrawarm1.large.elasticsearch
  warm_count: 1,
}

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

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#dedicated_master_countInteger

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

Returns:

  • (Integer)

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

#dedicated_master_enabledBoolean

A boolean value to indicate whether a dedicated master node is enabled. See About Dedicated Master Nodestarget="_blank" for more information.

Returns:

  • (Boolean)

    A boolean value to indicate whether a dedicated master node is enabled.

#dedicated_master_typeString

The instance type for a dedicated master node.

Possible values:

  • m3.medium.elasticsearch
  • m3.large.elasticsearch
  • m3.xlarge.elasticsearch
  • m3.2xlarge.elasticsearch
  • m4.large.elasticsearch
  • m4.xlarge.elasticsearch
  • m4.2xlarge.elasticsearch
  • m4.4xlarge.elasticsearch
  • m4.10xlarge.elasticsearch
  • m5.large.elasticsearch
  • m5.xlarge.elasticsearch
  • m5.2xlarge.elasticsearch
  • m5.4xlarge.elasticsearch
  • m5.12xlarge.elasticsearch
  • r5.large.elasticsearch
  • r5.xlarge.elasticsearch
  • r5.2xlarge.elasticsearch
  • r5.4xlarge.elasticsearch
  • r5.12xlarge.elasticsearch
  • c5.large.elasticsearch
  • c5.xlarge.elasticsearch
  • c5.2xlarge.elasticsearch
  • c5.4xlarge.elasticsearch
  • c5.9xlarge.elasticsearch
  • c5.18xlarge.elasticsearch
  • ultrawarm1.medium.elasticsearch
  • ultrawarm1.large.elasticsearch
  • t2.micro.elasticsearch
  • t2.small.elasticsearch
  • t2.medium.elasticsearch
  • r3.large.elasticsearch
  • r3.xlarge.elasticsearch
  • r3.2xlarge.elasticsearch
  • r3.4xlarge.elasticsearch
  • r3.8xlarge.elasticsearch
  • i2.xlarge.elasticsearch
  • i2.2xlarge.elasticsearch
  • d2.xlarge.elasticsearch
  • d2.2xlarge.elasticsearch
  • d2.4xlarge.elasticsearch
  • d2.8xlarge.elasticsearch
  • c4.large.elasticsearch
  • c4.xlarge.elasticsearch
  • c4.2xlarge.elasticsearch
  • c4.4xlarge.elasticsearch
  • c4.8xlarge.elasticsearch
  • r4.large.elasticsearch
  • r4.xlarge.elasticsearch
  • r4.2xlarge.elasticsearch
  • r4.4xlarge.elasticsearch
  • r4.8xlarge.elasticsearch
  • r4.16xlarge.elasticsearch
  • i3.large.elasticsearch
  • i3.xlarge.elasticsearch
  • i3.2xlarge.elasticsearch
  • i3.4xlarge.elasticsearch
  • i3.8xlarge.elasticsearch
  • i3.16xlarge.elasticsearch

Returns:

  • (String)

    The instance type for a dedicated master node.

#instance_countInteger

The number of instances in the specified domain cluster.

Returns:

  • (Integer)

    The number of instances in the specified domain cluster.

#instance_typeString

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

Possible values:

  • m3.medium.elasticsearch
  • m3.large.elasticsearch
  • m3.xlarge.elasticsearch
  • m3.2xlarge.elasticsearch
  • m4.large.elasticsearch
  • m4.xlarge.elasticsearch
  • m4.2xlarge.elasticsearch
  • m4.4xlarge.elasticsearch
  • m4.10xlarge.elasticsearch
  • m5.large.elasticsearch
  • m5.xlarge.elasticsearch
  • m5.2xlarge.elasticsearch
  • m5.4xlarge.elasticsearch
  • m5.12xlarge.elasticsearch
  • r5.large.elasticsearch
  • r5.xlarge.elasticsearch
  • r5.2xlarge.elasticsearch
  • r5.4xlarge.elasticsearch
  • r5.12xlarge.elasticsearch
  • c5.large.elasticsearch
  • c5.xlarge.elasticsearch
  • c5.2xlarge.elasticsearch
  • c5.4xlarge.elasticsearch
  • c5.9xlarge.elasticsearch
  • c5.18xlarge.elasticsearch
  • ultrawarm1.medium.elasticsearch
  • ultrawarm1.large.elasticsearch
  • t2.micro.elasticsearch
  • t2.small.elasticsearch
  • t2.medium.elasticsearch
  • r3.large.elasticsearch
  • r3.xlarge.elasticsearch
  • r3.2xlarge.elasticsearch
  • r3.4xlarge.elasticsearch
  • r3.8xlarge.elasticsearch
  • i2.xlarge.elasticsearch
  • i2.2xlarge.elasticsearch
  • d2.xlarge.elasticsearch
  • d2.2xlarge.elasticsearch
  • d2.4xlarge.elasticsearch
  • d2.8xlarge.elasticsearch
  • c4.large.elasticsearch
  • c4.xlarge.elasticsearch
  • c4.2xlarge.elasticsearch
  • c4.4xlarge.elasticsearch
  • c4.8xlarge.elasticsearch
  • r4.large.elasticsearch
  • r4.xlarge.elasticsearch
  • r4.2xlarge.elasticsearch
  • r4.4xlarge.elasticsearch
  • r4.8xlarge.elasticsearch
  • r4.16xlarge.elasticsearch
  • i3.large.elasticsearch
  • i3.xlarge.elasticsearch
  • i3.2xlarge.elasticsearch
  • i3.4xlarge.elasticsearch
  • i3.8xlarge.elasticsearch
  • i3.16xlarge.elasticsearch

Returns:

  • (String)

    The instance type for an Elasticsearch cluster.

#warm_countInteger

The number of warm nodes in the cluster.

Returns:

  • (Integer)

    The number of warm nodes in the cluster.

#warm_enabledBoolean

True to enable warm storage.

Returns:

  • (Boolean)

    True to enable warm storage.

#warm_typeString

The instance type for the Elasticsearch cluster\'s warm nodes.

Possible values:

  • ultrawarm1.medium.elasticsearch
  • ultrawarm1.large.elasticsearch

Returns:

  • (String)

    The instance type for the Elasticsearch cluster\'s warm nodes.

#zone_awareness_configTypes::ZoneAwarenessConfig

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

Returns:

#zone_awareness_enabledBoolean

A boolean value to indicate whether zone awareness is enabled. See About Zone Awarenesstarget="_blank" for more information.

Returns:

  • (Boolean)

    A boolean value to indicate whether zone awareness is enabled.