ElastiCache client

This page contains examples with the ElastiCache client. See the client introduction for a more detailed description how to use a client. You may also want to consider the authentication documentation to understand the many ways you can authenticate with AWS.

The ElastiCache package could be installed with Composer.

composer require async-aws/elasti-cache

A new client object may be instantiated by:

use AsyncAws\ElastiCache\ElastiCacheClient;

$elastiCache = new ElastiCacheClient();

The authentication parameters is read from the environment by default. You can also specify a AWS access id and secret:

use AsyncAws\ElastiCache\ElastiCacheClient;

$elastiCache = new ElastiCacheClient([
    'accessKeyId' => 'my_access_key',
    'accessKeySecret' => 'my_access_secret',
    'region' => 'eu-central-1',
]);

For all available options, see the configuration reference.

Usage¶

List all clusters¶

use AsyncAws\ElastiCache\ElastiCacheClient;
use AsyncAws\ElastiCache\Input\DescribeCacheClustersMessage;

$elastiCache = new ElastiCacheClient();
$clusters = $elastiCache->describeCacheClusters();

foreach ($clusters as $cluster) {
    echo 'Cluster id: '.$cluster->getCacheClusterId().PHP_EOL;
}

The source code to this page is found on GitHub.