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

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

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 ModifyReplicationGroupShardConfigurationMessage data as a hash:

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

Represents the input for a ModifyReplicationGroupShardConfiguration operation.

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.

Value: true

Returns:

  • (Boolean)


4123
4124
4125
4126
4127
4128
4129
4130
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 4123

class ModifyReplicationGroupShardConfigurationMessage < Struct.new(
  :replication_group_id,
  :node_group_count,
  :apply_immediately,
  :resharding_configuration,
  :node_groups_to_remove)
  include Aws::Structure
end

#node_group_countInteger

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

Returns:

  • (Integer)


4123
4124
4125
4126
4127
4128
4129
4130
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 4123

class ModifyReplicationGroupShardConfigurationMessage < Struct.new(
  :replication_group_id,
  :node_group_count,
  :apply_immediately,
  :resharding_configuration,
  :node_groups_to_remove)
  include Aws::Structure
end

#node_groups_to_removeArray<String>

If the value of NodeGroupCount is less than the current number of node groups (shards), NodeGroupsToRemove is a required list of node group ids to remove from the cluster.

Returns:

  • (Array<String>)


4123
4124
4125
4126
4127
4128
4129
4130
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 4123

class ModifyReplicationGroupShardConfigurationMessage < Struct.new(
  :replication_group_id,
  :node_group_count,
  :apply_immediately,
  :resharding_configuration,
  :node_groups_to_remove)
  include Aws::Structure
end

#replication_group_idString

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

Returns:

  • (String)


4123
4124
4125
4126
4127
4128
4129
4130
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 4123

class ModifyReplicationGroupShardConfigurationMessage < Struct.new(
  :replication_group_id,
  :node_group_count,
  :apply_immediately,
  :resharding_configuration,
  :node_groups_to_remove)
  include Aws::Structure
end

#resharding_configurationArray<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:



4123
4124
4125
4126
4127
4128
4129
4130
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 4123

class ModifyReplicationGroupShardConfigurationMessage < Struct.new(
  :replication_group_id,
  :node_group_count,
  :apply_immediately,
  :resharding_configuration,
  :node_groups_to_remove)
  include Aws::Structure
end