« blib/lib/Paws/ElastiCache/ModifyGlobalReplicationGroupResult.pm
↑ Summary
blib/lib/Paws/ElastiCache/ModifyReplicationGroupResult.pm »
| 1 | |||
| 2 | package Paws::ElastiCache::ModifyReplicationGroup; | ||
| 3 | use Moose; | ||
| 4 | has ApplyImmediately => (is => 'ro', isa => 'Bool'); | ||
| 5 | has AuthToken => (is => 'ro', isa => 'Str'); | ||
| 6 | has AuthTokenUpdateStrategy => (is => 'ro', isa => 'Str'); | ||
| 7 | has AutomaticFailoverEnabled => (is => 'ro', isa => 'Bool'); | ||
| 8 | has AutoMinorVersionUpgrade => (is => 'ro', isa => 'Bool'); | ||
| 9 | has CacheNodeType => (is => 'ro', isa => 'Str'); | ||
| 10 | has CacheParameterGroupName => (is => 'ro', isa => 'Str'); | ||
| 11 | has CacheSecurityGroupNames => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 12 | has EngineVersion => (is => 'ro', isa => 'Str'); | ||
| 13 | has LogDeliveryConfigurations => (is => 'ro', isa => 'ArrayRef[Paws::ElastiCache::LogDeliveryConfigurationRequest]'); | ||
| 14 | has MultiAZEnabled => (is => 'ro', isa => 'Bool'); | ||
| 15 | has NodeGroupId => (is => 'ro', isa => 'Str'); | ||
| 16 | has NotificationTopicArn => (is => 'ro', isa => 'Str'); | ||
| 17 | has NotificationTopicStatus => (is => 'ro', isa => 'Str'); | ||
| 18 | has PreferredMaintenanceWindow => (is => 'ro', isa => 'Str'); | ||
| 19 | has PrimaryClusterId => (is => 'ro', isa => 'Str'); | ||
| 20 | has RemoveUserGroups => (is => 'ro', isa => 'Bool'); | ||
| 21 | has ReplicationGroupDescription => (is => 'ro', isa => 'Str'); | ||
| 22 | has ReplicationGroupId => (is => 'ro', isa => 'Str', required => 1); | ||
| 23 | has SecurityGroupIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 24 | has SnapshotRetentionLimit => (is => 'ro', isa => 'Int'); | ||
| 25 | has SnapshottingClusterId => (is => 'ro', isa => 'Str'); | ||
| 26 | has SnapshotWindow => (is => 'ro', isa => 'Str'); | ||
| 27 | has UserGroupIdsToAdd => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 28 | has UserGroupIdsToRemove => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 29 | |||
| 30 | use MooseX::ClassAttribute; | ||
| 31 | |||
| 32 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ModifyReplicationGroup'); | ||
| 33 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ElastiCache::ModifyReplicationGroupResult'); | ||
| 34 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'ModifyReplicationGroupResult'); | ||
| 35 | 1; | ||
| 36 | |||
| 37 | ### main pod documentation begin ### | ||
| 38 | |||
| 39 | =head1 NAME | ||
| 40 | |||
| 41 | Paws::ElastiCache::ModifyReplicationGroup - Arguments for method ModifyReplicationGroup on L<Paws::ElastiCache> | ||
| 42 | |||
| 43 | =head1 DESCRIPTION | ||
| 44 | |||
| 45 | This class represents the parameters used for calling the method ModifyReplicationGroup on the | ||
| 46 | L<Amazon ElastiCache|Paws::ElastiCache> service. Use the attributes of this class | ||
| 47 | as arguments to method ModifyReplicationGroup. | ||
| 48 | |||
| 49 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ModifyReplicationGroup. | ||
| 50 | |||
| 51 | =head1 SYNOPSIS | ||
| 52 | |||
| 53 | my $elasticache = Paws->service('ElastiCache'); | ||
| 54 | # ModifyReplicationGroup | ||
| 55 | my $ModifyReplicationGroupResult = $elasticache->ModifyReplicationGroup( | ||
| 56 | 'ApplyImmediately' => 1, | ||
| 57 | 'ReplicationGroupDescription' => 'Modified replication group', | ||
| 58 | 'ReplicationGroupId' => 'my-redis-rg', | ||
| 59 | 'SnapshotRetentionLimit' => 30, | ||
| 60 | 'SnapshottingClusterId' => 'my-redis-rg-001' | ||
| 61 | ); | ||
| 62 | |||
| 63 | # Results: | ||
| 64 | my $ReplicationGroup = $ModifyReplicationGroupResult->ReplicationGroup; | ||
| 65 | |||
| 66 | # Returns a L<Paws::ElastiCache::ModifyReplicationGroupResult> object. | ||
| 67 | |||
| 68 | 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. | ||
| 69 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/elasticache/ModifyReplicationGroup> | ||
| 70 | |||
| 71 | =head1 ATTRIBUTES | ||
| 72 | |||
| 73 | |||
| 74 | =head2 ApplyImmediately => Bool | ||
| 75 | |||
| 76 | If C<true>, this parameter causes the modifications in this request and | ||
| 77 | any pending modifications to be applied, asynchronously and as soon as | ||
| 78 | possible, regardless of the C<PreferredMaintenanceWindow> setting for | ||
| 79 | the replication group. | ||
| 80 | |||
| 81 | If C<false>, changes to the nodes in the replication group are applied | ||
| 82 | on the next maintenance reboot, or the next failure reboot, whichever | ||
| 83 | occurs first. | ||
| 84 | |||
| 85 | Valid values: C<true> | C<false> | ||
| 86 | |||
| 87 | Default: C<false> | ||
| 88 | |||
| 89 | |||
| 90 | |||
| 91 | =head2 AuthToken => Str | ||
| 92 | |||
| 93 | Reserved parameter. The password used to access a password protected | ||
| 94 | server. This parameter must be specified with the | ||
| 95 | C<auth-token-update-strategy > parameter. Password constraints: | ||
| 96 | |||
| 97 | =over | ||
| 98 | |||
| 99 | =item * | ||
| 100 | |||
| 101 | Must be only printable ASCII characters | ||
| 102 | |||
| 103 | =item * | ||
| 104 | |||
| 105 | Must be at least 16 characters and no more than 128 characters in | ||
| 106 | length | ||
| 107 | |||
| 108 | =item * | ||
| 109 | |||
| 110 | Cannot contain any of the following characters: '/', '"', or '@', '%' | ||
| 111 | |||
| 112 | =back | ||
| 113 | |||
| 114 | For more information, see AUTH password at AUTH | ||
| 115 | (http://redis.io/commands/AUTH). | ||
| 116 | |||
| 117 | |||
| 118 | |||
| 119 | =head2 AuthTokenUpdateStrategy => Str | ||
| 120 | |||
| 121 | Specifies the strategy to use to update the AUTH token. This parameter | ||
| 122 | must be specified with the C<auth-token> parameter. Possible values: | ||
| 123 | |||
| 124 | =over | ||
| 125 | |||
| 126 | =item * | ||
| 127 | |||
| 128 | Rotate | ||
| 129 | |||
| 130 | =item * | ||
| 131 | |||
| 132 | Set | ||
| 133 | |||
| 134 | =back | ||
| 135 | |||
| 136 | For more information, see Authenticating Users with Redis AUTH | ||
| 137 | (http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/auth.html) | ||
| 138 | |||
| 139 | Valid values are: C<"SET">, C<"ROTATE">, C<"DELETE"> | ||
| 140 | |||
| 141 | =head2 AutomaticFailoverEnabled => Bool | ||
| 142 | |||
| 143 | Determines whether a read replica is automatically promoted to | ||
| 144 | read/write primary if the existing primary encounters a failure. | ||
| 145 | |||
| 146 | Valid values: C<true> | C<false> | ||
| 147 | |||
| 148 | |||
| 149 | |||
| 150 | =head2 AutoMinorVersionUpgrade => Bool | ||
| 151 | |||
| 152 | This parameter is currently disabled. | ||
| 153 | |||
| 154 | |||
| 155 | |||
| 156 | =head2 CacheNodeType => Str | ||
| 157 | |||
| 158 | A valid cache node type that you want to scale this replication group | ||
| 159 | to. | ||
| 160 | |||
| 161 | |||
| 162 | |||
| 163 | =head2 CacheParameterGroupName => Str | ||
| 164 | |||
| 165 | The name of the cache parameter group to apply to all of the clusters | ||
| 166 | in this replication group. This change is asynchronously applied as | ||
| 167 | soon as possible for parameters when the C<ApplyImmediately> parameter | ||
| 168 | is specified as C<true> for this request. | ||
| 169 | |||
| 170 | |||
| 171 | |||
| 172 | =head2 CacheSecurityGroupNames => ArrayRef[Str|Undef] | ||
| 173 | |||
| 174 | A list of cache security group names to authorize for the clusters in | ||
| 175 | this replication group. This change is asynchronously applied as soon | ||
| 176 | as possible. | ||
| 177 | |||
| 178 | This parameter can be used only with replication group containing | ||
| 179 | clusters running outside of an Amazon Virtual Private Cloud (Amazon | ||
| 180 | VPC). | ||
| 181 | |||
| 182 | Constraints: Must contain no more than 255 alphanumeric characters. | ||
| 183 | Must not be C<Default>. | ||
| 184 | |||
| 185 | |||
| 186 | |||
| 187 | =head2 EngineVersion => Str | ||
| 188 | |||
| 189 | The upgraded version of the cache engine to be run on the clusters in | ||
| 190 | the replication group. | ||
| 191 | |||
| 192 | B<Important:> You can upgrade to a newer engine version (see Selecting | ||
| 193 | a Cache Engine and Version | ||
| 194 | (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SelectEngine.html#VersionManagement)), | ||
| 195 | but you cannot downgrade to an earlier engine version. If you want to | ||
| 196 | use an earlier engine version, you must delete the existing replication | ||
| 197 | group and create it anew with the earlier engine version. | ||
| 198 | |||
| 199 | |||
| 200 | |||
| 201 | =head2 LogDeliveryConfigurations => ArrayRef[L<Paws::ElastiCache::LogDeliveryConfigurationRequest>] | ||
| 202 | |||
| 203 | Specifies the destination, format and type of the logs. | ||
| 204 | |||
| 205 | |||
| 206 | |||
| 207 | =head2 MultiAZEnabled => Bool | ||
| 208 | |||
| 209 | A list of tags to be added to this resource. A tag is a key-value pair. | ||
| 210 | A tag key must be accompanied by a tag value, although null is | ||
| 211 | accepted. | ||
| 212 | |||
| 213 | |||
| 214 | |||
| 215 | =head2 NodeGroupId => Str | ||
| 216 | |||
| 217 | Deprecated. This parameter is not used. | ||
| 218 | |||
| 219 | |||
| 220 | |||
| 221 | =head2 NotificationTopicArn => Str | ||
| 222 | |||
| 223 | The Amazon Resource Name (ARN) of the Amazon SNS topic to which | ||
| 224 | notifications are sent. | ||
| 225 | |||
| 226 | The Amazon SNS topic owner must be same as the replication group owner. | ||
| 227 | |||
| 228 | |||
| 229 | |||
| 230 | =head2 NotificationTopicStatus => Str | ||
| 231 | |||
| 232 | The status of the Amazon SNS notification topic for the replication | ||
| 233 | group. Notifications are sent only if the status is C<active>. | ||
| 234 | |||
| 235 | Valid values: C<active> | C<inactive> | ||
| 236 | |||
| 237 | |||
| 238 | |||
| 239 | =head2 PreferredMaintenanceWindow => Str | ||
| 240 | |||
| 241 | Specifies the weekly time range during which maintenance on the cluster | ||
| 242 | is performed. It is specified as a range in the format | ||
| 243 | ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window | ||
| 244 | is a 60 minute period. | ||
| 245 | |||
| 246 | Valid values for C<ddd> are: | ||
| 247 | |||
| 248 | =over | ||
| 249 | |||
| 250 | =item * | ||
| 251 | |||
| 252 | C<sun> | ||
| 253 | |||
| 254 | =item * | ||
| 255 | |||
| 256 | C<mon> | ||
| 257 | |||
| 258 | =item * | ||
| 259 | |||
| 260 | C<tue> | ||
| 261 | |||
| 262 | =item * | ||
| 263 | |||
| 264 | C<wed> | ||
| 265 | |||
| 266 | =item * | ||
| 267 | |||
| 268 | C<thu> | ||
| 269 | |||
| 270 | =item * | ||
| 271 | |||
| 272 | C<fri> | ||
| 273 | |||
| 274 | =item * | ||
| 275 | |||
| 276 | C<sat> | ||
| 277 | |||
| 278 | =back | ||
| 279 | |||
| 280 | Example: C<sun:23:00-mon:01:30> | ||
| 281 | |||
| 282 | |||
| 283 | |||
| 284 | =head2 PrimaryClusterId => Str | ||
| 285 | |||
| 286 | For replication groups with a single primary, if this parameter is | ||
| 287 | specified, ElastiCache promotes the specified cluster in the specified | ||
| 288 | replication group to the primary role. The nodes of all other clusters | ||
| 289 | in the replication group are read replicas. | ||
| 290 | |||
| 291 | |||
| 292 | |||
| 293 | =head2 RemoveUserGroups => Bool | ||
| 294 | |||
| 295 | Removes the user groups that can access this replication group. | ||
| 296 | |||
| 297 | |||
| 298 | |||
| 299 | =head2 ReplicationGroupDescription => Str | ||
| 300 | |||
| 301 | A description for the replication group. Maximum length is 255 | ||
| 302 | characters. | ||
| 303 | |||
| 304 | |||
| 305 | |||
| 306 | =head2 B<REQUIRED> ReplicationGroupId => Str | ||
| 307 | |||
| 308 | The identifier of the replication group to modify. | ||
| 309 | |||
| 310 | |||
| 311 | |||
| 312 | =head2 SecurityGroupIds => ArrayRef[Str|Undef] | ||
| 313 | |||
| 314 | Specifies the VPC Security Groups associated with the clusters in the | ||
| 315 | replication group. | ||
| 316 | |||
| 317 | This parameter can be used only with replication group containing | ||
| 318 | clusters running in an Amazon Virtual Private Cloud (Amazon VPC). | ||
| 319 | |||
| 320 | |||
| 321 | |||
| 322 | =head2 SnapshotRetentionLimit => Int | ||
| 323 | |||
| 324 | The number of days for which ElastiCache retains automatic node group | ||
| 325 | (shard) snapshots before deleting them. For example, if you set | ||
| 326 | C<SnapshotRetentionLimit> to 5, a snapshot that was taken today is | ||
| 327 | retained for 5 days before being deleted. | ||
| 328 | |||
| 329 | B<Important> If the value of SnapshotRetentionLimit is set to zero (0), | ||
| 330 | backups are turned off. | ||
| 331 | |||
| 332 | |||
| 333 | |||
| 334 | =head2 SnapshottingClusterId => Str | ||
| 335 | |||
| 336 | The cluster ID that is used as the daily snapshot source for the | ||
| 337 | replication group. This parameter cannot be set for Redis (cluster mode | ||
| 338 | enabled) replication groups. | ||
| 339 | |||
| 340 | |||
| 341 | |||
| 342 | =head2 SnapshotWindow => Str | ||
| 343 | |||
| 344 | The daily time range (in UTC) during which ElastiCache begins taking a | ||
| 345 | daily snapshot of the node group (shard) specified by | ||
| 346 | C<SnapshottingClusterId>. | ||
| 347 | |||
| 348 | Example: C<05:00-09:00> | ||
| 349 | |||
| 350 | If you do not specify this parameter, ElastiCache automatically chooses | ||
| 351 | an appropriate time range. | ||
| 352 | |||
| 353 | |||
| 354 | |||
| 355 | =head2 UserGroupIdsToAdd => ArrayRef[Str|Undef] | ||
| 356 | |||
| 357 | The user group you are associating with the replication group. | ||
| 358 | |||
| 359 | |||
| 360 | |||
| 361 | =head2 UserGroupIdsToRemove => ArrayRef[Str|Undef] | ||
| 362 | |||
| 363 | The user group to remove, meaning the users in the group no longer can | ||
| 364 | access the replication group. | ||
| 365 | |||
| 366 | |||
| 367 | |||
| 368 | |||
| 369 | =head1 SEE ALSO | ||
| 370 | |||
| 371 | This class forms part of L<Paws>, documenting arguments for method ModifyReplicationGroup in L<Paws::ElastiCache> | ||
| 372 | |||
| 373 | =head1 BUGS and CONTRIBUTIONS | ||
| 374 | |||
| 375 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 376 | |||
| 377 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 378 | |||
| 379 | =cut | ||
| 380 |