AWS SDK Version 3 for .NET
API Reference

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.

Modifies the settings for a cluster. For example, you can add another security or parameter group, update the preferred maintenance window, or change the master 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.

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.

Note:

For PCL this operation is only available in asynchronous form. Please refer to ModifyClusterAsync.

Namespace: Amazon.Redshift
Assembly: AWSSDK.Redshift.dll
Version: 3.x.y.z

Syntax

C#
public virtual ModifyClusterResponse ModifyCluster(
         ModifyClusterRequest request
)
Parameters
request
Type: Amazon.Redshift.Model.ModifyClusterRequest

Container for the necessary parameters to execute the ModifyCluster service method.

Return Value
The response from the ModifyCluster service method, as returned by Redshift.

Exceptions

ExceptionCondition
ClusterAlreadyExistsException The account already has a cluster with the given identifier.
ClusterNotFoundException The ClusterIdentifier parameter does not refer to an existing cluster.
ClusterParameterGroupNotFoundException The parameter group name does not refer to an existing parameter group.
ClusterSecurityGroupNotFoundException The cluster security group name does not refer to an existing cluster security group.
DependentServiceRequestThrottlingException The request cannot be completed because a dependent service is throttling requests made by Amazon Redshift on your behalf. Wait and retry the request.
HsmClientCertificateNotFoundException There is no Amazon Redshift HSM client certificate with the specified identifier.
HsmConfigurationNotFoundException There is no Amazon Redshift HSM configuration with the specified identifier.
InsufficientClusterCapacityException The number of nodes specified exceeds the allotted capacity of the cluster.
InvalidClusterSecurityGroupStateException The state of the cluster security group is not available.
InvalidClusterStateException The specified cluster is not in the available state.
InvalidElasticIpException The Elastic IP (EIP) is invalid or cannot be found.
LimitExceededException The encryption key has exceeded its grant limit in AWS KMS.
NumberOfNodesPerClusterLimitExceededException The operation would exceed the number of nodes allowed for a cluster.
NumberOfNodesQuotaExceededException The operation would exceed the number of nodes allotted to the account. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
UnauthorizedOperationException Your account is not authorized to perform the requested operation.
UnsupportedOptionException A request option was specified that is not supported.

Examples

This example shows how to associate a cluster security group with the specified cluster.

To modify a cluster


var response = client.ModifyCluster(new ModifyClusterRequest 
{
    ClusterIdentifier = "mycluster",
    ClusterSecurityGroups = new List {
        "mysecuritygroup"
    }
});


            

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

See Also