Container for the parameters to the ModifyCacheCluster operation.
The ModifyCacheCluster operation modifies the settings for a cache cluster. You can use this operation to change one or more cluster configuration parameters by specifying the parameters and the new values.
Declaration Syntax| C# |
public class ModifyCacheClusterRequest : AmazonWebServiceRequest
Members| All Members | Constructors | Methods | Properties | ||
| Icon | Member | Description | ||
|---|---|---|---|---|
 | ModifyCacheClusterRequest()()()() | Initializes a new instance of the ModifyCacheClusterRequest class | ||
 | ApplyImmediately |
If true, this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as
soon as possible, regardless of the PreferredMaintenanceWindow setting for the cache cluster. If false, then changes to the
cache cluster are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first. Valid values: true |
false Default: false | ||
| AutoMinorVersionUpgrade |
If true, then minor engine upgrades will be applied automatically to the cache cluster during the maintenance window. Valid values:
true | false Default: true | ||
| CacheClusterId |
The cache cluster identifier. This value is stored as a lowercase string.
| ||
| CacheNodeIdsToRemove |
A list of cache node IDs to be removed. A node ID is a numeric identifier (0001, 0002, etc.). 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 value of NumCacheNodes in the request.
| ||
| 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. This
parameter can be used only with clusters that are created outside of an Amazon Virtual Private Cloud (VPC). Constraints: Must contain no
more than 255 alphanumeric characters. Must not be "Default".
| ||
| EngineVersion |
The upgraded version of the cache engine to be run on the cache cluster nodes.
| ||
| 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. Notifications are sent only if the status is active. Valid values: active |
inactive | ||
| NumCacheNodes |
The number of cache nodes that the cache cluster should have. If the value for NumCacheNodes is greater than the existing number of
cache nodes, then more nodes will be added. If the value is less than the existing number of cache nodes, then cache nodes will be removed.
If you are removing cache nodes, you must use the CacheNodeIdsToRemove parameter to provide the IDs of the specific cache nodes to be
removed.
| ||
| PreferredMaintenanceWindow |
The weekly time range (in UTC) during which system maintenance can occur. Note that system maintenance may result in an outage. This change
is made immediately. If you are 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 that pending changes are applied.
| ||
| SecurityGroupIds |
Specifies the VPC Security Groups associated with the cache cluster. This parameter can be used only with clusters that are created in an
Amazon Virtual Private Cloud (VPC).
| ||
| SnapshotRetentionLimit |
The number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them. For example, if you set
SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.
| ||
| SnapshotWindow |
The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster.
| ||
| ToString()()()() | Returns a string that represents the current object. (Inherited from Object.) | ||
| WithApplyImmediately(Boolean) | Obsolete.
Sets the ApplyImmediately property
| ||
| WithAutoMinorVersionUpgrade(Boolean) | Obsolete.
Sets the AutoMinorVersionUpgrade property
| ||
| WithCacheClusterId(String) | Obsolete.
Sets the CacheClusterId property
| ||
| WithCacheNodeIdsToRemove(array<String>[]()[][]) | Obsolete.
Adds elements to the CacheNodeIdsToRemove collection
| ||
| WithCacheNodeIdsToRemove(IEnumerable<(Of <<'(String>)>>)) | Obsolete.
Adds elements to the CacheNodeIdsToRemove collection
| ||
| WithCacheParameterGroupName(String) | Obsolete.
Sets the CacheParameterGroupName property
| ||
| WithCacheSecurityGroupNames(array<String>[]()[][]) | Obsolete.
Adds elements to the CacheSecurityGroupNames collection
| ||
| WithCacheSecurityGroupNames(IEnumerable<(Of <<'(String>)>>)) | Obsolete.
Adds elements to the CacheSecurityGroupNames collection
| ||
| WithEngineVersion(String) | Obsolete.
Sets the EngineVersion property
| ||
| WithNotificationTopicArn(String) | Obsolete.
Sets the NotificationTopicArn property
| ||
| WithNotificationTopicStatus(String) | Obsolete.
Sets the NotificationTopicStatus property
| ||
| WithNumCacheNodes(Int32) | Obsolete.
Sets the NumCacheNodes property
| ||
| WithPreferredMaintenanceWindow(String) | Obsolete.
Sets the PreferredMaintenanceWindow property
| ||
| WithSecurityGroupIds(array<String>[]()[][]) | Obsolete.
Adds elements to the SecurityGroupIds collection
| ||
| WithSecurityGroupIds(IEnumerable<(Of <<'(String>)>>)) | Obsolete.
Adds elements to the SecurityGroupIds collection
| ||
| WithSnapshotRetentionLimit(Int32) | Obsolete.
Sets the SnapshotRetentionLimit property
| ||
| WithSnapshotWindow(String) | Obsolete.
Sets the SnapshotWindow property
|
Note: Inheritance Hierarchy| Object | ||
 | AmazonWebServiceRequest | |
| ModifyCacheClusterRequest | |