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
Namespace: Amazon.Runtime.CredentialManagement
Assembly: AWSSDK.Core.dll
Version: 3.x.y.z
Syntax
public class CredentialProfileOptions
The CredentialProfileOptions type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
CredentialProfileOptions() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
AccessKey | System.String |
The access key to be used in the AWSCredentials. |
|
|
CredentialProcess | System.String |
Contains the executable information to be used by the process credential retriever to either fetch Basic or Session credentials |
|
|
CredentialSource | System.String |
The source of credentials to be used to obtain AWSCredentials. |
|
|
EndpointName | System.String |
The endpoint name to be used for federated AWSCredentials. |
|
|
ExternalID | System.String |
The external id to use in assume role AWSCredentials. |
|
|
MfaSerial | System.String |
The serial number of the MFA to use in assume role AWSCredentials. |
|
|
RoleArn | System.String |
The role ARN to use when creating assume role or federated AWSCredentials. |
|
|
SecretKey | System.String |
The secret key to use when creating AWSCredentials. |
|
|
SourceProfile | System.String |
When this CredentialProfileOptions object references another CredentialProfile, the name of the referenced CredentialProfile. |
|
|
Token | System.String |
The session token to be used to create AWSCredentials. |
|
|
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
