Class CredentialProfileOptions

Namespace

Amazon.Runtime.CredentialManagement

Assembly

AWSSDK.Core.dll

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]

public class CredentialProfileOptions

Inheritance

object

CredentialProfileOptions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

CredentialProfileOptions()

public CredentialProfileOptions()

Properties

AccessKey

The access key to be used in the AWSCredentials.

public string AccessKey { get; set; }

Property Value

string

CredentialProcess

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

public string CredentialProcess { get; set; }

Property Value

string

CredentialSource

The source of credentials to be used to obtain AWSCredentials.

public string CredentialSource { get; set; }

Property Value

string

EndpointName

The endpoint name to be used for federated AWSCredentials.

public string EndpointName { get; set; }

Property Value

string

ExternalID

The external id to use in assume role AWSCredentials.

public string ExternalID { get; set; }

Property Value

string

MfaSerial

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

public string MfaSerial { get; set; }

Property Value

string

RoleArn

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

public string RoleArn { get; set; }

Property Value

string

RoleSessionName

An identifier for the assumed role session.

public string RoleSessionName { get; set; }

Property Value

string

SecretKey

The secret key to use when creating AWSCredentials.

public string SecretKey { get; set; }

Property Value

string

SourceProfile

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

public string SourceProfile { get; set; }

Property Value

string

Token

The session token to be used to create AWSCredentials.

public string Token { get; set; }

Property Value

string

UserIdentity

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 string UserIdentity { get; set; }

Property Value

string

WebIdentityTokenFile

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

public string WebIdentityTokenFile { get; set; }

Property Value

string

Methods

Equals(object)

public override bool Equals(object obj)

Parameters

obj object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

ToString()

public override string ToString()

Returns

string