software.amazon.awssdk.services.elasticache.model

Class ConfigureShard

java.lang.Object

software.amazon.awssdk.services.elasticache.model.ConfigureShard

All Implemented Interfaces:

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

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

Node group (shard) configuration options when adding or removing replicas. Each node group (shard) configuration has the following members: NodeGroupId, NewReplicaCount, and PreferredAvailabilityZones.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ConfigureShard.Builder

Method Summary

Modifier and Type	Method and Description
static ConfigureShard.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	newReplicaCount() The number of replicas you want in this node group at the end of this operation.
String	nodeGroupId() The 4-digit id for the node group you are configuring.
List<String>	preferredAvailabilityZones() A list of PreferredAvailabilityZone strings that specify which availability zones the replication group's nodes are to be in.
List<SdkField<?>>	sdkFields()
static Class<? extends ConfigureShard.Builder>	serializableBuilderClass()
ConfigureShard.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

nodeGroupId

public String nodeGroupId()

The 4-digit id for the node group you are configuring. For Redis (cluster mode disabled) replication groups, the node group id is always 0001. To find a Redis (cluster mode enabled)'s node group's (shard's) id, see Finding a Shard's Id.

Returns:

The 4-digit id for the node group you are configuring. For Redis (cluster mode disabled) replication groups, the node group id is always 0001. To find a Redis (cluster mode enabled)'s node group's (shard's) id, see Finding a Shard's Id.

newReplicaCount

public Integer newReplicaCount()

The number of replicas you want in this node group at the end of this operation. The maximum value for NewReplicaCount is 5. The minimum value depends upon the type of Redis replication group you are working with.

The minimum number of replicas in a shard or replication group is:

• Redis (cluster mode disabled)

  • If Multi-AZ with Automatic Failover is enabled: 1

  • If Multi-AZ with Automatic Failover is not enable: 0

• Redis (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails)

Returns:

The number of replicas you want in this node group at the end of this operation. The maximum value for NewReplicaCount is 5. The minimum value depends upon the type of Redis replication group you are working with.

The minimum number of replicas in a shard or replication group is:

• Redis (cluster mode disabled)

  • If Multi-AZ with Automatic Failover is enabled: 1

  • If Multi-AZ with Automatic Failover is not enable: 0

• Redis (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails)

preferredAvailabilityZones

public List<String> preferredAvailabilityZones()

A list of PreferredAvailabilityZone strings that specify which availability zones the replication group's nodes are to be in. The nummber of PreferredAvailabilityZone values must equal the value of NewReplicaCount plus 1 to account for the primary node. If this member of ReplicaConfiguration is omitted, ElastiCache for Redis selects the availability zone for each of the replicas.

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

Returns:

A list of PreferredAvailabilityZone strings that specify which availability zones the replication group's nodes are to be in. The nummber of PreferredAvailabilityZone values must equal the value of NewReplicaCount plus 1 to account for the primary node. If this member of ReplicaConfiguration is omitted, ElastiCache for Redis selects the availability zone for each of the replicas.

toBuilder

public ConfigureShard.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<ConfigureShard.Builder,ConfigureShard>

Returns:

a builder for type T

builder

public static ConfigureShard.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.