Interface CfnReplicationGroup.INodeGroupConfigurationProperty
NodeGroupConfiguration
is a property of the AWS::ElastiCache::ReplicationGroup
resource that configures an Amazon ElastiCache (ElastiCache) Redis cluster node group.
Namespace: Amazon.CDK.AWS.ElastiCache
Assembly: Amazon.CDK.AWS.ElastiCache.dll
Syntax (csharp)
public interface INodeGroupConfigurationProperty
Syntax (vb)
Public Interface INodeGroupConfigurationProperty
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.ElastiCache;
var nodeGroupConfigurationProperty = new NodeGroupConfigurationProperty {
NodeGroupId = "nodeGroupId",
PrimaryAvailabilityZone = "primaryAvailabilityZone",
ReplicaAvailabilityZones = new [] { "replicaAvailabilityZones" },
ReplicaCount = 123,
Slots = "slots"
};
Synopsis
Properties
NodeGroupId | Either the ElastiCache for Redis supplied 4-digit id or a user supplied id for the node group these configuration values apply to. |
PrimaryAvailabilityZone | The Availability Zone where the primary node of this node group (shard) is launched. |
ReplicaAvailabilityZones | A list of Availability Zones to be used for the read replicas. |
ReplicaCount | The number of read replica nodes in this node group (shard). |
Slots | A string of comma-separated values where the first set of values are the slot numbers (zero based), and the second set of values are the keyspaces for each slot. |
Properties
NodeGroupId
Either the ElastiCache for Redis supplied 4-digit id or a user supplied id for the node group these configuration values apply to.
virtual string NodeGroupId { get; }
Property Value
System.String
Remarks
PrimaryAvailabilityZone
The Availability Zone where the primary node of this node group (shard) is launched.
virtual string PrimaryAvailabilityZone { get; }
Property Value
System.String
Remarks
ReplicaAvailabilityZones
A list of Availability Zones to be used for the read replicas.
virtual string[] ReplicaAvailabilityZones { get; }
Property Value
System.String[]
Remarks
The number of Availability Zones in this list must match the value of ReplicaCount
or ReplicasPerNodeGroup
if not specified.
ReplicaCount
The number of read replica nodes in this node group (shard).
virtual Nullable<double> ReplicaCount { get; }
Property Value
System.Nullable<System.Double>
Remarks
Slots
A string of comma-separated values where the first set of values are the slot numbers (zero based), and the second set of values are the keyspaces for each slot.
virtual string Slots { get; }
Property Value
System.String
Remarks
The following example specifies three slots (numbered 0, 1, and 2): 0,1,2,0-4999,5000-9999,10000-16,383
.
If you don't specify a value, ElastiCache allocates keys equally among each slot.
When you use an UseOnlineResharding
update policy to update the number of node groups without interruption, ElastiCache evenly distributes the keyspaces between the specified number of slots. This cannot be updated later. Therefore, after updating the number of node groups in this way, you should remove the value specified for the Slots
property of each NodeGroupConfiguration
from the stack template, as it no longer reflects the actual values in each node group. For more information, see UseOnlineResharding Policy .