Class SSOAWSCredentials

Namespace

Amazon.Runtime

Assembly

AWSSDK.Core.dll

AWS Credentials that resolve using AWS SSO.

public class SSOAWSCredentials : RefreshingAWSCredentials, IDisposable

Inheritance

object

AWSCredentials

RefreshingAWSCredentials

SSOAWSCredentials

Implements

IDisposable

Inherited Members

RefreshingAWSCredentials.currentState

RefreshingAWSCredentials.GetCredentials()

RefreshingAWSCredentials.GetCredentialsAsync()

RefreshingAWSCredentials.Dispose(bool)

RefreshingAWSCredentials.ClearCredentials()

RefreshingAWSCredentials.Dispose()

RefreshingAWSCredentials.PreemptExpiryTime

RefreshingAWSCredentials.ShouldUpdate

AWSCredentials.Validate()

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

SSOAWSCredentials(string, string, string, string)

Constructs an SSOAWSCredentials object.

public SSOAWSCredentials(string accountId, string region, string roleName, string startUrl)

Parameters

accountId string

The AWS account ID that temporary AWS credentials will be resolved for.

region string

The AWS region where the SSO directory for startUrl is hosted.

roleName string

The corresponding IAM role in the AWS account that temporary AWS credentials will be resolved for.

startUrl string

The main URL for users to login to their SSO directory.

SSOAWSCredentials(string, string, string, string, SSOAWSCredentialsOptions)

Constructs an SSOAWSCredentials object.

public SSOAWSCredentials(string accountId, string region, string roleName, string startUrl, SSOAWSCredentialsOptions options)

Parameters

accountId string

The AWS account ID that temporary AWS credentials will be resolved for.

region string

The AWS region where the SSO directory for startUrl is hosted.

roleName string

The corresponding IAM role in the AWS account that temporary AWS credentials will be resolved for.

startUrl string

The main URL for users to login to their SSO directory.

options SSOAWSCredentialsOptions

Options to be used in the SSO flow to resolve credentials.

Properties

AccountId

The AWS account ID that temporary AWS credentials will be resolved for.

public string AccountId { get; }

Property Value

string

Options

Options to be used in the SSO flow to resolve credentials. Developers wishing to support AWS SSO would want to provide the following:

• ClientName
• SsoVerificationCallback

public SSOAWSCredentialsOptions Options { get; }

Property Value

SSOAWSCredentialsOptions

Region

The AWS region where the SSO directory for StartUrl is hosted.

public string Region { get; }

Property Value

string

RoleName

The corresponding IAM role in the AWS account that temporary AWS credentials will be resolved for.

public string RoleName { get; }

Property Value

string

StartUrl

The main URL for users to login to their SSO directory. Provided by the SSO service via the web console.

public string StartUrl { get; }

Property Value

string

Methods

GenerateNewCredentials()

protected override RefreshingAWSCredentials.CredentialsRefreshState GenerateNewCredentials()

Returns

RefreshingAWSCredentials.CredentialsRefreshState

GenerateNewCredentialsAsync()

protected override Task<RefreshingAWSCredentials.CredentialsRefreshState> GenerateNewCredentialsAsync()

Returns

Task<RefreshingAWSCredentials.CredentialsRefreshState>

HasCachedAccessTokenAvailable(string)

Returns true if there is already a non-expired cached login access token in the token cache.

[Obsolete("This method is no longer used or supported and will be removed in a future version.", false)]
public static bool HasCachedAccessTokenAvailable(string startUrl)

Parameters

startUrl string

Returns

bool

Obsolete: ALWAYS RETURNS FALSE