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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-opensearchservice/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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#cold_storage_optionsTypes::ColdStorageOptions

Container for cold storage configuration options.



1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 1078

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_countInteger

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)


1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 1078

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_enabledBoolean

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)


1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 1078

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_typeString

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

Returns:

  • (String)


1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 1078

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_countInteger

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

Returns:

  • (Integer)


1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 1078

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_typeString

Instance type of data nodes in the cluster.

Returns:

  • (String)


1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 1078

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_enabledBoolean

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.

Returns:

  • (Boolean)


1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 1078

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_countInteger

The number of warm nodes in the cluster.

Returns:

  • (Integer)


1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 1078

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_enabledBoolean

Whether to enable warm storage for the cluster.

Returns:

  • (Boolean)


1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 1078

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_typeString

The instance type for the cluster's warm nodes.

Returns:

  • (String)


1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 1078

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_configTypes::ZoneAwarenessConfig

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



1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 1078

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_enabledBoolean

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

Returns:

  • (Boolean)


1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 1078

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