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

Inherits:

Struct

• Object
• Struct
• Aws::SecurityHub::Types::AwsOpenSearchServiceDomainClusterConfigDetails

Defined in:

gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb

Overview

Details about the configuration of an OpenSearch cluster.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #dedicated_master_count ⇒ Integer

  The number of instances to use for the master node.

• #dedicated_master_enabled ⇒ Boolean

  Whether to use a dedicated master node for the OpenSearch domain.

• #dedicated_master_type ⇒ String

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

• #instance_count ⇒ Integer

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

• #instance_type ⇒ String

  The instance type for your data nodes.

• #warm_count ⇒ Integer

  The number of UltraWarm instances.

• #warm_enabled ⇒ Boolean

  Whether UltraWarm is enabled.

• #warm_type ⇒ String

  The type of UltraWarm instance.

• #zone_awareness_config ⇒ Types::AwsOpenSearchServiceDomainClusterConfigZoneAwarenessConfigDetails

  Configuration options for zone awareness.

• #zone_awareness_enabled ⇒ Boolean

  Whether to enable zone awareness for the OpenSearch domain.

Instance Attribute Details

#dedicated_master_count ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 15028

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_enabled ⇒ Boolean

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)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 15028

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_type ⇒ String

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

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

Returns:

• (String)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 15028

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_count ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 15028

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_type ⇒ String

The instance type for your data nodes.

For a list of valid values, see Supported instance types in Amazon OpenSearch Service in the Amazon OpenSearch Service Developer Guide.

Returns:

• (String)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 15028

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_count ⇒ Integer

The number of UltraWarm instances.

Returns:

• (Integer)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 15028

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_enabled ⇒ Boolean

Whether UltraWarm is enabled.

Returns:

• (Boolean)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 15028

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_type ⇒ String

The type of UltraWarm instance.

Returns:

• (String)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 15028

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_config ⇒ Types::AwsOpenSearchServiceDomainClusterConfigZoneAwarenessConfigDetails

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

Returns:

• (Types::AwsOpenSearchServiceDomainClusterConfigZoneAwarenessConfigDetails)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 15028

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_enabled ⇒ Boolean

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)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 15028

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