ModifyClusterRequest

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

The option to initiate relocation for an Amazon Redshift cluster to the target Availability Zone.

Link copied to clipboard

The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster modification is complete.

Link copied to clipboard

The unique identifier of the cluster to be modified.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

The new cluster type.

Link copied to clipboard

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

Link copied to clipboard

The Elastic IP (EIP) address for the cluster.

Link copied to clipboard

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.

Link copied to clipboard

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 in the Amazon Redshift Cluster Management Guide.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

The IP address types that the cluster supports. Possible values are ipv4 and dualstack.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

If true, Amazon Redshift uses Secrets Manager to manage this cluster's admin credentials. You can't use MasterUserPassword if ManageMasterPassword is true. If ManageMasterPassword is false or not set, Amazon Redshift uses MasterUserPassword for the admin user account's password.

Link copied to clipboard

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.

Link copied to clipboard

The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret. You can only use this parameter if ManageMasterPassword is true.

Link copied to clipboard

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.

Link copied to clipboard

If true and the cluster is currently only deployed in a single Availability Zone, the cluster will be modified to be deployed in two Availability Zones.

Link copied to clipboard

The new identifier for the cluster.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
val port: Int?

The option to change the port of an Amazon Redshift cluster.

Link copied to clipboard

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.

Link copied to clipboard

If true, the cluster can be accessed from a public network. Only clusters in VPCs can be set to be publicly available.

Link copied to clipboard

A list of virtual private cloud (VPC) security groups to be associated with the cluster. This change is asynchronously applied as soon as possible.

Functions

Link copied to clipboard
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String