reboot_cache_cluster ( $cache_cluster_id, $cache_node_ids_to_reboot, $opt )

Reboots some (or all) of the cache cluster nodes within a previously provisioned ElastiCache cluster. This API results in the application of modified CacheParameterGroup parameters to the cache cluster. This action is taken as soon as possible, and results in a momentary outage to the cache cluster during which the cache cluster status is set to rebooting. During that momentary outage, the contents of the cache (for each cache cluster node being rebooted) are lost. A CacheCluster event is created when the reboot is completed.

Access

public

Parameters

Parameter

Type

Required

Description

$cache_cluster_id

string

Required

The Cache Cluster identifier. This parameter is stored as a lowercase string.

$cache_node_ids_to_reboot

string
array

Required

A list of Cache Cluster Node Ids to reboot. To reboot an entire cache cluster, specify all cache cluster node Ids. Pass a string for a single value, or an indexed array for multiple values.

$opt

array

Optional

An associative array of parameters that can have the following keys:

  • curlopts - array - Optional - A set of values to pass directly into curl_setopt(), where the key is a pre-defined CURLOPT_* constant.
  • returnCurlHandle - boolean - Optional - A private toggle specifying that the cURL handle be returned rather than actually completing the request. This toggle is useful for manually managed batch requests.

Returns

Type

Description

CFResponse

A CFResponse object containing a parsed HTTP response.

Source

Method defined in services/elasticache.class.php | Toggle source view (12 lines) | View on GitHub

public function reboot_cache_cluster($cache_cluster_id, $cache_node_ids_to_reboot, $opt = null)
{
    if (!$opt) $opt = array();
    $opt['CacheClusterId'] = $cache_cluster_id;
    
    // Required list (non-map)
    $opt = array_merge($opt, CFComplexType::map(array(
        'CacheNodeIdsToReboot' => (is_array($cache_node_ids_to_reboot) ? $cache_node_ids_to_reboot : array($cache_node_ids_to_reboot))
    ), 'member'));

    return $this->authenticate('RebootCacheCluster', $opt);
}

Copyright © 2010–2013 Amazon Web Services, LLC


Feedback