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.

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 CredentialProcess System.String

Contains the executable information to be used by the process credential retriever to either fetch Basic or Session credentials

Public Property CredentialSource System.String

The source of credentials to be used to obtain 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 RoleSessionName System.String

An identifier for the assumed role session.

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 SsoAccountId System.String

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

Public Property SsoRegion System.String

The AWS region where the SSO directory for Amazon.Runtime.CredentialManagement.CredentialProfileOptions.SsoStartUrl is hosted.

Public Property SsoRoleName System.String

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

Public Property SsoStartUrl System.String

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

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.

Public Property WebIdentityTokenFile System.String

Absolute path to the file on disk containing an OIDC token.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

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