NOTE: For Version 3 of the AWS SDK for PHP, please see the V3 User Guide and V3 API Reference.

Class CacheableCredentials

Credentials decorator used to implement caching credentials

Aws\Common\Credentials\AbstractCredentialsDecorator implements Aws\Common\Credentials\CredentialsInterface

Extended by

Aws\Common\Credentials\AbstractRefreshableCredentials

Extended by

Aws\Common\Credentials\CacheableCredentials

Namespace: Aws\Common\Credentials
Located at Aws/Common/Credentials/CacheableCredentials.php

Methods summary

public __construct ( Aws\Common\Credentials\CredentialsInterface $credentials, Guzzle\Cache\CacheAdapterInterface $cache, string $cacheKey )

CacheableCredentials is a decorator that decorates other credentials
protected refresh ( )

Attempt to get new credentials from cache or from the adapted object

Methods detail

#


                     public


__construct( Aws\Common\Credentials\CredentialsInterface $credentials, Guzzle\Cache\CacheAdapterInterface $cache, string $cacheKey )

CacheableCredentials is a decorator that decorates other credentials

Parameters

$credentials: Aws\Common\Credentials\CredentialsInterface
$credentials Credentials to adapt
$cache: Guzzle\Cache\CacheAdapterInterface
$cache Cache to use to store credentials
$cacheKey: string
$cacheKey Cache key of the credentials

Overrides

Aws\Common\Credentials\AbstractCredentialsDecorator::__construct

#


                     protected


refresh( )

Attempt to get new credentials from cache or from the adapted object

Methods inherited from Aws\Common\Credentials\AbstractRefreshableCredentials

getAccessKeyId(), getCredentials(), getSecretKey(), getSecurityToken(), serialize()

Methods inherited from Aws\Common\Credentials\AbstractCredentialsDecorator

getExpiration(), isExpired(), setAccessKeyId(), setExpiration(), setSecretKey(), setSecurityToken(), unserialize()

Magic methods summary

Properties summary

`protected Guzzle\Cache\CacheAdapterInterface`	`$cache`	# Cache adapter used to store credentials
`protected string`	`$cacheKey`	# Cache key used to store the credentials

Properties inherited from Aws\Common\Credentials\AbstractCredentialsDecorator