CredentialsInterface
extends
Serializable
in
Provides access to the AWS credentials used for accessing AWS services: AWS access key ID, secret access key, and security token. These credentials are used to securely sign requests to AWS services.
Table of Contents
Methods
- getAccessKeyId() : string
- Returns the AWS access key ID for this credentials object.
- getExpiration() : int|null
- Get the UNIX timestamp in which the credentials will expire
- getSecretKey() : string
- Returns the AWS secret access key for this credentials object.
- getSecurityToken() : string|null
- Get the associated security token if available
- isExpired() : bool
- Check if the credentials are expired
- setAccessKeyId() : self
- Set the AWS access key ID for this credentials object.
- setExpiration() : self
- Set the UNIX timestamp in which the credentials will expire
- setSecretKey() : CredentialsInterface
- Set the AWS secret access key for this credentials object.
- setSecurityToken() : self
- Set the security token to use with this credentials object
Methods
getAccessKeyId()
Returns the AWS access key ID for this credentials object.
public
getAccessKeyId() : string
Return values
stringgetExpiration()
Get the UNIX timestamp in which the credentials will expire
public
getExpiration() : int|null
Return values
int|nullgetSecretKey()
Returns the AWS secret access key for this credentials object.
public
getSecretKey() : string
Return values
stringgetSecurityToken()
Get the associated security token if available
public
getSecurityToken() : string|null
Return values
string|nullisExpired()
Check if the credentials are expired
public
isExpired() : bool
Return values
boolsetAccessKeyId()
Set the AWS access key ID for this credentials object.
public
setAccessKeyId(string $key) : self
Parameters
- $key : string
-
AWS access key ID
Return values
selfsetExpiration()
Set the UNIX timestamp in which the credentials will expire
public
setExpiration(int $timestamp) : self
Parameters
- $timestamp : int
-
UNIX timestamp expiration
Return values
selfsetSecretKey()
Set the AWS secret access key for this credentials object.
public
setSecretKey(string $secret) : CredentialsInterface
Parameters
- $secret : string
-
AWS secret access key
Return values
CredentialsInterfacesetSecurityToken()
Set the security token to use with this credentials object
public
setSecurityToken(string $token) : self
Parameters
- $token : string
-
Security token