Credentials
in package
implements
CredentialProvider
FinalYes
Immutable store for Credentials parameters.
Tags
Table of Contents
Interfaces
- CredentialProvider
- Interface for providing Credential.
Constants
- EXPIRATION_DRIFT = 30
Properties
- $accessKeyId : string
- $expireDate : DateTimeImmutable|null
- $secretKey : string
- $sessionToken : string|null
Methods
- __construct() : mixed
- adjustExpireDate() : DateTimeImmutable
- getAccessKeyId() : string
- getCredentials() : Credentials|null
- Return a Credential when possible. Return null otherwise.
- getExpireDate() : DateTimeImmutable|null
- getSecretKey() : string
- getSessionToken() : string|null
- isExpired() : bool
Constants
EXPIRATION_DRIFT
private
mixed
EXPIRATION_DRIFT
= 30
Properties
$accessKeyId
private
string
$accessKeyId
$expireDate
private
DateTimeImmutable|null
$expireDate
$secretKey
private
string
$secretKey
$sessionToken
private
string|null
$sessionToken
Methods
__construct()
public
__construct(string $accessKeyId, string $secretKey[, string|null $sessionToken = null ][, DateTimeImmutable|null $expireDate = null ]) : mixed
Parameters
- $accessKeyId : string
- $secretKey : string
- $sessionToken : string|null = null
- $expireDate : DateTimeImmutable|null = null
adjustExpireDate()
public
static adjustExpireDate(DateTimeImmutable $expireDate[, DateTimeImmutable|null $reference = null ]) : DateTimeImmutable
Parameters
- $expireDate : DateTimeImmutable
- $reference : DateTimeImmutable|null = null
Return values
DateTimeImmutablegetAccessKeyId()
public
getAccessKeyId() : string
Return values
stringgetCredentials()
Return a Credential when possible. Return null otherwise.
public
getCredentials(Configuration $configuration) : Credentials|null
Parameters
- $configuration : Configuration
Return values
Credentials|nullgetExpireDate()
public
getExpireDate() : DateTimeImmutable|null
Return values
DateTimeImmutable|nullgetSecretKey()
public
getSecretKey() : string
Return values
stringgetSessionToken()
public
getSessionToken() : string|null
Return values
string|nullisExpired()
public
isExpired() : bool