Package software.amazon.awssdk.services.elasticache.model

Class NodeGroupConfiguration

java.lang.Object

software.amazon.awssdk.services.elasticache.model.NodeGroupConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<NodeGroupConfiguration.Builder,NodeGroupConfiguration>

@Generated("software.amazon.awssdk:codegen")
public final class NodeGroupConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<NodeGroupConfiguration.Builder,NodeGroupConfiguration>

Node group (shard) configuration options. Each node group (shard) configuration has the following: Slots, PrimaryAvailabilityZone, ReplicaAvailabilityZones, ReplicaCount.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	NodeGroupConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static NodeGroupConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasReplicaAvailabilityZones()	For responses, this returns true if the service returned a value for the ReplicaAvailabilityZones property.
boolean	hasReplicaOutpostArns()	For responses, this returns true if the service returned a value for the ReplicaOutpostArns property.
String	nodeGroupId()	Either the ElastiCache for Redis supplied 4-digit id or a user supplied id for the node group these configuration values apply to.
String	primaryAvailabilityZone()	The Availability Zone where the primary node of this node group (shard) is launched.
String	primaryOutpostArn()	The outpost ARN of the primary node.
List<String>	replicaAvailabilityZones()	A list of Availability Zones to be used for the read replicas.
Integer	replicaCount()	The number of read replica nodes in this node group (shard).
List<String>	replicaOutpostArns()	The outpost ARN of the node replicas.
List<SdkField<?>>	sdkFields()
static Class<? extends NodeGroupConfiguration.Builder>	serializableBuilderClass()
String	slots()	A string that specifies the keyspace for a particular node group.
NodeGroupConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

nodeGroupId

public final String nodeGroupId()

Either the ElastiCache for Redis supplied 4-digit id or a user supplied id for the node group these configuration values apply to.

Returns:

Either the ElastiCache for Redis supplied 4-digit id or a user supplied id for the node group these configuration values apply to.

slots

public final String slots()

A string that specifies the keyspace for a particular node group. Keyspaces range from 0 to 16,383. The string is in the format startkey-endkey.

Example: "0-3999"

Returns:

A string that specifies the keyspace for a particular node group. Keyspaces range from 0 to 16,383. The string is in the format startkey-endkey.

Example: "0-3999"

replicaCount

public final Integer replicaCount()

The number of read replica nodes in this node group (shard).

Returns:

The number of read replica nodes in this node group (shard).

primaryAvailabilityZone

public final String primaryAvailabilityZone()

The Availability Zone where the primary node of this node group (shard) is launched.

Returns:

The Availability Zone where the primary node of this node group (shard) is launched.

hasReplicaAvailabilityZones

public final boolean hasReplicaAvailabilityZones()

For responses, this returns true if the service returned a value for the ReplicaAvailabilityZones property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

replicaAvailabilityZones

public final List<String> replicaAvailabilityZones()

A list of Availability Zones to be used for the read replicas. The number of Availability Zones in this list must match the value of ReplicaCount or ReplicasPerNodeGroup if not specified.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasReplicaAvailabilityZones() method.

Returns:

A list of Availability Zones to be used for the read replicas. The number of Availability Zones in this list must match the value of ReplicaCount or ReplicasPerNodeGroup if not specified.

primaryOutpostArn

public final String primaryOutpostArn()

The outpost ARN of the primary node.

Returns:

The outpost ARN of the primary node.

hasReplicaOutpostArns

public final boolean hasReplicaOutpostArns()

For responses, this returns true if the service returned a value for the ReplicaOutpostArns property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

replicaOutpostArns

public final List<String> replicaOutpostArns()

The outpost ARN of the node replicas.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasReplicaOutpostArns() method.

Returns:

The outpost ARN of the node replicas.

toBuilder

public NodeGroupConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<NodeGroupConfiguration.Builder,NodeGroupConfiguration>

builder

public static NodeGroupConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends NodeGroupConfiguration.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo