Abstract class for automatically refreshing AWS credentials
Inheritance Hierarchy
Amazon.Runtime.Identity.BaseIdentity
Amazon.Runtime.AWSCredentials
Amazon.Runtime.RefreshingAWSCredentials
Namespace: Amazon.Runtime
Assembly: AWSSDK.Core.dll
Version: 3.x.y.z
Syntax
public abstract class RefreshingAWSCredentials : AWSCredentials IDisposable
The RefreshingAWSCredentials type exposes the following members
Properties
| Name | Type | Description | |
|---|---|---|---|
|
Expiration | System.Nullable<System.DateTime> |
The time after which this identity will no longer be valid. If this is null, an expiration time is not known (for example, when using long-term credentials). |
|
|
ExpirationBuffer | System.TimeSpan |
The time subtracted from the expiration provided by the credentials provider and then used for determining if the credentials are expired. This provides a buffer to avoid corner case issues of processing time on the client side before the credentials are actually used for signing and validation on the server side. |
|
|
PreemptExpiryTime | System.TimeSpan |
If credentials are still valid but the expiration is within the Expiration minus PreemptExpiryTime a background refresh of the credentials will be triggered. |
Methods
| Name | Description | |
|---|---|---|
|
|
ClearCredentials() |
Clears currently-stored credentials, forcing the next GetCredentials call to generate new credentials. |
|
|
Dispose() | |
|
|
GetCredentials() |
Returns an instance of ImmutableCredentials for this instance |
|
|
GetCredentialsAsync() |
Version Information
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.7.2 and newer