ModifyClusterRequest
Types
Properties
If true
, major version upgrades will be applied automatically to the cluster during the maintenance window.
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.
The option to initiate relocation for an Amazon Redshift cluster to the target Availability Zone.
The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster modification is complete.
The unique identifier of the cluster to be modified.
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.
A list of cluster security groups to be authorized on this cluster. This change is asynchronously applied as soon as possible.
The new cluster type.
The new version number of the Amazon Redshift engine to upgrade to.
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.
Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
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.
The IP address types that the cluster supports. Possible values are ipv4
and dualstack
.
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.
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.
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 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.
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.
The new identifier for the cluster.
The new number of nodes of the cluster. If you specify a new number of nodes, you must also specify the node type parameter.
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.
If true
, the cluster can be accessed from a public network. Only clusters in VPCs can be set to be publicly available.
A list of virtual private cloud (VPC) security groups to be associated with the cluster. This change is asynchronously applied as soon as possible.