com.amazonaws.services.elasticache.model

Class ModifyReplicationGroupShardConfigurationRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.elasticache.model.ModifyReplicationGroupShardConfigurationRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Represents the input for a ModifyReplicationGroupShardConfiguration operation.

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ModifyReplicationGroupShardConfigurationRequest()

Method Summary

Modifier and Type	Method and Description
ModifyReplicationGroupShardConfigurationRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Boolean	getApplyImmediately() Indicates that the shard reconfiguration process begins immediately.
Integer	getNodeGroupCount() The number of node groups (shards) that results from the modification of the shard configuration.
List<String>	getNodeGroupsToRemove() If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required.
List<String>	getNodeGroupsToRetain() If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required.
String	getReplicationGroupId() The name of the Redis OSS (cluster mode enabled) cluster (replication group) on which the shards are to be configured.
List<ReshardingConfiguration>	getReshardingConfiguration() Specifies the preferred availability zones for each node group in the cluster.
int	hashCode()
Boolean	isApplyImmediately() Indicates that the shard reconfiguration process begins immediately.
void	setApplyImmediately(Boolean applyImmediately) Indicates that the shard reconfiguration process begins immediately.
void	setNodeGroupCount(Integer nodeGroupCount) The number of node groups (shards) that results from the modification of the shard configuration.
void	setNodeGroupsToRemove(Collection<String> nodeGroupsToRemove) If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required.
void	setNodeGroupsToRetain(Collection<String> nodeGroupsToRetain) If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required.
void	setReplicationGroupId(String replicationGroupId) The name of the Redis OSS (cluster mode enabled) cluster (replication group) on which the shards are to be configured.
void	setReshardingConfiguration(Collection<ReshardingConfiguration> reshardingConfiguration) Specifies the preferred availability zones for each node group in the cluster.
String	toString() Returns a string representation of this object.
ModifyReplicationGroupShardConfigurationRequest	withApplyImmediately(Boolean applyImmediately) Indicates that the shard reconfiguration process begins immediately.
ModifyReplicationGroupShardConfigurationRequest	withNodeGroupCount(Integer nodeGroupCount) The number of node groups (shards) that results from the modification of the shard configuration.
ModifyReplicationGroupShardConfigurationRequest	withNodeGroupsToRemove(Collection<String> nodeGroupsToRemove) If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required.
ModifyReplicationGroupShardConfigurationRequest	withNodeGroupsToRemove(String... nodeGroupsToRemove) If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required.
ModifyReplicationGroupShardConfigurationRequest	withNodeGroupsToRetain(Collection<String> nodeGroupsToRetain) If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required.
ModifyReplicationGroupShardConfigurationRequest	withNodeGroupsToRetain(String... nodeGroupsToRetain) If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required.
ModifyReplicationGroupShardConfigurationRequest	withReplicationGroupId(String replicationGroupId) The name of the Redis OSS (cluster mode enabled) cluster (replication group) on which the shards are to be configured.
ModifyReplicationGroupShardConfigurationRequest	withReshardingConfiguration(Collection<ReshardingConfiguration> reshardingConfiguration) Specifies the preferred availability zones for each node group in the cluster.
ModifyReplicationGroupShardConfigurationRequest	withReshardingConfiguration(ReshardingConfiguration... reshardingConfiguration) Specifies the preferred availability zones for each node group in the cluster.

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

ModifyReplicationGroupShardConfigurationRequest

public ModifyReplicationGroupShardConfigurationRequest()

Method Detail

setReplicationGroupId

public void setReplicationGroupId(String replicationGroupId)

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

Parameters:

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

getReplicationGroupId

public String getReplicationGroupId()

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

Returns:

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

withReplicationGroupId

public ModifyReplicationGroupShardConfigurationRequest withReplicationGroupId(String replicationGroupId)

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

Parameters:

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

Returns:

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

setNodeGroupCount

public void setNodeGroupCount(Integer nodeGroupCount)

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

Parameters:

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

getNodeGroupCount

