com.amazonaws.services.opensearch.model

Class ClusterConfig

java.lang.Object

com.amazonaws.services.opensearch.model.ClusterConfig

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ClusterConfig
extends Object
implements Serializable, Cloneable, StructuredPojo

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ClusterConfig()

Method Summary

Modifier and Type	Method and Description
ClusterConfig	clone()
boolean	equals(Object obj)
ColdStorageOptions	getColdStorageOptions() Specifies the ColdStorageOptions config for a Domain
Integer	getDedicatedMasterCount() Total number of dedicated master nodes, active and on standby, for the cluster.
Boolean	getDedicatedMasterEnabled() A boolean value to indicate whether a dedicated master node is enabled.
String	getDedicatedMasterType() The instance type for a dedicated master node.
Integer	getInstanceCount() The number of instances in the specified domain cluster.
String	getInstanceType() The instance type for an OpenSearch cluster.
Integer	getWarmCount() The number of UltraWarm nodes in the cluster.
Boolean	getWarmEnabled() True to enable UltraWarm storage.
String	getWarmType() The instance type for the OpenSearch cluster's warm nodes.
ZoneAwarenessConfig	getZoneAwarenessConfig() The zone awareness configuration for a domain when zone awareness is enabled.
Boolean	getZoneAwarenessEnabled() A boolean value to indicate whether zone awareness is enabled.
int	hashCode()
Boolean	isDedicatedMasterEnabled() A boolean value to indicate whether a dedicated master node is enabled.
Boolean	isWarmEnabled() True to enable UltraWarm storage.
Boolean	isZoneAwarenessEnabled() A boolean value to indicate whether zone awareness is enabled.
void	marshall(ProtocolMarshaller protocolMarshaller)
void	setColdStorageOptions(ColdStorageOptions coldStorageOptions) Specifies the ColdStorageOptions config for a Domain
void	setDedicatedMasterCount(Integer dedicatedMasterCount) Total number of dedicated master nodes, active and on standby, for the cluster.
void	setDedicatedMasterEnabled(Boolean dedicatedMasterEnabled) A boolean value to indicate whether a dedicated master node is enabled.
void	setDedicatedMasterType(String dedicatedMasterType) The instance type for a dedicated master node.
void	setInstanceCount(Integer instanceCount) The number of instances in the specified domain cluster.
void	setInstanceType(String instanceType) The instance type for an OpenSearch cluster.
void	setWarmCount(Integer warmCount) The number of UltraWarm nodes in the cluster.
void	setWarmEnabled(Boolean warmEnabled) True to enable UltraWarm storage.
void	setWarmType(String warmType) The instance type for the OpenSearch cluster's warm nodes.
void	setZoneAwarenessConfig(ZoneAwarenessConfig zoneAwarenessConfig) The zone awareness configuration for a domain when zone awareness is enabled.
void	setZoneAwarenessEnabled(Boolean zoneAwarenessEnabled) A boolean value to indicate whether zone awareness is enabled.
String	toString() Returns a string representation of this object.
ClusterConfig	withColdStorageOptions(ColdStorageOptions coldStorageOptions) Specifies the ColdStorageOptions config for a Domain
ClusterConfig	withDedicatedMasterCount(Integer dedicatedMasterCount) Total number of dedicated master nodes, active and on standby, for the cluster.
ClusterConfig	withDedicatedMasterEnabled(Boolean dedicatedMasterEnabled) A boolean value to indicate whether a dedicated master node is enabled.
ClusterConfig	withDedicatedMasterType(OpenSearchPartitionInstanceType dedicatedMasterType) The instance type for a dedicated master node.
ClusterConfig	withDedicatedMasterType(String dedicatedMasterType) The instance type for a dedicated master node.
ClusterConfig	withInstanceCount(Integer instanceCount) The number of instances in the specified domain cluster.
ClusterConfig	withInstanceType(OpenSearchPartitionInstanceType instanceType) The instance type for an OpenSearch cluster.
ClusterConfig	withInstanceType(String instanceType) The instance type for an OpenSearch cluster.
ClusterConfig	withWarmCount(Integer warmCount) The number of UltraWarm nodes in the cluster.
ClusterConfig	withWarmEnabled(Boolean warmEnabled) True to enable UltraWarm storage.
ClusterConfig	withWarmType(OpenSearchWarmPartitionInstanceType warmType) The instance type for the OpenSearch cluster's warm nodes.
ClusterConfig	withWarmType(String warmType) The instance type for the OpenSearch cluster's warm nodes.
ClusterConfig	withZoneAwarenessConfig(ZoneAwarenessConfig zoneAwarenessConfig) The zone awareness configuration for a domain when zone awareness is enabled.
ClusterConfig	withZoneAwarenessEnabled(Boolean zoneAwarenessEnabled) A boolean value to indicate whether zone awareness is enabled.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ClusterConfig

public ClusterConfig()

Method Detail

setInstanceType

public void setInstanceType(String instanceType)

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

Parameters:

