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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb

Overview

Note:

When making an API call, you may pass DecreaseNodeGroupsInGlobalReplicationGroupMessage data as a 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
}

Constant Summary collapse

SENSITIVE =
[]

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)


2697
2698
2699
2700
2701
2702
2703
2704
2705
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 2697

class DecreaseNodeGroupsInGlobalReplicationGroupMessage < Struct.new(
  :global_replication_group_id,
  :node_group_count,
  :global_node_groups_to_remove,
  :global_node_groups_to_retain,
  :apply_immediately)
  SENSITIVE = []
  include Aws::Structure
end

#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>)


2697
2698
2699
2700
2701
2702
2703
2704
2705
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 2697

class DecreaseNodeGroupsInGlobalReplicationGroupMessage < Struct.new(
  :global_replication_group_id,
  :node_group_count,
  :global_node_groups_to_remove,
  :global_node_groups_to_retain,
  :apply_immediately)
  SENSITIVE = []
  include Aws::Structure
end

#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>)


2697
2698
2699
2700
2701
2702
2703
2704
2705
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 2697

class DecreaseNodeGroupsInGlobalReplicationGroupMessage < Struct.new(
  :global_replication_group_id,
  :node_group_count,
  :global_node_groups_to_remove,
  :global_node_groups_to_retain,
  :apply_immediately)
  SENSITIVE = []
  include Aws::Structure
end

#global_replication_group_idString

The name of the Global Datastore

Returns:

  • (String)


2697
2698
2699
2700
2701
2702
2703
2704
2705
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 2697

class DecreaseNodeGroupsInGlobalReplicationGroupMessage < Struct.new(
  :global_replication_group_id,
  :node_group_count,
  :global_node_groups_to_remove,
  :global_node_groups_to_retain,
  :apply_immediately)
  SENSITIVE = []
  include Aws::Structure
end

#node_group_countInteger

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

Returns:

  • (Integer)


2697
2698
2699
2700
2701
2702
2703
2704
2705
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 2697

class DecreaseNodeGroupsInGlobalReplicationGroupMessage < Struct.new(
  :global_replication_group_id,
  :node_group_count,
  :global_node_groups_to_remove,
  :global_node_groups_to_retain,
  :apply_immediately)
  SENSITIVE = []
  include Aws::Structure
end