software.amazon.awssdk.services.elasticache.model

Class DecreaseReplicaCountRequest

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.DecreaseReplicaCountRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DecreaseReplicaCountRequest.Builder,DecreaseReplicaCountRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DecreaseReplicaCountRequest.Builder

Method Summary

Modifier and Type	Method and Description
Boolean	applyImmediately() If True, the number of replica nodes is decreased immediately.
static DecreaseReplicaCountRequest.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
Integer	newReplicaCount() The number of read replica nodes you want at the completion of this operation.
List<ConfigureShard>	replicaConfiguration() A list of ConfigureShard objects that can be used to configure each shard in a Redis (cluster mode enabled) replication group.
List<String>	replicasToRemove() A list of the node ids to remove from the replication group or node group (shard).
String	replicationGroupId() The id of the replication group from which you want to remove replica nodes.
List<SdkField<?>>	sdkFields()
static Class<? extends DecreaseReplicaCountRequest.Builder>	serializableBuilderClass()
DecreaseReplicaCountRequest.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 software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

replicationGroupId

public String replicationGroupId()

The id of the replication group from which you want to remove replica nodes.

Returns:

The id of the replication group from which you want to remove replica nodes.

newReplicaCount

public Integer newReplicaCount()

The number of read replica nodes you want at the completion of this operation. For Redis (cluster mode disabled) replication groups, this is the number of replica nodes in the replication group. For Redis (cluster mode enabled) replication groups, this is the number of replica nodes in each of the replication group's node groups.

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 enabled: 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 read replica nodes you want at the completion of this operation. For Redis (cluster mode disabled) replication groups, this is the number of replica nodes in the replication group. For Redis (cluster mode enabled) replication groups, this is the number of replica nodes in each of the replication group's node groups.

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 enabled: 0

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

replicaConfiguration

public List<ConfigureShard> replicaConfiguration()

A list of ConfigureShard objects that can be used to configure each shard in a Redis (cluster mode enabled) replication group. The ConfigureShard has three members: NewReplicaCount, NodeGroupId, and PreferredAvailabilityZones.

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

Returns:

A list of ConfigureShard objects that can be used to configure each shard in a Redis (cluster mode enabled) replication group. The ConfigureShard has three members: NewReplicaCount, NodeGroupId, and PreferredAvailabilityZones.

replicasToRemove

public List<String> replicasToRemove()

A list of the node ids to remove from the replication group or node group (shard).

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

Returns:

A list of the node ids to remove from the replication group or node group (shard).

applyImmediately

public Boolean applyImmediately()

If True, the number of replica nodes is decreased immediately. If False, the number of replica nodes is decreased during the next maintenance window.

Returns:

If True, the number of replica nodes is decreased immediately. If False, the number of replica nodes is decreased during the next maintenance window.

toBuilder

public DecreaseReplicaCountRequest.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<DecreaseReplicaCountRequest.Builder,DecreaseReplicaCountRequest>

Specified by:

toBuilder in class ElastiCacheRequest

Returns:

a builder for type T

builder

public static DecreaseReplicaCountRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DecreaseReplicaCountRequest.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)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. 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, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

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

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.