class Aws::Redshift::Types::ModifyClusterMessage

@note When making an API call, you may pass ModifyClusterMessage

data as a hash:

    {
      cluster_identifier: "String", # required
      cluster_type: "String",
      node_type: "String",
      number_of_nodes: 1,
      cluster_security_groups: ["String"],
      vpc_security_group_ids: ["String"],
      master_user_password: "String",
      cluster_parameter_group_name: "String",
      automated_snapshot_retention_period: 1,
      manual_snapshot_retention_period: 1,
      preferred_maintenance_window: "String",
      cluster_version: "String",
      allow_version_upgrade: false,
      hsm_client_certificate_identifier: "String",
      hsm_configuration_identifier: "String",
      new_cluster_identifier: "String",
      publicly_accessible: false,
      elastic_ip: "String",
      enhanced_vpc_routing: false,
      maintenance_track_name: "String",
      encrypted: false,
      kms_key_id: "String",
      availability_zone_relocation: false,
      availability_zone: "String",
      port: 1,
    }

@!attribute [rw] cluster_identifier

The unique identifier of the cluster to be modified.

Example: `examplecluster`
@return [String]

@!attribute [rw] cluster_type

The new cluster type.

When you submit your cluster resize request, your existing cluster
goes into a read-only mode. After Amazon Redshift provisions a new
cluster based on your resize requirements, there will be outage for
a period while the old cluster is deleted and your connection is
switched to the new cluster. You can use DescribeResize to track the
progress of the resize request.

Valid Values: ` multi-node | single-node `
@return [String]

@!attribute [rw] node_type

The new node type of the cluster. If you specify a new node type,
you must also specify the number of nodes parameter.

For more information about resizing clusters, go to [Resizing
Clusters in Amazon Redshift][1] in the *Amazon Redshift Cluster
Management Guide*.

Valid Values: `ds2.xlarge` \| `ds2.8xlarge` \| `dc1.large` \|
`dc1.8xlarge` \| `dc2.large` \| `dc2.8xlarge` \| `ra3.xlplus` \|
`ra3.4xlarge` \| `ra3.16xlarge`

[1]: https://docs.aws.amazon.com/redshift/latest/mgmt/rs-resize-tutorial.html
@return [String]

@!attribute [rw] number_of_nodes

The new number of nodes of the cluster. If you specify a new number
of nodes, you must also specify the node type parameter.

For more information about resizing clusters, go to [Resizing
Clusters in Amazon Redshift][1] in the *Amazon Redshift Cluster
Management Guide*.

Valid Values: Integer greater than `0`.

[1]: https://docs.aws.amazon.com/redshift/latest/mgmt/rs-resize-tutorial.html
@return [Integer]

@!attribute [rw] cluster_security_groups

A list of cluster security groups to be authorized on this cluster.
This change is asynchronously applied as soon as possible.

Security groups currently associated with the cluster, and not in
the list of groups to apply, will be revoked from the cluster.

Constraints:

* Must be 1 to 255 alphanumeric characters or hyphens

* First character must be a letter

* Cannot end with a hyphen or contain two consecutive hyphens
@return [Array<String>]

@!attribute [rw] vpc_security_group_ids

A list of virtual private cloud (VPC) security groups to be
associated with the cluster. This change is asynchronously applied
as soon as possible.
@return [Array<String>]

@!attribute [rw] master_user_password

The new password for the cluster admin user. This change is
asynchronously applied as soon as possible. Between the time of the
request and the completion of the request, the `MasterUserPassword`
element exists in the `PendingModifiedValues` element of the
operation response.

<note markdown="1"> Operations never return the password, so this operation provides a
way to regain access to the admin user account for a cluster if the
password is lost.

 </note>

Default: Uses existing setting.

Constraints:

* Must be between 8 and 64 characters in length.

* Must contain at least one uppercase letter.

* Must contain at least one lowercase letter.

* Must contain one number.

* Can be any printable ASCII character (ASCII code 33 to 126) except
  ' (single quote), " (double quote), \\, /, @, or space.
@return [String]

@!attribute [rw] cluster_parameter_group_name

The name of the cluster parameter group to apply to this cluster.
This change is applied only after the cluster is rebooted. To reboot
a cluster use RebootCluster.

Default: Uses existing setting.

Constraints: The cluster parameter group must be in the same
parameter group family that matches the cluster version.
@return [String]

@!attribute [rw] automated_snapshot_retention_period

The number of days that automated snapshots are retained. If the
value is 0, automated snapshots are disabled. Even if automated
snapshots are disabled, you can still create manual snapshots when
you want with CreateClusterSnapshot.

If you decrease the automated snapshot retention period from its
current value, existing automated snapshots that fall outside of the
new retention period will be immediately deleted.

You can't disable automated snapshots for RA3 node types. Set the
automated retention period from 1-35 days.

Default: Uses existing setting.

Constraints: Must be a value from 0 to 35.
@return [Integer]

