You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::ElastiCache::Types::ModifyReplicationGroupShardConfigurationMessage

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ModifyReplicationGroupShardConfigurationMessage as input to an Aws::Client method, you can use a vanilla Hash:

{
  replication_group_id: "String", # required
  node_group_count: 1, # required
  apply_immediately: false, # required
  resharding_configuration: [
    {
      node_group_id: "AllowedNodeGroupId",
      preferred_availability_zones: ["String"],
    },
  ],
  node_groups_to_remove: ["AllowedNodeGroupId"],
  node_groups_to_retain: ["AllowedNodeGroupId"],
}

Represents the input for a ModifyReplicationGroupShardConfiguration operation.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#apply_immediately ⇒ Boolean

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

Value: true

Returns:

  • (Boolean) —

    Indicates that the shard reconfiguration process begins immediately.

#node_group_count ⇒ Integer

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

Returns:

  • (Integer) —

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

#node_groups_to_remove ⇒ Array<String>

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

Returns:

  • (Array<String>) —

    If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required.

#node_groups_to_retain ⇒ Array<String>

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

Returns:

  • (Array<String>) —

    If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required.

#replication_group_id ⇒ String

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

Returns:

  • (String) —

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

#resharding_configuration ⇒ Array<Types::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: