Class: Aws::SecurityHub::Types::AwsOpenSearchServiceDomainClusterConfigDetails

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb

Overview

Note:

When making an API call, you may pass AwsOpenSearchServiceDomainClusterConfigDetails data as a hash:

{
  instance_count: 1,
  warm_enabled: false,
  warm_count: 1,
  dedicated_master_enabled: false,
  zone_awareness_config: {
    availability_zone_count: 1,
  },
  dedicated_master_count: 1,
  instance_type: "NonEmptyString",
  warm_type: "NonEmptyString",
  zone_awareness_enabled: false,
  dedicated_master_type: "NonEmptyString",
}

Details about the configuration of an OpenSearch cluster.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#dedicated_master_countInteger

The number of instances to use for the master node. If this attribute is specified, then DedicatedMasterEnabled must be true.

Returns:

  • (Integer)


14308
14309
14310
14311
14312
14313
14314
14315
14316
14317
14318
14319
14320
14321
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 14308

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

#dedicated_master_enabledBoolean

Whether to use a dedicated master node for the OpenSearch domain. A dedicated master node performs cluster management tasks, but does not hold data or respond to data upload requests.

Returns:

  • (Boolean)


14308
14309
14310
14311
14312
14313
14314
14315
14316
14317
14318
14319
14320
14321
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 14308

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

#dedicated_master_typeString

The hardware configuration of the computer that hosts the dedicated master node.

If this attribute is specified, then DedicatedMasterEnabled must be true.

Returns:

  • (String)


14308
14309
14310
14311
14312
14313
14314
14315
14316
14317
14318
14319
14320
14321
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 14308

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

#instance_countInteger

The number of data nodes to use in the OpenSearch domain.

Returns:

  • (Integer)


14308
14309
14310
14311
14312
14313
14314
14315
14316
14317
14318
14319
14320
14321
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 14308

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

#instance_typeString

The instance type for your data nodes.

Returns:

  • (String)


14308
14309
14310
14311
14312
14313
14314
14315
14316
14317
14318
14319
14320
14321
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 14308

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

#warm_countInteger

The number of UltraWarm instances.

Returns:

  • (Integer)


14308
14309
14310
14311
14312
14313
14314
14315
14316
14317
14318
14319
14320
14321
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 14308

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

#warm_enabledBoolean

Whether UltraWarm is enabled.

Returns:

  • (Boolean)


14308
14309
14310
14311
14312
14313
14314
14315
14316
14317
14318
14319
14320
14321
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 14308

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

#warm_typeString

The type of UltraWarm instance.

Returns:

  • (String)


14308
14309
14310
14311
14312
14313
14314
14315
14316
14317
14318
14319
14320
14321
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 14308

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

#zone_awareness_configTypes::AwsOpenSearchServiceDomainClusterConfigZoneAwarenessConfigDetails

Configuration options for zone awareness. Provided if ZoneAwarenessEnabled is true.



14308
14309
14310
14311
14312
14313
14314
14315
14316
14317
14318
14319
14320
14321
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 14308

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

#zone_awareness_enabledBoolean

Whether to enable zone awareness for the OpenSearch domain. When zone awareness is enabled, OpenSearch Service allocates the cluster's nodes and replica index shards across Availability Zones (AZs) in the same Region. This prevents data loss and minimizes downtime if a node or data center fails.

Returns:

  • (Boolean)


14308
14309
14310
14311
14312
14313
14314
14315
14316
14317
14318
14319
14320
14321
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 14308

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