Class: Aws::ElastiCache::Types::IncreaseReplicaCountMessage

Inherits:

Struct

• Object
• Struct
• Aws::ElastiCache::Types::IncreaseReplicaCountMessage

Defined in:

gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb

Overview

Note:

When making an API call, you may pass IncreaseReplicaCountMessage data as a hash:

{
  replication_group_id: "String", # required
  new_replica_count: 1,
  replica_configuration: [
    {
      node_group_id: "AllowedNodeGroupId", # required
      new_replica_count: 1, # required
      preferred_availability_zones: ["String"],
      preferred_outpost_arns: ["String"],
    },
  ],
  apply_immediately: false, # required
}

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #apply_immediately ⇒ Boolean

  If True, the number of replica nodes is increased immediately.

• #new_replica_count ⇒ Integer

  The number of read replica nodes you want at the completion of this operation.

• #replica_configuration ⇒ Array<Types::ConfigureShard>

  A list of ConfigureShard objects that can be used to configure each shard in a Redis (cluster mode enabled) replication group.

• #replication_group_id ⇒ String

  The id of the replication group to which you want to add replica nodes.

Instance Attribute Details

#apply_immediately ⇒ Boolean

If True, the number of replica nodes is increased immediately. ApplyImmediately=False is not currently supported.

Returns:

• (Boolean)

# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 5204

class IncreaseReplicaCountMessage < Struct.new(
  :replication_group_id,
  :new_replica_count,
  :replica_configuration,
  :apply_immediately)
  SENSITIVE = []
  include Aws::Structure
end

#new_replica_count ⇒ Integer

The number of read replica nodes you want at the completion of this operation. For Redis (cluster mode disabled) replication groups, this is the number of replica nodes in the replication group. For Redis (cluster mode enabled) replication groups, this is the number of replica nodes in each of the replication group's node groups.

Returns:

• (Integer)

# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 5204

class IncreaseReplicaCountMessage < Struct.new(
  :replication_group_id,
  :new_replica_count,
  :replica_configuration,
  :apply_immediately)
  SENSITIVE = []
  include Aws::Structure
end

#replica_configuration ⇒ Array<Types::ConfigureShard>

A list of ConfigureShard objects that can be used to configure each shard in a Redis (cluster mode enabled) replication group. The ConfigureShard has three members: NewReplicaCount, NodeGroupId, and PreferredAvailabilityZones.

Returns:

• (Array<Types::ConfigureShard>)

# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 5204

class IncreaseReplicaCountMessage < Struct.new(
  :replication_group_id,
  :new_replica_count,
  :replica_configuration,
  :apply_immediately)
  SENSITIVE = []
  include Aws::Structure
end

#replication_group_id ⇒ String

The id of the replication group to which you want to add replica nodes.

Returns:

• (String)

# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 5204

class IncreaseReplicaCountMessage < Struct.new(
  :replication_group_id,
  :new_replica_count,
  :replica_configuration,
  :apply_immediately)
  SENSITIVE = []
  include Aws::Structure
end