Class AbstractCredentialsDecorator
Abstract credentials decorator
- Aws\Common\Credentials\AbstractCredentialsDecorator implements Aws\Common\Credentials\CredentialsInterface
Direct known subclasses
Indirect known subclasses
Aws\Common\Credentials\CacheableCredentials
,
Aws\Common\Credentials\RefreshableInstanceProfileCredentials
Located at Aws/Common/Credentials/AbstractCredentialsDecorator.php
Methods summary
-
public
__construct ( Aws\Common\Credentials\CredentialsInterface $credentials )
Constructs a new BasicAWSCredentials object, with the specified AWS access key and AWS secret key
-
public
serialize ( )
-
public
unserialize ( mixed $serialized )
-
public
getAccessKeyId ( )
Returns the AWS access key ID for this credentials object.
-
public
getSecretKey ( )
Returns the AWS secret access key for this credentials object.
-
public
getSecurityToken ( )
Get the associated security token if available
-
public
getExpiration ( )
Get the UNIX timestamp in which the credentials will expire
-
public
isExpired ( )
Check if the credentials are expired
-
public
setAccessKeyId ( string $key )
Set the AWS access key ID for this credentials object.
-
public
setSecretKey ( string $secret )
Set the AWS secret access key for this credentials object.
-
public
setSecurityToken ( string $token )
Set the security token to use with this credentials object
-
public
setExpiration ( int $timestamp )
Set the UNIX timestamp in which the credentials will expire
Methods detail
Constructs a new BasicAWSCredentials object, with the specified AWS access key and AWS secret key
Parameters
- $credentials
Aws\Common\Credentials\CredentialsInterface
$credentials
Implementation of
Implementation of
Returns the AWS access key ID for this credentials object.
Returns
string
Implementation of
Returns the AWS secret access key for this credentials object.
Returns
string
Implementation of
Get the associated security token if available
Returns
string|null
Implementation of
Get the UNIX timestamp in which the credentials will expire
Returns
integer|null
Implementation of
Check if the credentials are expired
Returns
boolean
Implementation of
Set the AWS access key ID for this credentials object.
Parameters
- $key
string
$key AWS access key ID
Returns
Implementation of
Set the AWS secret access key for this credentials object.
Parameters
- $secret
string
$secret AWS secret access key
Returns
Implementation of
Set the security token to use with this credentials object
Parameters
- $token
string
$token Security token
Returns
Implementation of
Set the UNIX timestamp in which the credentials will expire
Parameters
- $timestamp
integer
$timestamp UNIX timestamp expiration
Returns
Implementation of
Magic methods summary
Properties summary
protected
|
$credentials |
#
Wrapped credentials object |