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

# Class AbstractCredentialsDecorator

Abstract credentials decorator

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

### Direct known subclasses

`Aws\Common\Credentials\AbstractRefreshableCredentials`

### Indirect known subclasses

`Aws\Common\Credentials\CacheableCredentials`, `Aws\Common\Credentials\RefreshableInstanceProfileCredentials`

Namespace: Aws\Common\Credentials
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

# `public`
`__construct( `Aws\Common\Credentials\CredentialsInterface` $credentials )`

Constructs a new BasicAWSCredentials object, with the specified AWS access key and AWS secret key

#### Parameters

$credentials
  ``Aws\Common\Credentials\CredentialsInterface``
  $credentials

# `public`
`serialize( )`

#### Implementation of

`Serializable::serialize()`
# `public`
`unserialize( mixed $serialized )`

#### Implementation of

`Serializable::unserialize()`
# `public string`
`getAccessKeyId( )`

Returns the AWS access key ID for this credentials object.

#### Returns

`string`

#### Implementation of

`Aws\Common\Credentials\CredentialsInterface::getAccessKeyId()`
# `public string`
`getSecretKey( )`

Returns the AWS secret access key for this credentials object.

#### Returns

`string`

#### Implementation of

`Aws\Common\Credentials\CredentialsInterface::getSecretKey()`
# `public string|null`
`getSecurityToken( )`

Get the associated security token if available

#### Returns

`string|null`

#### Implementation of

`Aws\Common\Credentials\CredentialsInterface::getSecurityToken()`
# `public integer|null`
`getExpiration( )`

Get the UNIX timestamp in which the credentials will expire

#### Returns

`integer|null`

#### Implementation of

`Aws\Common\Credentials\CredentialsInterface::getExpiration()`
# `public boolean`
`isExpired( )`

Check if the credentials are expired

#### Returns

`boolean`

#### Implementation of

`Aws\Common\Credentials\CredentialsInterface::isExpired()`
# `public `Aws\Common\Credentials\AbstractCredentialsDecorator``
`setAccessKeyId( string $key )`

Set the AWS access key ID for this credentials object.

#### Parameters

$key
  `string`
  $key AWS access key ID

#### Returns

``Aws\Common\Credentials\AbstractCredentialsDecorator``

#### Implementation of

`Aws\Common\Credentials\CredentialsInterface::setAccessKeyId()`
# `public `Aws\Common\Credentials\CredentialsInterface``
`setSecretKey( string $secret )`

Set the AWS secret access key for this credentials object.

#### Parameters

$secret
  `string`
  $secret AWS secret access key

#### Returns

``Aws\Common\Credentials\CredentialsInterface``

#### Implementation of

`Aws\Common\Credentials\CredentialsInterface::setSecretKey()`
# `public `Aws\Common\Credentials\AbstractCredentialsDecorator``
`setSecurityToken( string $token )`

Set the security token to use with this credentials object

#### Parameters

$token
  `string`
  $token Security token

#### Returns

``Aws\Common\Credentials\AbstractCredentialsDecorator``

#### Implementation of

`Aws\Common\Credentials\CredentialsInterface::setSecurityToken()`
# `public `Aws\Common\Credentials\AbstractCredentialsDecorator``
`setExpiration( integer $timestamp )`

Set the UNIX timestamp in which the credentials will expire

#### Parameters

$timestamp
  `integer`
  $timestamp UNIX timestamp expiration

#### Returns

``Aws\Common\Credentials\AbstractCredentialsDecorator``

#### Implementation of

`Aws\Common\Credentials\CredentialsInterface::setExpiration()`

### Magic methods summary

## Properties summary

`protected `Aws\Common\Credentials\CredentialsInterface`` | $credentials | # Wrapped credentials object