@!attribute [rw] manual_snapshot_retention_period

The default for number of days that a newly created manual snapshot
is retained. If the value is -1, the manual snapshot is retained
indefinitely. This value doesn't retroactively change the retention
periods of existing manual snapshots.

The value must be either -1 or an integer between 1 and 3,653.

The default value is -1.
@return [Integer]

@!attribute [rw] preferred_maintenance_window

The weekly time range (in UTC) during which system maintenance can
occur, if necessary. If system maintenance is necessary during the
window, it may result in an outage.

This maintenance window change is made immediately. If the new
maintenance window indicates the current time, there must be at
least 120 minutes between the current time and end of the window in
order to ensure that pending changes are applied.

Default: Uses existing setting.

Format: ddd:hh24:mi-ddd:hh24:mi, for example `wed:07:30-wed:08:00`.

Valid Days: Mon \| Tue \| Wed \| Thu \| Fri \| Sat \| Sun

Constraints: Must be at least 30 minutes.
@return [String]

@!attribute [rw] cluster_version

The new version number of the Amazon Redshift engine to upgrade to.

For major version upgrades, if a non-default cluster parameter group
is currently in use, a new cluster parameter group in the cluster
parameter group family for the new version must be specified. The
new cluster parameter group can be the default for that cluster
parameter group family. For more information about parameters and
parameter groups, go to [Amazon Redshift Parameter Groups][1] in the
*Amazon Redshift Cluster Management Guide*.

Example: `1.0`

[1]: https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html
@return [String]

@!attribute [rw] allow_version_upgrade

If `true`, major version upgrades will be applied automatically to
the cluster during the maintenance window.

Default: `false`
@return [Boolean]

@!attribute [rw] hsm_client_certificate_identifier

Specifies the name of the HSM client certificate the Amazon Redshift
cluster uses to retrieve the data encryption keys stored in an HSM.
@return [String]

@!attribute [rw] hsm_configuration_identifier

Specifies the name of the HSM configuration that contains the
information the Amazon Redshift cluster can use to retrieve and
store keys in an HSM.
@return [String]

@!attribute [rw] new_cluster_identifier

The new identifier for the cluster.

Constraints:

* Must contain from 1 to 63 alphanumeric characters or hyphens.

* Alphabetic characters must be lowercase.

* First character must be a letter.

* Cannot end with a hyphen or contain two consecutive hyphens.

* Must be unique for all clusters within an Amazon Web Services
  account.

Example: `examplecluster`
@return [String]

@!attribute [rw] publicly_accessible

If `true`, the cluster can be accessed from a public network. Only
clusters in VPCs can be set to be publicly available.
@return [Boolean]

@!attribute [rw] elastic_ip

The Elastic IP (EIP) address for the cluster.

Constraints: The cluster must be provisioned in EC2-VPC and
publicly-accessible through an Internet gateway. For more
information about provisioning clusters in EC2-VPC, go to [Supported
Platforms to Launch Your Cluster][1] in the Amazon Redshift Cluster
Management Guide.

[1]: https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#cluster-platforms
@return [String]

@!attribute [rw] enhanced_vpc_routing

An option that specifies whether to create the cluster with enhanced
VPC routing enabled. To create a cluster that uses enhanced VPC
routing, the cluster must be in a VPC. For more information, see
[Enhanced VPC Routing][1] in the Amazon Redshift Cluster Management
Guide.

If this option is `true`, enhanced VPC routing is enabled.

Default: false

[1]: https://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html
@return [Boolean]

@!attribute [rw] maintenance_track_name

The name for the maintenance track that you want to assign for the
cluster. This name change is asynchronous. The new track name stays
in the `PendingModifiedValues` for the cluster until the next
maintenance window. When the maintenance track changes, the cluster
is switched to the latest cluster release available for the
maintenance track. At this point, the maintenance track name is
applied.
@return [String]

@!attribute [rw] encrypted

Indicates whether the cluster is encrypted. If the value is
encrypted (true) and you provide a value for the `KmsKeyId`
parameter, we encrypt the cluster with the provided `KmsKeyId`. If
you don't provide a `KmsKeyId`, we encrypt with the default key.

If the value is not encrypted (false), then the cluster is
decrypted.
@return [Boolean]

@!attribute [rw] kms_key_id

The Key Management Service (KMS) key ID of the encryption key that
you want to use to encrypt data in the cluster.
@return [String]

@!attribute [rw] availability_zone_relocation

The option to enable relocation for an Amazon Redshift cluster
between Availability Zones after the cluster modification is
complete.
@return [Boolean]

@!attribute [rw] availability_zone

The option to initiate relocation for an Amazon Redshift cluster to
the target Availability Zone.
@return [String]

@!attribute [rw] port

The option to change the port of an Amazon Redshift cluster.
@return [Integer]

@see docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ModifyClusterMessage AWS API Documentation

Constants

SENSITIVE