Container for the parameters to the ModifyCacheCluster operation.
Namespace: Amazon.ElastiCache.ModelModifies the Cache Cluster settings. You can change one or more Cache Cluster configuration parameters by specifying the parameters and the new values in the request.
Assembly: AWSSDK (in AWSSDK.dll) Version: 1.4.10.0 (1.4.10.0)
Syntax
| C# | Visual Basic | Visual C++ |
public class ModifyCacheClusterRequest : AmazonWebServiceRequest
Public Class ModifyCacheClusterRequest _ Inherits AmazonWebServiceRequest
public ref class ModifyCacheClusterRequest : public AmazonWebServiceRequest
Members
| All Members | Constructors  | Properties  | Methods |
 Public Protected | Instance Static  | Declared Inherited | XNA Framework Only  .NET Compact Framework Only  |
| Member | Description | |||
|---|---|---|---|---|
| ModifyCacheClusterRequest()()()() | Initializes a new instance of the ModifyCacheClusterRequest class | ||
| ApplyImmediately |
Specifies whether or not the modifications in this request and any pending modifications are asynchronously applied as soon as possible,
regardless of the PreferredMaintenanceWindow setting for the Cache Cluster. If this parameter is passed as false, changes to
the Cache Cluster are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first. Default: false | ||
| AutoMinorVersionUpgrade |
Indicates that minor engine upgrades will be applied automatically to the Cache Cluster during the maintenance window. Default: true | ||
| CacheClusterId |
The Cache Cluster identifier. This value is stored as a lowercase string.
| ||
| CacheNodeIdsToRemove |
The list of Cache Node IDs to be removed. This parameter is only valid when NumCacheNodes is less than the existing number of Cache Nodes.
The number of Cache Node Ids supplied in this parameter must match the difference between the existing number of Cache Nodes in the cluster
and the new NumCacheNodes requested.
| ||
| CacheParameterGroupName |
The name of the Cache Parameter Group to apply to this Cache Cluster. This change is asynchronously applied as soon as possible for
parameters when the ApplyImmediately parameter is specified as true for this request.
| ||
| CacheSecurityGroupNames |
A list of Cache Security Group Names to authorize on this Cache Cluster. This change is asynchronously applied as soon as possible.
Constraints: Must contain no more than 255 alphanumeric characters. Must not be "Default".
| ||
| EngineVersion |
The version of the cache engine to upgrade this cluster to.
| ||
| Equals(Object) | (Inherited from Object.) | ||
| GetHashCode()()()() |
Serves as a hash function for a particular type.
(Inherited from Object.) | ||
| GetType()()()() |
Gets the Type of the current instance.
(Inherited from Object.) | ||
| NotificationTopicArn |
The Amazon Resource Name (ARN) of the SNS topic to which notifications will be sent.
| ||
| NotificationTopicStatus |
The status of the Amazon SNS notification topic. The value can be active or inactive. Notifications are sent only if the
status is active.
| ||
| NumCacheNodes |
The number of Cache Nodes the Cache Cluster should have. If NumCacheNodes is greater than the existing number of Cache Nodes, Cache Nodes
will be added. If NumCacheNodes is less than the existing number of Cache Nodes, Cache Nodes will be removed. When removing Cache Nodes, the
Ids of the specific Cache Nodes to be removed must be supplied using the CacheNodeIdsToRemove parameter.
| ||
| PreferredMaintenanceWindow |
The weekly time range (in UTC) during which system maintenance can occur, which may result in an outage. This change is made immediately. If
moving this window to the current time, there must be at least 120 minutes between the current time and end of the window to ensure pending
changes are applied.
| ||
| ToString()()()() | (Inherited from Object.) | ||
| WithApplyImmediately(Boolean) |
Sets the ApplyImmediately property
| ||
| WithAutoMinorVersionUpgrade(Boolean) |
Sets the AutoMinorVersionUpgrade property
| ||
| WithCacheClusterId(String) |
Sets the CacheClusterId property
| ||
| WithCacheNodeIdsToRemove(IEnumerable<(Of <<'(String>)>>)) |
Adds elements to the CacheNodeIdsToRemove collection
| ||
| WithCacheNodeIdsToRemove(array<String>[]()[][]) |
Adds elements to the CacheNodeIdsToRemove collection
| ||
| WithCacheParameterGroupName(String) |
Sets the CacheParameterGroupName property
| ||
| WithCacheSecurityGroupNames(IEnumerable<(Of <<'(String>)>>)) |
Adds elements to the CacheSecurityGroupNames collection
| ||
| WithCacheSecurityGroupNames(array<String>[]()[][]) |
Adds elements to the CacheSecurityGroupNames collection
| ||
| WithEngineVersion(String) |
Sets the EngineVersion property
| ||
| WithNotificationTopicArn(String) |
Sets the NotificationTopicArn property
| ||
| WithNotificationTopicStatus(String) |
Sets the NotificationTopicStatus property
| ||
| WithNumCacheNodes(Int32) |
Sets the NumCacheNodes property
| ||
| WithPreferredMaintenanceWindow(String) |
Sets the PreferredMaintenanceWindow property
|
Note:Inheritance Hierarchy
System..::..Object
Amazon.Runtime..::..AmazonWebServiceRequest
Amazon.ElastiCache.Model..::..ModifyCacheClusterRequest
Amazon.Runtime..::..AmazonWebServiceRequest
Amazon.ElastiCache.Model..::..ModifyCacheClusterRequest
See Also
