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
-
publicserialize ( ) -
publicunserialize ( mixed $serialized ) -
publicgetAccessKeyId ( )Returns the AWS access key ID for this credentials object.
-
publicgetSecretKey ( )Returns the AWS secret access key for this credentials object.
-
publicgetSecurityToken ( )Get the associated security token if available
-
publicgetExpiration ( )Get the UNIX timestamp in which the credentials will expire
-
publicisExpired ( )Check if the credentials are expired
-
publicsetAccessKeyId ( string $key )Set the AWS access key ID for this credentials object.
-
publicsetSecretKey ( string $secret )Set the AWS secret access key for this credentials object.
-
publicsetSecurityToken ( string $token )Set the security token to use with this credentials object
-
publicsetExpiration ( 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
stringImplementation of
Returns the AWS secret access key for this credentials object.
Returns
stringImplementation of
Get the associated security token if available
Returns
string|nullImplementation of
Get the UNIX timestamp in which the credentials will expire
Returns
integer|nullImplementation of
Check if the credentials are expired
Returns
booleanImplementation 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 |