GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
Paws::ElastiCache::DecreaseReplicaCount(3) User Contributed Perl Documentation Paws::ElastiCache::DecreaseReplicaCount(3)

Paws::ElastiCache::DecreaseReplicaCount - Arguments for method DecreaseReplicaCount on Paws::ElastiCache

This class represents the parameters used for calling the method DecreaseReplicaCount on the Amazon ElastiCache service. Use the attributes of this class as arguments to method DecreaseReplicaCount.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DecreaseReplicaCount.

    my $elasticache = Paws->service('ElastiCache');
    my $DecreaseReplicaCountResult = $elasticache->DecreaseReplicaCount(
      ApplyImmediately     => 1,
      ReplicationGroupId   => 'MyString',
      NewReplicaCount      => 1,            # OPTIONAL
      ReplicaConfiguration => [
        {
          NewReplicaCount            => 1,
          NodeGroupId                => 'MyAllowedNodeGroupId', # min: 1, max: 4
          PreferredAvailabilityZones => [ 'MyString', ... ],    # OPTIONAL
          PreferredOutpostArns       => [ 'MyString', ... ],    # OPTIONAL
        },
        ...
      ],    # OPTIONAL
      ReplicasToRemove => [ 'MyString', ... ],    # OPTIONAL
    );
    # Results:
    my $ReplicationGroup = $DecreaseReplicaCountResult->ReplicationGroup;
    # Returns a L<Paws::ElastiCache::DecreaseReplicaCountResult> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/elasticache/DecreaseReplicaCount>

REQUIRED ApplyImmediately => Bool

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

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)

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".

A list of the node ids to remove from the replication group or node group (shard).

REQUIRED ReplicationGroupId => Str

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

This class forms part of Paws, documenting arguments for method DecreaseReplicaCount in Paws::ElastiCache

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>

2022-06-01 perl v5.40.2

Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.