Class FederatedAWSCredentialsOptions

Namespace

Amazon.Runtime

Assembly

AWSSDK.Core.dll

Options that control the behavior of FederatedAWSCredentials.

public class FederatedAWSCredentialsOptions

Inheritance

object

FederatedAWSCredentialsOptions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

FederatedAWSCredentialsOptions()

public FederatedAWSCredentialsOptions()

Properties

CredentialRequestCallback

FederatedAWSCredentials uses this callback to get credentials if the UserIdentity is set.

public Func<CredentialRequestCallbackArgs, NetworkCredential> CredentialRequestCallback { get; set; }

Property Value

Func<CredentialRequestCallbackArgs, NetworkCredential>

CustomCallbackState

When FederatedAWSCredentials makes a callback for credentials, this state will be included for use by the callback handler.

public object CustomCallbackState { get; set; }

Property Value

object

ProfileName

The profile name, if this FederatedAWSCredentialsOptions is associated with a CredentialProfile.

public string ProfileName { get; set; }

Property Value

string

ProxySettings

The proxy settings to use when calling the Secure Token Service and the ADFS endpoint.

public WebProxy ProxySettings { get; set; }

Property Value

WebProxy

STSRegion

Set this property when a region-specific STS endpoint must be used (eg cn-north-1). If left empty/null, the global sts.amazonaws.com endpoint will be used when credentials are obtained.

public RegionEndpoint STSRegion { get; set; }

Property Value

RegionEndpoint

UserIdentity

The identity to use when authenticating. This is in the form domain\username, or just username. If this option is not set, the current user's identity will be used.

public string UserIdentity { get; set; }

Property Value

string