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

Class: Aws::ElastiCache::Types::DecreaseNodeGroupsInGlobalReplicationGroupMessage

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

Overview

Note:

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

{
  global_replication_group_id: "String", # required
  node_group_count: 1, # required
  global_node_groups_to_remove: ["String"],
  global_node_groups_to_retain: ["String"],
  apply_immediately: false, # required
}

Instance Attribute Summary collapse

Instance Attribute Details

#apply_immediatelyBoolean

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

Returns:

  • (Boolean)

    Indicates that the shard reconfiguration process begins immediately.

#global_node_groups_to_removeArray<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.

#global_node_groups_to_retainArray<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.

#global_replication_group_idString

The name of the Global Datastore

Returns:

  • (String)

    The name of the Global Datastore.

#node_group_countInteger

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.