com.amazonaws.services.elasticache.model

Class ConfigureShard

java.lang.Object

com.amazonaws.services.elasticache.model.ConfigureShard

All Implemented Interfaces:

Serializable, Cloneable

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

Node group (shard) configuration options when adding or removing replicas. Each node group (shard) configuration has the following members: NodeGroupId, NewReplicaCount, and PreferredAvailabilityZones.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ConfigureShard()

Method Summary

Modifier and Type	Method and Description
ConfigureShard	clone()
boolean	equals(Object obj)
Integer	getNewReplicaCount() The number of replicas you want in this node group at the end of this operation.
String	getNodeGroupId() The 4-digit id for the node group you are configuring.
List<String>	getPreferredAvailabilityZones() A list of PreferredAvailabilityZone strings that specify which availability zones the replication group's nodes are to be in.
List<String>	getPreferredOutpostArns() The outpost ARNs in which the cache cluster is created.
int	hashCode()
void	setNewReplicaCount(Integer newReplicaCount) The number of replicas you want in this node group at the end of this operation.
void	setNodeGroupId(String nodeGroupId) The 4-digit id for the node group you are configuring.
void	setPreferredAvailabilityZones(Collection<String> preferredAvailabilityZones) A list of PreferredAvailabilityZone strings that specify which availability zones the replication group's nodes are to be in.
void	setPreferredOutpostArns(Collection<String> preferredOutpostArns) The outpost ARNs in which the cache cluster is created.
String	toString() Returns a string representation of this object.
ConfigureShard	withNewReplicaCount(Integer newReplicaCount) The number of replicas you want in this node group at the end of this operation.
ConfigureShard	withNodeGroupId(String nodeGroupId) The 4-digit id for the node group you are configuring.
ConfigureShard	withPreferredAvailabilityZones(Collection<String> preferredAvailabilityZones) A list of PreferredAvailabilityZone strings that specify which availability zones the replication group's nodes are to be in.
ConfigureShard	withPreferredAvailabilityZones(String... preferredAvailabilityZones) A list of PreferredAvailabilityZone strings that specify which availability zones the replication group's nodes are to be in.
ConfigureShard	withPreferredOutpostArns(Collection<String> preferredOutpostArns) The outpost ARNs in which the cache cluster is created.
ConfigureShard	withPreferredOutpostArns(String... preferredOutpostArns) The outpost ARNs in which the cache cluster is created.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ConfigureShard

public ConfigureShard()

Method Detail

setNodeGroupId

public void setNodeGroupId(String nodeGroupId)

The 4-digit id for the node group you are configuring. For Redis OSS (cluster mode disabled) replication groups, the node group id is always 0001. To find a Redis OSS (cluster mode enabled)'s node group's (shard's) id, see Finding a Shard's Id.

Parameters:

nodeGroupId - The 4-digit id for the node group you are configuring. For Redis OSS (cluster mode disabled) replication groups, the node group id is always 0001. To find a Redis OSS (cluster mode enabled)'s node group's (shard's) id, see Finding a Shard's Id.

getNodeGroupId

public String getNodeGroupId()

The 4-digit id for the node group you are configuring. For Redis OSS (cluster mode disabled) replication groups, the node group id is always 0001. To find a Redis OSS (cluster mode enabled)'s node group's (shard's) id, see Finding a Shard's Id.

Returns:

The 4-digit id for the node group you are configuring. For Redis OSS (cluster mode disabled) replication groups, the node group id is always 0001. To find a Redis OSS (cluster mode enabled)'s node group's (shard's) id, see Finding a Shard's Id.

withNodeGroupId

public ConfigureShard withNodeGroupId(String nodeGroupId)

The 4-digit id for the node group you are configuring. For Redis OSS (cluster mode disabled) replication groups, the node group id is always 0001. To find a Redis OSS (cluster mode enabled)'s node group's (shard's) id, see Finding a Shard's Id.

Parameters:

nodeGroupId - The 4-digit id for the node group you are configuring. For Redis OSS (cluster mode disabled) replication groups, the node group id is always 0001. To find a Redis OSS (cluster mode enabled)'s node group's (shard's) id, see Finding a Shard's Id.

Returns:

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

setNewReplicaCount

public void setNewReplicaCount(Integer newReplicaCount)

The number of replicas you want in this node group at the end of this operation. The maximum value for NewReplicaCount is 5. The minimum value depends upon the type of Redis OSS replication group you are working with.

The minimum number of replicas in a shard or replication group is:

• Redis OSS (cluster mode disabled)

  • If Multi-AZ: 1

  • If Multi-AZ: 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 replicas you want in this node group at the end of this operation. The maximum value for NewReplicaCount is 5. The minimum value depends upon the type of Redis OSS replication group you are working with.

The minimum number of replicas in a shard or replication group is:

• Redis OSS (cluster mode disabled)

  • If Multi-AZ: 1

  • If Multi-AZ: 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 replicas you want in this node group at the end of this operation. The maximum value for NewReplicaCount is 5. The minimum value depends upon the type of Redis OSS replication group you are working with.

The minimum number of replicas in a shard or replication group is:

• Redis OSS (cluster mode disabled)

  • If Multi-AZ: 1

  • If Multi-AZ: 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 replicas you want in this node group at the end of this operation. The maximum value for NewReplicaCount is 5. The minimum value depends upon the type of Redis OSS replication group you are working with.

The minimum number of replicas in a shard or replication group is:

• Redis OSS (cluster mode disabled)

  • If Multi-AZ: 1

  • If Multi-AZ: 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 ConfigureShard withNewReplicaCount(Integer newReplicaCount)

The number of replicas you want in this node group at the end of this operation. The maximum value for NewReplicaCount is 5. The minimum value depends upon the type of Redis OSS replication group you are working with.

The minimum number of replicas in a shard or replication group is:

• Redis OSS (cluster mode disabled)

  • If Multi-AZ: 1

  • If Multi-AZ: 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 replicas you want in this node group at the end of this operation. The maximum value for NewReplicaCount is 5. The minimum value depends upon the type of Redis OSS replication group you are working with.

The minimum number of replicas in a shard or replication group is:

• Redis OSS (cluster mode disabled)

  • If Multi-AZ: 1

  • If Multi-AZ: 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.

getPreferredAvailabilityZones

public List<String> getPreferredAvailabilityZones()

A list of PreferredAvailabilityZone strings that specify which availability zones the replication group's nodes are to be in. The nummber of PreferredAvailabilityZone values must equal the value of NewReplicaCount plus 1 to account for the primary node. If this member of ReplicaConfiguration is omitted, ElastiCache (Redis OSS) selects the availability zone for each of the replicas.

Returns:

A list of PreferredAvailabilityZone strings that specify which availability zones the replication group's nodes are to be in. The nummber of PreferredAvailabilityZone values must equal the value of NewReplicaCount plus 1 to account for the primary node. If this member of ReplicaConfiguration is omitted, ElastiCache (Redis OSS) selects the availability zone for each of the replicas.

setPreferredAvailabilityZones

public void setPreferredAvailabilityZones(Collection<String> preferredAvailabilityZones)

A list of PreferredAvailabilityZone strings that specify which availability zones the replication group's nodes are to be in. The nummber of PreferredAvailabilityZone values must equal the value of NewReplicaCount plus 1 to account for the primary node. If this member of ReplicaConfiguration is omitted, ElastiCache (Redis OSS) selects the availability zone for each of the replicas.

Parameters:

preferredAvailabilityZones - A list of PreferredAvailabilityZone strings that specify which availability zones the replication group's nodes are to be in. The nummber of PreferredAvailabilityZone values must equal the value of NewReplicaCount plus 1 to account for the primary node. If this member of ReplicaConfiguration is omitted, ElastiCache (Redis OSS) selects the availability zone for each of the replicas.

withPreferredAvailabilityZones

public ConfigureShard withPreferredAvailabilityZones(String... preferredAvailabilityZones)

A list of PreferredAvailabilityZone strings that specify which availability zones the replication group's nodes are to be in. The nummber of PreferredAvailabilityZone values must equal the value of NewReplicaCount plus 1 to account for the primary node. If this member of ReplicaConfiguration is omitted, ElastiCache (Redis OSS) selects the availability zone for each of the replicas.

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

Parameters:

preferredAvailabilityZones - A list of PreferredAvailabilityZone strings that specify which availability zones the replication group's nodes are to be in. The nummber of PreferredAvailabilityZone values must equal the value of NewReplicaCount plus 1 to account for the primary node. If this member of ReplicaConfiguration is omitted, ElastiCache (Redis OSS) selects the availability zone for each of the replicas.

Returns:

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

withPreferredAvailabilityZones

public ConfigureShard withPreferredAvailabilityZones(Collection<String> preferredAvailabilityZones)

A list of PreferredAvailabilityZone strings that specify which availability zones the replication group's nodes are to be in. The nummber of PreferredAvailabilityZone values must equal the value of NewReplicaCount plus 1 to account for the primary node. If this member of ReplicaConfiguration is omitted, ElastiCache (Redis OSS) selects the availability zone for each of the replicas.

Parameters:

preferredAvailabilityZones - A list of PreferredAvailabilityZone strings that specify which availability zones the replication group's nodes are to be in. The nummber of PreferredAvailabilityZone values must equal the value of NewReplicaCount plus 1 to account for the primary node. If this member of ReplicaConfiguration is omitted, ElastiCache (Redis OSS) selects the availability zone for each of the replicas.

Returns:

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

getPreferredOutpostArns

public List<String> getPreferredOutpostArns()

The outpost ARNs in which the cache cluster is created.

Returns:

The outpost ARNs in which the cache cluster is created.

setPreferredOutpostArns

public void setPreferredOutpostArns(Collection<String> preferredOutpostArns)

The outpost ARNs in which the cache cluster is created.

Parameters:

preferredOutpostArns - The outpost ARNs in which the cache cluster is created.

withPreferredOutpostArns

public ConfigureShard withPreferredOutpostArns(String... preferredOutpostArns)

The outpost ARNs in which the cache cluster is created.

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

Parameters:

preferredOutpostArns - The outpost ARNs in which the cache cluster is created.

Returns:

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

withPreferredOutpostArns

public ConfigureShard withPreferredOutpostArns(Collection<String> preferredOutpostArns)

The outpost ARNs in which the cache cluster is created.

Parameters:

preferredOutpostArns - The outpost ARNs in which the cache cluster is created.

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 ConfigureShard clone()

Overrides:

clone in class Object