AmazonElastiCacheClient.ModifyCacheCluster Method (ModifyCacheClusterRequest)

Modifies the settings for a cluster. You can use this operation to change one or more cluster configuration parameters by specifying the parameters and the new values.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to ModifyCacheClusterAsync.

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

Syntax

public virtual ModifyCacheClusterResponse ModifyCacheCluster(
         ModifyCacheClusterRequest request
)

Parameters

request: Type: Amazon.ElastiCache.Model.ModifyCacheClusterRequest

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

Return Value

Type: ModifyCacheClusterResponse

The response from the ModifyCacheCluster service method, as returned by ElastiCache.

Exceptions

Exception	Condition
CacheClusterNotFoundException	The requested cluster ID does not refer to an existing cluster.
CacheParameterGroupNotFoundException	The requested cache parameter group name does not refer to an existing cache parameter group.
CacheSecurityGroupNotFoundException	The requested cache security group name does not refer to an existing cache security group.
InsufficientCacheClusterCapacityException	The requested cache node type is not available in the specified Availability Zone. For more information, see InsufficientCacheClusterCapacity in the ElastiCache User Guide.
InvalidCacheClusterStateException	The requested cluster is not in the available state.
InvalidCacheSecurityGroupStateException	The current state of the cache security group does not allow deletion.
InvalidParameterCombinationException	Two or more incompatible parameters were specified.
InvalidParameterValueException	The value for a parameter is invalid.
InvalidVPCNetworkStateException	The VPC network is in an invalid state.
NodeQuotaForClusterExceededException	The request cannot be processed because it would exceed the allowed number of cache nodes in a single cluster.
NodeQuotaForCustomerExceededException	The request cannot be processed because it would exceed the allowed number of cache nodes per customer.

Examples

Copies a snapshot to a specified name.

ModifyCacheCluster


var client = new AmazonElastiCacheClient();
var response = client.ModifyCacheCluster(new ModifyCacheClusterRequest 
{
    ApplyImmediately = true,
    CacheClusterId = "redis-cluster",
    SnapshotRetentionLimit = 14
});

CacheCluster cacheCluster = response.CacheCluster;

Version Information

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

AmazonElastiCacheClient.ModifyCacheCluster (ModifyCacheClusterRequest)

Method