« blib/lib/Paws/RedShift/ModifyAquaOutputMessage.pm
↑ Summary
blib/lib/Paws/RedShift/ModifyClusterDbRevision.pm »
| 1 | |||
| 2 | package Paws::RedShift::ModifyCluster; | ||
| 3 | use Moose; | ||
| 4 | has AllowVersionUpgrade => (is => 'ro', isa => 'Bool'); | ||
| 5 | has AutomatedSnapshotRetentionPeriod => (is => 'ro', isa => 'Int'); | ||
| 6 | has AvailabilityZone => (is => 'ro', isa => 'Str'); | ||
| 7 | has AvailabilityZoneRelocation => (is => 'ro', isa => 'Bool'); | ||
| 8 | has ClusterIdentifier => (is => 'ro', isa => 'Str', required => 1); | ||
| 9 | has ClusterParameterGroupName => (is => 'ro', isa => 'Str'); | ||
| 10 | has ClusterSecurityGroups => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 11 | has ClusterType => (is => 'ro', isa => 'Str'); | ||
| 12 | has ClusterVersion => (is => 'ro', isa => 'Str'); | ||
| 13 | has ElasticIp => (is => 'ro', isa => 'Str'); | ||
| 14 | has Encrypted => (is => 'ro', isa => 'Bool'); | ||
| 15 | has EnhancedVpcRouting => (is => 'ro', isa => 'Bool'); | ||
| 16 | has HsmClientCertificateIdentifier => (is => 'ro', isa => 'Str'); | ||
| 17 | has HsmConfigurationIdentifier => (is => 'ro', isa => 'Str'); | ||
| 18 | has KmsKeyId => (is => 'ro', isa => 'Str'); | ||
| 19 | has MaintenanceTrackName => (is => 'ro', isa => 'Str'); | ||
| 20 | has ManualSnapshotRetentionPeriod => (is => 'ro', isa => 'Int'); | ||
| 21 | has MasterUserPassword => (is => 'ro', isa => 'Str'); | ||
| 22 | has NewClusterIdentifier => (is => 'ro', isa => 'Str'); | ||
| 23 | has NodeType => (is => 'ro', isa => 'Str'); | ||
| 24 | has NumberOfNodes => (is => 'ro', isa => 'Int'); | ||
| 25 | has Port => (is => 'ro', isa => 'Int'); | ||
| 26 | has PreferredMaintenanceWindow => (is => 'ro', isa => 'Str'); | ||
| 27 | has PubliclyAccessible => (is => 'ro', isa => 'Bool'); | ||
| 28 | has VpcSecurityGroupIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 29 | |||
| 30 | use MooseX::ClassAttribute; | ||
| 31 | |||
| 32 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ModifyCluster'); | ||
| 33 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RedShift::ModifyClusterResult'); | ||
| 34 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'ModifyClusterResult'); | ||
| 35 | 1; | ||
| 36 | |||
| 37 | ### main pod documentation begin ### | ||
| 38 | |||
| 39 | =head1 NAME | ||
| 40 | |||
| 41 | Paws::RedShift::ModifyCluster - Arguments for method ModifyCluster on L<Paws::RedShift> | ||
| 42 | |||
| 43 | =head1 DESCRIPTION | ||
| 44 | |||
| 45 | This class represents the parameters used for calling the method ModifyCluster on the | ||
| 46 | L<Amazon Redshift|Paws::RedShift> service. Use the attributes of this class | ||
| 47 | as arguments to method ModifyCluster. | ||
| 48 | |||
| 49 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ModifyCluster. | ||
| 50 | |||
| 51 | =head1 SYNOPSIS | ||
| 52 | |||
| 53 | my $redshift = Paws->service('RedShift'); | ||
| 54 | my $ModifyClusterResult = $redshift->ModifyCluster( | ||
| 55 | ClusterIdentifier => 'MyString', | ||
| 56 | AllowVersionUpgrade => 1, # OPTIONAL | ||
| 57 | AutomatedSnapshotRetentionPeriod => 1, # OPTIONAL | ||
| 58 | AvailabilityZone => 'MyString', # OPTIONAL | ||
| 59 | AvailabilityZoneRelocation => 1, # OPTIONAL | ||
| 60 | ClusterParameterGroupName => 'MyString', # OPTIONAL | ||
| 61 | ClusterSecurityGroups => [ | ||
| 62 | 'MyString', ... # max: 2147483647 | ||
| 63 | ], # OPTIONAL | ||
| 64 | ClusterType => 'MyString', # OPTIONAL | ||
| 65 | ClusterVersion => 'MyString', # OPTIONAL | ||
| 66 | ElasticIp => 'MyString', # OPTIONAL | ||
| 67 | Encrypted => 1, # OPTIONAL | ||
| 68 | EnhancedVpcRouting => 1, # OPTIONAL | ||
| 69 | HsmClientCertificateIdentifier => 'MyString', # OPTIONAL | ||
| 70 | HsmConfigurationIdentifier => 'MyString', # OPTIONAL | ||
| 71 | KmsKeyId => 'MyString', # OPTIONAL | ||
| 72 | MaintenanceTrackName => 'MyString', # OPTIONAL | ||
| 73 | ManualSnapshotRetentionPeriod => 1, # OPTIONAL | ||
| 74 | MasterUserPassword => 'MyString', # OPTIONAL | ||
| 75 | NewClusterIdentifier => 'MyString', # OPTIONAL | ||
| 76 | NodeType => 'MyString', # OPTIONAL | ||
| 77 | NumberOfNodes => 1, # OPTIONAL | ||
| 78 | Port => 1, # OPTIONAL | ||
| 79 | PreferredMaintenanceWindow => 'MyString', # OPTIONAL | ||
| 80 | PubliclyAccessible => 1, # OPTIONAL | ||
| 81 | VpcSecurityGroupIds => [ | ||
| 82 | 'MyString', ... # max: 2147483647 | ||
| 83 | ], # OPTIONAL | ||
| 84 | ); | ||
| 85 | |||
| 86 | # Results: | ||
| 87 | my $Cluster = $ModifyClusterResult->Cluster; | ||
| 88 | |||
| 89 | # Returns a L<Paws::RedShift::ModifyClusterResult> object. | ||
| 90 | |||
| 91 | 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. | ||
| 92 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/redshift/ModifyCluster> | ||
| 93 | |||
| 94 | =head1 ATTRIBUTES | ||
| 95 | |||
| 96 | |||
| 97 | =head2 AllowVersionUpgrade => Bool | ||
| 98 | |||
| 99 | If C<true>, major version upgrades will be applied automatically to the | ||
| 100 | cluster during the maintenance window. | ||
| 101 | |||
| 102 | Default: C<false> | ||
| 103 | |||
| 104 | |||
| 105 | |||
| 106 | =head2 AutomatedSnapshotRetentionPeriod => Int | ||
| 107 | |||
| 108 | The number of days that automated snapshots are retained. If the value | ||
| 109 | is 0, automated snapshots are disabled. Even if automated snapshots are | ||
| 110 | disabled, you can still create manual snapshots when you want with | ||
| 111 | CreateClusterSnapshot. | ||
| 112 | |||
| 113 | If you decrease the automated snapshot retention period from its | ||
| 114 | current value, existing automated snapshots that fall outside of the | ||
| 115 | new retention period will be immediately deleted. | ||
| 116 | |||
| 117 | You can't disable automated snapshots for RA3 node types. Set the | ||
| 118 | automated retention period from 1-35 days. | ||
| 119 | |||
| 120 | Default: Uses existing setting. | ||
| 121 | |||
| 122 | Constraints: Must be a value from 0 to 35. | ||
| 123 | |||
| 124 | |||
| 125 | |||
| 126 | =head2 AvailabilityZone => Str | ||
| 127 | |||
| 128 | The option to initiate relocation for an Amazon Redshift cluster to the | ||
| 129 | target Availability Zone. | ||
| 130 | |||
| 131 | |||
| 132 | |||
| 133 | =head2 AvailabilityZoneRelocation => Bool | ||
| 134 | |||
| 135 | The option to enable relocation for an Amazon Redshift cluster between | ||
| 136 | Availability Zones after the cluster modification is complete. | ||
| 137 | |||
| 138 | |||
| 139 | |||
| 140 | =head2 B<REQUIRED> ClusterIdentifier => Str | ||
| 141 | |||
| 142 | The unique identifier of the cluster to be modified. | ||
| 143 | |||
| 144 | Example: C<examplecluster> | ||
| 145 | |||
| 146 | |||
| 147 | |||
| 148 | =head2 ClusterParameterGroupName => Str | ||
| 149 | |||
| 150 | The name of the cluster parameter group to apply to this cluster. This | ||
| 151 | change is applied only after the cluster is rebooted. To reboot a | ||
| 152 | cluster use RebootCluster. | ||
| 153 | |||
| 154 | Default: Uses existing setting. | ||
| 155 | |||
| 156 | Constraints: The cluster parameter group must be in the same parameter | ||
| 157 | group family that matches the cluster version. | ||
| 158 | |||
| 159 | |||
| 160 | |||
| 161 | =head2 ClusterSecurityGroups => ArrayRef[Str|Undef] | ||
| 162 | |||
| 163 | A list of cluster security groups to be authorized on this cluster. | ||
| 164 | This change is asynchronously applied as soon as possible. | ||
| 165 | |||
| 166 | Security groups currently associated with the cluster, and not in the | ||
| 167 | list of groups to apply, will be revoked from the cluster. | ||
| 168 | |||
| 169 | Constraints: | ||
| 170 | |||
| 171 | =over | ||
| 172 | |||
| 173 | =item * | ||
| 174 | |||
| 175 | Must be 1 to 255 alphanumeric characters or hyphens | ||
| 176 | |||
| 177 | =item * | ||
| 178 | |||
| 179 | First character must be a letter | ||
| 180 | |||
| 181 | =item * | ||
| 182 | |||
| 183 | Cannot end with a hyphen or contain two consecutive hyphens | ||
| 184 | |||
| 185 | =back | ||
| 186 | |||
| 187 | |||
| 188 | |||
| 189 | |||
| 190 | =head2 ClusterType => Str | ||
| 191 | |||
| 192 | The new cluster type. | ||
| 193 | |||
| 194 | When you submit your cluster resize request, your existing cluster goes | ||
| 195 | into a read-only mode. After Amazon Redshift provisions a new cluster | ||
| 196 | based on your resize requirements, there will be outage for a period | ||
| 197 | while the old cluster is deleted and your connection is switched to the | ||
| 198 | new cluster. You can use DescribeResize to track the progress of the | ||
| 199 | resize request. | ||
| 200 | |||
| 201 | Valid Values: C< multi-node | single-node> | ||
| 202 | |||
| 203 | |||
| 204 | |||
| 205 | =head2 ClusterVersion => Str | ||
| 206 | |||
| 207 | The new version number of the Amazon Redshift engine to upgrade to. | ||
| 208 | |||
| 209 | For major version upgrades, if a non-default cluster parameter group is | ||
| 210 | currently in use, a new cluster parameter group in the cluster | ||
| 211 | parameter group family for the new version must be specified. The new | ||
| 212 | cluster parameter group can be the default for that cluster parameter | ||
| 213 | group family. For more information about parameters and parameter | ||
| 214 | groups, go to Amazon Redshift Parameter Groups | ||
| 215 | (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html) | ||
| 216 | in the I<Amazon Redshift Cluster Management Guide>. | ||
| 217 | |||
| 218 | Example: C<1.0> | ||
| 219 | |||
| 220 | |||
| 221 | |||
| 222 | =head2 ElasticIp => Str | ||
| 223 | |||
| 224 | The Elastic IP (EIP) address for the cluster. | ||
| 225 | |||
| 226 | Constraints: The cluster must be provisioned in EC2-VPC and | ||
| 227 | publicly-accessible through an Internet gateway. For more information | ||
| 228 | about provisioning clusters in EC2-VPC, go to Supported Platforms to | ||
| 229 | Launch Your Cluster | ||
| 230 | (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#cluster-platforms) | ||
| 231 | in the Amazon Redshift Cluster Management Guide. | ||
| 232 | |||
| 233 | |||
| 234 | |||
| 235 | =head2 Encrypted => Bool | ||
| 236 | |||
| 237 | Indicates whether the cluster is encrypted. If the value is encrypted | ||
| 238 | (true) and you provide a value for the C<KmsKeyId> parameter, we | ||
| 239 | encrypt the cluster with the provided C<KmsKeyId>. If you don't provide | ||
| 240 | a C<KmsKeyId>, we encrypt with the default key. | ||
| 241 | |||
| 242 | If the value is not encrypted (false), then the cluster is decrypted. | ||
| 243 | |||
| 244 | |||
| 245 | |||
| 246 | =head2 EnhancedVpcRouting => Bool | ||
| 247 | |||
| 248 | An option that specifies whether to create the cluster with enhanced | ||
| 249 | VPC routing enabled. To create a cluster that uses enhanced VPC | ||
| 250 | routing, the cluster must be in a VPC. For more information, see | ||
| 251 | Enhanced VPC Routing | ||
| 252 | (https://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html) | ||
| 253 | in the Amazon Redshift Cluster Management Guide. | ||
| 254 | |||
| 255 | If this option is C<true>, enhanced VPC routing is enabled. | ||
| 256 | |||
| 257 | Default: false | ||
| 258 | |||
| 259 | |||
| 260 | |||
| 261 | =head2 HsmClientCertificateIdentifier => Str | ||
| 262 | |||
| 263 | Specifies the name of the HSM client certificate the Amazon Redshift | ||
| 264 | cluster uses to retrieve the data encryption keys stored in an HSM. | ||
| 265 | |||
| 266 | |||
| 267 | |||
| 268 | =head2 HsmConfigurationIdentifier => Str | ||
| 269 | |||
| 270 | Specifies the name of the HSM configuration that contains the | ||
| 271 | information the Amazon Redshift cluster can use to retrieve and store | ||
| 272 | keys in an HSM. | ||
| 273 | |||
| 274 | |||
| 275 | |||
| 276 | =head2 KmsKeyId => Str | ||
| 277 | |||
| 278 | The AWS Key Management Service (KMS) key ID of the encryption key that | ||
| 279 | you want to use to encrypt data in the cluster. | ||
| 280 | |||
| 281 | |||
| 282 | |||
| 283 | =head2 MaintenanceTrackName => Str | ||
| 284 | |||
| 285 | The name for the maintenance track that you want to assign for the | ||
| 286 | cluster. This name change is asynchronous. The new track name stays in | ||
| 287 | the C<PendingModifiedValues> for the cluster until the next maintenance | ||
| 288 | window. When the maintenance track changes, the cluster is switched to | ||
| 289 | the latest cluster release available for the maintenance track. At this | ||
| 290 | point, the maintenance track name is applied. | ||
| 291 | |||
| 292 | |||
| 293 | |||
| 294 | =head2 ManualSnapshotRetentionPeriod => Int | ||
| 295 | |||
| 296 | The default for number of days that a newly created manual snapshot is | ||
| 297 | retained. If the value is -1, the manual snapshot is retained | ||
| 298 | indefinitely. This value doesn't retroactively change the retention | ||
| 299 | periods of existing manual snapshots. | ||
| 300 | |||
| 301 | The value must be either -1 or an integer between 1 and 3,653. | ||
| 302 | |||
| 303 | The default value is -1. | ||
| 304 | |||
| 305 | |||
| 306 | |||
| 307 | =head2 MasterUserPassword => Str | ||
| 308 | |||
| 309 | The new password for the cluster master user. This change is | ||
| 310 | asynchronously applied as soon as possible. Between the time of the | ||
| 311 | request and the completion of the request, the C<MasterUserPassword> | ||
| 312 | element exists in the C<PendingModifiedValues> element of the operation | ||
| 313 | response. | ||
| 314 | |||
| 315 | Operations never return the password, so this operation provides a way | ||
| 316 | to regain access to the master user account for a cluster if the | ||
| 317 | password is lost. | ||
| 318 | |||
| 319 | Default: Uses existing setting. | ||
| 320 | |||
| 321 | Constraints: | ||
| 322 | |||
| 323 | =over | ||
| 324 | |||
| 325 | =item * | ||
| 326 | |||
| 327 | Must be between 8 and 64 characters in length. | ||
| 328 | |||
| 329 | =item * | ||
| 330 | |||
| 331 | Must contain at least one uppercase letter. | ||
| 332 | |||
| 333 | =item * | ||
| 334 | |||
| 335 | Must contain at least one lowercase letter. | ||
| 336 | |||
| 337 | =item * | ||
| 338 | |||
| 339 | Must contain one number. | ||
| 340 | |||
| 341 | =item * | ||
| 342 | |||
| 343 | Can be any printable ASCII character (ASCII code 33 to 126) except ' | ||
| 344 | (single quote), " (double quote), \, /, @, or space. | ||
| 345 | |||
| 346 | =back | ||
| 347 | |||
| 348 | |||
| 349 | |||
| 350 | |||
| 351 | =head2 NewClusterIdentifier => Str | ||
| 352 | |||
| 353 | The new identifier for the cluster. | ||
| 354 | |||
| 355 | Constraints: | ||
| 356 | |||
| 357 | =over | ||
| 358 | |||
| 359 | =item * | ||
| 360 | |||
| 361 | Must contain from 1 to 63 alphanumeric characters or hyphens. | ||
| 362 | |||
| 363 | =item * | ||
| 364 | |||
| 365 | Alphabetic characters must be lowercase. | ||
| 366 | |||
| 367 | =item * | ||
| 368 | |||
| 369 | First character must be a letter. | ||
| 370 | |||
| 371 | =item * | ||
| 372 | |||
| 373 | Cannot end with a hyphen or contain two consecutive hyphens. | ||
| 374 | |||
| 375 | =item * | ||
| 376 | |||
| 377 | Must be unique for all clusters within an AWS account. | ||
| 378 | |||
| 379 | =back | ||
| 380 | |||
| 381 | Example: C<examplecluster> | ||
| 382 | |||
| 383 | |||
| 384 | |||
| 385 | =head2 NodeType => Str | ||
| 386 | |||
| 387 | The new node type of the cluster. If you specify a new node type, you | ||
| 388 | must also specify the number of nodes parameter. | ||
| 389 | |||
| 390 | For more information about resizing clusters, go to Resizing Clusters | ||
| 391 | in Amazon Redshift | ||
| 392 | (https://docs.aws.amazon.com/redshift/latest/mgmt/rs-resize-tutorial.html) | ||
| 393 | in the I<Amazon Redshift Cluster Management Guide>. | ||
| 394 | |||
| 395 | Valid Values: C<ds2.xlarge> | C<ds2.8xlarge> | C<dc1.large> | | ||
| 396 | C<dc1.8xlarge> | C<dc2.large> | C<dc2.8xlarge> | C<ra3.xlplus> | | ||
| 397 | C<ra3.4xlarge> | C<ra3.16xlarge> | ||
| 398 | |||
| 399 | |||
| 400 | |||
| 401 | =head2 NumberOfNodes => Int | ||
| 402 | |||
| 403 | The new number of nodes of the cluster. If you specify a new number of | ||
| 404 | nodes, you must also specify the node type parameter. | ||
| 405 | |||
| 406 | For more information about resizing clusters, go to Resizing Clusters | ||
| 407 | in Amazon Redshift | ||
| 408 | (https://docs.aws.amazon.com/redshift/latest/mgmt/rs-resize-tutorial.html) | ||
| 409 | in the I<Amazon Redshift Cluster Management Guide>. | ||
| 410 | |||
| 411 | Valid Values: Integer greater than C<0>. | ||
| 412 | |||
| 413 | |||
| 414 | |||
| 415 | =head2 Port => Int | ||
| 416 | |||
| 417 | The option to change the port of an Amazon Redshift cluster. | ||
| 418 | |||
| 419 | |||
| 420 | |||
| 421 | =head2 PreferredMaintenanceWindow => Str | ||
| 422 | |||
| 423 | The weekly time range (in UTC) during which system maintenance can | ||
| 424 | occur, if necessary. If system maintenance is necessary during the | ||
| 425 | window, it may result in an outage. | ||
| 426 | |||
| 427 | This maintenance window change is made immediately. If the new | ||
| 428 | maintenance window indicates the current time, there must be at least | ||
| 429 | 120 minutes between the current time and end of the window in order to | ||
| 430 | ensure that pending changes are applied. | ||
| 431 | |||
| 432 | Default: Uses existing setting. | ||
| 433 | |||
| 434 | Format: ddd:hh24:mi-ddd:hh24:mi, for example C<wed:07:30-wed:08:00>. | ||
| 435 | |||
| 436 | Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun | ||
| 437 | |||
| 438 | Constraints: Must be at least 30 minutes. | ||
| 439 | |||
| 440 | |||
| 441 | |||
| 442 | =head2 PubliclyAccessible => Bool | ||
| 443 | |||
| 444 | If C<true>, the cluster can be accessed from a public network. Only | ||
| 445 | clusters in VPCs can be set to be publicly available. | ||
| 446 | |||
| 447 | |||
| 448 | |||
| 449 | =head2 VpcSecurityGroupIds => ArrayRef[Str|Undef] | ||
| 450 | |||
| 451 | A list of virtual private cloud (VPC) security groups to be associated | ||
| 452 | with the cluster. This change is asynchronously applied as soon as | ||
| 453 | possible. | ||
| 454 | |||
| 455 | |||
| 456 | |||
| 457 | |||
| 458 | =head1 SEE ALSO | ||
| 459 | |||
| 460 | This class forms part of L<Paws>, documenting arguments for method ModifyCluster in L<Paws::RedShift> | ||
| 461 | |||
| 462 | =head1 BUGS and CONTRIBUTIONS | ||
| 463 | |||
| 464 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 465 | |||
| 466 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 467 | |||
| 468 | =cut | ||
| 469 |