Class: Aws::OpenSearchService::Types::ClusterConfig

Inherits:

Struct

Object
Struct
Aws::OpenSearchService::Types::ClusterConfig

show all

Includes:: Structure

Defined in:: lib/aws-sdk-opensearchservice/types.rb

Overview

Container for the cluster configuration of an OpenSearch Service domain. For more information, see [Creating and managing Amazon OpenSearch Service domains].

[1]: docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#cold_storage_options ⇒ Types::ColdStorageOptions

Container for cold storage configuration options.
#dedicated_master_count ⇒ Integer

Number of dedicated master nodes in the cluster.
#dedicated_master_enabled ⇒ Boolean

Indicates whether dedicated master nodes are enabled for the cluster.‘True` if the cluster will use a dedicated master node.`False` if the cluster will not.
#dedicated_master_type ⇒ String

OpenSearch Service instance type of the dedicated master nodes in the cluster.
#instance_count ⇒ Integer

Number of data nodes in the cluster.
#instance_type ⇒ String

Instance type of data nodes in the cluster.
#multi_az_with_standby_enabled ⇒ Boolean

A boolean that indicates whether a multi-AZ domain is turned on with a standby AZ.
#warm_count ⇒ Integer

The number of warm nodes in the cluster.
#warm_enabled ⇒ Boolean

Whether to enable warm storage for the cluster.
#warm_type ⇒ String

The instance type for the cluster’s warm nodes.
#zone_awareness_config ⇒ Types::ZoneAwarenessConfig

Container for zone awareness configuration options.
#zone_awareness_enabled ⇒ Boolean

Indicates whether multiple Availability Zones are enabled.

Instance Attribute Details

#cold_storage_options ⇒ `Types::ColdStorageOptions`

Container for cold storage configuration options.

Returns:

(Types::ColdStorageOptions)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 1141

class ClusterConfig < 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,
  :multi_az_with_standby_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#dedicated_master_count ⇒ `Integer`

Number of dedicated master nodes in the cluster. This number must be greater than 2 and not 4, otherwise you receive a validation exception.

Returns:

(Integer)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 1141

class ClusterConfig < 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,
  :multi_az_with_standby_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#dedicated_master_enabled ⇒ `Boolean`

Indicates whether dedicated master nodes are enabled for the cluster.‘True` if the cluster will use a dedicated master node.`False` if the cluster will not.

Returns:

(Boolean)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 1141

class ClusterConfig < 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,
  :multi_az_with_standby_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#dedicated_master_type ⇒ `String`

OpenSearch Service instance type of the dedicated master nodes in the cluster.

Returns:

(String)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 1141

class ClusterConfig < 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,
  :multi_az_with_standby_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#instance_count ⇒ `Integer`

Number of data nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.

Returns:

(Integer)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 1141

class ClusterConfig < 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,
  :multi_az_with_standby_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#instance_type ⇒ `String`

Instance type of data nodes in the cluster.

Returns:

(String)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 1141

class ClusterConfig < 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,
  :multi_az_with_standby_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#multi_az_with_standby_enabled ⇒ `Boolean`

A boolean that indicates whether a multi-AZ domain is turned on with a standby AZ. For more information, see [Configuring a multi-AZ domain in Amazon OpenSearch Service].

[1]: docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-multiaz.html

Returns:

(Boolean)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 1141

class ClusterConfig < 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,
  :multi_az_with_standby_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#warm_count ⇒ `Integer`

The number of warm nodes in the cluster.

Returns:

(Integer)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 1141

class ClusterConfig < 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,
  :multi_az_with_standby_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#warm_enabled ⇒ `Boolean`

Whether to enable warm storage for the cluster.

Returns:

(Boolean)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 1141

class ClusterConfig < 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,
  :multi_az_with_standby_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#warm_type ⇒ `String`

The instance type for the cluster’s warm nodes.

Returns:

(String)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 1141

class ClusterConfig < 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,
  :multi_az_with_standby_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#zone_awareness_config ⇒ `Types::ZoneAwarenessConfig`

Container for zone awareness configuration options. Only required if ‘ZoneAwarenessEnabled` is `true`.

Returns:

(Types::ZoneAwarenessConfig)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 1141

class ClusterConfig < 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,
  :multi_az_with_standby_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#zone_awareness_enabled ⇒ `Boolean`

Indicates whether multiple Availability Zones are enabled. For more information, see [Configuring a multi-AZ domain in Amazon OpenSearch Service].

[1]: docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-multiaz.html

Returns:

(Boolean)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 1141

class ClusterConfig < 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,
  :multi_az_with_standby_enabled)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::OpenSearchService::Types::ClusterConfig

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#cold_storage_options ⇒ Types::ColdStorageOptions

#dedicated_master_count ⇒ Integer

#dedicated_master_enabled ⇒ Boolean

#dedicated_master_type ⇒ String

#instance_count ⇒ Integer

#instance_type ⇒ String

#multi_az_with_standby_enabled ⇒ Boolean

#warm_count ⇒ Integer

#warm_enabled ⇒ Boolean

#warm_type ⇒ String

#zone_awareness_config ⇒ Types::ZoneAwarenessConfig

#zone_awareness_enabled ⇒ Boolean

#cold_storage_options ⇒ `Types::ColdStorageOptions`

#dedicated_master_count ⇒ `Integer`

#dedicated_master_enabled ⇒ `Boolean`

#dedicated_master_type ⇒ `String`

#instance_count ⇒ `Integer`

#instance_type ⇒ `String`

#multi_az_with_standby_enabled ⇒ `Boolean`

#warm_count ⇒ `Integer`

#warm_enabled ⇒ `Boolean`

#warm_type ⇒ `String`

#zone_awareness_config ⇒ `Types::ZoneAwarenessConfig`

#zone_awareness_enabled ⇒ `Boolean`