software.amazon.awssdk.services.elasticache.model

Class ModifyReplicationGroupShardConfigurationRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.elasticache.model.ElastiCacheRequest

software.amazon.awssdk.services.elasticache.model.ModifyReplicationGroupShardConfigurationRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ModifyReplicationGroupShardConfigurationRequest.Builder,ModifyReplicationGroupShardConfigurationRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class ModifyReplicationGroupShardConfigurationRequest
extends ElastiCacheRequest
implements ToCopyableBuilder<ModifyReplicationGroupShardConfigurationRequest.Builder,ModifyReplicationGroupShardConfigurationRequest>

Represents the input for a ModifyReplicationGroupShardConfiguration operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ModifyReplicationGroupShardConfigurationRequest.Builder

Method Summary

Modifier and Type	Method and Description
Boolean	applyImmediately() Indicates that the shard reconfiguration process begins immediately.
static ModifyReplicationGroupShardConfigurationRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasNodeGroupsToRemove() For responses, this returns true if the service returned a value for the NodeGroupsToRemove property.
boolean	hasNodeGroupsToRetain() For responses, this returns true if the service returned a value for the NodeGroupsToRetain property.
boolean	hasReshardingConfiguration() For responses, this returns true if the service returned a value for the ReshardingConfiguration property.
Integer	nodeGroupCount() The number of node groups (shards) that results from the modification of the shard configuration.
List<String>	nodeGroupsToRemove() If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required.
List<String>	nodeGroupsToRetain() If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required.
String	replicationGroupId() The name of the Redis (cluster mode enabled) cluster (replication group) on which the shards are to be configured.
List<ReshardingConfiguration>	reshardingConfiguration() Specifies the preferred availability zones for each node group in the cluster.
List<SdkField<?>>	sdkFields()
static Class<? extends ModifyReplicationGroupShardConfigurationRequest.Builder>	serializableBuilderClass()
ModifyReplicationGroupShardConfigurationRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

replicationGroupId

public final String replicationGroupId()

The name of the Redis (cluster mode enabled) cluster (replication group) on which the shards are to be configured.

Returns:

The name of the Redis (cluster mode enabled) cluster (replication group) on which the shards are to be configured.

nodeGroupCount

public final Integer nodeGroupCount()

The number of node groups (shards) that results from the modification of the shard configuration.

Returns:

The number of node groups (shards) that results from the modification of the shard configuration.

applyImmediately

public final Boolean applyImmediately()

Indicates that the shard reconfiguration process begins immediately. At present, the only permitted value for this parameter is true.

Value: true

Returns:

Indicates that the shard reconfiguration process begins immediately. At present, the only permitted value for this parameter is true.

Value: true

hasReshardingConfiguration

public final boolean hasReshardingConfiguration()

For responses, this returns true if the service returned a value for the ReshardingConfiguration 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.

reshardingConfiguration

public final List<ReshardingConfiguration> reshardingConfiguration()

Specifies the preferred availability zones for each node group in the cluster. If the value of NodeGroupCount is greater than the current number of node groups (shards), you can use this parameter to specify the preferred availability zones of the cluster's shards. If you omit this parameter ElastiCache selects availability zones for you.

You can specify this parameter only if the value of NodeGroupCount is greater than the current number of node groups (shards).

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 hasReshardingConfiguration() method.

Returns:

Specifies the preferred availability zones for each node group in the cluster. If the value of NodeGroupCount is greater than the current number of node groups (shards), you can use this parameter to specify the preferred availability zones of the cluster's shards. If you omit this parameter ElastiCache selects availability zones for you.

You can specify this parameter only if the value of NodeGroupCount is greater than the current number of node groups (shards).

hasNodeGroupsToRemove

public final boolean hasNodeGroupsToRemove()

For responses, this returns true if the service returned a value for the NodeGroupsToRemove 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.

nodeGroupsToRemove

public final List<String> nodeGroupsToRemove()

If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. NodeGroupsToRemove is a list of NodeGroupIds to remove from the cluster.

ElastiCache for Redis will attempt to remove all node groups listed by NodeGroupsToRemove from the cluster.

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 hasNodeGroupsToRemove() method.

Returns:

If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. NodeGroupsToRemove is a list of NodeGroupIds to remove from the cluster.

ElastiCache for Redis will attempt to remove all node groups listed by NodeGroupsToRemove from the cluster.

hasNodeGroupsToRetain

public final boolean hasNodeGroupsToRetain()

For responses, this returns true if the service returned a value for the NodeGroupsToRetain 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.

nodeGroupsToRetain

public final List<String> nodeGroupsToRetain()

If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. NodeGroupsToRetain is a list of NodeGroupIds to retain in the cluster.

ElastiCache for Redis will attempt to remove all node groups except those listed by NodeGroupsToRetain from the cluster.

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 hasNodeGroupsToRetain() method.

Returns:

If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. NodeGroupsToRetain is a list of NodeGroupIds to retain in the cluster.

ElastiCache for Redis will attempt to remove all node groups except those listed by NodeGroupsToRetain from the cluster.

toBuilder

public ModifyReplicationGroupShardConfigurationRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ModifyReplicationGroupShardConfigurationRequest.Builder,ModifyReplicationGroupShardConfigurationRequest>

Specified by:

toBuilder in class ElastiCacheRequest

builder

public static ModifyReplicationGroupShardConfigurationRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo