amazonka-elasticache-1.4.5: Amazon ElastiCache SDK.

Copyright(c) 2013-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.ElastiCache.ModifyCacheCluster

Contents

Description

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.

Synopsis

Creating a Request

modifyCacheCluster Source #

Creates a value of ModifyCacheCluster with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • mccEngineVersion - The upgraded version of the cache engine to be run on the cache nodes. Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version ), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cache cluster and create it anew with the earlier engine version.
  • mccCacheNodeType - A valid cache node type that you want to scale this cache cluster up to.
  • mccSecurityGroupIds - 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 (Amazon VPC).
  • mccAutoMinorVersionUpgrade - This parameter is currently disabled.
  • mccCacheParameterGroupName - 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.
  • mccSnapshotWindow - The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cache cluster.
  • mccNewAvailabilityZones - The list of Availability Zones where the new Memcached cache nodes are created. This parameter is only valid when NumCacheNodes in the request is greater than the sum of the number of active cache nodes and the number of cache nodes pending creation (which may be zero). The number of Availability Zones supplied in this list must match the cache nodes being added in this request. This option is only supported on Memcached clusters. Scenarios: * Scenario 1: You have 3 active nodes and wish to add 2 nodes. Specify NumCacheNodes=5 (3 + 2) and optionally specify two Availability Zones for the two new nodes. * Scenario 2: You have 3 active nodes and 2 nodes pending creation (from the scenario 1 call) and want to add 1 more node. Specify NumCacheNodes=6 ((3 + 2) + 1) and optionally specify an Availability Zone for the new node. * Scenario 3: You want to cancel all pending operations. Specify NumCacheNodes=3 to cancel all pending operations. The Availability Zone placement of nodes pending creation cannot be modified. If you wish to cancel any nodes pending creation, add 0 nodes by setting NumCacheNodes to the number of current nodes. If cross-az is specified, existing Memcached nodes remain in their current Availability Zone. Only newly created nodes can be located in different Availability Zones. For guidance on how to move existing Memcached nodes to different Availability Zones, see the Availability Zone Considerations section of Cache Node Considerations for Memcached . Impact of new add/remove requests upon pending requests * Scenario-1 * Pending Action: Delete * New Request: Delete * Result: The new delete, pending or immediate, replaces the pending delete. * Scenario-2 * Pending Action: Delete * New Request: Create * Result: The new create, pending or immediate, replaces the pending delete. * Scenario-3 * Pending Action: Create * New Request: Delete * Result: The new delete, pending or immediate, replaces the pending create. * Scenario-4 * Pending Action: Create * New Request: Create * Result: The new create is added to the pending create. Important: Important: If the new create request is Apply Immediately - Yes , all creates are performed immediately. If the new create request is Apply Immediately - No , all creates are pending.
  • mccPreferredMaintenanceWindow - Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ddd are: * sun * mon * tue * wed * thu * fri * sat Example: sun:23:00-mon:01:30
  • mccCacheNodeIdsToRemove - 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 or pending cache nodes, whichever is greater, and the value of NumCacheNodes in the request. For example: If you have 3 active cache nodes, 7 pending cache nodes, and the number of cache nodes in this ModifyCacheCluser call is 5, you must list 2 (7 - 5) cache node IDs to remove.
  • mccSnapshotRetentionLimit - The number of days for which ElastiCache retains automatic cache cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.
  • mccNotificationTopicStatus - The status of the Amazon SNS notification topic. Notifications are sent only if the status is active . Valid values: active | inactive
  • mccAZMode - Specifies whether the new nodes in this Memcached cache cluster are all created in a single Availability Zone or created across multiple Availability Zones. Valid values: single-az | cross-az . This option is only supported for Memcached cache clusters.
  • mccApplyImmediately - 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 , changes to the cache cluster are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first. Important: If you perform a ModifyCacheCluster before a pending modification is applied, the pending modification is replaced by the newer modification. Valid values: true | false Default: false
  • mccNotificationTopicARN - The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are sent.
  • mccNumCacheNodes - The number of cache nodes that the cache cluster should have. If the value for NumCacheNodes is greater than the sum of the number of current cache nodes and the number of cache nodes pending creation (which may be zero), more nodes are added. If the value is less than the number of existing cache nodes, nodes are removed. If the value is equal to the number of current cache nodes, any pending add or remove requests are canceled. If you are removing cache nodes, you must use the CacheNodeIdsToRemove parameter to provide the IDs of the specific cache nodes to remove. For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.
  • mccCacheSecurityGroupNames - A list of cache security group names to authorize on this cache cluster. This change is asynchronously applied as soon as possible. You can use this parameter only with clusters that are created outside of an Amazon Virtual Private Cloud (Amazon VPC). Constraints: Must contain no more than 255 alphanumeric characters. Must not be Default.
  • mccCacheClusterId - The cache cluster identifier. This value is stored as a lowercase string.

data ModifyCacheCluster Source #

Represents the input of a ModifyCacheCluster operation.

See: modifyCacheCluster smart constructor.

Instances

Eq ModifyCacheCluster Source # 
Data ModifyCacheCluster Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ModifyCacheCluster -> c ModifyCacheCluster #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ModifyCacheCluster #

toConstr :: ModifyCacheCluster -> Constr #

dataTypeOf :: ModifyCacheCluster -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ModifyCacheCluster) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ModifyCacheCluster) #

gmapT :: (forall b. Data b => b -> b) -> ModifyCacheCluster -> ModifyCacheCluster #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ModifyCacheCluster -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ModifyCacheCluster -> r #

gmapQ :: (forall d. Data d => d -> u) -> ModifyCacheCluster -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ModifyCacheCluster -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ModifyCacheCluster -> m ModifyCacheCluster #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ModifyCacheCluster -> m ModifyCacheCluster #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ModifyCacheCluster -> m ModifyCacheCluster #

Read ModifyCacheCluster Source # 
Show ModifyCacheCluster Source # 
Generic ModifyCacheCluster Source # 
Hashable ModifyCacheCluster Source # 
NFData ModifyCacheCluster Source # 

Methods

rnf :: ModifyCacheCluster -> () #

AWSRequest ModifyCacheCluster Source # 
ToPath ModifyCacheCluster Source # 
ToHeaders ModifyCacheCluster Source # 
ToQuery ModifyCacheCluster Source # 
type Rep ModifyCacheCluster Source # 
type Rep ModifyCacheCluster = D1 (MetaData "ModifyCacheCluster" "Network.AWS.ElastiCache.ModifyCacheCluster" "amazonka-elasticache-1.4.5-DCZ22LKkzpiJjmUycYjUf" False) (C1 (MetaCons "ModifyCacheCluster'" PrefixI True) ((:*:) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_mccEngineVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_mccCacheNodeType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_mccSecurityGroupIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) (S1 (MetaSel (Just Symbol "_mccAutoMinorVersionUpgrade") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_mccCacheParameterGroupName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_mccSnapshotWindow") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_mccNewAvailabilityZones") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) (S1 (MetaSel (Just Symbol "_mccPreferredMaintenanceWindow") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_mccCacheNodeIdsToRemove") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) (S1 (MetaSel (Just Symbol "_mccSnapshotRetentionLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int)))) ((:*:) (S1 (MetaSel (Just Symbol "_mccNotificationTopicStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_mccAZMode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe AZMode))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_mccApplyImmediately") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_mccNotificationTopicARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_mccNumCacheNodes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int))) ((:*:) (S1 (MetaSel (Just Symbol "_mccCacheSecurityGroupNames") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) (S1 (MetaSel (Just Symbol "_mccCacheClusterId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))))
type Rs ModifyCacheCluster Source # 

Request Lenses

mccEngineVersion :: Lens' ModifyCacheCluster (Maybe Text) Source #

The upgraded version of the cache engine to be run on the cache nodes. Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version ), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cache cluster and create it anew with the earlier engine version.

mccCacheNodeType :: Lens' ModifyCacheCluster (Maybe Text) Source #

A valid cache node type that you want to scale this cache cluster up to.

mccSecurityGroupIds :: Lens' ModifyCacheCluster [Text] Source #

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 (Amazon VPC).

mccAutoMinorVersionUpgrade :: Lens' ModifyCacheCluster (Maybe Bool) Source #

This parameter is currently disabled.

mccCacheParameterGroupName :: Lens' ModifyCacheCluster (Maybe Text) Source #

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.

mccSnapshotWindow :: Lens' ModifyCacheCluster (Maybe Text) Source #

The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cache cluster.

mccNewAvailabilityZones :: Lens' ModifyCacheCluster [Text] Source #

The list of Availability Zones where the new Memcached cache nodes are created. This parameter is only valid when NumCacheNodes in the request is greater than the sum of the number of active cache nodes and the number of cache nodes pending creation (which may be zero). The number of Availability Zones supplied in this list must match the cache nodes being added in this request. This option is only supported on Memcached clusters. Scenarios: * Scenario 1: You have 3 active nodes and wish to add 2 nodes. Specify NumCacheNodes=5 (3 + 2) and optionally specify two Availability Zones for the two new nodes. * Scenario 2: You have 3 active nodes and 2 nodes pending creation (from the scenario 1 call) and want to add 1 more node. Specify NumCacheNodes=6 ((3 + 2) + 1) and optionally specify an Availability Zone for the new node. * Scenario 3: You want to cancel all pending operations. Specify NumCacheNodes=3 to cancel all pending operations. The Availability Zone placement of nodes pending creation cannot be modified. If you wish to cancel any nodes pending creation, add 0 nodes by setting NumCacheNodes to the number of current nodes. If cross-az is specified, existing Memcached nodes remain in their current Availability Zone. Only newly created nodes can be located in different Availability Zones. For guidance on how to move existing Memcached nodes to different Availability Zones, see the Availability Zone Considerations section of Cache Node Considerations for Memcached . Impact of new add/remove requests upon pending requests * Scenario-1 * Pending Action: Delete * New Request: Delete * Result: The new delete, pending or immediate, replaces the pending delete. * Scenario-2 * Pending Action: Delete * New Request: Create * Result: The new create, pending or immediate, replaces the pending delete. * Scenario-3 * Pending Action: Create * New Request: Delete * Result: The new delete, pending or immediate, replaces the pending create. * Scenario-4 * Pending Action: Create * New Request: Create * Result: The new create is added to the pending create. Important: Important: If the new create request is Apply Immediately - Yes , all creates are performed immediately. If the new create request is Apply Immediately - No , all creates are pending.

mccPreferredMaintenanceWindow :: Lens' ModifyCacheCluster (Maybe Text) Source #

Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ddd are: * sun * mon * tue * wed * thu * fri * sat Example: sun:23:00-mon:01:30

mccCacheNodeIdsToRemove :: Lens' ModifyCacheCluster [Text] Source #

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 or pending cache nodes, whichever is greater, and the value of NumCacheNodes in the request. For example: If you have 3 active cache nodes, 7 pending cache nodes, and the number of cache nodes in this ModifyCacheCluser call is 5, you must list 2 (7 - 5) cache node IDs to remove.

mccSnapshotRetentionLimit :: Lens' ModifyCacheCluster (Maybe Int) Source #

The number of days for which ElastiCache retains automatic cache cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.

mccNotificationTopicStatus :: Lens' ModifyCacheCluster (Maybe Text) Source #

The status of the Amazon SNS notification topic. Notifications are sent only if the status is active . Valid values: active | inactive

mccAZMode :: Lens' ModifyCacheCluster (Maybe AZMode) Source #

Specifies whether the new nodes in this Memcached cache cluster are all created in a single Availability Zone or created across multiple Availability Zones. Valid values: single-az | cross-az . This option is only supported for Memcached cache clusters.

mccApplyImmediately :: Lens' ModifyCacheCluster (Maybe Bool) Source #

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 , changes to the cache cluster are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first. Important: If you perform a ModifyCacheCluster before a pending modification is applied, the pending modification is replaced by the newer modification. Valid values: true | false Default: false

mccNotificationTopicARN :: Lens' ModifyCacheCluster (Maybe Text) Source #

The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are sent.

mccNumCacheNodes :: Lens' ModifyCacheCluster (Maybe Int) Source #

The number of cache nodes that the cache cluster should have. If the value for NumCacheNodes is greater than the sum of the number of current cache nodes and the number of cache nodes pending creation (which may be zero), more nodes are added. If the value is less than the number of existing cache nodes, nodes are removed. If the value is equal to the number of current cache nodes, any pending add or remove requests are canceled. If you are removing cache nodes, you must use the CacheNodeIdsToRemove parameter to provide the IDs of the specific cache nodes to remove. For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.

mccCacheSecurityGroupNames :: Lens' ModifyCacheCluster [Text] Source #

A list of cache security group names to authorize on this cache cluster. This change is asynchronously applied as soon as possible. You can use this parameter only with clusters that are created outside of an Amazon Virtual Private Cloud (Amazon VPC). Constraints: Must contain no more than 255 alphanumeric characters. Must not be Default.

mccCacheClusterId :: Lens' ModifyCacheCluster Text Source #

The cache cluster identifier. This value is stored as a lowercase string.

Destructuring the Response

modifyCacheClusterResponse Source #

Creates a value of ModifyCacheClusterResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data ModifyCacheClusterResponse Source #

See: modifyCacheClusterResponse smart constructor.

Instances

Eq ModifyCacheClusterResponse Source # 
Data ModifyCacheClusterResponse Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ModifyCacheClusterResponse -> c ModifyCacheClusterResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ModifyCacheClusterResponse #

toConstr :: ModifyCacheClusterResponse -> Constr #

dataTypeOf :: ModifyCacheClusterResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ModifyCacheClusterResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ModifyCacheClusterResponse) #

gmapT :: (forall b. Data b => b -> b) -> ModifyCacheClusterResponse -> ModifyCacheClusterResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ModifyCacheClusterResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ModifyCacheClusterResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> ModifyCacheClusterResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ModifyCacheClusterResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ModifyCacheClusterResponse -> m ModifyCacheClusterResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ModifyCacheClusterResponse -> m ModifyCacheClusterResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ModifyCacheClusterResponse -> m ModifyCacheClusterResponse #

Read ModifyCacheClusterResponse Source # 
Show ModifyCacheClusterResponse Source # 
Generic ModifyCacheClusterResponse Source # 
NFData ModifyCacheClusterResponse Source # 
type Rep ModifyCacheClusterResponse Source # 
type Rep ModifyCacheClusterResponse = D1 (MetaData "ModifyCacheClusterResponse" "Network.AWS.ElastiCache.ModifyCacheCluster" "amazonka-elasticache-1.4.5-DCZ22LKkzpiJjmUycYjUf" False) (C1 (MetaCons "ModifyCacheClusterResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_mccrsCacheCluster") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe CacheCluster))) (S1 (MetaSel (Just Symbol "_mccrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int))))

Response Lenses