instanceType - The instance type for an OpenSearch cluster. UltraWarm instance types are not supported for data instances.

See Also:

OpenSearchPartitionInstanceType

getInstanceType

public String getInstanceType()

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

Returns:

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

See Also:

OpenSearchPartitionInstanceType

withInstanceType

public ClusterConfig withInstanceType(String instanceType)

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

Parameters:

instanceType - The instance type for an OpenSearch cluster. UltraWarm instance types are not supported for data instances.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

OpenSearchPartitionInstanceType

withInstanceType

public ClusterConfig withInstanceType(OpenSearchPartitionInstanceType instanceType)

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

Parameters:

instanceType - The instance type for an OpenSearch cluster. UltraWarm instance types are not supported for data instances.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

OpenSearchPartitionInstanceType

setInstanceCount

public void setInstanceCount(Integer instanceCount)

The number of instances in the specified domain cluster.

Parameters:

instanceCount - The number of instances in the specified domain cluster.

getInstanceCount

public Integer getInstanceCount()

The number of instances in the specified domain cluster.

Returns:

The number of instances in the specified domain cluster.

withInstanceCount

public ClusterConfig withInstanceCount(Integer instanceCount)

The number of instances in the specified domain cluster.

Parameters:

instanceCount - The number of instances in the specified domain cluster.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDedicatedMasterEnabled

public void setDedicatedMasterEnabled(Boolean dedicatedMasterEnabled)

A boolean value to indicate whether a dedicated master node is enabled. See Dedicated master nodes in Amazon OpenSearch Service for more information.

Parameters:

dedicatedMasterEnabled - A boolean value to indicate whether a dedicated master node is enabled. See Dedicated master nodes in Amazon OpenSearch Service for more information.

getDedicatedMasterEnabled

public Boolean getDedicatedMasterEnabled()

A boolean value to indicate whether a dedicated master node is enabled. See Dedicated master nodes in Amazon OpenSearch Service for more information.

Returns:

A boolean value to indicate whether a dedicated master node is enabled. See Dedicated master nodes in Amazon OpenSearch Service for more information.

withDedicatedMasterEnabled

public ClusterConfig withDedicatedMasterEnabled(Boolean dedicatedMasterEnabled)

A boolean value to indicate whether a dedicated master node is enabled. See Dedicated master nodes in Amazon OpenSearch Service for more information.

Parameters:

dedicatedMasterEnabled - A boolean value to indicate whether a dedicated master node is enabled. See Dedicated master nodes in Amazon OpenSearch Service for more information.

Returns:

Returns a reference to this object so that method calls can be chained together.

isDedicatedMasterEnabled

public Boolean isDedicatedMasterEnabled()

A boolean value to indicate whether a dedicated master node is enabled. See Dedicated master nodes in Amazon OpenSearch Service for more information.

Returns:

A boolean value to indicate whether a dedicated master node is enabled. See Dedicated master nodes in Amazon OpenSearch Service for more information.

setZoneAwarenessEnabled

public void setZoneAwarenessEnabled(Boolean zoneAwarenessEnabled)

A boolean value to indicate whether zone awareness is enabled. See Configuring a multi-AZ domain in Amazon OpenSearch Service for more information.

Parameters:

zoneAwarenessEnabled - A boolean value to indicate whether zone awareness is enabled. See Configuring a multi-AZ domain in Amazon OpenSearch Service for more information.

getZoneAwarenessEnabled

public Boolean getZoneAwarenessEnabled()

A boolean value to indicate whether zone awareness is enabled. See Configuring a multi-AZ domain in Amazon OpenSearch Service for more information.

Returns:

A boolean value to indicate whether zone awareness is enabled. See Configuring a multi-AZ domain in Amazon OpenSearch Service for more information.

withZoneAwarenessEnabled

public ClusterConfig withZoneAwarenessEnabled(Boolean zoneAwarenessEnabled)

A boolean value to indicate whether zone awareness is enabled. See Configuring a multi-AZ domain in Amazon OpenSearch Service for more information.

Parameters:

zoneAwarenessEnabled - A boolean value to indicate whether zone awareness is enabled. See Configuring a multi-AZ domain in Amazon OpenSearch Service for more information.

Returns:

Returns a reference to this object so that method calls can be chained together.

isZoneAwarenessEnabled

public Boolean isZoneAwarenessEnabled()

A boolean value to indicate whether zone awareness is enabled. See Configuring a multi-AZ domain in Amazon OpenSearch Service for more information.

Returns:

A boolean value to indicate whether zone awareness is enabled. See Configuring a multi-AZ domain in Amazon OpenSearch Service for more information.

setZoneAwarenessConfig

public void setZoneAwarenessConfig(ZoneAwarenessConfig zoneAwarenessConfig)

The zone awareness configuration for a domain when zone awareness is enabled.

Parameters:

zoneAwarenessConfig - The zone awareness configuration for a domain when zone awareness is enabled.

getZoneAwarenessConfig

