« blib/lib/Paws/ElastiCache/LogDeliveryConfigurationRequest.pm
↑ Summary
blib/lib/Paws/ElastiCache/ModifyCacheClusterResult.pm »
| 1 | |||
| 2 | package Paws::ElastiCache::ModifyCacheCluster; | ||
| 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 AutoMinorVersionUpgrade => (is => 'ro', isa => 'Bool'); | ||
| 8 | has AZMode => (is => 'ro', isa => 'Str'); | ||
| 9 | has CacheClusterId => (is => 'ro', isa => 'Str', required => 1); | ||
| 10 | has CacheNodeIdsToRemove => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 11 | has CacheNodeType => (is => 'ro', isa => 'Str'); | ||
| 12 | has CacheParameterGroupName => (is => 'ro', isa => 'Str'); | ||
| 13 | has CacheSecurityGroupNames => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 14 | has EngineVersion => (is => 'ro', isa => 'Str'); | ||
| 15 | has LogDeliveryConfigurations => (is => 'ro', isa => 'ArrayRef[Paws::ElastiCache::LogDeliveryConfigurationRequest]'); | ||
| 16 | has NewAvailabilityZones => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 17 | has NotificationTopicArn => (is => 'ro', isa => 'Str'); | ||
| 18 | has NotificationTopicStatus => (is => 'ro', isa => 'Str'); | ||
| 19 | has NumCacheNodes => (is => 'ro', isa => 'Int'); | ||
| 20 | has PreferredMaintenanceWindow => (is => 'ro', isa => 'Str'); | ||
| 21 | has SecurityGroupIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 22 | has SnapshotRetentionLimit => (is => 'ro', isa => 'Int'); | ||
| 23 | has SnapshotWindow => (is => 'ro', isa => 'Str'); | ||
| 24 | |||
| 25 | use MooseX::ClassAttribute; | ||
| 26 | |||
| 27 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ModifyCacheCluster'); | ||
| 28 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ElastiCache::ModifyCacheClusterResult'); | ||
| 29 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'ModifyCacheClusterResult'); | ||
| 30 | 1; | ||
| 31 | |||
| 32 | ### main pod documentation begin ### | ||
| 33 | |||
| 34 | =head1 NAME | ||
| 35 | |||
| 36 | Paws::ElastiCache::ModifyCacheCluster - Arguments for method ModifyCacheCluster on L<Paws::ElastiCache> | ||
| 37 | |||
| 38 | =head1 DESCRIPTION | ||
| 39 | |||
| 40 | This class represents the parameters used for calling the method ModifyCacheCluster on the | ||
| 41 | L<Amazon ElastiCache|Paws::ElastiCache> service. Use the attributes of this class | ||
| 42 | as arguments to method ModifyCacheCluster. | ||
| 43 | |||
| 44 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ModifyCacheCluster. | ||
| 45 | |||
| 46 | =head1 SYNOPSIS | ||
| 47 | |||
| 48 | my $elasticache = Paws->service('ElastiCache'); | ||
| 49 | # ModifyCacheCluster | ||
| 50 | # Copies a snapshot to a specified name. | ||
| 51 | my $ModifyCacheClusterResult = $elasticache->ModifyCacheCluster( | ||
| 52 | 'ApplyImmediately' => 1, | ||
| 53 | 'CacheClusterId' => 'redis-cluster', | ||
| 54 | 'SnapshotRetentionLimit' => 14 | ||
| 55 | ); | ||
| 56 | |||
| 57 | # Results: | ||
| 58 | my $CacheCluster = $ModifyCacheClusterResult->CacheCluster; | ||
| 59 | |||
| 60 | # Returns a L<Paws::ElastiCache::ModifyCacheClusterResult> object. | ||
| 61 | |||
| 62 | 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. | ||
| 63 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/elasticache/ModifyCacheCluster> | ||
| 64 | |||
| 65 | =head1 ATTRIBUTES | ||
| 66 | |||
| 67 | |||
| 68 | =head2 ApplyImmediately => Bool | ||
| 69 | |||
| 70 | If C<true>, this parameter causes the modifications in this request and | ||
| 71 | any pending modifications to be applied, asynchronously and as soon as | ||
| 72 | possible, regardless of the C<PreferredMaintenanceWindow> setting for | ||
| 73 | the cluster. | ||
| 74 | |||
| 75 | If C<false>, changes to the cluster are applied on the next maintenance | ||
| 76 | reboot, or the next failure reboot, whichever occurs first. | ||
| 77 | |||
| 78 | If you perform a C<ModifyCacheCluster> before a pending modification is | ||
| 79 | applied, the pending modification is replaced by the newer | ||
| 80 | modification. | ||
| 81 | |||
| 82 | Valid values: C<true> | C<false> | ||
| 83 | |||
| 84 | Default: C<false> | ||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | =head2 AuthToken => Str | ||
| 89 | |||
| 90 | Reserved parameter. The password used to access a password protected | ||
| 91 | server. This parameter must be specified with the C<auth-token-update> | ||
| 92 | parameter. Password constraints: | ||
| 93 | |||
| 94 | =over | ||
| 95 | |||
| 96 | =item * | ||
| 97 | |||
| 98 | Must be only printable ASCII characters | ||
| 99 | |||
| 100 | =item * | ||
| 101 | |||
| 102 | Must be at least 16 characters and no more than 128 characters in | ||
| 103 | length | ||
| 104 | |||
| 105 | =item * | ||
| 106 | |||
| 107 | Cannot contain any of the following characters: '/', '"', or '@', '%' | ||
| 108 | |||
| 109 | =back | ||
| 110 | |||
| 111 | For more information, see AUTH password at AUTH | ||
| 112 | (http://redis.io/commands/AUTH). | ||
| 113 | |||
| 114 | |||
| 115 | |||
| 116 | =head2 AuthTokenUpdateStrategy => Str | ||
| 117 | |||
| 118 | Specifies the strategy to use to update the AUTH token. This parameter | ||
| 119 | must be specified with the C<auth-token> parameter. Possible values: | ||
| 120 | |||
| 121 | =over | ||
| 122 | |||
| 123 | =item * | ||
| 124 | |||
| 125 | Rotate | ||
| 126 | |||
| 127 | =item * | ||
| 128 | |||
| 129 | Set | ||
| 130 | |||
| 131 | =back | ||
| 132 | |||
| 133 | For more information, see Authenticating Users with Redis AUTH | ||
| 134 | (http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/auth.html) | ||
| 135 | |||
| 136 | Valid values are: C<"SET">, C<"ROTATE">, C<"DELETE"> | ||
| 137 | |||
| 138 | =head2 AutoMinorVersionUpgrade => Bool | ||
| 139 | |||
| 140 | This parameter is currently disabled. | ||
| 141 | |||
| 142 | |||
| 143 | |||
| 144 | =head2 AZMode => Str | ||
| 145 | |||
| 146 | Specifies whether the new nodes in this Memcached cluster are all | ||
| 147 | created in a single Availability Zone or created across multiple | ||
| 148 | Availability Zones. | ||
| 149 | |||
| 150 | Valid values: C<single-az> | C<cross-az>. | ||
| 151 | |||
| 152 | This option is only supported for Memcached clusters. | ||
| 153 | |||
| 154 | You cannot specify C<single-az> if the Memcached cluster already has | ||
| 155 | cache nodes in different Availability Zones. If C<cross-az> is | ||
| 156 | specified, existing Memcached nodes remain in their current | ||
| 157 | Availability Zone. | ||
| 158 | |||
| 159 | Only newly created nodes are located in different Availability Zones. | ||
| 160 | |||
| 161 | Valid values are: C<"single-az">, C<"cross-az"> | ||
| 162 | |||
| 163 | =head2 B<REQUIRED> CacheClusterId => Str | ||
| 164 | |||
| 165 | The cluster identifier. This value is stored as a lowercase string. | ||
| 166 | |||
| 167 | |||
| 168 | |||
| 169 | =head2 CacheNodeIdsToRemove => ArrayRef[Str|Undef] | ||
| 170 | |||
| 171 | A list of cache node IDs to be removed. A node ID is a numeric | ||
| 172 | identifier (0001, 0002, etc.). This parameter is only valid when | ||
| 173 | C<NumCacheNodes> is less than the existing number of cache nodes. The | ||
| 174 | number of cache node IDs supplied in this parameter must match the | ||
| 175 | difference between the existing number of cache nodes in the cluster or | ||
| 176 | pending cache nodes, whichever is greater, and the value of | ||
| 177 | C<NumCacheNodes> in the request. | ||
| 178 | |||
| 179 | For example: If you have 3 active cache nodes, 7 pending cache nodes, | ||
| 180 | and the number of cache nodes in this C<ModifyCacheCluster> call is 5, | ||
| 181 | you must list 2 (7 - 5) cache node IDs to remove. | ||
| 182 | |||
| 183 | |||
| 184 | |||
| 185 | =head2 CacheNodeType => Str | ||
| 186 | |||
| 187 | A valid cache node type that you want to scale this cluster up to. | ||
| 188 | |||
| 189 | |||
| 190 | |||
| 191 | =head2 CacheParameterGroupName => Str | ||
| 192 | |||
| 193 | The name of the cache parameter group to apply to this cluster. This | ||
| 194 | change is asynchronously applied as soon as possible for parameters | ||
| 195 | when the C<ApplyImmediately> parameter is specified as C<true> for this | ||
| 196 | request. | ||
| 197 | |||
| 198 | |||
| 199 | |||
| 200 | =head2 CacheSecurityGroupNames => ArrayRef[Str|Undef] | ||
| 201 | |||
| 202 | A list of cache security group names to authorize on this cluster. This | ||
| 203 | change is asynchronously applied as soon as possible. | ||
| 204 | |||
| 205 | You can use this parameter only with clusters that are created outside | ||
| 206 | of an Amazon Virtual Private Cloud (Amazon VPC). | ||
| 207 | |||
| 208 | Constraints: Must contain no more than 255 alphanumeric characters. | ||
| 209 | Must not be "Default". | ||
| 210 | |||
| 211 | |||
| 212 | |||
| 213 | =head2 EngineVersion => Str | ||
| 214 | |||
| 215 | The upgraded version of the cache engine to be run on the cache nodes. | ||
| 216 | |||
| 217 | B<Important:> You can upgrade to a newer engine version (see Selecting | ||
| 218 | a Cache Engine and Version | ||
| 219 | (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SelectEngine.html#VersionManagement)), | ||
| 220 | but you cannot downgrade to an earlier engine version. If you want to | ||
| 221 | use an earlier engine version, you must delete the existing cluster and | ||
| 222 | create it anew with the earlier engine version. | ||
| 223 | |||
| 224 | |||
| 225 | |||
| 226 | =head2 LogDeliveryConfigurations => ArrayRef[L<Paws::ElastiCache::LogDeliveryConfigurationRequest>] | ||
| 227 | |||
| 228 | Specifies the destination, format and type of the logs. | ||
| 229 | |||
| 230 | |||
| 231 | |||
| 232 | =head2 NewAvailabilityZones => ArrayRef[Str|Undef] | ||
| 233 | |||
| 234 | This option is only supported on Memcached clusters. | ||
| 235 | |||
| 236 | The list of Availability Zones where the new Memcached cache nodes are | ||
| 237 | created. | ||
| 238 | |||
| 239 | This parameter is only valid when C<NumCacheNodes> in the request is | ||
| 240 | greater than the sum of the number of active cache nodes and the number | ||
| 241 | of cache nodes pending creation (which may be zero). The number of | ||
| 242 | Availability Zones supplied in this list must match the cache nodes | ||
| 243 | being added in this request. | ||
| 244 | |||
| 245 | Scenarios: | ||
| 246 | |||
| 247 | =over | ||
| 248 | |||
| 249 | =item * | ||
| 250 | |||
| 251 | B<Scenario 1:> You have 3 active nodes and wish to add 2 nodes. Specify | ||
| 252 | C<NumCacheNodes=5> (3 + 2) and optionally specify two Availability | ||
| 253 | Zones for the two new nodes. | ||
| 254 | |||
| 255 | =item * | ||
| 256 | |||
| 257 | B<Scenario 2:> You have 3 active nodes and 2 nodes pending creation | ||
| 258 | (from the scenario 1 call) and want to add 1 more node. Specify | ||
| 259 | C<NumCacheNodes=6> ((3 + 2) + 1) and optionally specify an Availability | ||
| 260 | Zone for the new node. | ||
| 261 | |||
| 262 | =item * | ||
| 263 | |||
| 264 | B<Scenario 3:> You want to cancel all pending operations. Specify | ||
| 265 | C<NumCacheNodes=3> to cancel all pending operations. | ||
| 266 | |||
| 267 | =back | ||
| 268 | |||
| 269 | The Availability Zone placement of nodes pending creation cannot be | ||
| 270 | modified. If you wish to cancel any nodes pending creation, add 0 nodes | ||
| 271 | by setting C<NumCacheNodes> to the number of current nodes. | ||
| 272 | |||
| 273 | If C<cross-az> is specified, existing Memcached nodes remain in their | ||
| 274 | current Availability Zone. Only newly created nodes can be located in | ||
| 275 | different Availability Zones. For guidance on how to move existing | ||
| 276 | Memcached nodes to different Availability Zones, see the B<Availability | ||
| 277 | Zone Considerations> section of Cache Node Considerations for Memcached | ||
| 278 | (https://docs.aws.amazon.com/AmazonElastiCache/latest/mem-ug/CacheNodes.SupportedTypes.html). | ||
| 279 | |||
| 280 | B<Impact of new add/remove requests upon pending requests> | ||
| 281 | |||
| 282 | =over | ||
| 283 | |||
| 284 | =item * | ||
| 285 | |||
| 286 | Scenario-1 | ||
| 287 | |||
| 288 | =over | ||
| 289 | |||
| 290 | =item * | ||
| 291 | |||
| 292 | Pending Action: Delete | ||
| 293 | |||
| 294 | =item * | ||
| 295 | |||
| 296 | New Request: Delete | ||
| 297 | |||
| 298 | =item * | ||
| 299 | |||
| 300 | Result: The new delete, pending or immediate, replaces the pending | ||
| 301 | delete. | ||
| 302 | |||
| 303 | =back | ||
| 304 | |||
| 305 | =item * | ||
| 306 | |||
| 307 | Scenario-2 | ||
| 308 | |||
| 309 | =over | ||
| 310 | |||
| 311 | =item * | ||
| 312 | |||
| 313 | Pending Action: Delete | ||
| 314 | |||
| 315 | =item * | ||
| 316 | |||
| 317 | New Request: Create | ||
| 318 | |||
| 319 | =item * | ||
| 320 | |||
| 321 | Result: The new create, pending or immediate, replaces the pending | ||
| 322 | delete. | ||
| 323 | |||
| 324 | =back | ||
| 325 | |||
| 326 | =item * | ||
| 327 | |||
| 328 | Scenario-3 | ||
| 329 | |||
| 330 | =over | ||
| 331 | |||
| 332 | =item * | ||
| 333 | |||
| 334 | Pending Action: Create | ||
| 335 | |||
| 336 | =item * | ||
| 337 | |||
| 338 | New Request: Delete | ||
| 339 | |||
| 340 | =item * | ||
| 341 | |||
| 342 | Result: The new delete, pending or immediate, replaces the pending | ||
| 343 | create. | ||
| 344 | |||
| 345 | =back | ||
| 346 | |||
| 347 | =item * | ||
| 348 | |||
| 349 | Scenario-4 | ||
| 350 | |||
| 351 | =over | ||
| 352 | |||
| 353 | =item * | ||
| 354 | |||
| 355 | Pending Action: Create | ||
| 356 | |||
| 357 | =item * | ||
| 358 | |||
| 359 | New Request: Create | ||
| 360 | |||
| 361 | =item * | ||
| 362 | |||
| 363 | Result: The new create is added to the pending create. | ||
| 364 | |||
| 365 | B<Important:> If the new create request is B<Apply Immediately - Yes>, | ||
| 366 | all creates are performed immediately. If the new create request is | ||
| 367 | B<Apply Immediately - No>, all creates are pending. | ||
| 368 | |||
| 369 | =back | ||
| 370 | |||
| 371 | =back | ||
| 372 | |||
| 373 | |||
| 374 | |||
| 375 | |||
| 376 | =head2 NotificationTopicArn => Str | ||
| 377 | |||
| 378 | The Amazon Resource Name (ARN) of the Amazon SNS topic to which | ||
| 379 | notifications are sent. | ||
| 380 | |||
| 381 | The Amazon SNS topic owner must be same as the cluster owner. | ||
| 382 | |||
| 383 | |||
| 384 | |||
| 385 | =head2 NotificationTopicStatus => Str | ||
| 386 | |||
| 387 | The status of the Amazon SNS notification topic. Notifications are sent | ||
| 388 | only if the status is C<active>. | ||
| 389 | |||
| 390 | Valid values: C<active> | C<inactive> | ||
| 391 | |||
| 392 | |||
| 393 | |||
| 394 | =head2 NumCacheNodes => Int | ||
| 395 | |||
| 396 | The number of cache nodes that the cluster should have. If the value | ||
| 397 | for C<NumCacheNodes> is greater than the sum of the number of current | ||
| 398 | cache nodes and the number of cache nodes pending creation (which may | ||
| 399 | be zero), more nodes are added. If the value is less than the number of | ||
| 400 | existing cache nodes, nodes are removed. If the value is equal to the | ||
| 401 | number of current cache nodes, any pending add or remove requests are | ||
| 402 | canceled. | ||
| 403 | |||
| 404 | If you are removing cache nodes, you must use the | ||
| 405 | C<CacheNodeIdsToRemove> parameter to provide the IDs of the specific | ||
| 406 | cache nodes to remove. | ||
| 407 | |||
| 408 | For clusters running Redis, this value must be 1. For clusters running | ||
| 409 | Memcached, this value must be between 1 and 40. | ||
| 410 | |||
| 411 | Adding or removing Memcached cache nodes can be applied immediately or | ||
| 412 | as a pending operation (see C<ApplyImmediately>). | ||
| 413 | |||
| 414 | A pending operation to modify the number of cache nodes in a cluster | ||
| 415 | during its maintenance window, whether by adding or removing nodes in | ||
| 416 | accordance with the scale out architecture, is not queued. The | ||
| 417 | customer's latest request to add or remove nodes to the cluster | ||
| 418 | overrides any previous pending operations to modify the number of cache | ||
| 419 | nodes in the cluster. For example, a request to remove 2 nodes would | ||
| 420 | override a previous pending operation to remove 3 nodes. Similarly, a | ||
| 421 | request to add 2 nodes would override a previous pending operation to | ||
| 422 | remove 3 nodes and vice versa. As Memcached cache nodes may now be | ||
| 423 | provisioned in different Availability Zones with flexible cache node | ||
| 424 | placement, a request to add nodes does not automatically override a | ||
| 425 | previous pending operation to add nodes. The customer can modify the | ||
| 426 | previous pending operation to add more nodes or explicitly cancel the | ||
| 427 | pending request and retry the new request. To cancel pending operations | ||
| 428 | to modify the number of cache nodes in a cluster, use the | ||
| 429 | C<ModifyCacheCluster> request and set C<NumCacheNodes> equal to the | ||
| 430 | number of cache nodes currently in the cluster. | ||
| 431 | |||
| 432 | |||
| 433 | |||
| 434 | =head2 PreferredMaintenanceWindow => Str | ||
| 435 | |||
| 436 | Specifies the weekly time range during which maintenance on the cluster | ||
| 437 | is performed. It is specified as a range in the format | ||
| 438 | ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window | ||
| 439 | is a 60 minute period. | ||
| 440 | |||
| 441 | Valid values for C<ddd> are: | ||
| 442 | |||
| 443 | =over | ||
| 444 | |||
| 445 | =item * | ||
| 446 | |||
| 447 | C<sun> | ||
| 448 | |||
| 449 | =item * | ||
| 450 | |||
| 451 | C<mon> | ||
| 452 | |||
| 453 | =item * | ||
| 454 | |||
| 455 | C<tue> | ||
| 456 | |||
| 457 | =item * | ||
| 458 | |||
| 459 | C<wed> | ||
| 460 | |||
| 461 | =item * | ||
| 462 | |||
| 463 | C<thu> | ||
| 464 | |||
| 465 | =item * | ||
| 466 | |||
| 467 | C<fri> | ||
| 468 | |||
| 469 | =item * | ||
| 470 | |||
| 471 | C<sat> | ||
| 472 | |||
| 473 | =back | ||
| 474 | |||
| 475 | Example: C<sun:23:00-mon:01:30> | ||
| 476 | |||
| 477 | |||
| 478 | |||
| 479 | =head2 SecurityGroupIds => ArrayRef[Str|Undef] | ||
| 480 | |||
| 481 | Specifies the VPC Security Groups associated with the cluster. | ||
| 482 | |||
| 483 | This parameter can be used only with clusters that are created in an | ||
| 484 | Amazon Virtual Private Cloud (Amazon VPC). | ||
| 485 | |||
| 486 | |||
| 487 | |||
| 488 | =head2 SnapshotRetentionLimit => Int | ||
| 489 | |||
| 490 | The number of days for which ElastiCache retains automatic cluster | ||
| 491 | snapshots before deleting them. For example, if you set | ||
| 492 | C<SnapshotRetentionLimit> to 5, a snapshot that was taken today is | ||
| 493 | retained for 5 days before being deleted. | ||
| 494 | |||
| 495 | If the value of C<SnapshotRetentionLimit> is set to zero (0), backups | ||
| 496 | are turned off. | ||
| 497 | |||
| 498 | |||
| 499 | |||
| 500 | =head2 SnapshotWindow => Str | ||
| 501 | |||
| 502 | The daily time range (in UTC) during which ElastiCache begins taking a | ||
| 503 | daily snapshot of your cluster. | ||
| 504 | |||
| 505 | |||
| 506 | |||
| 507 | |||
| 508 | =head1 SEE ALSO | ||
| 509 | |||
| 510 | This class forms part of L<Paws>, documenting arguments for method ModifyCacheCluster in L<Paws::ElastiCache> | ||
| 511 | |||
| 512 | =head1 BUGS and CONTRIBUTIONS | ||
| 513 | |||
| 514 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 515 | |||
| 516 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 517 | |||
| 518 | =cut | ||
| 519 |