AWS SDK Version 3 for .NET
API Reference

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.

Options that control the behavior of Amazon.Runtime.FederatedAWSCredentials.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.FederatedAWSCredentialsOptions

Namespace: Amazon.Runtime
Assembly: AWSSDK.Core.dll
Version: 3.x.y.z

Syntax

C#
public class FederatedAWSCredentialsOptions

The FederatedAWSCredentialsOptions type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property CredentialRequestCallback System.Func<Amazon.Runtime.CredentialRequestCallbackArgs, System.Net.NetworkCredential>

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

Public Property CustomCallbackState System.Object

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

Public Property ProfileName System.String

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

Public Property ProxySettings System.Net.WebProxy

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

Public Property STSRegion Amazon.RegionEndpoint

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 Property UserIdentity System.String

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.

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5