Class ModifyReplicationGroupShardConfigurationRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ModifyReplicationGroupShardConfigurationRequest.Builder,
ModifyReplicationGroupShardConfigurationRequest>
Represents the input for a ModifyReplicationGroupShardConfiguration
operation.
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
-
Method Summary
Modifier and TypeMethodDescriptionfinal Boolean
Indicates that the shard reconfiguration process begins immediately.builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the NodeGroupsToRemove property.final boolean
For responses, this returns true if the service returned a value for the NodeGroupsToRetain property.final boolean
For responses, this returns true if the service returned a value for the ReshardingConfiguration property.final Integer
The number of node groups (shards) that results from the modification of the shard configuration.If the value ofNodeGroupCount
is less than the current number of node groups (shards), then eitherNodeGroupsToRemove
orNodeGroupsToRetain
is required.If the value ofNodeGroupCount
is less than the current number of node groups (shards), then eitherNodeGroupsToRemove
orNodeGroupsToRetain
is required.final String
The name of the Redis (cluster mode enabled) cluster (replication group) on which the shards are to be configured.final List
<ReshardingConfiguration> Specifies the preferred availability zones for each node group in the cluster.static Class
<? extends ModifyReplicationGroupShardConfigurationRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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
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 theisEmpty()
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
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 theisEmpty()
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
If the value of
NodeGroupCount
is less than the current number of node groups (shards), then eitherNodeGroupsToRemove
orNodeGroupsToRetain
is required.NodeGroupsToRemove
is a list ofNodeGroupId
s 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 eitherNodeGroupsToRemove
orNodeGroupsToRetain
is required.NodeGroupsToRemove
is a list ofNodeGroupId
s 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 theisEmpty()
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
If the value of
NodeGroupCount
is less than the current number of node groups (shards), then eitherNodeGroupsToRemove
orNodeGroupsToRetain
is required.NodeGroupsToRetain
is a list ofNodeGroupId
s 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 eitherNodeGroupsToRemove
orNodeGroupsToRetain
is required.NodeGroupsToRetain
is a list ofNodeGroupId
s to retain in the cluster.ElastiCache for Redis will attempt to remove all node groups except those listed by
NodeGroupsToRetain
from the cluster.
-
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 interfaceToCopyableBuilder<ModifyReplicationGroupShardConfigurationRequest.Builder,
ModifyReplicationGroupShardConfigurationRequest> - Specified by:
toBuilder
in classElastiCacheRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends ModifyReplicationGroupShardConfigurationRequest.Builder> serializableBuilderClass() -
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-