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.

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.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginModifyCluster and EndModifyCluster.

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

Syntax

C#
public abstract Task<ModifyClusterResponse> ModifyClusterAsync(
         ModifyClusterRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.Redshift.Model.ModifyClusterRequest

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

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

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.
CustomCnameAssociationException An error occurred when an attempt was made to change the custom domain association.
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.
InvalidClusterTrackException The provided cluster track name is not valid.
InvalidElasticIpException The Elastic IP (EIP) is invalid or cannot be found.
InvalidRetentionPeriodException The retention period specified is either in the past or is not a valid value. The value must be either -1 or an integer between 1 and 3,653.
Ipv6CidrBlockNotFoundException There are no subnets in your VPC with associated IPv6 CIDR blocks. To use dual-stack mode, associate an IPv6 CIDR block with each subnet in your VPC.
LimitExceededException The encryption key has exceeded its grant limit in Amazon Web Services 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.
TableLimitExceededException The number of tables in the cluster exceeds the limit for the requested new cluster node type.
UnauthorizedOperationException Your account is not authorized to perform the requested operation.
UnsupportedOperationException The requested operation isn't supported.
UnsupportedOptionException A request option was specified that is not supported.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also