class Aws::ElastiCache::Types::DecreaseReplicaCountMessage

@note When making an API call, you may pass DecreaseReplicaCountMessage

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"],
        },
      ],
      replicas_to_remove: ["String"],
      apply_immediately: false, # required
    }

@!attribute [rw] replication_group_id

The id of the replication group from which you want to remove
replica nodes.
@return [String]

@!attribute [rw] new_replica_count

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.

The minimum number of replicas in a shard or replication group is:

* Redis (cluster mode disabled)

  * If Multi-AZ is enabled: 1

  * If Multi-AZ is not enabled: 0

* Redis (cluster mode enabled): 0 (though you will not be able to
  failover to a replica if your primary node fails)
@return [Integer]

@!attribute [rw] replica_configuration

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`.
@return [Array<Types::ConfigureShard>]

@!attribute [rw] replicas_to_remove

A list of the node ids to remove from the replication group or node
group (shard).
@return [Array<String>]

@!attribute [rw] apply_immediately

If `True`, the number of replica nodes is decreased immediately.
`ApplyImmediately=False` is not currently supported.
@return [Boolean]

@see docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/DecreaseReplicaCountMessage AWS API Documentation

Constants

SENSITIVE