ConfigureShard (AWS Java SDK :: Services :: Amazon ElastiCache 2.16.76 API)

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

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ConfigureShard.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ConfigureShard.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasPreferredAvailabilityZones()` Returns true if the PreferredAvailabilityZones property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasPreferredOutpostArns()` Returns true if the PreferredOutpostArns property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`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<String>`	`preferredOutpostArns()` The outpost ARNs in which the cache cluster is created.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ConfigureShard.Builder>`	`serializableBuilderClass()`
`ConfigureShard.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()
```
    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 final 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: 1
      
      If Multi-AZ: 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: 1
    
    If Multi-AZ: 0
    
    Redis (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails)
  - hasPreferredAvailabilityZones
```
public final boolean hasPreferredAvailabilityZones()
```
    Returns true if the PreferredAvailabilityZones property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - preferredAvailabilityZones
```
public final 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.
    
    You can use hasPreferredAvailabilityZones() to see if a value was sent in this field.
    
    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.
  - hasPreferredOutpostArns
```
public final boolean hasPreferredOutpostArns()
```
    Returns true if the PreferredOutpostArns property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - preferredOutpostArns
```
public final List<String> preferredOutpostArns()
```
    The outpost ARNs in which the cache cluster is created.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasPreferredOutpostArns() to see if a value was sent in this field.
    
    Returns:
    
    The outpost ARNs in which the cache cluster is created.
  - toBuilder
```
public ConfigureShard.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ConfigureShard.Builder,ConfigureShard>
  - builder
```
public static ConfigureShard.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ConfigureShard.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

Class ConfigureShard

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

nodeGroupId

newReplicaCount

hasPreferredAvailabilityZones

preferredAvailabilityZones

hasPreferredOutpostArns

preferredOutpostArns

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields