CARVIEW |
AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
SSOAWSCredentials
Class
AWS Credentials that resolve using AWS SSO.
Inheritance Hierarchy
Amazon.Runtime.Identity.BaseIdentity
Amazon.Runtime.AWSCredentials
Amazon.Runtime.RefreshingAWSCredentials
Amazon.Runtime.SSOAWSCredentials
Namespace: Amazon.Runtime
Assembly: AWSSDK.Core.dll
Version: 3.x.y.z
Syntax
public class SSOAWSCredentials : RefreshingAWSCredentials IDisposable
The SSOAWSCredentials type exposes the following members
Constructors
Name | Description | |
---|---|---|
![]() |
SSOAWSCredentials(string, string, string, string) |
Constructs an SSOAWSCredentials object. |
![]() |
SSOAWSCredentials(string, string, string, string, SSOAWSCredentialsOptions) |
Constructs an SSOAWSCredentials object. |
Properties
Name | Type | Description | |
---|---|---|---|
![]() |
AccountId | System.String |
The AWS account ID that temporary AWS credentials will be resolved for. |
![]() |
Expiration | System.Nullable<System.DateTime> | Inherited from Amazon.Runtime.RefreshingAWSCredentials. |
![]() |
Options | Amazon.Runtime.SSOAWSCredentialsOptions |
Options to be used in the SSO flow to resolve credentials.
Developers wishing to support AWS SSO would want to provide the following:
- |
![]() |
PreemptExpiryTime | System.TimeSpan | Inherited from Amazon.Runtime.RefreshingAWSCredentials. |
![]() |
Region | System.String |
The AWS region where the SSO directory for Amazon.Runtime.SSOAWSCredentials.StartUrl is hosted. |
![]() |
RoleName | System.String |
The corresponding IAM role in the AWS account that temporary AWS credentials will be resolved for. |
![]() |
StartUrl | System.String |
The main URL for users to login to their SSO directory. Provided by the SSO service via the web console. |
Methods
Name | Description | |
---|---|---|
![]() |
ClearCredentials() | Inherited from Amazon.Runtime.RefreshingAWSCredentials. |
![]() |
Dispose() | Inherited from Amazon.Runtime.RefreshingAWSCredentials. |
![]() |
GetCredentials() | Inherited from Amazon.Runtime.RefreshingAWSCredentials. |
![]() |
GetCredentialsAsync() | Inherited from Amazon.Runtime.RefreshingAWSCredentials. |
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