public ZoneAwarenessConfig getZoneAwarenessConfig()

The zone awareness configuration for a domain when zone awareness is enabled.

Returns:

The zone awareness configuration for a domain when zone awareness is enabled.

withZoneAwarenessConfig

public ClusterConfig withZoneAwarenessConfig(ZoneAwarenessConfig zoneAwarenessConfig)

The zone awareness configuration for a domain when zone awareness is enabled.

Parameters:

zoneAwarenessConfig - The zone awareness configuration for a domain when zone awareness is enabled.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDedicatedMasterType

public void setDedicatedMasterType(String dedicatedMasterType)

The instance type for a dedicated master node.

Parameters:

dedicatedMasterType - The instance type for a dedicated master node.

See Also:

OpenSearchPartitionInstanceType

getDedicatedMasterType

public String getDedicatedMasterType()

The instance type for a dedicated master node.

Returns:

The instance type for a dedicated master node.

See Also:

OpenSearchPartitionInstanceType

withDedicatedMasterType

public ClusterConfig withDedicatedMasterType(String dedicatedMasterType)

The instance type for a dedicated master node.

Parameters:

dedicatedMasterType - The instance type for a dedicated master node.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

OpenSearchPartitionInstanceType

withDedicatedMasterType

public ClusterConfig withDedicatedMasterType(OpenSearchPartitionInstanceType dedicatedMasterType)

The instance type for a dedicated master node.

Parameters:

dedicatedMasterType - The instance type for a dedicated master node.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

OpenSearchPartitionInstanceType

setDedicatedMasterCount

public void setDedicatedMasterCount(Integer dedicatedMasterCount)

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

Parameters:

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

getDedicatedMasterCount

public Integer getDedicatedMasterCount()

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

Returns:

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

withDedicatedMasterCount

public ClusterConfig withDedicatedMasterCount(Integer dedicatedMasterCount)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setWarmEnabled

public void setWarmEnabled(Boolean warmEnabled)

True to enable UltraWarm storage.

Parameters:

warmEnabled - True to enable UltraWarm storage.

getWarmEnabled

public Boolean getWarmEnabled()

True to enable UltraWarm storage.

Returns:

True to enable UltraWarm storage.

withWarmEnabled

public ClusterConfig withWarmEnabled(Boolean warmEnabled)

True to enable UltraWarm storage.

Parameters:

warmEnabled - True to enable UltraWarm storage.

Returns:

Returns a reference to this object so that method calls can be chained together.

isWarmEnabled

public Boolean isWarmEnabled()

True to enable UltraWarm storage.

Returns:

True to enable UltraWarm storage.

setWarmType

public void setWarmType(String warmType)

The instance type for the OpenSearch cluster's warm nodes.

Parameters:

warmType - The instance type for the OpenSearch cluster's warm nodes.

See Also:

OpenSearchWarmPartitionInstanceType

getWarmType

public String getWarmType()

The instance type for the OpenSearch cluster's warm nodes.

Returns:

The instance type for the OpenSearch cluster's warm nodes.

See Also:

OpenSearchWarmPartitionInstanceType

withWarmType

public ClusterConfig withWarmType(String warmType)

The instance type for the OpenSearch cluster's warm nodes.

Parameters:

warmType - The instance type for the OpenSearch cluster's warm nodes.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

OpenSearchWarmPartitionInstanceType

withWarmType

public ClusterConfig withWarmType(OpenSearchWarmPartitionInstanceType warmType)

The instance type for the OpenSearch cluster's warm nodes.

Parameters:

warmType - The instance type for the OpenSearch cluster's warm nodes.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

OpenSearchWarmPartitionInstanceType

setWarmCount

public void setWarmCount(Integer warmCount)

The number of UltraWarm nodes in the cluster.

Parameters:

warmCount - The number of UltraWarm nodes in the cluster.

getWarmCount

public Integer getWarmCount()

The number of UltraWarm nodes in the cluster.

Returns:

The number of UltraWarm nodes in the cluster.

withWarmCount

public ClusterConfig withWarmCount(Integer warmCount)

The number of UltraWarm nodes in the cluster.

Parameters:

warmCount - The number of UltraWarm nodes in the cluster.

Returns:

Returns a reference to this object so that method calls can be chained together.

setColdStorageOptions

public void setColdStorageOptions(ColdStorageOptions coldStorageOptions)

Specifies the ColdStorageOptions config for a Domain

Parameters:

coldStorageOptions - Specifies the ColdStorageOptions config for a Domain

getColdStorageOptions

public ColdStorageOptions getColdStorageOptions()

Specifies the ColdStorageOptions config for a Domain

Returns:

Specifies the ColdStorageOptions config for a Domain

withColdStorageOptions

public ClusterConfig withColdStorageOptions(ColdStorageOptions coldStorageOptions)

Specifies the ColdStorageOptions config for a Domain

Parameters:

coldStorageOptions - Specifies the ColdStorageOptions config for a Domain

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ClusterConfig clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo