Interface ConfigureShard.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<ConfigureShard.Builder,
,ConfigureShard> SdkBuilder<ConfigureShard.Builder,
,ConfigureShard> SdkPojo
- Enclosing class:
ConfigureShard
-
Method Summary
Modifier and TypeMethodDescriptionnewReplicaCount
(Integer newReplicaCount) The number of replicas you want in this node group at the end of this operation.nodeGroupId
(String nodeGroupId) The 4-digit id for the node group you are configuring.preferredAvailabilityZones
(String... preferredAvailabilityZones) A list ofPreferredAvailabilityZone
strings that specify which availability zones the replication group's nodes are to be in.preferredAvailabilityZones
(Collection<String> preferredAvailabilityZones) A list ofPreferredAvailabilityZone
strings that specify which availability zones the replication group's nodes are to be in.preferredOutpostArns
(String... preferredOutpostArns) The outpost ARNs in which the cache cluster is created.preferredOutpostArns
(Collection<String> preferredOutpostArns) The outpost ARNs in which the cache cluster is created.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
nodeGroupId
The 4-digit id for the node group you are configuring. For Redis (cluster mode disabled) replication groups, the node group id is always 0001. To find a Redis (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 (cluster mode disabled) replication groups, the node group id is always 0001. To find a Redis (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.
-
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 replication group you are working with.The minimum number of replicas in a shard or replication group is:
-
Redis (cluster mode disabled)
-
If Multi-AZ: 1
-
If Multi-AZ: 0
-
-
Redis (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 forNewReplicaCount
is 5. The minimum value depends upon the type of Redis replication group you are working with.The minimum number of replicas in a shard or replication group is:
-
Redis (cluster mode disabled)
-
If Multi-AZ: 1
-
If Multi-AZ: 0
-
-
Redis (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.
-
-
preferredAvailabilityZones
A list of
PreferredAvailabilityZone
strings that specify which availability zones the replication group's nodes are to be in. The nummber ofPreferredAvailabilityZone
values must equal the value ofNewReplicaCount
plus 1 to account for the primary node. If this member ofReplicaConfiguration
is omitted, ElastiCache for Redis selects the availability zone for each of the replicas.- Parameters:
preferredAvailabilityZones
- A list ofPreferredAvailabilityZone
strings that specify which availability zones the replication group's nodes are to be in. The nummber ofPreferredAvailabilityZone
values must equal the value ofNewReplicaCount
plus 1 to account for the primary node. If this member ofReplicaConfiguration
is omitted, ElastiCache for Redis selects the availability zone for each of the replicas.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
preferredAvailabilityZones
A list of
PreferredAvailabilityZone
strings that specify which availability zones the replication group's nodes are to be in. The nummber ofPreferredAvailabilityZone
values must equal the value ofNewReplicaCount
plus 1 to account for the primary node. If this member ofReplicaConfiguration
is omitted, ElastiCache for Redis selects the availability zone for each of the replicas.- Parameters:
preferredAvailabilityZones
- A list ofPreferredAvailabilityZone
strings that specify which availability zones the replication group's nodes are to be in. The nummber ofPreferredAvailabilityZone
values must equal the value ofNewReplicaCount
plus 1 to account for the primary node. If this member ofReplicaConfiguration
is omitted, ElastiCache for Redis selects the availability zone for each of the replicas.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
-
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.
-