public Integer getNodeGroupCount()

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.

withNodeGroupCount

public ModifyReplicationGroupShardConfigurationRequest withNodeGroupCount(Integer nodeGroupCount)

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

Parameters:

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

Returns:

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

setApplyImmediately

public void setApplyImmediately(Boolean applyImmediately)

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

Value: true

Parameters:

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

Value: true

getApplyImmediately

public Boolean getApplyImmediately()

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

withApplyImmediately

public ModifyReplicationGroupShardConfigurationRequest withApplyImmediately(Boolean applyImmediately)

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

Value: true

Parameters:

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

Value: true

Returns:

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

isApplyImmediately

public Boolean isApplyImmediately()

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

getReshardingConfiguration

public List<ReshardingConfiguration> getReshardingConfiguration()

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

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

setReshardingConfiguration

public void setReshardingConfiguration(Collection<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).

Parameters:

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

withReshardingConfiguration

public ModifyReplicationGroupShardConfigurationRequest withReshardingConfiguration(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).

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

Parameters:

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

Returns:

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

withReshardingConfiguration

public ModifyReplicationGroupShardConfigurationRequest withReshardingConfiguration(Collection<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).

Parameters:

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

Returns:

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

getNodeGroupsToRemove

public List<String> getNodeGroupsToRemove()

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 (Redis OSS) will attempt to remove all node groups listed by NodeGroupsToRemove from the cluster.

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 (Redis OSS) will attempt to remove all node groups listed by NodeGroupsToRemove from the cluster.

setNodeGroupsToRemove

public void setNodeGroupsToRemove(Collection<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 (Redis OSS) will attempt to remove all node groups listed by NodeGroupsToRemove from the cluster.

Parameters:

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 (Redis OSS) will attempt to remove all node groups listed by NodeGroupsToRemove from the cluster.

withNodeGroupsToRemove

public ModifyReplicationGroupShardConfigurationRequest withNodeGroupsToRemove(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 (Redis OSS) will attempt to remove all node groups listed by NodeGroupsToRemove from the cluster.

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

Parameters:

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 (Redis OSS) will attempt to remove all node groups listed by NodeGroupsToRemove from the cluster.

Returns:

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

withNodeGroupsToRemove

public ModifyReplicationGroupShardConfigurationRequest withNodeGroupsToRemove(Collection<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 (Redis OSS) will attempt to remove all node groups listed by NodeGroupsToRemove from the cluster.

Parameters:

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 (Redis OSS) will attempt to remove all node groups listed by NodeGroupsToRemove from the cluster.

Returns:

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

getNodeGroupsToRetain

public List<String> getNodeGroupsToRetain()

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 (Redis OSS) will attempt to remove all node groups except those listed by NodeGroupsToRetain from the cluster.

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 (Redis OSS) will attempt to remove all node groups except those listed by NodeGroupsToRetain from the cluster.

setNodeGroupsToRetain

public void setNodeGroupsToRetain(Collection<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 (Redis OSS) will attempt to remove all node groups except those listed by NodeGroupsToRetain from the cluster.

Parameters:

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 (Redis OSS) will attempt to remove all node groups except those listed by NodeGroupsToRetain from the cluster.

withNodeGroupsToRetain

public ModifyReplicationGroupShardConfigurationRequest withNodeGroupsToRetain(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 (Redis OSS) will attempt to remove all node groups except those listed by NodeGroupsToRetain from the cluster.

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

Parameters:

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 (Redis OSS) will attempt to remove all node groups except those listed by NodeGroupsToRetain from the cluster.

Returns:

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

withNodeGroupsToRetain

public ModifyReplicationGroupShardConfigurationRequest withNodeGroupsToRetain(Collection<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 (Redis OSS) will attempt to remove all node groups except those listed by NodeGroupsToRetain from the cluster.

Parameters:

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 (Redis OSS) will attempt to remove all node groups except those listed by NodeGroupsToRetain from the cluster.

Returns:

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

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 ModifyReplicationGroupShardConfigurationRequest 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()