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.
Container for the parameters to the ModifyCluster operation. Modifies the settings for a cluster.
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.
You can add another security or parameter group, or change the admin user password. Resetting a cluster password or modifying the security groups associated with a cluster do not need a reboot. However, modifying a parameter group requires a reboot for parameters to take effect. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
Namespace: Amazon.Redshift.Model
Assembly: AWSSDK.Redshift.dll
Version: 3.x.y.z
public class ModifyClusterRequest : AmazonRedshiftRequest IAmazonWebServiceRequest
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. 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. |
|
AvailabilityZone | System.String |
Gets and sets the property AvailabilityZone. The option to initiate relocation for an Amazon Redshift cluster to the target Availability Zone. |
|
AvailabilityZoneRelocation | System.Boolean |
Gets and sets the property AvailabilityZoneRelocation. The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster modification is complete. |
|
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: |
|
ElasticIp | System.String |
Gets and sets the property ElasticIp. 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 in the Amazon Redshift Cluster Management Guide. |
|
Encrypted | System.Boolean |
Gets and sets the property Encrypted.
Indicates whether the cluster is encrypted. If the value is encrypted (true) and you
provide a value for the If the value is not encrypted (false), then the cluster is decrypted. |
|
EnhancedVpcRouting | System.Boolean |
Gets and sets the property EnhancedVpcRouting. 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.
If this option is Default: false |
|
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. |
|
IpAddressType | System.String |
Gets and sets the property IpAddressType.
The IP address types that the cluster supports. Possible values are |
|
KmsKeyId | System.String |
Gets and sets the property KmsKeyId. The Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster. |
|
MaintenanceTrackName | System.String |
Gets and sets the property MaintenanceTrackName.
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 |
|
ManageMasterPassword | System.Boolean |
Gets and sets the property ManageMasterPassword.
If |
|
ManualSnapshotRetentionPeriod | System.Int32 |
Gets and sets the property ManualSnapshotRetentionPeriod. 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. |
|
MasterPasswordSecretKmsKeyId | System.String |
Gets and sets the property MasterPasswordSecretKmsKeyId.
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 |
|
MasterUserPassword | System.String |
Gets and sets the property MasterUserPassword.
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
You can't use 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. Default: Uses existing setting. Constraints:
|
|
MultiAZ | System.Boolean |
Gets and sets the property MultiAZ. 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. |
|
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. For more information about resizing clusters, go to Resizing Clusters in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
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. For more information about resizing clusters, go to Resizing Clusters in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
Valid Values: Integer greater than |
|
Port | System.Int32 |
Gets and sets the property Port. The option to change the port of an Amazon Redshift cluster. Valid Values:
|
|
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. |
|
PubliclyAccessible | System.Boolean |
Gets and sets the property PubliclyAccessible.
If |
|
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. This change is asynchronously applied as soon as possible. |
This example shows how to associate a cluster security group with the specified cluster.
var client = new AmazonRedshiftClient(); var response = client.ModifyCluster(new ModifyClusterRequest { ClusterIdentifier = "mycluster", ClusterSecurityGroups = new List<string> { "mysecuritygroup" } });
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5