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.

The options that are available for creating AWSCredentials with the AWSCredentialsFactory. The type of AWSCredentials that are created depends on which Options are set. Below are the different types of credentials returned, along with the options that are used to obtain them. ([] denotes options that are not required) BasicAWSCredentials AccessKey SecretKey SessionAWSCredentials AccessKey SecretKey Token AssmeRoleAWSCredentials SourceProfile RoleArn [ExternalID] [MfaSerial] FederatedAWSCredentials EndpointName RoleArn [UserIdentity]

Inheritance Hierarchy

System.Object
  Amazon.Runtime.CredentialManagement.CredentialProfileOptions

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

Syntax

C#
public class CredentialProfileOptions

The CredentialProfileOptions type exposes the following members

Constructors

NameDescription
Public Method CredentialProfileOptions()

Properties

NameTypeDescription
Public Property AccessKey System.String

The access key to be used in the AWSCredentials.

Public Property EndpointName System.String

The endpoint name to be used for federated AWSCredentials.

Public Property ExternalID System.String

The external id to use in assume role AWSCredentials.

Public Property MfaSerial System.String

The serial number of the MFA to use in assume role AWSCredentials.

Public Property RoleArn System.String

The role ARN to use when creating assume role or federated AWSCredentials.

Public Property SecretKey System.String

The secret key to use when creating AWSCredentials.

Public Property SourceProfile System.String

When this CredentialProfileOptions object references another CredentialProfile, the name of the referenced CredentialProfile.

Public Property Token System.String

The session token to be used to create AWSCredentials.

Public Property UserIdentity System.String

The user identity to use when creating federated AWSCredentials. If not set, the user identity that the code is running under will be used.

Version Information

.NET Standard:
Supported in: 1.3

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