com.amazonaws.services.elasticache.model

Class DecreaseReplicaCountRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.elasticache.model.DecreaseReplicaCountRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DecreaseReplicaCountRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DecreaseReplicaCountRequest()

Method Summary

Modifier and Type	Method and Description
DecreaseReplicaCountRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Boolean	getApplyImmediately() If True, the number of replica nodes is decreased immediately.
Integer	getNewReplicaCount() The number of read replica nodes you want at the completion of this operation.
List<ConfigureShard>	getReplicaConfiguration() A list of ConfigureShard objects that can be used to configure each shard in a Redis OSS (cluster mode enabled) replication group.
List<String>	getReplicasToRemove() A list of the node ids to remove from the replication group or node group (shard).
String	getReplicationGroupId() The id of the replication group from which you want to remove replica nodes.
int	hashCode()
Boolean	isApplyImmediately() If True, the number of replica nodes is decreased immediately.
void	setApplyImmediately(Boolean applyImmediately) If True, the number of replica nodes is decreased immediately.
void	setNewReplicaCount(Integer newReplicaCount) The number of read replica nodes you want at the completion of this operation.
void	setReplicaConfiguration(Collection<ConfigureShard> replicaConfiguration) A list of ConfigureShard objects that can be used to configure each shard in a Redis OSS (cluster mode enabled) replication group.
void	setReplicasToRemove(Collection<String> replicasToRemove) A list of the node ids to remove from the replication group or node group (shard).
void	setReplicationGroupId(String replicationGroupId) The id of the replication group from which you want to remove replica nodes.
String	toString() Returns a string representation of this object.
DecreaseReplicaCountRequest	withApplyImmediately(Boolean applyImmediately) If True, the number of replica nodes is decreased immediately.
DecreaseReplicaCountRequest	withNewReplicaCount(Integer newReplicaCount) The number of read replica nodes you want at the completion of this operation.
DecreaseReplicaCountRequest	withReplicaConfiguration(Collection<ConfigureShard> replicaConfiguration) A list of ConfigureShard objects that can be used to configure each shard in a Redis OSS (cluster mode enabled) replication group.
DecreaseReplicaCountRequest	withReplicaConfiguration(ConfigureShard... replicaConfiguration) A list of ConfigureShard objects that can be used to configure each shard in a Redis OSS (cluster mode enabled) replication group.
DecreaseReplicaCountRequest	withReplicasToRemove(Collection<String> replicasToRemove) A list of the node ids to remove from the replication group or node group (shard).
DecreaseReplicaCountRequest	withReplicasToRemove(String... replicasToRemove) A list of the node ids to remove from the replication group or node group (shard).
DecreaseReplicaCountRequest	withReplicationGroupId(String replicationGroupId) The id of the replication group from which you want to remove replica nodes.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DecreaseReplicaCountRequest

public DecreaseReplicaCountRequest()

Method Detail

setReplicationGroupId

public void setReplicationGroupId(String replicationGroupId)

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

Parameters:

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

getReplicationGroupId

public String getReplicationGroupId()

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.

withReplicationGroupId

public DecreaseReplicaCountRequest withReplicationGroupId(String replicationGroupId)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setNewReplicaCount

public void setNewReplicaCount(Integer newReplicaCount)

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

  • If Multi-AZ is enabled: 1

  • If Multi-AZ is not enabled: 0

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

Parameters:

newReplicaCount - The number of read replica nodes you want at the completion of this operation. For Redis OSS (cluster mode disabled) replication groups, this is the number of replica nodes in the replication group. For Redis OSS (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 OSS (cluster mode disabled)

  • If Multi-AZ is enabled: 1

  • If Multi-AZ is not enabled: 0

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

getNewReplicaCount

public Integer getNewReplicaCount()

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

  • If Multi-AZ is enabled: 1

  • If Multi-AZ is not enabled: 0

• Redis OSS (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 OSS (cluster mode disabled) replication groups, this is the number of replica nodes in the replication group. For Redis OSS (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 OSS (cluster mode disabled)

  • If Multi-AZ is enabled: 1

  • If Multi-AZ is not enabled: 0

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

withNewReplicaCount

public DecreaseReplicaCountRequest withNewReplicaCount(Integer newReplicaCount)

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

  • If Multi-AZ is enabled: 1

  • If Multi-AZ is not enabled: 0

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

Parameters:

newReplicaCount - The number of read replica nodes you want at the completion of this operation. For Redis OSS (cluster mode disabled) replication groups, this is the number of replica nodes in the replication group. For Redis OSS (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 OSS (cluster mode disabled)

  • If Multi-AZ is enabled: 1

  • If Multi-AZ is not enabled: 0

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

Returns:

Returns a reference to this object so that method calls can be chained together.

getReplicaConfiguration

public List<ConfigureShard> getReplicaConfiguration()

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

Returns:

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

setReplicaConfiguration

public void setReplicaConfiguration(Collection<ConfigureShard> replicaConfiguration)

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

Parameters:

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

withReplicaConfiguration

public DecreaseReplicaCountRequest withReplicaConfiguration(ConfigureShard... replicaConfiguration)

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

NOTE: This method appends the values to the existing list (if any). Use setReplicaConfiguration(java.util.Collection) or withReplicaConfiguration(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

withReplicaConfiguration

public DecreaseReplicaCountRequest withReplicaConfiguration(Collection<ConfigureShard> replicaConfiguration)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

getReplicasToRemove

public List<String> getReplicasToRemove()

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

Returns:

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

setReplicasToRemove

public void setReplicasToRemove(Collection<String> replicasToRemove)

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

Parameters:

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

withReplicasToRemove

public DecreaseReplicaCountRequest withReplicasToRemove(String... replicasToRemove)

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

NOTE: This method appends the values to the existing list (if any). Use setReplicasToRemove(java.util.Collection) or withReplicasToRemove(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

withReplicasToRemove

public DecreaseReplicaCountRequest withReplicasToRemove(Collection<String> replicasToRemove)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setApplyImmediately

public void setApplyImmediately(Boolean applyImmediately)

If True, the number of replica nodes is decreased immediately. ApplyImmediately=False is not currently supported.

Parameters:

applyImmediately - If True, the number of replica nodes is decreased immediately. ApplyImmediately=False is not currently supported.

getApplyImmediately

public Boolean getApplyImmediately()

If True, the number of replica nodes is decreased immediately. ApplyImmediately=False is not currently supported.

Returns:

If True, the number of replica nodes is decreased immediately. ApplyImmediately=False is not currently supported.

withApplyImmediately

public DecreaseReplicaCountRequest withApplyImmediately(Boolean applyImmediately)

If True, the number of replica nodes is decreased immediately. ApplyImmediately=False is not currently supported.

Parameters:

applyImmediately - If True, the number of replica nodes is decreased immediately. ApplyImmediately=False is not currently supported.

Returns:

Returns a reference to this object so that method calls can be chained together.

isApplyImmediately

public Boolean isApplyImmediately()

If True, the number of replica nodes is decreased immediately. ApplyImmediately=False is not currently supported.

Returns:

If True, the number of replica nodes is decreased immediately. ApplyImmediately=False is not currently supported.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public DecreaseReplicaCountRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()