AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
You can also change node type and the number of nodes to scale up or down the cluster. When resizing a cluster, you must specify both the number of nodes and the node type even if one of the parameters does not change.
Namespace: Amazon.Redshift.Model
Assembly: AWSSDK.dll
Version: (assembly version)
public class ModifyClusterRequest : AmazonRedshiftRequest IRequestEvents
The ModifyClusterRequest type exposes the following members
Name | Description | |
---|---|---|
ModifyClusterRequest() |
Name | Type | Description | |
---|---|---|---|
AllowVersionUpgrade | System.Boolean |
Gets and sets the property AllowVersionUpgrade.
If
Default: |
|
AutomatedSnapshotRetentionPeriod | System.Int32 |
Gets and sets the property AutomatedSnapshotRetentionPeriod.
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. Default: Uses existing setting. Constraints: Must be a value from 0 to 35. |
|
ClusterIdentifier | System.String |
Gets and sets the property ClusterIdentifier.
The unique identifier of the cluster to be modified.
Example: |
|
ClusterParameterGroupName | System.String |
Gets and sets the property ClusterParameterGroupName.
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. |
|
ClusterSecurityGroups | System.Collections.Generic.List<System.String> |
Gets and sets the property ClusterSecurityGroups.
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:
|
|
ClusterType | System.String |
Gets and sets the property ClusterType.
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: |
|
ClusterVersion | System.String |
Gets and sets the property ClusterVersion.
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 in the Amazon Redshift Cluster Management Guide.
Example: |
|
HsmClientCertificateIdentifier | System.String |
Gets and sets the property HsmClientCertificateIdentifier.
Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM. |
|
HsmConfigurationIdentifier | System.String |
Gets and sets the property HsmConfigurationIdentifier.
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. |
|
MasterUserPassword | System.String |
Gets and sets the property MasterUserPassword.
The new password for the cluster master user. This change is asynchronously applied
as soon as possible. Between the time of the request and the completion of the request,
the Default: Uses existing setting. Constraints:
|
|
NewClusterIdentifier | System.String |
Gets and sets the property NewClusterIdentifier.
The new identifier for the cluster. Constraints:
Example: |
|
NodeType | System.String |
Gets and sets the property NodeType.
The new node type of the cluster. If you specify a new node type, you must also specify the number of nodes parameter. When you submit your request to resize a cluster, Amazon Redshift sets access permissions for the cluster to read-only. After Amazon Redshift provisions a new cluster according to your resize requirements, there will be a temporary outage while the old cluster is deleted and your connection is switched to the new cluster. When the new connection is complete, the original access permissions for the cluster are restored. You can use DescribeResize to track the progress of the resize request.
Valid Values: |
|
NumberOfNodes | System.Int32 |
Gets and sets the property NumberOfNodes.
The new number of nodes of the cluster. If you specify a new number of nodes, you must also specify the node type parameter. When you submit your request to resize a cluster, Amazon Redshift sets access permissions for the cluster to read-only. After Amazon Redshift provisions a new cluster according to your resize requirements, there will be a temporary outage while the old cluster is deleted and your connection is switched to the new cluster. When the new connection is complete, the original access permissions for the cluster are restored. You can use DescribeResize to track the progress of the resize request.
Valid Values: Integer greater than |
|
PreferredMaintenanceWindow | System.String |
Gets and sets the property PreferredMaintenanceWindow.
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 Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun Constraints: Must be at least 30 minutes. |
|
VpcSecurityGroupIds | System.Collections.Generic.List<System.String> |
Gets and sets the property VpcSecurityGroupIds.
A list of virtual private cloud (VPC) security groups to be associated with the cluster. |
.NET Framework:
Supported in: 4.5, 4.0, 3.5
.NET for Windows Store apps:
Supported in: Windows 8