« blib/lib/Paws/ElastiCache/ModifyReplicationGroupResult.pm
↑ Summary
blib/lib/Paws/ElastiCache/ModifyReplicationGroupShardConfigurationResult.pm »
| 1 | |||
| 2 | package Paws::ElastiCache::ModifyReplicationGroupShardConfiguration; | ||
| 3 | use Moose; | ||
| 4 | has ApplyImmediately => (is => 'ro', isa => 'Bool', required => 1); | ||
| 5 | has NodeGroupCount => (is => 'ro', isa => 'Int', required => 1); | ||
| 6 | has NodeGroupsToRemove => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 7 | has NodeGroupsToRetain => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 8 | has ReplicationGroupId => (is => 'ro', isa => 'Str', required => 1); | ||
| 9 | has ReshardingConfiguration => (is => 'ro', isa => 'ArrayRef[Paws::ElastiCache::ReshardingConfiguration]'); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ModifyReplicationGroupShardConfiguration'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ElastiCache::ModifyReplicationGroupShardConfigurationResult'); | ||
| 15 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'ModifyReplicationGroupShardConfigurationResult'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::ElastiCache::ModifyReplicationGroupShardConfiguration - Arguments for method ModifyReplicationGroupShardConfiguration on L<Paws::ElastiCache> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method ModifyReplicationGroupShardConfiguration on the | ||
| 27 | L<Amazon ElastiCache|Paws::ElastiCache> service. Use the attributes of this class | ||
| 28 | as arguments to method ModifyReplicationGroupShardConfiguration. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ModifyReplicationGroupShardConfiguration. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $elasticache = Paws->service('ElastiCache'); | ||
| 35 | my $ModifyReplicationGroupShardConfigurationResult = | ||
| 36 | $elasticache->ModifyReplicationGroupShardConfiguration( | ||
| 37 | ApplyImmediately => 1, | ||
| 38 | NodeGroupCount => 1, | ||
| 39 | ReplicationGroupId => 'MyString', | ||
| 40 | NodeGroupsToRemove => [ | ||
| 41 | 'MyAllowedNodeGroupId', ... # min: 1, max: 4 | ||
| 42 | ], # OPTIONAL | ||
| 43 | NodeGroupsToRetain => [ | ||
| 44 | 'MyAllowedNodeGroupId', ... # min: 1, max: 4 | ||
| 45 | ], # OPTIONAL | ||
| 46 | ReshardingConfiguration => [ | ||
| 47 | { | ||
| 48 | NodeGroupId => 'MyAllowedNodeGroupId', # min: 1, max: 4 | ||
| 49 | PreferredAvailabilityZones => [ 'MyString', ... ], # OPTIONAL | ||
| 50 | }, | ||
| 51 | ... | ||
| 52 | ], # OPTIONAL | ||
| 53 | ); | ||
| 54 | |||
| 55 | # Results: | ||
| 56 | my $ReplicationGroup = | ||
| 57 | $ModifyReplicationGroupShardConfigurationResult->ReplicationGroup; | ||
| 58 | |||
| 59 | # Returns a L<Paws::ElastiCache::ModifyReplicationGroupShardConfigurationResult> object. | ||
| 60 | |||
| 61 | 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. | ||
| 62 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/elasticache/ModifyReplicationGroupShardConfiguration> | ||
| 63 | |||
| 64 | =head1 ATTRIBUTES | ||
| 65 | |||
| 66 | |||
| 67 | =head2 B<REQUIRED> ApplyImmediately => Bool | ||
| 68 | |||
| 69 | Indicates that the shard reconfiguration process begins immediately. At | ||
| 70 | present, the only permitted value for this parameter is C<true>. | ||
| 71 | |||
| 72 | Value: true | ||
| 73 | |||
| 74 | |||
| 75 | |||
| 76 | =head2 B<REQUIRED> NodeGroupCount => Int | ||
| 77 | |||
| 78 | The number of node groups (shards) that results from the modification | ||
| 79 | of the shard configuration. | ||
| 80 | |||
| 81 | |||
| 82 | |||
| 83 | =head2 NodeGroupsToRemove => ArrayRef[Str|Undef] | ||
| 84 | |||
| 85 | If the value of C<NodeGroupCount> is less than the current number of | ||
| 86 | node groups (shards), then either C<NodeGroupsToRemove> or | ||
| 87 | C<NodeGroupsToRetain> is required. C<NodeGroupsToRemove> is a list of | ||
| 88 | C<NodeGroupId>s to remove from the cluster. | ||
| 89 | |||
| 90 | ElastiCache for Redis will attempt to remove all node groups listed by | ||
| 91 | C<NodeGroupsToRemove> from the cluster. | ||
| 92 | |||
| 93 | |||
| 94 | |||
| 95 | =head2 NodeGroupsToRetain => ArrayRef[Str|Undef] | ||
| 96 | |||
| 97 | If the value of C<NodeGroupCount> is less than the current number of | ||
| 98 | node groups (shards), then either C<NodeGroupsToRemove> or | ||
| 99 | C<NodeGroupsToRetain> is required. C<NodeGroupsToRetain> is a list of | ||
| 100 | C<NodeGroupId>s to retain in the cluster. | ||
| 101 | |||
| 102 | ElastiCache for Redis will attempt to remove all node groups except | ||
| 103 | those listed by C<NodeGroupsToRetain> from the cluster. | ||
| 104 | |||
| 105 | |||
| 106 | |||
| 107 | =head2 B<REQUIRED> ReplicationGroupId => Str | ||
| 108 | |||
| 109 | The name of the Redis (cluster mode enabled) cluster (replication | ||
| 110 | group) on which the shards are to be configured. | ||
| 111 | |||
| 112 | |||
| 113 | |||
| 114 | =head2 ReshardingConfiguration => ArrayRef[L<Paws::ElastiCache::ReshardingConfiguration>] | ||
| 115 | |||
| 116 | Specifies the preferred availability zones for each node group in the | ||
| 117 | cluster. If the value of C<NodeGroupCount> is greater than the current | ||
| 118 | number of node groups (shards), you can use this parameter to specify | ||
| 119 | the preferred availability zones of the cluster's shards. If you omit | ||
| 120 | this parameter ElastiCache selects availability zones for you. | ||
| 121 | |||
| 122 | You can specify this parameter only if the value of C<NodeGroupCount> | ||
| 123 | is greater than the current number of node groups (shards). | ||
| 124 | |||
| 125 | |||
| 126 | |||
| 127 | |||
| 128 | =head1 SEE ALSO | ||
| 129 | |||
| 130 | This class forms part of L<Paws>, documenting arguments for method ModifyReplicationGroupShardConfiguration in L<Paws::ElastiCache> | ||
| 131 | |||
| 132 | =head1 BUGS and CONTRIBUTIONS | ||
| 133 | |||
| 134 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 135 | |||
| 136 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 137 | |||
| 138 | =cut | ||
| 139 |